2008-09-01 05:13:32 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
< HTML >
< HEAD >
2008-10-14 00:36:54 +02:00
<!-- Generated by javadoc (build 1.5.0_15) on Mon Oct 13 15:29:02 PDT 2008 -->
2008-09-01 05:13:32 +02:00
< META http-equiv = "Content-Type" content = "text/html; charset=ISO-8859-1" >
< TITLE >
2008-10-14 00:36:54 +02:00
Expose (Gson 1.2.1 API)
2008-09-01 05:13:32 +02:00
< / TITLE >
2008-10-14 00:36:54 +02:00
< META NAME = "keywords" CONTENT = "com.google.gson.annotations.Expose class" >
2008-09-01 05:13:32 +02:00
< LINK REL = "stylesheet" TYPE = "text/css" HREF = "../../../../stylesheet.css" TITLE = "Style" >
< SCRIPT type = "text/javascript" >
function windowTitle()
{
2008-10-14 00:36:54 +02:00
parent.document.title="Expose (Gson 1.2.1 API)";
2008-09-01 05:13:32 +02:00
}
< / SCRIPT >
< NOSCRIPT >
< / NOSCRIPT >
< / HEAD >
< BODY BGCOLOR = "white" onload = "windowTitle();" >
<!-- ========= START OF TOP NAVBAR ======= -->
< A NAME = "navbar_top" > <!-- --> < / A >
< A HREF = "#skip-navbar_top" title = "Skip navigation links" > < / A >
< TABLE BORDER = "0" WIDTH = "100%" CELLPADDING = "1" CELLSPACING = "0" SUMMARY = "" >
< TR >
< TD COLSPAN = 2 BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" >
< A NAME = "navbar_top_firstrow" > <!-- --> < / A >
< TABLE BORDER = "0" CELLPADDING = "0" CELLSPACING = "3" SUMMARY = "" >
< TR ALIGN = "center" VALIGN = "top" >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "../../../../overview-summary.html" > < FONT CLASS = "NavBarFont1" > < B > Overview< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "package-summary.html" > < FONT CLASS = "NavBarFont1" > < B > Package< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#FFFFFF" CLASS = "NavBarCell1Rev" > < FONT CLASS = "NavBarFont1Rev" > < B > Class< / B > < / FONT > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "class-use/Expose.html" > < FONT CLASS = "NavBarFont1" > < B > Use< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "package-tree.html" > < FONT CLASS = "NavBarFont1" > < B > Tree< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "../../../../deprecated-list.html" > < FONT CLASS = "NavBarFont1" > < B > Deprecated< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "../../../../index-all.html" > < FONT CLASS = "NavBarFont1" > < B > Index< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "../../../../help-doc.html" > < FONT CLASS = "NavBarFont1" > < B > Help< / B > < / FONT > < / A > < / TD >
< / TR >
< / TABLE >
< / TD >
< TD ALIGN = "right" VALIGN = "top" ROWSPAN = 3 > < EM >
< / EM >
< / TD >
< / TR >
< TR >
< TD BGCOLOR = "white" CLASS = "NavBarCell2" > < FONT SIZE = "-2" >
PREV CLASS
< A HREF = "../../../../com/google/gson/annotations/SerializedName.html" title = "annotation in com.google.gson.annotations" > < B > NEXT CLASS< / B > < / A > < / FONT > < / TD >
< TD BGCOLOR = "white" CLASS = "NavBarCell2" > < FONT SIZE = "-2" >
< A HREF = "../../../../index.html?com/google/gson/annotations/Expose.html" target = "_top" > < B > FRAMES< / B > < / A >
< A HREF = "Expose.html" target = "_top" > < B > NO FRAMES< / B > < / A >
< SCRIPT type = "text/javascript" >
<!--
if(window==top) {
document.writeln('< A HREF = "../../../../allclasses-noframe.html" > < B > All Classes< / B > < / A > ');
}
//-->
< / SCRIPT >
< NOSCRIPT >
< A HREF = "../../../../allclasses-noframe.html" > < B > All Classes< / B > < / A >
< / NOSCRIPT >
< / FONT > < / TD >
< / TR >
< TR >
< TD VALIGN = "top" CLASS = "NavBarCell3" > < FONT SIZE = "-2" >
SUMMARY: REQUIRED | OPTIONAL< / FONT > < / TD >
< TD VALIGN = "top" CLASS = "NavBarCell3" > < FONT SIZE = "-2" >
DETAIL: ELEMENT< / FONT > < / TD >
< / TR >
< / TABLE >
< A NAME = "skip-navbar_top" > < / A >
<!-- ========= END OF TOP NAVBAR ========= -->
< HR >
<!-- ======== START OF CLASS DATA ======== -->
< H2 >
< FONT SIZE = "-1" >
com.google.gson.annotations< / FONT >
< BR >
Annotation Type Expose< / H2 >
< HR >
< DL >
2008-10-14 00:36:54 +02:00
< DT > < PRE > < FONT SIZE = "-1" > < A HREF = "http://java.sun.com/j2se/1.5.0/docs/api/java/lang/annotation/Retention.html" title = "class or interface in java.lang.annotation" > @Retention< / A > (< A HREF = "http://java.sun.com/j2se/1.5.0/docs/api/java/lang/annotation/Retention.html#value()" title = "class or interface in java.lang.annotation" > value< / A > =< A HREF = "http://java.sun.com/j2se/1.5.0/docs/api/java/lang/annotation/RetentionPolicy.html#RUNTIME" title = "class or interface in java.lang.annotation" > RUNTIME< / A > )
< A HREF = "http://java.sun.com/j2se/1.5.0/docs/api/java/lang/annotation/Target.html" title = "class or interface in java.lang.annotation" > @Target< / A > (< A HREF = "http://java.sun.com/j2se/1.5.0/docs/api/java/lang/annotation/Target.html#value()" title = "class or interface in java.lang.annotation" > value< / A > =< A HREF = "http://java.sun.com/j2se/1.5.0/docs/api/java/lang/annotation/ElementType.html#FIELD" title = "class or interface in java.lang.annotation" > FIELD< / A > )
2008-09-01 05:13:32 +02:00
< / FONT > public @interface < B > Expose< / B > < / DL >
< / PRE >
< P >
An annotation that indicates this member should be exposed for JSON
serialization or deserialization.
< p > This annotation has no effect unless you build < A HREF = "../../../../com/google/gson/Gson.html" title = "class in com.google.gson" > < CODE > Gson< / CODE > < / A >
with a < A HREF = "../../../../com/google/gson/GsonBuilder.html" title = "class in com.google.gson" > < CODE > GsonBuilder< / CODE > < / A > and invoke
< A HREF = "../../../../com/google/gson/GsonBuilder.html#excludeFieldsWithoutExposeAnnotation()" > < CODE > GsonBuilder.excludeFieldsWithoutExposeAnnotation()< / CODE > < / A >
method.< / p >
< p > Here is an example of how this annotation is meant to be used:
< p > < pre >
public class User {
& #64Expose private String firstName;
& #64Expose private String lastName;
& #64Expose private String emailAddress;
private String password;
}
< / pre > < / p >
If you created Gson with < code > new Gson()< / code > , the < code > toJson()< / code > and < code > fromJson()< / code >
methods will use the < code > password< / code > field along-with < code > firstName< / code > , < code > lastName< / code > ,
and < code > emailAddress< / code > for serialization and deserialization. However, if you created Gson
with < code > Gson gson = new GsonBuilder().excludeFieldsWithoutExposeAnnotation().create()< / code >
then the < code > toJson()< / code > and < code > fromJson()< / code > methods of Gson will exclude the
< code > password< / code > field. This is because the < code > password< / code > field is not marked with the
< code > @Expose< / code > annotation.
< p > Note that another way to achieve the same effect would have been to just mark the
< code > password< / code > field as < code > transient< / code > , and Gson would have excluded it even with default
settings. The < code > @Expose< / code > annotation is useful in a style of programming where you want to
explicitly specify all fields that should get considered for serialization or deserialization.
< P >
< P >
< DL >
< DT > < B > Author:< / B > < / DT >
< DD > Inderjeet Singh< / DD >
< / DL >
< P >
< P >
<!-- ========= END OF CLASS DATA ========= -->
< HR >
<!-- ======= START OF BOTTOM NAVBAR ====== -->
< A NAME = "navbar_bottom" > <!-- --> < / A >
< A HREF = "#skip-navbar_bottom" title = "Skip navigation links" > < / A >
< TABLE BORDER = "0" WIDTH = "100%" CELLPADDING = "1" CELLSPACING = "0" SUMMARY = "" >
< TR >
< TD COLSPAN = 2 BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" >
< A NAME = "navbar_bottom_firstrow" > <!-- --> < / A >
< TABLE BORDER = "0" CELLPADDING = "0" CELLSPACING = "3" SUMMARY = "" >
< TR ALIGN = "center" VALIGN = "top" >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "../../../../overview-summary.html" > < FONT CLASS = "NavBarFont1" > < B > Overview< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "package-summary.html" > < FONT CLASS = "NavBarFont1" > < B > Package< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#FFFFFF" CLASS = "NavBarCell1Rev" > < FONT CLASS = "NavBarFont1Rev" > < B > Class< / B > < / FONT > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "class-use/Expose.html" > < FONT CLASS = "NavBarFont1" > < B > Use< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "package-tree.html" > < FONT CLASS = "NavBarFont1" > < B > Tree< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "../../../../deprecated-list.html" > < FONT CLASS = "NavBarFont1" > < B > Deprecated< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "../../../../index-all.html" > < FONT CLASS = "NavBarFont1" > < B > Index< / B > < / FONT > < / A > < / TD >
< TD BGCOLOR = "#EEEEFF" CLASS = "NavBarCell1" > < A HREF = "../../../../help-doc.html" > < FONT CLASS = "NavBarFont1" > < B > Help< / B > < / FONT > < / A > < / TD >
< / TR >
< / TABLE >
< / TD >
< TD ALIGN = "right" VALIGN = "top" ROWSPAN = 3 > < EM >
< / EM >
< / TD >
< / TR >
< TR >
< TD BGCOLOR = "white" CLASS = "NavBarCell2" > < FONT SIZE = "-2" >
PREV CLASS
< A HREF = "../../../../com/google/gson/annotations/SerializedName.html" title = "annotation in com.google.gson.annotations" > < B > NEXT CLASS< / B > < / A > < / FONT > < / TD >
< TD BGCOLOR = "white" CLASS = "NavBarCell2" > < FONT SIZE = "-2" >
< A HREF = "../../../../index.html?com/google/gson/annotations/Expose.html" target = "_top" > < B > FRAMES< / B > < / A >
< A HREF = "Expose.html" target = "_top" > < B > NO FRAMES< / B > < / A >
< SCRIPT type = "text/javascript" >
<!--
if(window==top) {
document.writeln('< A HREF = "../../../../allclasses-noframe.html" > < B > All Classes< / B > < / A > ');
}
//-->
< / SCRIPT >
< NOSCRIPT >
< A HREF = "../../../../allclasses-noframe.html" > < B > All Classes< / B > < / A >
< / NOSCRIPT >
< / FONT > < / TD >
< / TR >
< TR >
< TD VALIGN = "top" CLASS = "NavBarCell3" > < FONT SIZE = "-2" >
SUMMARY: REQUIRED | OPTIONAL< / FONT > < / TD >
< TD VALIGN = "top" CLASS = "NavBarCell3" > < FONT SIZE = "-2" >
DETAIL: ELEMENT< / FONT > < / TD >
< / TR >
< / TABLE >
< A NAME = "skip-navbar_bottom" > < / A >
<!-- ======== END OF BOTTOM NAVBAR ======= -->
< HR >
Copyright © 2008. All Rights Reserved.
< / BODY >
< / HTML >