XPathFactory (Java Platform SE 8)

java.lang.Object
- javax.xml.xpath.XPathFactory

```
public abstract class XPathFactory
extends Object
```
XPathFactoryインスタンスを使用して、XPathオブジェクトを作成できます。

検索メカニズムについては、newInstance(String uri)を参照してください。

XPathFactoryクラスはスレッドに対して安全ではありません。つまり、アプリケーション側で、どのような場合もXPathFactoryオブジェクトを使用するスレッドが1つだけであるようにする必要があります。実装では、メソッドにsynchronizedのマークを付けて、障害のあるクライアントから保護することをお勧めします。
XPathFactoryは再入不可能です。newInstanceメソッドの1つが呼び出されているときに、アプリケーションは、同じスレッドからであっても、newInstanceメソッドを再帰的に呼び出すことはできません。

導入されたバージョン:

1.5

フィールドのサマリー

フィールド
修飾子と型	フィールドと説明
`static String`	`DEFAULT_OBJECT_MODEL_URI` デフォルトのオブジェクト・モデルURIです。
`static String`	`DEFAULT_PROPERTY_NAME` JAXP仕様に従ったデフォルトのプロパティ名です。

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

コンストラクタ
修飾子	コンストラクタと説明
`protected`	`XPathFactory()` `newInstance()`、`newInstance(String uri)`、または`newInstance(String uri, String factoryClassName, ClassLoader classLoader)`としてprotectedコンストラクタを使用して、`XPathFactory`の新しいインスタンスを作成する必要があります。

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド抽象メソッド具象メソッド
修飾子と型	メソッドと説明
`abstract boolean`	`getFeature(String name)` 名前が付けられた機能の状態を取得します。
`abstract boolean`	`isObjectModelSupported(String objectModel)` 指定されたオブジェクト・モデルがこの`XPathFactory`にサポートされているかを返します。
`static XPathFactory`	`newInstance()` デフォルトのオブジェクト・モデル、`DEFAULT_OBJECT_MODEL_URI`、W3C DOMを使用して、新しい`XPathFactory`インスタンスを取得します。
`static XPathFactory`	`newInstance(String uri)` 指定されたオブジェクト・モデルを使用して、新しい`XPathFactory`インスタンスを取得します。
`static XPathFactory`	`newInstance(String uri, String factoryClassName, ClassLoader classLoader)` ファクトリ・クラス名から`XPathFactory`の新しいインスタンスを取得します。
`abstract XPath`	`newXPath()` `XPathFactory`がインスタンス化された際に特定された基本となるオブジェクト・モデルを使用して、新しい`XPath`を返します。
`abstract void`	`setFeature(String name, boolean value)` このファクトリによって生成された`XPathFactory`および`XPath`の機能を設定します。
`abstract void`	`setXPathFunctionResolver(XPathFunctionResolver resolver)` デフォルトの関数リゾルバを設定します。
`abstract void`	`setXPathVariableResolver(XPathVariableResolver resolver)` デフォルトの変数リゾルバを設定します。

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

- フィールドの詳細
  - DEFAULT_PROPERTY_NAME
```
public static final String DEFAULT_PROPERTY_NAME
```
    JAXP仕様に従ったデフォルトのプロパティ名です。
    
    関連項目:
    
    定数フィールド値
  - DEFAULT_OBJECT_MODEL_URI
```
public static final String DEFAULT_OBJECT_MODEL_URI
```
    デフォルトのオブジェクト・モデルURIです。
    
    関連項目:
    
    定数フィールド値
- コンストラクタの詳細
  - XPathFactory
```
protected XPathFactory()
```
    newInstance()、newInstance(String uri)、またはnewInstance(String uri, String factoryClassName, ClassLoader classLoader)としてprotectedコンストラクタを使用して、XPathFactoryの新しいインスタンスを作成する必要があります。
- メソッドの詳細
  - newInstance
```
public static XPathFactory newInstance()
```
    デフォルトのオブジェクト・モデル、DEFAULT_OBJECT_MODEL_URI、W3C DOMを使用して、新しいXPathFactoryインスタンスを取得します。
    
    このメソッドは、機能的には次と同等です。
```
   newInstance(DEFAULT_OBJECT_MODEL_URI)
 
```
    W3C DOMの実装が常に使用できるため、このメソッドが失敗することはありません。
    戻り値:
    
    XPathFactoryのインスタンス。
    
    例外:
    
    RuntimeException - デフォルトのオブジェクト・モデルに対するXPathFactoryの作成時にエラーが発生した場合。
  - newInstance
```
public static XPathFactory newInstance(String uri)
                                throws XPathFactoryConfigurationException
```
    指定されたオブジェクト・モデルを使用して、新しいXPathFactoryインスタンスを取得します。
    
    XPathFactoryオブジェクトを検索する場合、このメソッドは「クラス・ローダー」がコンテキスト・クラス・ローダーを参照する次の順番で、次の場所を調べます。
    1. システム・プロパティDEFAULT_PROPERTY_NAME+:uriが存在し、uriがこのメソッドのパラメータである場合、その値はクラス名として読み取られる。このメソッドは、クラス・ローダーを使用してこのクラスの新しいインスタンスの作成を試み、成功した場合はそれを返します。
    2. ${java.home}/lib/jaxp.propertiesが読み取られ、上記のシステム・プロパティであるキーに関連付けられた値が検索される。値が存在すれば、上記のように値が処理されます。
    3. ServiceLoaderクラスで定義されているサービス・プロバイダのロード機能を使用して、デフォルトのロード・メカニズムによってサービスの実装の特定およびロードを試みる。サービス・プロバイダのロード機能は、現在のスレッドのコンテキスト・クラス・ローダーを使用してサービスのロードを試みる。コンテキスト・クラス・ローダーがnullの場合、システム・クラス・ローダーが使用されます。
      使用される可能性のある各サービス・プロバイダは、メソッドisObjectModelSupported(String objectModel)を実装している必要があります。指定されたオブジェクト・モデルをサポートする最初に検出されたサービス・プロバイダが返されます。
      ServiceConfigurationErrorが発生した場合、XPathFactoryConfigurationExceptionがスローされます。
    4. プラットフォームのデフォルトXPathFactoryは、実装固有の方法で配置される。W3C DOM用のプラットフォームのデフォルトXPathFactory、つまりDEFAULT_OBJECT_MODEL_URIがある必要があります。
    すべてが失敗した場合、XPathFactoryConfigurationExceptionがスローされます。
    
    トラブルシューティングのヒント:
    
    プロパティ・ファイルがどのように構文解析されるかについては、Properties.load(java.io.InputStream)を参照してください。特に、コロン「:」は、プロパティ・ファイル内でエスケープされる必要があるため、URIが適切にエスケープされていることを確認してください。次に例を示します。
```
   http\://java.sun.com/jaxp/xpath/dom=org.acme.DomXPathFactory
 
```
    パラメータ:
    
    uri - 基本となるオブジェクト・モデルを識別する。仕様は、URI DEFAULT_OBJECT_MODEL_URI、W3C DOMの場合はhttp://java.sun.com/jaxp/xpath/dom、org.w3c.domパッケージのみを定義し、実装はほかのオブジェクト・モデルのURIを自由に導入可能。
    
    戻り値:
    
    XPathFactoryのインスタンス。
    
    例外:
    
    XPathFactoryConfigurationException - 指定されたオブジェクト・モデルが使用できない場合、または構成エラーがある場合。
    
    NullPointerException - uriがnullの場合。
    
    IllegalArgumentException - uriがnullまたはuri.length()== 0の場合。
  - newInstance
```
public static XPathFactory newInstance(String uri,
                                       String factoryClassName,
                                       ClassLoader classLoader)
                                throws XPathFactoryConfigurationException
```
    ファクトリ・クラス名からXPathFactoryの新しいインスタンスを取得します。指定されたファクトリ・クラスが指定されたオブジェクト・モデルをサポートする場合、XPathFactoryが返されます。この関数は、クラス・パスに複数のプロバイダがある場合に便利です。どのプロバイダがロードされるかを指定できるため、アプリケーションをさらに制御できます。
    
    トラブルシューティングのヒント
    
    jaxp.debugシステム・プロパティを設定すると、このメソッドは実行中の処理や検索している場所に関する大量のデバッグ・メッセージをSystem.errに出力します。
    
    問題がある場合、次のようにします。
```
 java -Djaxp.debug=1 YourProgram ....
 
```
    パラメータ:
    
    uri - 基本となるオブジェクト・モデルを識別する。仕様は、URI DEFAULT_OBJECT_MODEL_URI、W3C DOMの場合はhttp://java.sun.com/jaxp/xpath/dom、org.w3c.domパッケージのみを定義し、実装はほかのオブジェクト・モデルのURIを自由に導入可能。
    
    factoryClassName - javax.xml.xpath.XPathFactoryの実装を提供する完全修飾のファクトリ・クラス名。
    
    classLoader - ファクトリ・クラスのロードに使用されるClassLoader。nullの場合は、現在のThreadのコンテキストclassLoaderが、ファクトリ・クラスのロードに使用されます。
    
    戻り値:
    
    XPathFactoryの新しいインスタンス
    
    例外:
    
    XPathFactoryConfigurationException - factoryClassNameがnullの場合。または、ファクトリ・クラスをロードおよびインスタンス化できない場合。または、ファクトリ・クラスがuriパラメータで指定されたオブジェクト・モデルをサポートしない場合。
    
    NullPointerException - uriがnullの場合。
    
    IllegalArgumentException - uriがnullまたはuri.length()== 0の場合。
    
    導入されたバージョン:
    
    1.6
    
    関連項目:
    
    newInstance(), newInstance(String uri)
  - isObjectModelSupported
```
public abstract boolean isObjectModelSupported(String objectModel)
```
    指定されたオブジェクト・モデルがこのXPathFactoryにサポートされているかを返します。
    
    パラメータ:
    
    objectModel - 返されたXPathFactoryを認識するオブジェクト・モデルを指定する。
    
    戻り値:
    
    XPathFactoryがobjectModelをサポートしている場合はtrue、そうでない場合はfalse。
    
    例外:
    
    NullPointerException - objectModelがnullの場合。
    
    IllegalArgumentException - objectModel.length()== 0の場合。
  - setFeature
```
public abstract void setFeature(String name,
                                boolean value)
                         throws XPathFactoryConfigurationException
```
    このファクトリによって生成されたXPathFactoryおよびXPathの機能を設定します。
    
    機能名は完全修飾URIです。実装が独自の機能を定義することもできます。生成するXPathFactoryまたはXPathがその機能をサポートできない場合は、XPathFactoryConfigurationExceptionがスローされます。XPathFactoryは機能の値を表示できますが、その状態を変更することはできません。
    
    実装はすべて、XMLConstants.FEATURE_SECURE_PROCESSING機能をサポートしている必要があります。機能がtrueの場合は、外部関数を参照するとエラーになります。こうした場合、実装はXPathFunctionResolverを呼び出せないので、XPathFunctionExceptionをスローします。
    
    パラメータ:
    
    name - 機能名。
    
    value - 機能の状態がtrueかfalseか。
    
    例外:
    
    XPathFactoryConfigurationException - このXPathFactoryまたはそれによって作成されるXPathがこの機能をサポートできない場合。
    
    NullPointerException - nameがnullの場合。
  - getFeature
```
public abstract boolean getFeature(String name)
                            throws XPathFactoryConfigurationException
```
    名前が付けられた機能の状態を取得します。
    
    機能名は完全修飾URIです。実装が独自の機能を定義することもできます。生成するXPathFactoryまたはXPathがその機能をサポートできない場合は、XPathFactoryConfigurationExceptionがスローされます。XPathFactoryは機能の値を表示できますが、その状態を変更することはできません。
    
    パラメータ:
    
    name - 機能名。
    
    戻り値:
    
    名前が付けられた機能の状態。
    
    例外:
    
    XPathFactoryConfigurationException - このXPathFactoryまたはそれによって作成されるXPathがこの機能をサポートできない場合。
    
    NullPointerException - nameがnullの場合。
  - setXPathVariableResolver
```
public abstract void setXPathVariableResolver(XPathVariableResolver resolver)
```
    デフォルトの変数リゾルバを設定します。
    
    このファクトリで構築されたXPathオブジェクトは、デフォルトで指定されたリゾルバを使用します。
    
    resolverがnullの場合、NullPointerExceptionがスローされます。
    
    パラメータ:
    
    resolver - 変数リゾルバ。
    
    例外:
    
    NullPointerException - resolverがnullの場合。
  - setXPathFunctionResolver
```
public abstract void setXPathFunctionResolver(XPathFunctionResolver resolver)
```
    デフォルトの関数リゾルバを設定します。
    
    このファクトリで構築されたXPathオブジェクトは、デフォルトで指定されたリゾルバを使用します。
    
    resolverがnullの場合、NullPointerExceptionがスローされます。
    
    パラメータ:
    
    resolver - XPath関数リゾルバ。
    
    例外:
    
    NullPointerException - resolverがnullの場合。
  - newXPath
```
public abstract XPath newXPath()
```
    XPathFactoryがインスタンス化された際に特定された基本となるオブジェクト・モデルを使用して、新しいXPathを返します。
    
    戻り値:
    
    XPathの新しいインスタンス。

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

クラスXPathFactory

フィールドのサマリー

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

メソッドのサマリー

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

フィールドの詳細

DEFAULT_PROPERTY_NAME

DEFAULT_OBJECT_MODEL_URI

コンストラクタの詳細

XPathFactory

メソッドの詳細

newInstance

newInstance

newInstance

トラブルシューティングのヒント

isObjectModelSupported

setFeature

getFeature

setXPathVariableResolver

setXPathFunctionResolver

newXPath