javax.xml.bind.annotation

Annotation Type XmlElementRef

@Retention(value=RUNTIME)
 @Target(value={FIELD,METHOD})
public @interface XmlElementRef

图一个JavaBean属性的一种源于属性的类型的XML元素。

使用

@XmlElementRef注释可以使用JavaBean属性或在XmlElementRefs

这个注释的动态关联的XML元素的名称与JavaBean属性。当一个JavaBean属性的注释与XmlElement，XML元素名称静来自JavaBean的属性名称。然而，当使用这个注释，XML元素名来源于运行时的JavaBean属性的类的实例。

schema模式替换组支持

XML Schema的XML文档的作者可以使用XML元素名称，不是一种模式使用替代组的内容模型的静态指定。图式源代码提供了使用元素性质替代团体的支持，（第5.5.5、“单元属性”的JAXB 2规范）。一个元素的属性的方法签名的形式是：

public void setTerm（jaxbelement）；公共jaxbelementgetterm()；

一元工厂方法注释的XmlElementDecl是用来创建一个JAXBElement实例，包含一个XML元素名称。在元件属性的“xmlelementref注释的存在表明JAXBElement实例元素名称代替从JavaBean属性名称导出的XML元素的名称。

使用是受以下约束：

• 如果集合项目类型（收集财产）或产权式（单值属性）是JAXBElement，然后@XmlElementRef}.name()和@XmlElementRef.namespace()必须点一个类中注明“xmlregistry @ xmlelementdecl注释元素工厂方法（通常是由编译器生成的图式化类）：
  • “xmlelementdecl。（）必须等于@ xmlelementref。（）
  • “xmlelementdecl。namespace() @ xmlelementref namespace()必须相等。
• 如果集合项目类型（收集财产）或产权式（单值属性）是不JAXBElement，然后通过属性或字段引用的类型必须注明XmlRootElement。
• 这个注释可以用下面的注释：XmlElementWrapper，XmlJavaTypeAdapter。

看到“包装规范”的额外的信息共享javax.xml.bind.package javadoc。

例1：蚁群任务的例子

以下java类层次结构模型的Ant构建脚本。一个蚂蚁任务对应于类层次结构中的一个类。蚂蚁任务的XML元素的名称是由其对应的类“xmlrootelement注释说明。

“xmlrootelement（name =“目标”）班级目标{// @ xmlelementref的存在表明，XML/ /元素名称将由“xmlrootelement//注释的类型（例如，“罐子”JarTask）。@ XmlElementRef列表
 
        
        
        
      
        
      <任务>
       
         
       
         
         
         
  任务；}抽象类任务}“xmlrootelement（name=“罐子”）类jartask延伸任务{…}“xmlrootelement（name=“javac”）类javactask延伸任务{…}<！“XML模式片段”>< xs：元名称=“目标”type=“目标”>< xs：complexType名称=“目标”>< xs：序列>< xs：选择maxOccurs =“无界”>< xs：元ref =“罐子”>< xs：元ref=“javac”>< / xs：选择>< / xs：序列>< / xs：名称>
 
        
        
        
      
        
      

因此下面的代码片段：

目标=新target()；目标。任务添加（新jartask()）；目标。任务添加（新javactask()）；元帅（目标）；

会产生下面的XML输出：

 
        
        
        
      
        
      <目标>
  
         
         
         
       
         
       <罐>
         的…< /罐>< javac >的…< / javac >< /目标> 
       
 
        
        
        
      
        
      

这是不是有一个类扩展Task没有XmlRootElement错误。但他们不能出现在一个XML实例（因为他们没有XML元素名称）。

例2：XML Schema取代集团的支持

下面的示例显示了XML模式替换组的注释。注释和化源于图式。

@ xmlelement数学课堂{type()is /价值/ / jaxbelement.class，说明XML/ /元一般类标记化-名称// @ xmlregistry。（见化下）/ // / name()是“经营者”，一个指向带有注释的工厂方法/ / XmlElementDecl名字与“经营者”。自/ /“操作符”是替换组的负责人/ /包含元素“添加”和“子”元素，“操作符”/ /元素可以在实例文档中替换/ /元素“添加”或“子”。在运行时，jaxbelement/实例包含已被的元素名称在XML文档中替换。/ /@ XmlElementRef（类型= jaxbelement。类，名字为“经营者”）jaxbelement <？扩展操作员>术语；}@ XmlRegistry类化{@ XmlElementDecl（name=“经营者”）jaxbelement <
 
        
        
        
      
        
      <运算符>
       
         
       
         
         
         
   createoperator（算符O）{…}@ XmlElementDecl（name=“添加”，substitutionheadname =“经营者”）jaxbelement <
  
         
         
         
       
         
       <运算符>
         createadd（算符O）{…}@ XmlElementDecl（name=“子”，substitutionheadname =“经营者”）jaxbelement < 
        <运算符>
          创建子（算符O）{…}}类算子{…} 
         
       
 
        
        
        
      
        
      

因此，下面的代码片段

数学新math() M =；m.term =新objectfactory() createadd（新operator()）；元帅（M）；

会产生下面的XML输出：

<
 
        
        
        
      
        
      <数学>
       
         
       
         
         
         
  >
  
         
         
         
       
         
       <添加>
         ……< /数学> 
       
 
        
        
        
      
        
      

从以下版本开始：

jaxb2.0

另请参见：

XmlElementRefs

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	name
String	namespace 该参数用于确定和 name() JavaBean属性的XML元素。
boolean	required 自定义需要的元素声明。
类	type java类型的引用。

Element Detail

type

public abstract 类 type

java类型的引用。

如果价值是DEFAULT.class，类型是从类型的JavaBean属性推断。

Default:

javax.xml.bind.annotation.xmlelementref.default.class

namespace

public abstract String namespace

该参数用于确定和 name() JavaBean属性的XML元素。

如果type()是JAXBElement.class，然后namespace()和name()点与XmlElementDecl工厂方法。XML元素名称的元素的名称从工厂方法的XmlElementDecl注释或者其替代组元素（它是一头元）已经在XML文档中的元素名称取代，然后从XmlElementDecl取代元素。

如果type()不JAXBElement.class，那么XML元素的名称和使用注释对XmlRootElement型静态关联的XML元素的名称。如果类型没有被注释的一个XmlElementDecl，那么它是一个错误。

如果type()不JAXBElement.class，那么这个值必须是“”。

Default:

“”

name

public abstract String name

另请参见：

namespace()

Default:

“# #默认”

required

public abstract boolean required

自定义需要的元素声明。

如果required()属实，那么JavaBean属性映射为XML架构元素声明具有minoccurs =“1”。“1”maxOccurs单值属性和“无界”的多值属性。

如果required()是假的，那么JavaBean属性映射为XML架构元素声明具有minoccurs =“0”。“1”maxOccurs单值属性和“无界”的多值属性。

用JAXB 2.1的兼容性，该属性的默认值为true，尽管XmlElement.required()默认为false。

从以下版本开始：

二点二

Default:

真正的