arez.annotations.OnDepsChanged Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of arez-annotations Show documentation

Arez Annotations

There is a newer version: 0.95

package arez.annotations;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Target;
import javax.annotation.Nonnull;

/**
 * Identifies method that will be invoked when the dependencies of the paired @Track annotated method are changed.
 *
 * The method that is annotated with OnDepsChanged must comply with the additional constraints:
 * 
 * Must not be annotated with any other arez annotation
 * Must not be private
 * Must not be static
 * Must not be abstract
 * Must have no parameters
 * Must not return a value
 * Must not throw an exception
 * 
 */
@Documented
@Target( ElementType.METHOD )
public @interface OnDepsChanged
{
  /**
   * Return the name of the paired Tracked relative to the component.
   * The value must conform to the requirements of a java identifier.
   * The name need not be specified. If the @Track annotated method is
   * named "render" then this will default to being named "onRenderDepsChanged".
   *
   * @return the name of the paired @Track annotated method relative to the component.
   */
  @Nonnull
  String name() default "";
}