arez.annotations.OnDispose 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 is called when the ComputedValue is disposed.
 *
 * The method must also conform to the following constraints:
 * 
 * Must not be annotated with any other arez annotation
 * Must have 0 parameters
 * Must not return a value
 * Must not be private
 * Must not be static
 * Must not be abstract
 * Must not throw exceptions
 * 
 */
@Documented
@Target( ElementType.METHOD )
public @interface OnDispose
{
  /**
   * Return the name of the ComputedValue that this method is associated with.
   * This value of the name will be derived if the method name matches the pattern "on[Name]Dispose",
   * otherwise it must be specified.
   *
   * @return the name of the ComputedValue.
   */
  @Nonnull
  String name() default "";
}