フィールドの詳細

• DEFAULT_ENCODING

  public static final StringSE DEFAULT_ENCODING

  ストリームアクセスに使用されるデフォルトのエンコーディング: UTF-8。

  関連事項:

  定数フィールド値

コンストラクターの詳細

• CastorMarshaller

  public CastorMarshaller()

メソッドの詳細

• setEncoding

  public void setEncoding(StringSE encoding)

  ストリームアクセスに使用するエンコードを設定します。

  関連事項:

  DEFAULT_ENCODING

• getDefaultEncoding

  protected StringSE getDefaultEncoding()

  クラスからコピーされた説明: AbstractMarshaller
  バイトストリームからのマーシャリングまたはアンマーシャリングに使用するデフォルトエンコーディングを決定します。存在しない場合は null を決定します。

  デフォルトの実装は null を返します。

  オーバーライド:

  クラス AbstractMarshaller の getDefaultEncoding 

• setMappingLocation

  public void setMappingLocation(Resource mappingLocation)

  Castor XML マッピングファイルの場所を設定します。

• setMappingLocations

  public void setMappingLocations(Resource... mappingLocations)

  Castor XML マッピングファイルの場所を設定します。

• setTargetClass

  public void setTargetClass(ClassSE<?> targetClass)

  Castor ターゲットクラスを設定します。

  関連事項:

  setTargetPackage(java.lang.String), setMappingLocation(org.springframework.core.io.Resource)

• setTargetClasses

  public void setTargetClasses(ClassSE<?>... targetClasses)

  Castor ターゲットクラスを設定します。

  関連事項:

  setTargetPackages(java.lang.String...), setMappingLocations(org.springframework.core.io.Resource...)

• setTargetPackage

  public void setTargetPackage(StringSE targetPackage)

  Castor 記述子クラスを使用してパッケージの名前を設定します。

• setTargetPackages

  public void setTargetPackages(StringSE... targetPackages)

  Castor 記述子クラスを使用してパッケージの名前を設定します。

• setValidating

  public void setValidating(boolean validating)

  このマーシャラーが送受信ドキュメントを検証するかどうかを設定します。

  デフォルトは false です。

  関連事項:

  Marshaller.setValidation(boolean)

• setSuppressNamespaces

  public void setSuppressNamespaces(boolean suppressNamespaces)

  このマーシャラーが名前空間を出力するかどうかを設定します。

  デフォルトは false です。つまり、名前空間が書き込まれます。

  関連事項:

  Marshaller.setSuppressNamespaces(boolean)

• setSuppressXsiType

  public void setSuppressXsiType(boolean suppressXsiType)

  このマーシャラーが xsi:type 属性を出力するかどうかを設定します。

  デフォルトは false です。つまり、xsi:type が書き込まれます。

  関連事項:

  Marshaller.setSuppressXSIType(boolean)

• setMarshalAsDocument

  public void setMarshalAsDocument(boolean marshalAsDocument)

  このマーシャラーが xml 宣言を出力するかどうかを設定します。

  デフォルトは true で、XML 宣言が書き込まれます。

  関連事項:

  Marshaller.setMarshalAsDocument(boolean)

• setMarshalExtendedType

  public void setMarshalExtendedType(boolean marshalExtendedType)

  このマーシャラーが指定された型の xsi:type 属性を出力するかどうかを設定します。

  デフォルトは true で、xsi:type 属性が書き込まれます。

  関連事項:

  Marshaller.setMarshalExtendedType(boolean)

• setRootElement

  public void setRootElement(StringSE rootElement)

  ルート要素の名前を設定します。

  関連事項:

  Marshaller.setRootElement(String)

• setNoNamespaceSchemaLocation

  public void setNoNamespaceSchemaLocation(StringSE noNamespaceSchemaLocation)

  xsi:noNamespaceSchemaLocation 属性の値を設定します。設定すると、xsi:noNamespaceSchemaLocation 属性がルート要素に書き込まれます。

  関連事項:

  Marshaller.setNoNamespaceSchemaLocation(String)

• setSchemaLocation

  public void setSchemaLocation(StringSE schemaLocation)

  xsi:schemaLocation 属性の値を設定します。設定すると、xsi:schemaLocation 属性がルート要素に書き込まれます。

  関連事項:

  Marshaller.setSchemaLocation(String)

• setUseXSITypeAtRoot

  public void setUseXSITypeAtRoot(boolean useXSITypeAtRoot)

  このマーシャラーがルート要素の xsi:type 属性を出力するかどうかを設定します。これは、要素名から単純に要素の型を判別できない場合に役立ちます。

  デフォルトは false です。ルート要素の xsi:type 属性は書き込まれません。

  関連事項:

  Marshaller.setUseXSITypeAtRoot(boolean)

• setWhitespacePreserve

  public void setWhitespacePreserve(boolean whitespacePreserve)

  Castor Unmarshaller が「無視できる」空白を保持するかどうかを設定します。

  デフォルトは false です。

  関連事項:

  Unmarshaller.setWhitespacePreserve(boolean)

• setIgnoreExtraAttributes

  public void setIgnoreExtraAttributes(boolean ignoreExtraAttributes)

  Castor Unmarshaller が特定のフィールドに一致しない属性を無視するかどうかを設定します。

  デフォルトは true です: 余分な属性は無視されます。

  関連事項:

  Unmarshaller.setIgnoreExtraAttributes(boolean)

• setIgnoreExtraElements

  public void setIgnoreExtraElements(boolean ignoreExtraElements)

  Castor Unmarshaller が特定のフィールドに一致しない要素を無視するかどうかを設定します。

  デフォルトは false です: 余分な要素はエラーとしてフラグが立てられます。

  関連事項:

  Unmarshaller.setIgnoreExtraElements(boolean)

• setRootObject

  public void setRootObject(ObjectSE root)

  ソースが非整列化される非整列化のために予想されるルートオブジェクトを設定します。

  関連事項:

  Unmarshaller.setObject(Object)

• setReuseObjects

  public void setReuseObjects(boolean reuseObjects)

  このアンマーシャラーがオブジェクトを再利用するかどうかを設定します。これは、既存のオブジェクトに非整列化する場合にのみ使用されます。

  デフォルトは false です。つまり、オブジェクトは再利用されません。

  関連事項:

  Unmarshaller.setReuseObjects(boolean)

• setClearCollections

  public void setClearCollections(boolean clearCollections)

  このアンマーシャラーが最初の使用時にコレクションをクリアするかどうかを設定します。

  デフォルトは false で、マーシャラーはコレクションをクリアしません。

  関連事項:

  Unmarshaller.setClearCollections(boolean)

• setCastorProperties

  public void setCastorProperties(MapSE<StringSE,StringSE> castorProperties)

  マーシャリングとアンマーシャリングの Castor 固有のプロパティを設定します。各エントリキーはプロパティ名と見なされ、各値はプロパティ値と見なされます。

  関連事項:

  Marshaller.setProperty(String, String), Unmarshaller.setProperty(String, String)

• setDoctypes

  public void setDoctypes(MapSE<StringSE,StringSE> doctypes)

  マーシャラーのドキュメント型定義を含むマップを設定します。各エントリには、キーとしてシステム ID があり、値として公開 ID があります。

  関連事項:

  Marshaller.setDoctype(String, String)

• setProcessingInstructions

  public void setProcessingInstructions(MapSE<StringSE,StringSE> processingInstructions)

  マーシャリング中に使用される処理命令を設定します。キーは処理対象であり、値には処理データが含まれます。

  関連事項:

  Marshaller.addProcessingInstruction(String, String)

• setNamespaceMappings

  public void setNamespaceMappings(MapSE<StringSE,StringSE> namespaceMappings)

  名前空間のマッピングを設定します。プロパティ名は名前空間接頭辞として解釈されます。値は名前空間 URI です。

  関連事項:

  Marshaller.setNamespaceMapping(String, String)

• setNamespaceToPackageMapping

  public void setNamespaceToPackageMapping(MapSE<StringSE,StringSE> namespaceToPackageMapping)

  名前空間をパッケージマッピングに設定します。プロパティ名は名前空間 URI を表し、値はパッケージです。

  関連事項:

  Marshaller.setNamespaceMapping(String, String)

• setEntityResolver

  public void setEntityResolver(EntityResolverSE entityResolver)

  アンマーシャリング中に使用される EntityResolverSE を設定します。このリゾルバーは、システム ID とパブリック ID を解決するために使用されます。

  関連事項:

  Unmarshaller.setEntityResolver(EntityResolver)

• setClassDescriptorResolver

  public void setClassDescriptorResolver(org.exolab.castor.xml.XMLClassDescriptorResolver classDescriptorResolver)

  アンマーシャリング中に使用される XMLClassDescriptorResolver を設定します。このリゾルバーは、クラス記述子を解決するために使用されます。

  関連事項:

  Unmarshaller.setResolver(XMLClassDescriptorResolver)

• setIdResolver

  public void setIdResolver(org.exolab.castor.xml.IDResolver idResolver)

  アンマーシャリング中に使用する Castor IDResolver を設定します。

  関連事項:

  Unmarshaller.setIDResolver(IDResolver)

• setObjectFactory

  public void setObjectFactory(org.exolab.castor.util.ObjectFactory objectFactory)

  アンマーシャリング中に使用する Castor ObjectFactory を設定します。

  関連事項:

  Unmarshaller.setObjectFactory(ObjectFactory)

• setBeanClassLoader

  public void setBeanClassLoader(ClassLoaderSE classLoader)

  インターフェースからコピーされた説明: BeanClassLoaderAware
  Bean class loaderSE を Bean インスタンスに提供するコールバック。

  通常の Bean プロパティの設定後、ただし InitializingBean's InitializingBean.afterPropertiesSet() メソッドやカスタム init-method などの初期化コールバックの前に呼び出されます。

  次で指定:

  インターフェース BeanClassLoaderAware の setBeanClassLoader 

  パラメーター:

  classLoader - 所有クラスローダー

• afterPropertiesSet

  public void afterPropertiesSet()
                          throws CastorMappingException,
                                 IOExceptionSE

  インターフェースからコピーされた説明: InitializingBean
  指定されたすべての Bean プロパティを設定した（そして BeanFactoryAware と ApplicationContextAware を満たした）後に BeanFactory によって呼び出されます。

  このメソッドにより、Bean インスタンスは、すべての Bean プロパティが設定されている場合にのみ可能な初期化を実行し、設定ミスの場合に例外をスローできます。

  次で指定:

  インターフェース InitializingBean の afterPropertiesSet 

  例外:

  CastorMappingException

  IOExceptionSE

• createXMLContext

  protected org.exolab.castor.xml.XMLContext createXMLContext(@Nullable
                                                              Resource[] mappingLocations,
                                                              @Nullable
                                                              ClassSE<?>[] targetClasses,
                                                              @Nullable
                                                              StringSE[] targetPackages)
                                                       throws org.exolab.castor.mapping.MappingException,
                                                              org.exolab.castor.xml.ResolverException,
                                                              IOExceptionSE

  Castor XMLContext を作成します。サブクラスはこれをオーバーライドしてカスタムコンテキストを作成できます。

  デフォルトの実装は、定義されている場合はマッピングファイルを、定義されている場合はターゲットクラスまたはパッケージをロードします。

  戻り値:

  作成されたリゾルバー

  例外:

  org.exolab.castor.mapping.MappingException - マッピングファイルをロードできない場合

  IOExceptionSE - I/O エラーの場合

  org.exolab.castor.xml.ResolverException

  関連事項:

  XMLContext.addMapping(org.exolab.castor.mapping.Mapping), XMLContext.addClass(Class)

• supports

  public boolean supports(ClassSE<?> clazz)

  すべてのクラスの true を返します。つまり、Castor は任意のクラスをサポートします。

  次で指定:

  インターフェース Marshaller の supports 

  次で指定:

  インターフェース Unmarshaller の supports 

  パラメーター:

  clazz - このマーシャラーがマーシャリングできるかどうか尋ねられているクラス

  戻り値:

  このマーシャラーが実際に提供されたクラスのインスタンスをマーシャリングできる場合は true。それ以外の場合は false 

• marshalDomNode

  protected void marshalDomNode(ObjectSE graph,
                                NodeSE node)
                         throws XmlMappingException

  クラスからコピーされた説明: AbstractMarshaller
  指定されたオブジェクトグラフを DOM Node にマーシャリングする抽象テンプレートメソッド。

  実際には、ノードは Document ノード、DocumentFragment ノード、Element ノードです。つまり、子を受け入れるノードです。

  次で指定:

  クラス AbstractMarshaller の marshalDomNode 

  パラメーター:

  graph - マーシャリングするオブジェクトグラフのルート

  node - 結果ツリーを含む DOM ノード

  例外:

  XmlMappingException - 指定されたオブジェクトを DOM ノードに整列化できない場合

  関連事項:

  DocumentSE, DocumentFragmentSE, ElementSE

• marshalXmlEventWriter

  protected void marshalXmlEventWriter(ObjectSE graph,
                                       XMLEventWriterSE eventWriter)
                                throws XmlMappingException

  クラスからコピーされた説明: AbstractMarshaller
  指定されたオブジェクトを StAX XMLEventWriter にマーシャリングする抽象テンプレートメソッド。

  次で指定:

  クラス AbstractMarshaller の marshalXmlEventWriter 

  パラメーター:

  graph - マーシャリングするオブジェクトグラフのルート

  eventWriter - 書き込む XMLEventWriter 

  例外:

  XmlMappingException - 指定されたオブジェクトを DOM ノードに整列化できない場合

• marshalXmlStreamWriter

  protected void marshalXmlStreamWriter(ObjectSE graph,
                                        XMLStreamWriterSE streamWriter)
                                 throws XmlMappingException

  クラスからコピーされた説明: AbstractMarshaller
  指定されたオブジェクトを StAX XMLStreamWriter にマーシャリングする抽象テンプレートメソッド。

  次で指定:

  クラス AbstractMarshaller の marshalXmlStreamWriter 

  パラメーター:

  graph - マーシャリングするオブジェクトグラフのルート

  streamWriter - 書き込む XMLStreamWriter 

  例外:

  XmlMappingException - 指定されたオブジェクトを DOM ノードに整列化できない場合

• marshalSaxHandlers

  protected void marshalSaxHandlers(ObjectSE graph,
                                    ContentHandlerSE contentHandler,
                                    @Nullable
                                    LexicalHandlerSE lexicalHandler)
                             throws XmlMappingException

  クラスからコピーされた説明: AbstractMarshaller
  指定されたオブジェクトグラフを SAX ContentHandler にマーシャリングする抽象テンプレートメソッド。

  次で指定:

  クラス AbstractMarshaller の marshalSaxHandlers 

  パラメーター:

  graph - マーシャリングするオブジェクトグラフのルート

  contentHandler - SAX ContentHandler

  lexicalHandler - SAX2 LexicalHandler null にすることができます。

  例外:

  XmlMappingException - 指定されたオブジェクトをハンドラーにマーシャリングできない場合

• marshalOutputStream

  protected void marshalOutputStream(ObjectSE graph,
                                     OutputStreamSE outputStream)
                              throws XmlMappingException,
                                     IOExceptionSE

  クラスからコピーされた説明: AbstractMarshaller
  指定されたオブジェクトグラフを OutputStream にマーシャリングする抽象テンプレートメソッド。

  次で指定:

  クラス AbstractMarshaller の marshalOutputStream 

  パラメーター:

  graph - マーシャリングするオブジェクトグラフのルート

  outputStream - 書き込む OutputStream 

  例外:

  XmlMappingException - 指定されたオブジェクトをライターにマーシャリングできない場合

  IOExceptionSE - I/O 例外が発生した場合

• marshalWriter

  protected void marshalWriter(ObjectSE graph,
                               WriterSE writer)
                        throws XmlMappingException,
                               IOExceptionSE

  クラスからコピーされた説明: AbstractMarshaller
  指定されたオブジェクトグラフを Writer にマーシャリングする抽象テンプレートメソッド。

  次で指定:

  クラス AbstractMarshaller の marshalWriter 

  パラメーター:

  graph - マーシャリングするオブジェクトグラフのルート

  writer - 書き込む Writer 

  例外:

  XmlMappingException - 指定されたオブジェクトをライターにマーシャリングできない場合

  IOExceptionSE - I/O 例外が発生した場合

• customizeMarshaller

  protected void customizeMarshaller(org.exolab.castor.xml.Marshaller marshaller)

  特定の Castor Marshaller のカスタマイズを可能にするテンプレートメソッド。

• unmarshalDomNode

  protected ObjectSE unmarshalDomNode(NodeSE node)
                             throws XmlMappingException

  クラスからコピーされた説明: AbstractMarshaller
  指定された DOM Node から非整列化するための抽象テンプレートメソッド。

  次で指定:

  クラス AbstractMarshaller の unmarshalDomNode 

  パラメーター:

  node - 非整列化するオブジェクトを含む DOM ノード

  戻り値:

  オブジェクトグラフ

  例外:

  XmlMappingException - 指定された DOM ノードをオブジェクトにマップできない場合

• unmarshalXmlEventReader

  protected ObjectSE unmarshalXmlEventReader(XMLEventReaderSE eventReader)

  クラスからコピーされた説明: AbstractMarshaller
  指定された Stax XMLEventReader から非整列化するための抽象テンプレートメソッド。

  次で指定:

  クラス AbstractMarshaller の unmarshalXmlEventReader 

  パラメーター:

  eventReader - 読み込む XMLEventReader 

  戻り値:

  オブジェクトグラフ

• unmarshalXmlStreamReader

  protected ObjectSE unmarshalXmlStreamReader(XMLStreamReaderSE streamReader)

  クラスからコピーされた説明: AbstractMarshaller
  指定された Stax XMLStreamReader から非整列化するための抽象テンプレートメソッド。

  次で指定:

  クラス AbstractMarshaller の unmarshalXmlStreamReader 

  パラメーター:

  streamReader - 読み込む XMLStreamReader 

  戻り値:

  オブジェクトグラフ

• unmarshalSaxReader

  protected ObjectSE unmarshalSaxReader(XMLReaderSE xmlReader,
                                      InputSourceSE inputSource)
                               throws XmlMappingException,
                                      IOExceptionSE

  クラスからコピーされた説明: AbstractMarshaller
  特定の SAX XMLReader および InputSource を使用して非整列化するための抽象テンプレートメソッド。

  次で指定:

  クラス AbstractMarshaller の unmarshalSaxReader 

  パラメーター:

  xmlReader - 解析する SAX XMLReader 

  inputSource - 解析する入力ソース

  戻り値:

  オブジェクトグラフ

  例外:

  XmlMappingException - 指定されたリーダーと入力ソースをオブジェクトに変換できない場合

  IOExceptionSE - I/O 例外が発生した場合

• unmarshalInputStream

  protected ObjectSE unmarshalInputStream(InputStreamSE inputStream)
                                 throws XmlMappingException,
                                        IOExceptionSE

  クラスからコピーされた説明: AbstractMarshaller
  指定された InputStream から非整列化するための抽象テンプレートメソッド。

  次で指定:

  クラス AbstractMarshaller の unmarshalInputStream 

  パラメーター:

  inputStream - 読み込む InputStreamStream 

  戻り値:

  オブジェクトグラフ

  例外:

  XmlMappingException - 指定されたストリームをオブジェクトに変換できない場合

  IOExceptionSE - I/O 例外が発生した場合

• unmarshalReader

  protected ObjectSE unmarshalReader(ReaderSE reader)
                            throws XmlMappingException,
                                   IOExceptionSE

  クラスからコピーされた説明: AbstractMarshaller
  指定された Reader から非整列化するための抽象テンプレートメソッド。

  次で指定:

  クラス AbstractMarshaller の unmarshalReader 

  パラメーター:

  reader - 読み込む Reader 

  戻り値:

  オブジェクトグラフ

  例外:

  XmlMappingException - 指定されたリーダーをオブジェクトに変換できない場合

  IOExceptionSE - I/O 例外が発生した場合

• customizeUnmarshaller

  protected void customizeUnmarshaller(org.exolab.castor.xml.Unmarshaller unmarshaller)

  特定の Castor Unmarshaller のカスタマイズを可能にするテンプレートメソッド。

• convertCastorException

  protected XmlMappingException convertCastorException(org.exolab.castor.xml.XMLException ex,
                                                       boolean marshalling)

  指定された XMLException を org.springframework.oxm 階層からの適切な例外に変換します。

  Castor 自体は例外階層でこの区別を行わないため、ブールフラグを使用して、この例外がマーシャリング中に発生するかアンマーシャリング中に発生するかを示します。

  パラメーター:

  ex - 発生したキャスター XMLException 

  marshalling - マーシャリング中に例外が発生するか（true）、アンマーシャリングするかを示します (false)

  戻り値:

  対応する XmlMappingException