|
JavaTM Platform Standard Ed. 6 |
|||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
java.lang.Object javax.xml.bind.helpers.AbstractMarshallerImpl
public abstract class AbstractMarshallerImpl
部分的なデフォルト Marshaller 実装です。
このクラスは、Marshaller
インタフェースの部分的なデフォルト実装を提供します。
JAXB プロバイダが実装する必要があるメソッドは、marshal(Object, javax.xml.transform.Result)
、marshal(Object, javax.xml.stream.XMLStreamWriter)
、および marshal(Object, javax.xml.stream.XMLEventWriter)
のみです。
Marshaller
入れ子のクラスの概要 |
---|
インタフェース javax.xml.bind.Marshaller から継承された入れ子のクラス/インタフェース |
---|
Marshaller.Listener |
フィールドの概要 |
---|
インタフェース javax.xml.bind.Marshaller から継承されたフィールド |
---|
JAXB_ENCODING, JAXB_FORMATTED_OUTPUT, JAXB_FRAGMENT, JAXB_NO_NAMESPACE_SCHEMA_LOCATION, JAXB_SCHEMA_LOCATION |
コンストラクタの概要 | |
---|---|
AbstractMarshallerImpl()
|
メソッドの概要 | ||
---|---|---|
|
getAdapter(Class<A> type)
指定した型に関連付けられているアダプタを取得します。 |
|
AttachmentMarshaller |
getAttachmentMarshaller()
|
|
protected String |
getEncoding()
現在の出力エンコーディングを取得するための簡易メソッドです。 |
|
ValidationEventHandler |
getEventHandler()
現在のイベントハンドラ、または、それが設定されていない場合はデフォルトイベントハンドラを返します。 |
|
protected String |
getJavaEncoding(String encoding)
IANA 名から対応する Java エンコーディング名を取得します。 |
|
Marshaller.Listener |
getListener()
この Marshaller に登録されている Marshaller.Listener を返します。 |
|
Node |
getNode(Object obj)
デフォルトでは、getNode メソッドはサポートされず、 UnsupportedOperationException をスローします。 |
|
protected String |
getNoNSSchemaLocation()
現在の noNamespaceSchemaLocation を取得するための簡易メソッドです。 |
|
Object |
getProperty(String name)
getProperty メソッドのデフォルト実装では、Marshaller の 4 つの定義済みプロパティーを扱います。 |
|
Schema |
getSchema()
整列化時の検証に使用される JAXP 1.3 Schema オブジェクトを取得します。 |
|
protected String |
getSchemaLocation()
現在の schemaLocation を取得するための簡易メソッドです。 |
|
protected boolean |
isFormattedOutput()
書式設定された出力フラグを取得するための簡易メソッドです。 |
|
protected boolean |
isFragment()
フラグメントフラグを取得するための簡易メソッドです。 |
|
void |
marshal(Object obj,
ContentHandler handler)
jaxbElement をルートとするコンテンツツリーを SAX2 イベントに整列化します。 |
|
void |
marshal(Object jaxbElement,
File output)
jaxbElement をルートとするコンテンツツリーをファイルに整列化します。 |
|
void |
marshal(Object obj,
Node node)
jaxbElement をルートとするコンテンツツリーを DOM ツリーに整列化します。 |
|
void |
marshal(Object obj,
OutputStream os)
jaxbElement をルートとするコンテンツツリーを出力ストリームに整列化します。 |
|
void |
marshal(Object obj,
Writer w)
jaxbElement をルートとするコンテンツツリーを Writer に整列化します。 |
|
void |
marshal(Object obj,
XMLEventWriter writer)
jaxbElement をルートとするコンテンツツリーを XMLEventWriter に整列化します。 |
|
void |
marshal(Object obj,
XMLStreamWriter writer)
jaxbElement をルートとするコンテンツツリーを XMLStreamWriter に整列化します。 |
|
|
setAdapter(Class<A> type,
A adapter)
XmlAdapter の設定済みのインスタンスをこの Marshaller に関連付けます。 |
|
void |
setAdapter(XmlAdapter adapter)
XmlAdapter の設定済みのインスタンスをこの Marshaller に関連付けます。 |
|
void |
setAttachmentMarshaller(AttachmentMarshaller am)
XML 文書内のバイナリデータを、XML バイナリの最適化された添付として転送可能にするコンテキストを関連付けます。 |
|
protected void |
setEncoding(String encoding)
出力エンコーディングを設定するための簡易メソッドです。 |
|
void |
setEventHandler(ValidationEventHandler handler)
アプリケーションで検証イベントハンドラを登録できるようにします。 |
|
protected void |
setFormattedOutput(boolean v)
書式設定された出力フラグを設定するための簡易メソッドです。 |
|
protected void |
setFragment(boolean v)
フラグメントフラグを設定するための簡易メソッドです。 |
|
void |
setListener(Marshaller.Listener listener)
この Marshaller に整列化イベントコールバック Marshaller.Listener を登録します。 |
|
protected void |
setNoNSSchemaLocation(String location)
noNamespaceSchemaLocation を設定するための簡易メソッドです。 |
|
void |
setProperty(String name,
Object value)
setProperty メソッドのデフォルト実装では、Marshaller の 4 つの定義済みプロパティーを扱います。 |
|
void |
setSchema(Schema schema)
後の整列化操作の検証に使用する、JAXP 1.3 Schema オブジェクトを指定します。 |
|
protected void |
setSchemaLocation(String location)
schemaLocation を設定するための簡易メソッドです。 |
クラス java.lang.Object から継承されたメソッド |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
インタフェース javax.xml.bind.Marshaller から継承されたメソッド |
---|
marshal |
コンストラクタの詳細 |
---|
public AbstractMarshallerImpl()
メソッドの詳細 |
---|
public final void marshal(Object obj, OutputStream os) throws JAXBException
Marshaller
の記述:
Marshaller
内の marshal
obj
- 整列化するコンテンツツリーのルートos
- XML はこのストリームに追加される
JAXBException
- 整列化の実行中に予想外の問題が発生した場合
MarshalException
- ValidationEventHandler
の handleEvent メソッドから false が返されるか、Marshaller が obj (または obj から到達可能なオブジェクト) を整列化できない場合。「JAXB 要素の整列化」を参照public void marshal(Object jaxbElement, File output) throws JAXBException
Marshaller
の記述:
Marshaller
内の marshal
jaxbElement
- 整列化するコンテンツツリーのルートoutput
- 書き込まれるファイル。このファイルがすでに存在する場合は上書きされる
JAXBException
- 整列化の実行中に予想外の問題が発生した場合
MarshalException
- ValidationEventHandler
の handleEvent メソッドから false が返されるか、Marshaller が obj (または obj から到達可能なオブジェクト) を整列化できない場合。「JAXB 要素の整列化」を参照public final void marshal(Object obj, Writer w) throws JAXBException
Marshaller
の記述:
Marshaller
内の marshal
obj
- 整列化するコンテンツツリーのルートw
- XML はこのライターに送信される
JAXBException
- 整列化の実行中に予想外の問題が発生した場合
MarshalException
- ValidationEventHandler
の handleEvent メソッドから false が返されるか、Marshaller が obj (または obj から到達可能なオブジェクト) を整列化できない場合。「JAXB 要素の整列化」を参照public final void marshal(Object obj, ContentHandler handler) throws JAXBException
Marshaller
の記述:
Marshaller
内の marshal
obj
- 整列化するコンテンツツリーのルートhandler
- XML はこのハンドラに SAX2 イベントとして送信される
JAXBException
- 整列化の実行中に予想外の問題が発生した場合
MarshalException
- ValidationEventHandler
の handleEvent メソッドから false が返されるか、Marshaller が obj (または obj から到達可能なオブジェクト) を整列化できない場合。「JAXB 要素の整列化」を参照public final void marshal(Object obj, Node node) throws JAXBException
Marshaller
の記述:
Marshaller
内の marshal
obj
- 整列化するコンテンツツリーnode
- DOM ノードがこのノードの子として追加される。このパラメータは、子 (Document
、DocumentFragment
、または Element
) を受け入れるノードにする必要がある
JAXBException
- 整列化の実行中に予想外の問題が発生した場合
MarshalException
- ValidationEventHandler
の handleEvent メソッドから false が返されるか、Marshaller が jaxbElement (または jaxbElement から到達可能なオブジェクト) を整列化できない場合。「JAXB 要素の整列化」を参照public Node getNode(Object obj) throws JAXBException
UnsupportedOperationException
をスローします。
このメソッドをサポートすることを選択した実装は、このメソッドをオーバーライドする必要があります。
Marshaller
内の getNode
obj
- - XML コンテンツの JAXB Java 表現
JAXBException
- 予想外の問題が発生した場合protected String getEncoding()
protected void setEncoding(String encoding)
encoding
- Marshaller クラス文書で指定された有効なエンコーディングprotected String getSchemaLocation()
protected void setSchemaLocation(String location)
location
- schemaLocation 値protected String getNoNSSchemaLocation()
protected void setNoNSSchemaLocation(String location)
location
- noNamespaceSchemaLocation 値protected boolean isFormattedOutput()
protected void setFormattedOutput(boolean v)
v
- 書式設定された出力フラグの値protected boolean isFragment()
protected void setFragment(boolean v)
v
- フラグメントフラグの値protected String getJavaEncoding(String encoding) throws UnsupportedEncodingException
UnsupportedEncodingException
- この実装が Java エンコーディング名を検出できなかった場合public void setProperty(String name, Object value) throws PropertyException
Marshaller
内の setProperty
name
- 設定するプロパティーの名前。この値は、定数フィールドの 1 つかユーザーが指定した文字列を使用して指定できるvalue
- 設定するプロパティーの値
PropertyException
- 指定したプロパティーまたは値の処理中にエラーが発生した場合public Object getProperty(String name) throws PropertyException
Marshaller
内の getProperty
name
- 取得するプロパティーの名前
PropertyException
- 指定したプロパティーまたは値プロパティー名の取得中にエラーが発生した場合public ValidationEventHandler getEventHandler() throws JAXBException
Marshaller
の記述:
Marshaller
内の getEventHandler
JAXBException
- 現在のイベントハンドラの取得中にエラーが発生した場合Marshaller.getEventHandler()
public void setEventHandler(ValidationEventHandler handler) throws JAXBException
Marshaller
の記述:検証イベントハンドラは、いずれかの整列化 API を呼び出している途中で検証エラーが発生した場合に JAXB プロバイダによって呼び出されます。整列化メソッドのいずれかを呼び出す前に、クライアントアプリケーションが検証イベントハンドラを登録していない場合、検証イベントはデフォルトイベントハンドラによって処理されます。デフォルトイベントハンドラは、最初のエラーまたは致命的なエラーの発生後に整列化操作を終了させます。
このメソッドを null パラメータとともに呼び出した場合、Marshaller はデフォルトのデフォルトイベントハンドラに戻されます。
Marshaller
内の setEventHandler
handler
- 検証イベントハンドラ
JAXBException
- イベントハンドラの設定中にエラーが発生した場合Marshaller.setEventHandler(ValidationEventHandler)
public void marshal(Object obj, XMLEventWriter writer) throws JAXBException
Marshaller
の記述:XMLEventWriter
に整列化します。
Marshaller
内の marshal
obj
- 整列化する jaxbElement をルートとするコンテンツツリーwriter
- XML はこのライターに送信される
JAXBException
- 整列化の実行中に予想外の問題が発生した場合
MarshalException
- ValidationEventHandler
の handleEvent メソッドから false が返されるか、Marshaller が obj (または obj から到達可能なオブジェクト) を整列化できない場合。「JAXB 要素の整列化」を参照public void marshal(Object obj, XMLStreamWriter writer) throws JAXBException
Marshaller
の記述:XMLStreamWriter
に整列化します。
Marshaller
内の marshal
obj
- 整列化するコンテンツツリーwriter
- XML はこのライターに送信される
JAXBException
- 整列化の実行中に予想外の問題が発生した場合
MarshalException
- ValidationEventHandler
の handleEvent メソッドから false が返されるか、Marshaller が obj (または obj から到達可能なオブジェクト) を整列化できない場合。「JAXB 要素の整列化」を参照public void setSchema(Schema schema)
Marshaller
の記述:Schema
オブジェクトを指定します。このメソッドに null を渡すと、検証は無効になります。
このメソッドにより、呼び出し側は整列化の実行時に、整列化される XML を検証できます。
このプロパティーは最初に null に設定されます。
Marshaller
内の setSchema
schema
- 整列化操作の検証に使用するスキーマオブジェクト。検証を無効にする場合は nullpublic Schema getSchema()
Marshaller
の記述:Schema
オブジェクトを取得します。Marshaller にスキーマが設定されていない場合、このメソッドは、整列化時に検証を実行しないことを示す、null を返します。
Marshaller
内の getSchema
public void setAdapter(XmlAdapter adapter)
Marshaller
の記述:XmlAdapter
の設定済みのインスタンスをこの Marshaller に関連付けます。
これは、setAdapter(adapter.getClass(),adapter);
を呼び出す簡易メソッドです。
Marshaller
内の setAdapter
Marshaller.setAdapter(Class,XmlAdapter)
public <A extends XmlAdapter> void setAdapter(Class<A> type, A adapter)
Marshaller
の記述:XmlAdapter
の設定済みのインスタンスをこの Marshaller に関連付けます。
すべての Marshaller は、内部的に Map
<Class
,XmlAdapter
> を保持しており、フィールドまたはメソッドが XmlJavaTypeAdapter
で注釈されたクラスを整列化するために使用します。
このメソッドにより、アプリケーションは XmlAdapter
の設定済みのインスタンスを使用することができます。アダプタのインスタンスが与えられない場合、Marshaller はそれのデフォルトコンストラクタを呼び出してインスタンスを作成します。
Marshaller
内の setAdapter
type
- アダプタの型。XmlJavaTypeAdapter.value()
がこの型を参照する場合は、指定したインスタンスが使用されるadapter
- 使用するアダプタのインスタンス。null の場合、この型に対して現在設定されているアダプタの登録が解除されるpublic <A extends XmlAdapter> A getAdapter(Class<A> type)
Marshaller
の記述:Marshaller.setAdapter(javax.xml.bind.annotation.adapters.XmlAdapter)
メソッドの逆の操作です。
Marshaller
内の getAdapter
public void setAttachmentMarshaller(AttachmentMarshaller am)
Marshaller
の記述:XML 文書内のバイナリデータを、XML バイナリの最適化された添付として転送可能にするコンテキストを関連付けます。添付は、XML 文書コンテンツモデルから、XML 文書内に保存されたコンテンツ ID URI (cid) 参照によって参照されます。
Marshaller
内の setAttachmentMarshaller
public AttachmentMarshaller getAttachmentMarshaller()
Marshaller
内の getAttachmentMarshaller
public void setListener(Marshaller.Listener listener)
Marshaller
の記述:
この Marshaller
に整列化イベントコールバック Marshaller.Listener
を登録します。
各 Marshaller に Listener は 1 つだけです。Listener を設定すると、前に設定されていた Listener と置き換わります。Listener に null を設定することにより、現在の Listener の登録を解除できます。
Marshaller
内の setListener
listener
- Marshaller.Listener
を実装するクラスのインスタンスpublic Marshaller.Listener getListener()
Marshaller
の記述:この Marshaller
に登録されている Marshaller.Listener
を返します。
Marshaller
内の getListener
Marshaller.Listener
、または、この Marshaller に登録されている Listener がない場合、null
|
JavaTM Platform Standard Ed. 6 |
|||||||||
前のクラス 次のクラス | フレームあり フレームなし | |||||||||
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド |
Copyright 2009 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。