auto.parse.AutoParse 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.parse;

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

/**
 * Specifies that AutoParse 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:  *
 *   @AutoParse
 *   abstract class Person {
 *     static Person create(String name, int id) {
 *       return new AutoParse_Person(name, id);
 *     }
 *
 *     abstract String name();
 *     abstract int id();
 *   }
 *
 * @author Éamonn McManus
 * @author Kevin Bourrillion
 * @see AutoParse User's Guide
 */
@Retention(RetentionPolicy.SOURCE) @Target(ElementType.TYPE)
public @interface AutoParse {
  /**
   * Specifies whether the generated class should cache each instance's {@link Object#hashCode
   * hashCode} value in a field once it is first computed. Note: most classes should have
   * no need of this behavior and should omit this parameter entirely. Use only if certain of its
   * performance benefit to your application.
   *
   * Warning: while using mutable field types is strongly discouraged in general, using
   * this feature makes it especially dangerous.
   */
  boolean cacheHashCode() default false;
}