javax.xml.bind.annotation

注釈型XmlTransient

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

JavaBeanプロパティ/型のXML表現へのマッピングを禁止します。

@XmlTransient注釈は、JavaBeanプロパティ名とフィールド名の間の名前の競合を解決したり、フィールドまたはプロパティのマッピングを禁止したりするときに便利です。小文字に変換されたJavaBeanプロパティ名とフィールド名が同じ場合、名前の競合が発生する可能性があります。JavaBeanプロパティがフィールドを参照している場合、@XmlTransient注釈を使用してフィールドまたはJavaBeanプロパティのマッピングを禁止することによって、名前の競合を解決できます。

この注釈をクラスに配置した場合は、そのクラスが単独でXMLにマップされるべきでないことを示します。このようなクラスのプロパティは、クラスがインライン化されるかのように、その派生クラスとともにXMLにマップされます。

使用法

@XmlTransient注釈は、次のプログラム要素で使用できます。

• JavaBeanプロパティ
• フィールド
• クラス

@XmlTransientは、その他のすべての定義済みのJAXB注釈と相互に排他的です。

追加の一般的な情報については、javax.xml.bind.package javadocの「パッケージの仕様」を参照してください。

例: JavaBeanプロパティとフィールド名の間の名前の競合を解決する

   // Example: Code fragment
   public class USAddress {

       // The field name "name" collides with the property name
       // obtained by bean decapitalization of getName() below
       @XmlTransient public String name;

       String getName() {..};
       String setName() {..};
   }


   <!-- Example: XML Schema fragment -->
   <xs:complexType name="USAddress">
     <xs:sequence>
       <xs:element name="name" type="xs:string"/>
     </xs:sequence>
   </xs:complexType>
 

導入されたバージョン:

JAXB2.0