Annotation (Java Platform SE 8 ) (original) (raw)

• All Known Implementing Classes:
  Action, Addressing, BindingType, ConstructorProperties, Deprecated, DescriptorKey, Documented, FaultAction, FunctionalInterface, Generated, HandlerChain, Inherited, InitParam, MTOM, MXBean, Native, Oneway, Override, PostConstruct, PreDestroy, Repeatable, RequestWrapper, Resource, Resources, RespectBinding, ResponseWrapper, Retention, SafeVarargs, ServiceMode, SOAPBinding, SOAPMessageHandler, SOAPMessageHandlers, SupportedAnnotationTypes, SupportedOptions, SupportedSourceVersion, SuppressWarnings, Target, Transient, WebEndpoint, WebFault, WebMethod, WebParam, WebResult, WebService, WebServiceClient, WebServiceFeatureAnnotation, WebServiceProvider, WebServiceRef, WebServiceRefs, XmlAccessorOrder, XmlAccessorType, XmlAnyAttribute, XmlAnyElement, XmlAttachmentRef, XmlAttribute, XmlElement, XmlElementDecl, XmlElementRef, XmlElementRefs, XmlElements, XmlElementWrapper, XmlEnum, XmlEnumValue, XmlID, XmlIDREF, XmlInlineBinaryData, XmlJavaTypeAdapter, XmlJavaTypeAdapters, XmlList, XmlMimeType, XmlMixed, XmlNs, XmlRegistry, XmlRootElement, XmlSchema, XmlSchemaType, XmlSchemaTypes, XmlSeeAlso, XmlTransient, XmlType, XmlValue

public interface Annotation
The common interface extended by all annotation types. Note that an interface that manually extends this one does not define an annotation type. Also note that this interface does not itself define an annotation type. More information about annotation types can be found in section 9.6 ofThe Java™ Language Specification. The AnnotatedElement interface discusses compatibility concerns when evolving an annotation type from being non-repeatable to being repeatable.
Since:
1.5

• • Method Summary

  All Methods Instance Methods Abstract Methods

  Modifier and Type	Method	Description
  Class<? extends Annotation>	annotationType()	Returns the annotation type of this annotation.
  boolean	equals(Object obj)	Returns true if the specified object represents an annotation that is logically equivalent to this one.
  int	hashCode()	Returns the hash code of this annotation, as defined below:
  String	toString()	Returns a string representation of this annotation.

• • Method Detail

     * #### equals  
     boolean equals([Object](../../../java/lang/Object.html "class in java.lang") obj)  
     Returns true if the specified object represents an annotation that is logically equivalent to this one. In other words, returns true if the specified object is an instance of the same annotation type as this instance, all of whose members are equal to the corresponding member of this annotation, as defined below:  
              * Two corresponding primitive typed members whose values arex and y are considered equal if x == y, unless their type is float or double.  
              * Two corresponding float members whose values are x and y are considered equal ifFloat.valueOf(x).equals(Float.valueOf(y)). (Unlike the \== operator, NaN is considered equal to itself, and 0.0f unequal to \-0.0f.)  
              * Two corresponding double members whose values are x and y are considered equal ifDouble.valueOf(x).equals(Double.valueOf(y)). (Unlike the \== operator, NaN is considered equal to itself, and 0.0 unequal to \-0.0.)  
              * Two corresponding String, Class, enum, or annotation typed members whose values are x and y are considered equal if x.equals(y). (Note that this definition is recursive for annotation typed members.)  
              * Two corresponding array typed members x and y are considered equal if Arrays.equals(x, y), for the appropriate overloading of [Arrays.equals(long\[\], long\[\])](../../../java/util/Arrays.html#equals-long:A-long:A-).  
     Overrides:  
     `[equals](../../../java/lang/Object.html#equals-java.lang.Object-)` in class `[Object](../../../java/lang/Object.html "class in java.lang")`  
     Parameters:  
     `obj` \- the reference object with which to compare.  
     Returns:  
     true if the specified object represents an annotation that is logically equivalent to this one, otherwise false  
     See Also:  
     [Object.hashCode()](../../../java/lang/Object.html#hashCode--), [HashMap](../../../java/util/HashMap.html "class in java.util")  
     * #### hashCode  
     int hashCode()  
     Returns the hash code of this annotation, as defined below:  
     The hash code of an annotation is the sum of the hash codes of its members (including those with default values), as defined below: The hash code of an annotation member is (127 times the hash code of the member-name as computed by [String.hashCode()](../../../java/lang/String.html#hashCode--)) XOR the hash code of the member-value, as defined below:  
     The hash code of a member-value depends on its type:  
              * The hash code of a primitive value _v_ is equal to_WrapperType_.valueOf(_v_).hashCode(), where_WrapperType_ is the wrapper type corresponding to the primitive type of _v_ ([Byte](../../../java/lang/Byte.html "class in java.lang"),[Character](../../../java/lang/Character.html "class in java.lang"), [Double](../../../java/lang/Double.html "class in java.lang"), [Float](../../../java/lang/Float.html "class in java.lang"), [Integer](../../../java/lang/Integer.html "class in java.lang"),[Long](../../../java/lang/Long.html "class in java.lang"), [Short](../../../java/lang/Short.html "class in java.lang"), or [Boolean](../../../java/lang/Boolean.html "class in java.lang")).  
              * The hash code of a string, enum, class, or annotation member-value I _v_ is computed as by calling_v_.hashCode(). (In the case of annotation member values, this is a recursive definition.)  
              * The hash code of an array member-value is computed by calling the appropriate overloading of[Arrays.hashCode](../../../java/util/Arrays.html#hashCode-long:A-) on the value. (There is one overloading for each primitive type, and one for object reference types.)  
     Overrides:  
     `[hashCode](../../../java/lang/Object.html#hashCode--)` in class `[Object](../../../java/lang/Object.html "class in java.lang")`  
     Returns:  
     the hash code of this annotation  
     See Also:  
     [Object.equals(java.lang.Object)](../../../java/lang/Object.html#equals-java.lang.Object-), [System.identityHashCode(java.lang.Object)](../../../java/lang/System.html#identityHashCode-java.lang.Object-)  
     * #### toString  
     [String](../../../java/lang/String.html "class in java.lang") toString()  
     Returns a string representation of this annotation. The details of the representation are implementation-dependent, but the following may be regarded as typical:  
        @com.acme.util.Name(first=Alfred, middle=E., last=Neuman)  
            
     Overrides:  
     `[toString](../../../java/lang/Object.html#toString--)` in class `[Object](../../../java/lang/Object.html "class in java.lang")`  
     Returns:  
     a string representation of this annotation  
     * #### annotationType  
     [Class](../../../java/lang/Class.html "class in java.lang")<? extends [Annotation](../../../java/lang/annotation/Annotation.html "interface in java.lang.annotation")> annotationType()  
     Returns the annotation type of this annotation.  
     Returns:  
     the annotation type of this annotation

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.