XMLInputFactory (Java Platform SE 7)

java.lang.Object
- javax.xml.stream.XMLInputFactory

public abstract class XMLInputFactory
extends Object

ストリームを取得するためのファクトリの抽象実装を定義します。次の表に、この仕様の標準プロパティーの定義を示します。各プロパティーは、実装ごとに必要となるサポートのレベルが異なります。必要なサポートレベルは、「必須」の列に示されています。

構成パラメータ
プロパティー名	動作	戻り型	デフォルト値	必須
javax.xml.stream.isValidating	実装に固有の DTD 検証のオン/オフを切り替えます	Boolean	False	いいえ
javax.xml.stream.isNamespaceAware	XML 1.0 サポートの名前空間処理のオン/オフを切り替えます	Boolean	True	True (必須) / False (省略可能)
javax.xml.stream.isCoalescing	隣接する文字データの合体をプロセッサに要求します	Boolean	False	はい
javax.xml.stream.isReplacingEntityReferences	内部エンティティー参照を置換テキストに置き換え、それらを文字として報告します	Boolean	True	はい
javax.xml.stream.isSupportingExternalEntities	外部の解析対象エンティティーを解決します	Boolean	指定なし	はい
javax.xml.stream.supportDTD	DTD をサポートしないプロセッサを要求する場合は、このプロパティーを使用します	Boolean	True	はい
javax.xml.stream.reporter	XMLReporter の実装を設定/取得します	javax.xml.stream.XMLReporter	Null	はい
javax.xml.stream.resolver	XMLResolver インタフェースの実装を設定/取得します	javax.xml.stream.XMLResolver	Null	はい
javax.xml.stream.allocator	XMLEventAllocator インタフェースの実装を設定/取得します	javax.xml.stream.util.XMLEventAllocator	Null	はい

導入されたバージョン:: 1.6
関連項目:: XMLOutputFactory, XMLEventReader, XMLStreamReader, EventFilter, XMLReporter, XMLResolver, XMLEventAllocator

フィールドのサマリー

フィールド
修飾子と型	フィールドと説明
`static String`	`ALLOCATOR` アロケータの実装の設定/取得に使用するプロパティーです。
`static String`	`IS_COALESCING` 隣接する文字データセクションの合体をパーサーに要求するプロパティーです。
`static String`	`IS_NAMESPACE_AWARE` 名前空間サポートのオン/オフの切り替えに使用するプロパティーです。これは XML 1.0 文書をサポートするためのものです。true の設定のみサポートされます。
`static String`	`IS_REPLACING_ENTITY_REFERENCES` 内部エンティティー参照を置換テキストに置き換え、それらを文字として報告することをパーサーに要求します。
`static String`	`IS_SUPPORTING_EXTERNAL_ENTITIES` 外部の解析対象エンティティーの解決をパーサーに要求するプロパティーです。
`static String`	`IS_VALIDATING` 実装に固有の検証のオン/オフを切り替えるために使用するプロパティーです。
`static String`	`REPORTER` XMLReporter インタフェースの実装の設定/取得に使用するプロパティーです。
`static String`	`RESOLVER` XMLResolver の実装の設定/取得に使用するプロパティーです。
`static String`	`SUPPORT_DTD` DTD のサポートをパーサーに要求するプロパティーです。

コンストラクタのサマリー

コンストラクタ
修飾子コンストラクタと説明

protected XMLInputFactory()

コンストラクタ
修飾子	コンストラクタと説明
`protected`	`XMLInputFactory()`

メソッドのサマリー

メソッド
修飾子と型	メソッドと説明
`abstract XMLEventReader`	`createFilteredReader(XMLEventReader reader, EventFilter filter)` イベントリーダーをフィルタでラップするフィルタ処理されたイベントリーダーを作成します。
`abstract XMLStreamReader`	`createFilteredReader(XMLStreamReader reader, StreamFilter filter)` リーダーをフィルタでラップするフィルタ処理されたリーダーを作成します。
`abstract XMLEventReader`	`createXMLEventReader(InputStream stream)` java.io.InputStream から新しい XMLEventReader を作成します。
`abstract XMLEventReader`	`createXMLEventReader(InputStream stream, String encoding)` java.io.InputStream から新しい XMLEventReader を作成します。
`abstract XMLEventReader`	`createXMLEventReader(Reader reader)` リーダーから新しい XMLEventReader を作成します。
`abstract XMLEventReader`	`createXMLEventReader(Source source)` JAXP ソースから新しい XMLEventReader を作成します。
`abstract XMLEventReader`	`createXMLEventReader(String systemId, InputStream stream)` java.io.InputStream から新しい XMLEventReader を作成します。
`abstract XMLEventReader`	`createXMLEventReader(String systemId, Reader reader)` リーダーから新しい XMLEventReader を作成します。
`abstract XMLEventReader`	`createXMLEventReader(XMLStreamReader reader)` XMLStreamReader から新しい XMLEventReader を作成します。
`abstract XMLStreamReader`	`createXMLStreamReader(InputStream stream)` java.io.InputStream から新しい XMLStreamReader を作成します。
`abstract XMLStreamReader`	`createXMLStreamReader(InputStream stream, String encoding)` java.io.InputStream から新しい XMLStreamReader を作成します。
`abstract XMLStreamReader`	`createXMLStreamReader(Reader reader)` リーダーから新しい XMLStreamReader を作成します。
`abstract XMLStreamReader`	`createXMLStreamReader(Source source)` JAXP ソースから新しい XMLStreamReader を作成します。
`abstract XMLStreamReader`	`createXMLStreamReader(String systemId, InputStream stream)` java.io.InputStream から新しい XMLStreamReader を作成します。
`abstract XMLStreamReader`	`createXMLStreamReader(String systemId, Reader reader)` java.io.InputStream から新しい XMLStreamReader を作成します。
`abstract XMLEventAllocator`	`getEventAllocator()` このファクトリを使用して作成されるストリームが使用するアロケータを取得します。
`abstract Object`	`getProperty(String name)` ベースとなる実装から機能またはプロパティーの値を取得します。
`abstract XMLReporter`	`getXMLReporter()` 任意の XMLStreamReader または XMLEventReader にレポータを設定します。このファクトリインスタンスによって作成されます。
`abstract XMLResolver`	`getXMLResolver()` 任意の XMLStreamReader または XMLEventReader にリゾルバを設定します。このファクトリインスタンスによって作成されます。
`abstract boolean`	`isPropertySupported(String name)` このファクトリがサポートするプロパティーセットを照会します。
`static XMLInputFactory`	`newFactory()` ファクトリの新しいインスタンスを作成します。
`static XMLInputFactory`	`newFactory(String factoryId, ClassLoader classLoader)` ファクトリの新しいインスタンスを作成します。
`static XMLInputFactory`	`newInstance()` ファクトリの新しいインスタンスを作成します。
`static XMLInputFactory`	`newInstance(String factoryId, ClassLoader classLoader)` 非推奨。 API の整合性を維持するために、このメソッドは非推奨になりました。すべての newInstance メソッドが、対応する newFactory メソッドに置き換えられています。代替の `newFactory(java.lang.String, java.lang.ClassLoader)` メソッドでは、動作の変更は定義されていません。
`abstract void`	`setEventAllocator(XMLEventAllocator allocator)` イベント用のユーザー定義のイベントアロケータを設定します。
`abstract void`	`setProperty(String name, Object value)` ユーザーがベースとなる実装に特定の機能とプロパティーを設定できるようにします。
`abstract void`	`setXMLReporter(XMLReporter reporter)` 任意の XMLStreamReader または XMLEventReader にレポータを設定します。このファクトリインスタンスによって作成されます。
`abstract void`	`setXMLResolver(XMLResolver resolver)` 任意の XMLStreamReader または XMLEventReader にリゾルバを設定します。このファクトリインスタンスによって作成されます。

クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- フィールドの詳細
  - IS_NAMESPACE_AWARE
```
public static final String IS_NAMESPACE_AWARE
```
    名前空間サポートのオン/オフの切り替えに使用するプロパティーです。これは XML 1.0 文書をサポートするためのものです。true の設定のみサポートされます。
    
    関連項目:
    定数フィールド値
  - IS_VALIDATING
```
public static final String IS_VALIDATING
```
    実装に固有の検証のオン/オフを切り替えるために使用するプロパティーです。
    
    関連項目:
    定数フィールド値
  - IS_COALESCING
```
public static final String IS_COALESCING
```
    隣接する文字データセクションの合体をパーサーに要求するプロパティーです。
    
    関連項目:
    定数フィールド値
  - IS_REPLACING_ENTITY_REFERENCES
```
public static final String IS_REPLACING_ENTITY_REFERENCES
```
    内部エンティティー参照を置換テキストに置き換え、それらを文字として報告することをパーサーに要求します。
    
    関連項目:
    定数フィールド値
  - IS_SUPPORTING_EXTERNAL_ENTITIES
```
public static final String IS_SUPPORTING_EXTERNAL_ENTITIES
```
    外部の解析対象エンティティーの解決をパーサーに要求するプロパティーです。
    
    関連項目:
    定数フィールド値
  - SUPPORT_DTD
```
public static final String SUPPORT_DTD
```
    DTD のサポートをパーサーに要求するプロパティーです。
    
    関連項目:
    定数フィールド値
  - REPORTER
```
public static final String REPORTER
```
    XMLReporter インタフェースの実装の設定/取得に使用するプロパティーです。
    
    関連項目:
    定数フィールド値
  - RESOLVER
```
public static final String RESOLVER
```
    XMLResolver の実装の設定/取得に使用するプロパティーです。
    
    関連項目:
    定数フィールド値
  - ALLOCATOR
```
public static final String ALLOCATOR
```
    アロケータの実装の設定/取得に使用するプロパティーです。
    
    関連項目:
    定数フィールド値
- コンストラクタの詳細
  - XMLInputFactory
```
protected XMLInputFactory()
```
- メソッドの詳細
  - newInstance
```
public static XMLInputFactory newInstance()
                                   throws FactoryConfigurationError
```
    ファクトリの新しいインスタンスを作成します。
    
    例外:
    
    FactoryConfigurationError - このファクトリのインスタンスをロードできない場合
  - newFactory
```
public static XMLInputFactory newFactory()
                                  throws FactoryConfigurationError
```
    ファクトリの新しいインスタンスを作成します。この static メソッドは新しいファクトリインスタンスを作成します。このメソッドは次の順序の検索手順で、ロードする XMLInputFactory 実装クラスを決定します。javax.xml.stream.XMLInputFactory system プロパティーを使用する。JRE ディレクトリ内のプロパティーファイル lib/stax.properties を使用する。この構成ファイルは標準の java.util.Properties 形式であり、上記のように定義されたシステムプロパティーであるキーを持つ実装クラスの完全指定の名前を含む。可能であれば、JAR 仕様で詳細に説明されているサービス API を使用して、クラス名を判定する。サービス API は、実行時に使用できる jar 内の META-INF/services/javax.xml.stream.XMLInputFactory ファイルからクラス名を検索する。デフォルトの XMLInputFactory インスタンスをプラットフォームとする。アプリケーションが XMLInputFactory への参照を取得すると、ファクトリを使用してストリームのインスタンスを構成および取得することができます。これは非推奨の newInstance() メソッドを置き換える新しいメソッドです。非推奨のメソッドに関連して、この置換メソッドによって定義されている動作に変更はありません。
    
    例外:
    
    FactoryConfigurationError - このファクトリのインスタンスをロードできない場合
  - newInstance
```
public static XMLInputFactory newInstance(String factoryId,
                          ClassLoader classLoader)
                                   throws FactoryConfigurationError
```
    非推奨。 API の整合性を維持するために、このメソッドは非推奨になりました。すべての newInstance メソッドが、対応する newFactory メソッドに置き換えられています。代替の newFactory(java.lang.String, java.lang.ClassLoader) メソッドでは、動作の変更は定義されていません。
    
    ファクトリの新しいインスタンスを作成します。
    
    パラメータ:
    factoryId - 検索するファクトリの名前。プロパティー名と同一
    classLoader - 使用する classLoader
    
    戻り値:
    ファクトリの実装
    
    例外:
    
    FactoryConfigurationError - このファクトリのインスタンスをロードできない場合
  - newFactory
```
public static XMLInputFactory newFactory(String factoryId,
                         ClassLoader classLoader)
                                  throws FactoryConfigurationError
```
    ファクトリの新しいインスタンスを作成します。classLoader 引数が null の場合、ContextClassLoader が使用されます。これは非推奨の newInstance(String factoryId、ClassLoader classLoader) メソッドを置き換える新しいメソッドです。非推奨のメソッドに関連して、この置換メソッドによって定義されている動作に変更はありません。
    
    パラメータ:
    factoryId - 検索するファクトリの名前。プロパティー名と同一
    classLoader - 使用する classLoader
    
    戻り値:
    ファクトリの実装
    
    例外:
    
    FactoryConfigurationError - このファクトリのインスタンスをロードできない場合
  - createXMLStreamReader
```
public abstract XMLStreamReader createXMLStreamReader(Reader reader)
                                               throws XMLStreamException
```
    リーダーから新しい XMLStreamReader を作成します。
    
    パラメータ:
    reader - 読み込み元の XML データ
    
    例外:
    
    XMLStreamException
  - createXMLStreamReader
```
public abstract XMLStreamReader createXMLStreamReader(Source source)
                                               throws XMLStreamException
```
    JAXP ソースから新しい XMLStreamReader を作成します。このメソッドはオプションです。
    
    パラメータ:
    source - 読み込み元のソース
    
    例外:
    
    UnsupportedOperationException - この XMLInputFactory でこのメソッドがサポートされていない場合
    
    XMLStreamException
  - createXMLStreamReader
```
public abstract XMLStreamReader createXMLStreamReader(InputStream stream)
                                               throws XMLStreamException
```
    java.io.InputStream から新しい XMLStreamReader を作成します。
    
    パラメータ:
    stream - 読み込み元の InputStream
    
    例外:
    
    XMLStreamException
  - createXMLStreamReader
```
public abstract XMLStreamReader createXMLStreamReader(InputStream stream,
                                    String encoding)
                                               throws XMLStreamException
```
    java.io.InputStream から新しい XMLStreamReader を作成します。
    
    パラメータ:
    stream - 読み込み元の InputStream
    encoding - ストリームの文字エンコーディング
    
    例外:
    
    XMLStreamException
  - createXMLStreamReader
```
public abstract XMLStreamReader createXMLStreamReader(String systemId,
                                    InputStream stream)
                                               throws XMLStreamException
```
    java.io.InputStream から新しい XMLStreamReader を作成します。
    
    パラメータ:
    systemId - ストリームのシステム ID
    stream - 読み込み元の InputStream
    
    例外:
    
    XMLStreamException
  - createXMLStreamReader
```
public abstract XMLStreamReader createXMLStreamReader(String systemId,
                                    Reader reader)
                                               throws XMLStreamException
```
    java.io.InputStream から新しい XMLStreamReader を作成します。
    
    パラメータ:
    systemId - ストリームのシステム ID
    reader - 読み込み元の InputStream
    
    例外:
    
    XMLStreamException
  - createXMLEventReader
```
public abstract XMLEventReader createXMLEventReader(Reader reader)
                                             throws XMLStreamException
```
    リーダーから新しい XMLEventReader を作成します。
    
    パラメータ:
    reader - 読み込み元の XML データ
    
    例外:
    
    XMLStreamException
  - createXMLEventReader
```
public abstract XMLEventReader createXMLEventReader(String systemId,
                                  Reader reader)
                                             throws XMLStreamException
```
    リーダーから新しい XMLEventReader を作成します。
    
    パラメータ:
    systemId - 入力のシステム ID
    reader - 読み込み元の XML データ
    
    例外:
    
    XMLStreamException
  - createXMLEventReader
```
public abstract XMLEventReader createXMLEventReader(XMLStreamReader reader)
                                             throws XMLStreamException
```
    XMLStreamReader から新しい XMLEventReader を作成します。このメソッドから返された XMLEventReader インスタンスの構築に使用されたあとは、その XMLStreamReader を使用してはいけません。
    
    パラメータ:
    reader - 読み込み元の XMLStreamReader (変更されていない)
    
    戻り値:
    新しい XMLEventReader
    
    例外:
    
    XMLStreamException
  - createXMLEventReader
```
public abstract XMLEventReader createXMLEventReader(Source source)
                                             throws XMLStreamException
```
    JAXP ソースから新しい XMLEventReader を作成します。このメソッドのサポートはオプションです。
    
    パラメータ:
    source - 読み込み元のソース
    
    例外:
    
    UnsupportedOperationException - この XMLInputFactory でこのメソッドがサポートされていない場合
    
    XMLStreamException
  - createXMLEventReader
```
public abstract XMLEventReader createXMLEventReader(InputStream stream)
                                             throws XMLStreamException
```
    java.io.InputStream から新しい XMLEventReader を作成します。
    
    パラメータ:
    stream - 読み込み元の InputStream
    
    例外:
    
    XMLStreamException
  - createXMLEventReader
```
public abstract XMLEventReader createXMLEventReader(InputStream stream,
                                  String encoding)
                                             throws XMLStreamException
```
    java.io.InputStream から新しい XMLEventReader を作成します。
    
    パラメータ:
    stream - 読み込み元の InputStream
    encoding - ストリームの文字エンコーディング
    
    例外:
    
    XMLStreamException
  - createXMLEventReader
```
public abstract XMLEventReader createXMLEventReader(String systemId,
                                  InputStream stream)
                                             throws XMLStreamException
```
    java.io.InputStream から新しい XMLEventReader を作成します。
    
    パラメータ:
    systemId - ストリームのシステム ID
    stream - 読み込み元の InputStream
    
    例外:
    
    XMLStreamException
  - createFilteredReader
```
public abstract XMLStreamReader createFilteredReader(XMLStreamReader reader,
                                   StreamFilter filter)
                                              throws XMLStreamException
```
    リーダーをフィルタでラップするフィルタ処理されたリーダーを作成します。
    
    パラメータ:
    reader - フィルタ処理するリーダー
    filter - リーダーに適用するフィルタ
    
    例外:
    
    XMLStreamException
  - createFilteredReader
```
public abstract XMLEventReader createFilteredReader(XMLEventReader reader,
                                  EventFilter filter)
                                             throws XMLStreamException
```
    イベントリーダーをフィルタでラップするフィルタ処理されたイベントリーダーを作成します。
    
    パラメータ:
    reader - ラップするイベントリーダー
    filter - イベントリーダーに適用するフィルタ
    
    例外:
    
    XMLStreamException
  - getXMLResolver
```
public abstract XMLResolver getXMLResolver()
```
    任意の XMLStreamReader または XMLEventReader にリゾルバを設定します。このファクトリインスタンスによって作成されます。
  - setXMLResolver
```
public abstract void setXMLResolver(XMLResolver resolver)
```
    任意の XMLStreamReader または XMLEventReader にリゾルバを設定します。このファクトリインスタンスによって作成されます。
    
    パラメータ:
    resolver - 参照の解決に使用されるリゾルバ
  - getXMLReporter
```
public abstract XMLReporter getXMLReporter()
```
    任意の XMLStreamReader または XMLEventReader にレポータを設定します。このファクトリインスタンスによって作成されます。
  - setXMLReporter
```
public abstract void setXMLReporter(XMLReporter reporter)
```
    任意の XMLStreamReader または XMLEventReader にレポータを設定します。このファクトリインスタンスによって作成されます。
    
    パラメータ:
    reporter - 重大ではないエラーの報告に使用されるリゾルバ
  - setProperty
```
public abstract void setProperty(String name,
               Object value)
                          throws IllegalArgumentException
```
    ユーザーがベースとなる実装に特定の機能とプロパティーを設定できるようにします。ベースとなる実装では、仕様にあるすべてのプロパティーの設定をすべてサポートすることは要求されません。また、ベースとなる実装では IllegalArgumentException を使用して、サポートされないプロパティーに指定値を設定できないことを通知できます。
    JAXP 1.5 またはそれ以降を実装する実装はすべて、XMLConstants.ACCESS_EXTERNAL_DTD プロパティーをサポートしている必要があります。
    - 外部 DTD および外部エンティティー参照へのアクセスが、そのプロパティーで指定されたプロトコルに制限されます。このプロパティーの制限が原因で構文解析中にアクセスが拒否された場合は、XMLStreamReader.next() または XMLEventReader.nextEvent() メソッドによって XMLStreamException がスローされます。
    パラメータ:
    name - プロパティーの名前 (null 以外)
    value - プロパティーの値
    
    例外:
    
    IllegalArgumentException - プロパティーがサポートされていない場合
  - getProperty
```
public abstract Object getProperty(String name)
                            throws IllegalArgumentException
```
    ベースとなる実装から機能またはプロパティーの値を取得します。
    
    パラメータ:
    name - プロパティーの名前 (null 以外)
    
    戻り値:
    プロパティーの値
    
    例外:
    
    IllegalArgumentException - プロパティーがサポートされていない場合
  - isPropertySupported
```
public abstract boolean isPropertySupported(String name)
```
    このファクトリがサポートするプロパティーセットを照会します。
    
    パラメータ:
    name - プロパティーの名前 (null 以外)
    
    戻り値:
    プロパティーがサポートされている場合は true、そうでない場合は false
  - setEventAllocator
```
public abstract void setEventAllocator(XMLEventAllocator allocator)
```
    イベント用のユーザー定義のイベントアロケータを設定します。
    
    パラメータ:
    allocator - ユーザー定義のアロケータ
  - getEventAllocator
```
public abstract XMLEventAllocator getEventAllocator()
```
    このファクトリを使用して作成されるストリームが使用するアロケータを取得します。

バグまたは機能を送信
詳細な API リファレンスおよび開発者ドキュメントについては、Java SE のドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.

クラス XMLInputFactory

フィールドのサマリー

コンストラクタのサマリー

メソッドのサマリー

クラス java.lang.Object から継承されたメソッド

フィールドの詳細

IS_NAMESPACE_AWARE

IS_VALIDATING

IS_COALESCING

IS_REPLACING_ENTITY_REFERENCES

IS_SUPPORTING_EXTERNAL_ENTITIES

SUPPORT_DTD

REPORTER

RESOLVER

ALLOCATOR

コンストラクタの詳細

XMLInputFactory

メソッドの詳細

newInstance

newFactory

newInstance

newFactory

createXMLStreamReader

createXMLStreamReader

createXMLStreamReader

createXMLStreamReader

createXMLStreamReader

createXMLStreamReader

createXMLEventReader

createXMLEventReader

createXMLEventReader

createXMLEventReader

createXMLEventReader

createXMLEventReader

createXMLEventReader

createFilteredReader

createFilteredReader

getXMLResolver

setXMLResolver

getXMLReporter

setXMLReporter

setProperty

getProperty

isPropertySupported

setEventAllocator

getEventAllocator