All Downloads are FREE. Search and download functionalities are using the official Maven repository.

Explore the source code of the class Expose.java

/*
 * Copyright (C) 2008 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.gson.annotations;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * An annotation that indicates this member should be exposed for JSON
 * serialization or deserialization.
 *
 * 

This annotation has no effect unless you build [email protected] com.google.gson.Gson} * with a [email protected] com.google.gson.GsonBuilder} and invoke * [email protected] com.google.gson.GsonBuilder#excludeFieldsWithoutExposeAnnotation()} * method.

* *

Here is an example of how this annotation is meant to be used: *

 * public class User {
 *   @Expose private String firstName;
 *   @Expose(serialize = false) private String lastName;
 *   @Expose (serialize = false, deserialize = false) private String emailAddress;
 *   private String password;
 * }
 * 

* If you created Gson with [email protected] new Gson()}, the [email protected] toJson()} and [email protected] fromJson()} * methods will use the [email protected] password} field along-with [email protected] firstName}, [email protected] lastName}, * and [email protected] emailAddress} for serialization and deserialization. However, if you created Gson * with [email protected] Gson gson = new GsonBuilder().excludeFieldsWithoutExposeAnnotation().create()} * then the [email protected] toJson()} and [email protected] fromJson()} methods of Gson will exclude the * [email protected] password} field. This is because the [email protected] password} field is not marked with the * [email protected] @Expose} annotation. Gson will also exclude [email protected] lastName} and [email protected] emailAddress} * from serialization since [email protected] serialize} is set to [email protected] false}. Similarly, Gson will * exclude [email protected] emailAddress} from deserialization since [email protected] deserialize} is set to false. * *

Note that another way to achieve the same effect would have been to just mark the * [email protected] password} field as [email protected] transient}, and Gson would have excluded it even with default * settings. The [email protected] @Expose} annotation is useful in a style of programming where you want to * explicitly specify all fields that should get considered for serialization or deserialization. * * @author Inderjeet Singh * @author Joel Leitch */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.FIELD) public @interface Expose { /** * If [email protected] true}, the field marked with this annotation is written out in the JSON while * serializing. If [email protected] false}, the field marked with this annotation is skipped from the * serialized output. Defaults to [email protected] true}. * @since 1.4 */ public boolean serialize() default true; /** * If [email protected] true}, the field marked with this annotation is deserialized from the JSON. * If [email protected] false}, the field marked with this annotation is skipped during deserialization. * Defaults to [email protected] true}. * @since 1.4 */ public boolean deserialize() default true; }