Annotation - [ Java参考文档 ] - 在线原生手册

目录搜索

文字

概述

软件包

类

使用

树

已过时

索引

帮助

Java^TM 2 Platform
Standard Ed. 6

上一个下一个

框架 无框架

接口 java.lang.annotation.Annotation
的使用

使用 Annotation 的软件包
java.beans	包含与开发 beans 有关的类，即基于 JavaBeans^TM 架构的组件。
java.lang	提供利用 Java 编程语言进行程序设计的基础类。
java.lang.annotation	为 Java 编程语言注释设施提供库支持。
java.lang.reflect	提供类和接口，以获得关于类和对象的反射信息。
javax.annotation
javax.annotation.processing	用来声明注释处理器并允许注释处理器与注释处理工具环境通信的工具。
javax.jws
javax.jws.soap
javax.lang.model.element	用于 Java 编程语言的模型元素的接口。
javax.management	提供 Java Management Extensions 的核心类。
javax.xml.bind.annotation	定义将 Java 程序元素定制成 XML 模式映射的注释。
javax.xml.bind.annotation.adapters	`XmlAdapter` 及其规范定义的子类允许任意 Java 类与 JAXB 一起使用。
javax.xml.ws	此包包含核心 JAX-WS API。

java.beans 中 Annotation 的使用

实现 Annotation 的 java.beans 中的类
`interface`	`ConstructorProperties` 关于构造方法的注释，用来说明该构造方法的参数如何与被构造对象的获取方法相对应。

java.lang 中 Annotation 的使用

实现 Annotation 的 java.lang 中的类
`interface`	`Deprecated` 用 @Deprecated 注释的程序元素，不鼓励程序员使用这样的元素，通常是因为它很危险或存在更好的选择。
`interface`	`Override` 表示一个方法声明打算重写超类中的另一个方法声明。
`interface`	`SuppressWarnings` 指示应该在注释元素（以及包含在该注释元素中的所有程序元素）中取消显示指定的编译器警告。

类型参数类型为 Annotation 的 java.lang 中的方法




<A extends Annotation> 


A

Package.getAnnotation(Class<A> annotationClass)




<A extends Annotation> 


A

Class.getAnnotation(Class<A> annotationClass)

返回 Annotation 的 java.lang 中的方法
`Annotation[]`	`Package.getAnnotations()`
`Annotation[]`	`Class.getAnnotations()`
`Annotation[]`	`Package.getDeclaredAnnotations()`
`Annotation[]`	`Class.getDeclaredAnnotations()`

类型变量类型为 Annotation 的 java.lang 中的方法参数
`boolean`	`Package.isAnnotationPresent(Class<? extends Annotation> annotationClass)`
`boolean`	`Class.isAnnotationPresent(Class<? extends Annotation> annotationClass)`

java.lang.annotation 中 Annotation 的使用

实现 Annotation 的 java.lang.annotation 中的类
`interface`	`Documented` 指示某一类型的注释将通过 javadoc 和类似的默认工具进行文档化。
`interface`	`Inherited` 指示注释类型被自动继承。
`interface`	`Retention` 指示注释类型的注释要保留多久。
`interface`	`Target` 指示注释类型所适用的程序元素的种类。

返回变量类型为 Annotation 的类型的 java.lang.annotation 中的方法
`Class<? extends Annotation>`	`IncompleteAnnotationException.annotationType()` 返回带有缺少元素的注释类型的 Class 对象。
`Class<? extends Annotation>`	`Annotation.annotationType()` 返回此 annotation 的注释类型。

类型变量类型为 Annotation 的 java.lang.annotation 中的构造方法参数
`IncompleteAnnotationException(Class<? extends Annotation> annotationType, String elementName)` 构造一个指示指定注释类型中缺少指定元素的 IncompleteAnnotationException。

java.lang.reflect 中 Annotation 的使用

类型参数类型为 Annotation 的 java.lang.reflect 中的方法




<T extends Annotation> 


T

Constructor.getAnnotation(Class<T> annotationClass)




<T extends Annotation> 


T

Method.getAnnotation(Class<T> annotationClass)




<T extends Annotation> 


T

Field.getAnnotation(Class<T> annotationClass)




<T extends Annotation> 


T

AccessibleObject.getAnnotation(Class<T> annotationClass)




<T extends Annotation> 


T

AnnotatedElement.getAnnotation(Class<T> annotationClass)
如果存在该元素的指定类型的注释，则返回这些注释，否则返回 null。

返回 Annotation 的 java.lang.reflect 中的方法
`Annotation[]`	`AccessibleObject.getAnnotations()`
`Annotation[]`	`AnnotatedElement.getAnnotations()` 返回此元素上存在的所有注释。
`Annotation[]`	`Constructor.getDeclaredAnnotations()`
`Annotation[]`	`Method.getDeclaredAnnotations()`
`Annotation[]`	`Field.getDeclaredAnnotations()`
`Annotation[]`	`AccessibleObject.getDeclaredAnnotations()`
`Annotation[]`	`AnnotatedElement.getDeclaredAnnotations()` 返回直接存在于此元素上的所有注释。
`Annotation[][]`	`Constructor.getParameterAnnotations()` 按照声明顺序返回一组数组，这些数组表示通过此 `Constructor` 对象表示的方法的形参上的注释。
`Annotation[][]`	`Method.getParameterAnnotations()` 返回表示按照声明顺序对此 `Method` 对象所表示方法的形参进行注释的那个数组的数组。

类型变量类型为 Annotation 的 java.lang.reflect 中的方法参数
`boolean`	`AccessibleObject.isAnnotationPresent(Class<? extends Annotation> annotationClass)`
`boolean`	`AnnotatedElement.isAnnotationPresent(Class<? extends Annotation> annotationClass)` 如果指定类型的注释存在于此元素上，则返回 true，否则返回 false。

javax.annotation 中 Annotation 的使用

实现 Annotation 的 javax.annotation 中的类
`interface`	`Generated` Generated 注释用于标记已生成的源代码。
`interface`	`PostConstruct` PostConstruct 注释用于在依赖关系注入完成之后需要执行的方法上，以执行任何初始化。
`interface`	`PreDestroy` PreDestroy 注释作为回调通知用于各方法，以表示该实例正处于被容器移除的过程中。
`interface`	`Resource` Resource 注释标记应用程序所需的资源。
`interface`	`Resources` 此类用于允许多个资源声明。

javax.annotation.processing 中 Annotation 的使用

实现 Annotation 的 javax.annotation.processing 中的类
`interface`	`SupportedAnnotationTypes` 用来指示注释处理器支持哪些注释类型的注释。
`interface`	`SupportedOptions` 用来指示注释处理器支持哪些选项的注释。
`interface`	`SupportedSourceVersion` 用来指示注释处理器所支持的最新源版本的注释。

类型变量类型为 Annotation 的 javax.annotation.processing 中的方法参数
`Set<? extends Element>`	`RoundEnvironment.getElementsAnnotatedWith(Class<? extends Annotation> a)` 返回使用给定注释类型注释的元素。

javax.jws 中 Annotation 的使用

实现 Annotation 的 javax.jws 中的类
`interface`	`HandlerChain` 将 Web Service 与外部定义的处理程序链关联。
`interface`	`Oneway` 指示给定 @WebMethod 只有一条输入消息并且没有输出。
`interface`	`WebMethod` 定制一个公开为 Web Service 操作的方法。
`interface`	`WebParam` 定制单个参数到 Web Service 消息部分和 XML 元素的映射关系。
`interface`	`WebResult` 定制返回值到 WSDL 部分和 XML 元素的映射关系。
`interface`	`WebService` 将 Java 类标记为实现 Web Service，或者将 Java 接口标记为定义 Web Service 接口。

javax.jws.soap 中 Annotation 的使用

实现 Annotation 的 javax.jws.soap 中的类
`interface`	`InitParam` 已过时。从 JSR-181 2.0 开始，无替代版本。
`interface`	`SOAPBinding` 指定 Web Service 到 SOAP 消息协议的映射关系。
`interface`	`SOAPMessageHandler` 已过时。从 JSR-181 2.0 开始，无替代版本。
`interface`	`SOAPMessageHandlers` 已过时。从 JSR-181 2.0 开始，无替代版本。

javax.lang.model.element 中 Annotation 的使用

类型参数类型为 Annotation 的 javax.lang.model.element 中的方法




<A extends Annotation> 


A

Element.getAnnotation(Class<A> annotationType)
返回此元素针对指定类型的注释（如果存在这样的注释），否则返回 null。

javax.management 中 Annotation 的使用

实现 Annotation 的 javax.management 中的类
`interface`	`DescriptorKey` 描述注释元素与 `Descriptor` 中字段之间关联方式的元注释。
`interface`	`MXBean` 显式地标记某一接口是否为 MXBean 接口的注释。

javax.xml.bind.annotation 中 Annotation 的使用

实现 Annotation 的 javax.xml.bind.annotation 中的类
`interface`	`XmlAccessorOrder` 控制类中字段和属性的排序。
`interface`	`XmlAccessorType` 控制默认情况下是否对字段或 Javabean 属性进行系列化。
`interface`	`XmlAnyAttribute` 将 JavaBean 属性映射到通配符属性的映射表中。
`interface`	`XmlAnyElement` 将 JavaBean 属性映射到 XML 信息集表示形式和/或 JAXB 元素。
`interface`	`XmlAttachmentRef` 标记字段/属性，其 XML 形式是对 MIME 内容的 URI 引用。
`interface`	`XmlAttribute` 将 JavaBean 属性映射到 XML 属性。
`interface`	`XmlElement` 将 JavaBean 属性映射到派生于属性名称的 XML 元素。
`interface`	`XmlElementDecl` 将工厂方法映射到 XML 元素。
`interface`	`XmlElementRef` 将 JavaBean 属性映射到派生于属性类型的 XML 元素。
`interface`	`XmlElementRefs` 标记一个属性，该属性引用带有 `XmlElement` 或 JAXBElement 的类。
`interface`	`XmlElements` 多个 @`XmlElement` 注释的容器。
`interface`	`XmlElementWrapper` 生成一个包装 XML 表示形式的包装器元素。
`interface`	`XmlEnum` 将枚举类型 `Enum` 映射到 XML 表示形式。
`interface`	`XmlEnumValue` 将 `Enum` 类型中的枚举常量映射到 XML 表示形式。
`interface`	`XmlID` 将 JavaBean 属性映射到 XML ID。
`interface`	`XmlIDREF` 将 JavaBean 属性映射到 XML IDREF。
`interface`	`XmlInlineBinaryData` 禁止对绑定到 XML 中 base64-encoded 二进制数据的数据类型进行 XOP 编码。
`interface`	`XmlList` 用来将属性映射到列表简单类型。
`interface`	`XmlMimeType` 关联控制属性 XML 表示形式的 MIME 类型。
`interface`	`XmlMixed` 注释 JavaBean 多值属性，以支持混合内容。
`interface`	`XmlNs` 关联名称空间前缀与 XML 名称空间 URI。
`interface`	`XmlRegistry` 标记具有 `XmlElementDecl` 的类。
`interface`	`XmlRootElement` 将类或枚举类型映射到 XML 元素。
`interface`	`XmlSchema` 将包名称映射到 XML 名称空间。
`interface`	`XmlSchemaType` 将 Java 类型映射到一个简单的模式内置类型。
`interface`	`XmlSchemaTypes` 多个 @`XmlSchemaType` 注释的容器。
`interface`	`XmlTransient` 阻止将 JavaBean 属性映射到 XML 表示形式。
`interface`	`XmlType` 将类或枚举类型映射到 XML 模式类型。
`interface`	`XmlValue` 支持将类映射到带有 simpleContent 的 XML 模式复杂类型或 XML 模式简单类型。

javax.xml.bind.annotation.adapters 中 Annotation 的使用

实现 Annotation 的 javax.xml.bind.annotation.adapters 中的类
`interface`	`XmlJavaTypeAdapter` 对自定义编组使用实现 `XmlAdapter` 的适配器。
`interface`	`XmlJavaTypeAdapters` 多个 @`XmlJavaTypeAdapter` 注释的容器。

javax.xml.ws 中 Annotation 的使用

实现 Annotation 的 javax.xml.ws 中的类
`interface`	`BindingType` `BindingType` 注释用于指定 Web 服务端点实现类所使用的绑定。
`interface`	`RequestWrapper` 此类通过将在运行时使用的请求包装器 bean 注释服务端点接口中的方法。
`interface`	`ResponseWrapper` 此类通过将在运行时使用的响应包装器 bean 注释服务端点接口中的方法。
`interface`	`ServiceMode` 用于指示 Provider 实现是希望使用整个协议消息还是只使用协议消息负载。
`interface`	`WebEndpoint` 此类用来注释所生成服务接口的 `getPortName()` 方法。
`interface`	`WebFault` 此类用来注释特定于服务的异常类，以自定义故障元素的本地名称和名称空间名称以及故障 bean 的名称。
`interface`	`WebServiceClient` 此类用来注释生成的服务接口。
`interface`	`WebServiceProvider` 此类用来注释 Provider 实现类。
`interface`	`WebServiceRef` `WebServiceRef` 注释用于定义 Web 服务及其（可选）注入目标的引用。
`interface`	`WebServiceRefs` `WebServiceRefs` 注释允许在类级别声明多个 web 服务引用。

概述