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

Explore the source code of the class

 * 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
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * See the License for the specific language governing permissions and
 * limitations under the License.


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

 * An annotation that indicates the version number until a member or a type should be present.
 * Basically, if Gson is created with a version number that exceeds the value stored in the
 * [email protected] Until} annotation then the field will be ignored from the JSON output.  This annotation
 * is useful to manage versioning of your JSON classes for a web-service.

* This annotation has no effect unless you build [email protected]} with a * [email protected]} and invoke * [email protected]} method. * *

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

 * public class User {
 *   private String firstName;
 *   private String lastName;
 *   @Until(1.1) private String emailAddress;
 *   @Until(1.1) private String password;
 * }
* *

If you created Gson with [email protected] new Gson()}, the [email protected] toJson()} and [email protected] fromJson()} * methods will use all the fields for serialization and deserialization. However, if you created * Gson with [email protected] Gson gson = new GsonBuilder().setVersion(1.2).create()} then the * [email protected] toJson()} and [email protected] fromJson()} methods of Gson will exclude the [email protected] emailAddress} * and [email protected] password} fields from the example above, because the version number passed to the * GsonBuilder, [email protected] 1.2}, exceeds the version number set on the [email protected] Until} annotation, * [email protected] 1.1}, for those fields. * * @author Inderjeet Singh * @author Joel Leitch * @since 1.3 */ @Retention(RetentionPolicy.RUNTIME) @Target({ElementType.FIELD, ElementType.TYPE}) public @interface Until { /** * the value indicating a version number until this member * or type should be ignored. */ double value(); }