com.airbnb.epoxy.PackageEpoxyConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of epoxy-annotations Show documentation
Epoxy is a system for composing complex screens with a ReyclerView in Android.
There is a newer version: 5.1.4
package com.airbnb.epoxy;

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

/**
 * Use this annotation on any class in your package to specify default behavior for the Epoxy
 * annotation processor for that package. You can only have one instance of this annotation per
 * package.
 * 
 * If an instance of this annotation is not found in a package then the default values are used.
 * 

 * See https://github.com/airbnb/epoxy/wiki/Configuration for more details on these options.
 */
@Target(ElementType.PACKAGE)
@Retention(RetentionPolicy.CLASS)
public @interface PackageEpoxyConfig {
  boolean REQUIRE_HASHCODE_DEFAULT = false;
  boolean REQUIRE_ABSTRACT_MODELS_DEFAULT = false;
  boolean IMPLICITLY_ADD_AUTO_MODELS_DEFAULT = false;
  /**
   * If true, all fields marked with {@link com.airbnb.epoxy.EpoxyAttribute} must have a type that
   * implements hashCode and equals (besides the default Object implementation), or the attribute
   * must set DoNotHash as an option.
   * 

   * Setting this to true is useful for ensuring that all model attributes correctly implement
   * hashCode and equals, or use DoNotHash (eg for click listeners). It is a common mistake to miss
   * these, which leads to invalid model state and incorrect diffing.
   * 

   * The check is done at compile time and compilation will fail if a hashCode validation fails.
   * 

   * Since it is done at compile time this can only check the direct type of the field. Interfaces
   * or classes will pass the check if they either have an abstract hashCode/equals method (since it
   * is assumed that the object at runtime will implement it) or their class hierarchy must have an
   * implementation of hashCode/equals besides the default Object implementation.
   * 

   * If an attribute is an Iterable or Array then the type of object in that collection must
   * implement hashCode/equals.
   */
  boolean requireHashCode() default REQUIRE_HASHCODE_DEFAULT;

  /**
   * If true, all classes that contains {@link com.airbnb.epoxy.EpoxyAttribute} or {@link
   * com.airbnb.epoxy.EpoxyModelClass} annotations in your project must be abstract. Otherwise
   * compilation will fail.
   * 

   * Forcing models to be abstract can prevent the mistake of using the original model class instead
   * of the generated class.
   */
  boolean requireAbstractModels() default REQUIRE_ABSTRACT_MODELS_DEFAULT;

  /**
   * If true, models in an EpoxyController that use the {@link AutoModel} annotation don't need to
   * be explicitly added to the controller with ".addTo". Instead, they will be added automatically
   * after they are modified.
   * 
   * For more details, see the wiki:
   * https://github.com/airbnb/epoxy/wiki/Epoxy-Controller#implicit-adding
   */
  boolean implicitlyAddAutoModels() default IMPLICITLY_ADD_AUTO_MODELS_DEFAULT;
}