Package org.jboss.jandex

Class AnnotationInstance

  • public final class AnnotationInstance
extends java.lang.Object
    An annotation instance represents a specific usage of an annotation on a target. It contains a set of values, as well as a reference to the target itself (e.g. class, field, method, etc).

    Thread-Safety

    This class is immutable and can be shared between threads without safe publication.

    • Method Detail

      • create

        public static final AnnotationInstance create​(DotName name,
                                              AnnotationTarget target,
                                              AnnotationValue[] values)
        Construct a new mock annotation instance. The passed values array will be defensively copied.
        Parameters:
        name - the name of the annotation instance
        target - the thing the annotation is declared on
        values - the values of this annotation instance
        Returns:
        the new mock Annotation Instance

      • create

        public static final AnnotationInstance create​(DotName name,
                                              AnnotationTarget target,
                                              java.util.List<AnnotationValue> values)
        Construct a new mock annotation instance. The passed values list will be defensively copied.
        Parameters:
        name - the name of the annotation instance
        target - the thing the annotation is declared on
        values - the values of this annotation instance
        Returns:
        the new mock Annotation Instance

      • name

        public DotName name()
        The name of this annotation in DotName form.
        Returns:
        the name of this annotation

      • target

        public AnnotationTarget target()
        The Java element that this annotation was declared on. This can be a class, a field, a method, or a method parameter. In addition it may be null if this instance is a nested annotation, in which case there is no target.
        Returns:
        the target this annotation instance refers to

      • value

        public AnnotationValue value​(java.lang.String name)
        Returns a value that corresponds with the specified parameter name. If the parameter was not specified by this instance then null is returned. Note that this also applies to a defaulted parameter, which is not recorded in the target class.
        Parameters:
        name - the parameter name
        Returns:
        the value of the specified parameter, or null if not provided

      • value

        public AnnotationValue value()
        Returns the value that is associated with the special default "value" parameter.
        Returns:
        the "value" value

      • valueWithDefault

        public AnnotationValue valueWithDefault​(IndexView index,
                                        java.lang.String name)
        Returns a value that corresponds with the specified parameter name, accounting for its default value. Since an annotation's defaults are only stored on the annotation's defining class, and not usages of the annotation, an index containing the Annotation class must be provided as a parameter. If the index does not contain the defining annotation class, then an IllegalArgumentException will be thrown to prevent non-deterministic results.

        If the parameter was not specified by this instance, then the annotation's ClassInfo is checked for a default value. If there is a default, that value is returned. Otherwise null is returned.

        Parameters:
        index - the index containing the defining annotation class
        name - the name of the annotation parameter
        Returns:
        the value of the specified parameter, the default, or null
        Throws:
        java.lang.IllegalArgumentException - if index does not contain the defining annotation class
        Since:
        2.1

      • valueWithDefault

        public AnnotationValue valueWithDefault​(IndexView index)
        Returns the value that is associated with the special default "value" parameter, also accounting for a value default. Since an annotation's defaults are only stored on the annotation's defining class, and not usages of the annotation, an index containing the Annotation class must be provided as a parameter. If the index does not contain the defining annotation class, then an IllegalArgumentException will be thrown to prevent non-deterministic results.

        If the "value" parameter was not specified by this instance, then the annotation's ClassInfo is checked for a default value. If there is a default, that value is returned. Otherwise null is returned.

        Parameters:
        index - the index containing the defining annotation class
        Returns:
        the "value" value, or its default, or null
        Throws:
        java.lang.IllegalArgumentException - if index does not contain the defining annotation class
        Since:
        2.1

      • valuesWithDefaults

        public java.util.List<AnnotationValue> valuesWithDefaults​(IndexView index)
        Returns a list of all parameter values on this annotation instance, including default values id defined. Since an annotation's defaults are only stored on the annotation's defining class, and not usages of the annotation, an index containing the Annotation class must be provided as a parameter. If the index does not contain the defining annotation class, then an IllegalArgumentException will be thrown to prevent non-deterministic results.

        The order of this list is undefined.

        Returns:
        the parameter values of this annotation
        Throws:
        java.lang.IllegalArgumentException - if index does not contain the defining annotation class
        Since:
        2.1

      • values

        public java.util.List<AnnotationValue> values()
        Returns a list of all parameter values on this annotation instance. While random access is allowed, the ordering algorithm of the list should not be relied upon. Although it will be consistent for the life of this instance.
        Returns:
        the parameter values of this annotation

      • toString

        public java.lang.String toString​(boolean simple)
        Returns an optionally simplified string that represents this annotation instance. If simplified the output is smaller but missing information, such as the package qualifier.
        Parameters:
        simple - whether to provide a simpler string representation
        Returns:
        a string representation for this object
        Since:
        2.0

      • toString

        public java.lang.String toString()
        Returns a string representation for this annotation instance. This method is equivalent to calling toString(boolean) with a value of true.
        Overrides:
        toString in class java.lang.Object
        Returns:
        a simple string representation for this annotation instance

      • equals

        public boolean equals​(java.lang.Object o)
        Returns whether or not this annotation instance is equivalent to another instance. An annotation instance is equivalent if its name and values are equal, and it shares the exact same AnnotationTarget instance. The latter restriction may be softened in future versions.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        o - the annotation instance to compare to.
        Returns:
        true if equal, false if not
        See Also:
        Object.equals(Object)

      • hashCode

        public int hashCode()
        Returns a hash code representing this object.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        the hash code of this object
        See Also:
        Object.hashCode()