Interface Annotations

All Known Implementing Classes:
AnnotationsProvider

public interface Annotations
Provides methods for working with annotations.
Author:
cdivilly
  • Field Details

    • INSTANCE

      static final Annotations INSTANCE
      Global Annotations Service instance, for use by code that runs outside of the dependency injection runtime
  • Method Details

    • create

      <T extends Annotation> Annotations.Builder<T> create(Class<T> type)
      Create an Annotation literal Annotations.Builder.
      Type Parameters:
      T - An instance of an Annotation sub-type
      Parameters:
      type - The type of annotation to build
      Returns:
      a Annotations.Builder instance.
      See Also:
    • equals

      boolean equals(Annotation[] expected, Annotation[] actual)
      Determines if one array of annotations is exactly equivalent to another
      Parameters:
      expected - The annotations that must be present
      actual - The annotations that are present
      Returns:
      true if the actual set of annotations is identical to the expected set of annotations
    • literal

      <T extends Annotation> T literal(Class<T> type)
      Create an Annotation literal value that has no properties.
      Type Parameters:
      T - An instance of an Annotation sub-type
      Parameters:
      type - The type of annotation to instantiate
      Returns:
      Annotation instance
    • literal

      <T extends Annotation> T literal(Class<T> type, Object value)
      Create an Annotation literal value for the specified Annotation type, using the specified #value() property.
      Type Parameters:
      T - An instance of an Annotation sub-type
      Parameters:
      type - The type of annotation to instantiate
      value - The value to assign to the #value() property
      Returns:
      Annotation instance
    • matches

      default boolean matches(Annotation[] expected, Annotation[] actual)
      Determines if one array of annotations is a subset of another
      Parameters:
      expected - The annotations that must be present
      actual - The annotations that are present
      Returns:
      true if the actual set of annotations contains every annotation in the expected set, false otherwise
    • matches

      boolean matches(Iterable<? extends Annotation> expected, Iterable<? extends Annotation> actual)
      Determines if one array of annotations is a subset of another
      Parameters:
      expected - The annotations that must be present
      actual - The annotations that are present
      Returns:
      true if the actual set of annotations contains every annotation in the expected set, false otherwise
      Since:
      19.3.0
    • modify

      <T extends Annotation> Annotations.Builder<T> modify(T annotation)
      Create an Annotation literal Annotations.Builder initialized with the values of an existing annotation.
      Type Parameters:
      T - An instance of an Annotation sub-type
      Parameters:
      annotation - The existing annotation instance
      Returns:
      Annotations.Builder instance
    • instance

      static Annotations instance()
      Retrieve the global instance of Annotations
      Returns:
      Annotations singleton instance
      Since:
      19.3.0