auto.parcelgson.AutoParcelGson Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2012 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 auto.parcelgson;

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

/**
 * Specifies that AutoParcel should
 * generate an implementation class for the annotated abstract class, implementing the standard
 * {@link Object} methods like {@link Object#equals equals} to have conventional value semantics. A
 * simple example:  * 
 *   @AutoParcelGson
 *   abstract class Person implements Parcelable {
 *     static Person create(String name, int id) {
 *       return new AutoParcelGson_Person(name, id);
 *     }
 * 

 *     abstract String name();
 *     abstract int id();
 *   }
 *
 * @author Éamonn McManus
 * @author Kevin Bourrillion
 * @see AutoParcel User's Guide
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface AutoParcelGson {

  /**
   * Specifies that AutoParcelGson should generate an implementation of the annotated class or interface,
   * to serve as a builder for the value-type class it is nested within. As a simple example,
   * here is an alternative way to write the {@code Person} class mentioned in the {@link AutoParcelGson}
   * example:    * 
   *   @AutoParcel
   *   abstract class Person {
   *     static Builder builder() {
   *       return new AutoParcelGson_Person.Builder();
   *     }
   * 

   *     abstract String name();
   *     abstract int id();
   * 

   *     @AutoParcel.Builder
   *     interface Builder {
   *       Builder name(String x);
   *       Builder id(int x);
   *       Person build();
   *     }
   *   }
   * 
   * 
This API is provisional and subject to change.
   *
   * @author Éamonn McManus
   */
  @Retention(RetentionPolicy.SOURCE)
  @Target(ElementType.TYPE)
  public @interface Builder {
  }

  /**
   * Specifies that the annotated method is a validation method. The method should be a non-private
   * no-argument method in an AutoParcel class. It will be called by the {@code build()} method of
   * the {@link Builder @AutoParcelGson.Builder} implementation, immediately after constructing the new
   * object. It can throw an exception if the new object fails validation checks.
   */
  @Retention(RetentionPolicy.SOURCE)
  @Target(ElementType.METHOD)
  public @interface Validate {
  }
}