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