XPath (Java Platform SE 8)

public interface XPath

XPathはXPath評価環境および式へのアクセスを提供します。

XPath式の評価。
コンテキスト	コンテキスト項目がない式を評価する要求が行われた場合、コンテキストには空のドキュメント・ノードが使用される。XPath式を評価するため、DocumentFragmentがドキュメント・ノードと同様に扱われる。
変数	式に変数の参照が含まれる場合、`setXPathVariableResolver(XPathVariableResolver resolver)`で設定された`XPathVariableResolver`によってその値が見つけられる。変数リゾルバが定義されていないか、リゾルバから変数に対して`null`が返された場合、`XPathExpressionException`が生成される。変数の値は、1回の評価の過程を通じて不変でなければならない。
関数	式に関数の参照が含まれる場合、`setXPathFunctionResolver(XPathFunctionResolver resolver)`で設定された`XPathFunctionResolver`によって関数が見つけられる。関数リゾルバが定義されていないか、関数リゾルバから関数に対して`null`が返された場合、`XPathExpressionException`が生成される。
QName	式の中のQNameは`setNamespaceContext(NamespaceContext nsContext)`で設定されたXPath名前空間コンテキストと照らして解決される。
結果	式の評価の結果は目的の戻り値の型のインスタンスに変換される。有効な戻り値の型は、`XPathConstants`に定義する。戻り値の型への変換はXPath変換規則に従う。

XPathオブジェクトはスレッドセーフではなく、再入不可能です。つまり、アプリケーション側で、どのような場合でも1つの XPathオブジェクトが複数のスレッドから使用されることがないようにする必要があります。また、evaluateメソッドが呼び出されている間、アプリケーションは再帰的にevaluateメソッドを呼び出すことができません。

導入されたバージョン:: 1.5
関連項目:: XML Path Language (XPath) Version 1.0

メソッドのサマリー

すべてのメソッドインスタンス・メソッド抽象メソッド
修飾子と型	メソッドと説明
`XPathExpression`	`compile(String expression)` あとで評価するため、Xpath式をコンパイルします。
`String`	`evaluate(String expression, InputSource source)` 指定された`InputSource`のコンテキストでXPath式を評価し、結果を`String`として返します。
`Object`	`evaluate(String expression, InputSource source, QName returnType)` 指定された`InputSource`のコンテキストでXPath式を評価し、結果を指定された型として返します。
`String`	`evaluate(String expression, Object item)` 指定されたコンテキストでXPath式を評価し、結果を`String`として返します。
`Object`	`evaluate(String expression, Object item, QName returnType)` 指定されたコンテキストで`XPath`式を評価し、結果を指定された型として返します。
`NamespaceContext`	`getNamespaceContext()` 現在の名前空間コンテキストを返します。
`XPathFunctionResolver`	`getXPathFunctionResolver()` 現在の関数リゾルバを返します。
`XPathVariableResolver`	`getXPathVariableResolver()` 現在の変数リゾルバを返します。
`void`	`reset()` この`XPath`を元の構成にリセットします。
`void`	`setNamespaceContext(NamespaceContext nsContext)` 名前空間コンテキストを設定します。
`void`	`setXPathFunctionResolver(XPathFunctionResolver resolver)` 関数リゾルバを設定します。
`void`	`setXPathVariableResolver(XPathVariableResolver resolver)` 変数リゾルバを設定します。

- メソッドの詳細
  - reset
```
void reset()
```
    このXPathを元の構成にリセットします。
    
    XPathは、XPathFactory.newXPath()で作成された時点の状態にリセットされます。reset()は、既存のXPathの再使用を許可するように設計されているため、新しいXPathの作成に関連するリソースを節約できます。
    
    XPathをリセットした場合、同じXPathFunctionResolver、XPathVariableResolverまたはNamespaceContext Object (たとえば、Object.equals(Object obj))を持つことは保証されません。機能的に同じXPathFunctionResolver、XPathVariableResolverおよびNamespaceContextを持つことは保証されます。
  - setXPathVariableResolver
```
void setXPathVariableResolver(XPathVariableResolver resolver)
```
    変数リゾルバを設定します。
    
    resolverがnullの場合、NullPointerExceptionがスローされます。
    
    パラメータ:
    
    resolver - 変数リゾルバ。
    
    例外:
    
    NullPointerException - resolverがnullの場合。
  - getXPathVariableResolver
```
XPathVariableResolver getXPathVariableResolver()
```
    現在の変数リゾルバを返します。
    
    有効な変数リゾルバがない場合、nullが返されます。
    
    戻り値:
    
    現在の変数リゾルバ。
  - setXPathFunctionResolver
```
void setXPathFunctionResolver(XPathFunctionResolver resolver)
```
    関数リゾルバを設定します。
    
    resolverがnullの場合、NullPointerExceptionがスローされます。
    
    パラメータ:
    
    resolver - XPath関数リゾルバ。
    
    例外:
    
    NullPointerException - resolverがnullの場合。
  - getXPathFunctionResolver
```
XPathFunctionResolver getXPathFunctionResolver()
```
    現在の関数リゾルバを返します。
    
    有効な関数リゾルバがない場合、nullが返されます。
    
    戻り値:
    
    現在の関数リゾルバ。
  - setNamespaceContext
```
void setNamespaceContext(NamespaceContext nsContext)
```
    名前空間コンテキストを設定します。
    
    nsContextがnullの場合、NullPointerExceptionがスローされます。
    
    パラメータ:
    
    nsContext - 使用する名前空間コンテキスト。
    
    例外:
    
    NullPointerException - nsContextがnullの場合。
  - getNamespaceContext
```
NamespaceContext getNamespaceContext()
```
    現在の名前空間コンテキストを返します。
    
    有効な名前空間コンテキストがない場合、nullが返されます。
    
    戻り値:
    
    現在の名前空間コンテキスト。
  - compile
```
XPathExpression compile(String expression)
                 throws XPathExpressionException
```
    あとで評価するため、Xpath式をコンパイルします。
    
    expressionにXPathFunctionが含まれている場合は、XPathFunctionResolverで使用可能である必要があります。XPathFunctionがXPathFunctionResolverで解決できない場合、XPathExpressionExceptionがスローされます。
    
    expressionに変数が含まれている場合は、コンパイル時に有効なXPathVariableResolverを使用してそれらを解決します。
    
    expressionがnullの場合、NullPointerExceptionがスローされます。
    
    パラメータ:
    
    expression - XPath式。
    
    戻り値:
    
    コンパイル済みのXPath式。
    
    例外:
    
    XPathExpressionException - expressionをコンパイルできない場合。
    
    NullPointerException - expressionがnullの場合。
  - evaluate
```
Object evaluate(String expression,
                Object item,
                QName returnType)
         throws XPathExpressionException
```
    指定されたコンテキストでXPath式を評価し、結果を指定された型として返します。
    
    コンテキスト項目の評価、変数、関数、およびQNameの解決と戻り値の型の変換については「XPath式の評価」を参照してください。
    
    returnTypeがXPathConstantsに定義された型でない場合(NUMBER、STRING、BOOLEAN、NODE、またはNODESET)、IllegalArgumentExceptionがスローされます。
    
    itemにnull値が指定される場合、コンテキストには空のドキュメントが使用されます。expressionまたはreturnTypeがnullの場合、NullPointerExceptionがスローされます。
    
    パラメータ:
    
    expression - XPath式。
    
    item - 開始コンテキスト(ノードなど)。
    
    returnType - 目的の戻り値の型。
    
    戻り値:
    
    returnTypeのObjectとしてのXPath式の評価の結果。
    
    例外:
    
    XPathExpressionException - expressionを評価できない場合。
    
    IllegalArgumentException - returnTypeがXPathConstantsに定義された型でない場合。
    
    NullPointerException - expressionまたはreturnTypeがnullの場合。
  - evaluate
```
String evaluate(String expression,
                Object item)
         throws XPathExpressionException
```
    指定されたコンテキストでXPath式を評価し、結果をStringとして返します。
    
    このメソッドは、XPathConstants.STRINGのreturnTypeを指定してevaluate(String expression, Object item, QName returnType)を呼び出します。
    
    コンテキスト項目の評価、変数、関数、およびQNameの解決と戻り値の型の変換については「XPath式の評価」を参照してください。
    
    itemにnull値が指定される場合、コンテキストには空のドキュメントが使用されます。expressionがnullの場合、NullPointerExceptionがスローされます。
    
    パラメータ:
    
    expression - XPath式。
    
    item - 開始コンテキスト(ノードなど)。
    
    戻り値:
    
    式を評価し、結果をStringに変換した結果であるString。
    
    例外:
    
    XPathExpressionException - expressionを評価できない場合。
    
    NullPointerException - expressionがnullの場合。
  - evaluate
```
Object evaluate(String expression,
                InputSource source,
                QName returnType)
         throws XPathExpressionException
```
    指定されたInputSourceのコンテキストでXPath式を評価し、結果を指定された型として返します。
    
    このメソッドはInputSourceのデータ・モデルを構築し、結果として得られるドキュメント・オブジェクトに対してevaluate(String expression, Object item, QName returnType)を呼び出します。
    
    コンテキスト項目の評価、変数、関数、およびQNameの解決と戻り値の型の変換については「XPath式の評価」を参照してください。
    
    returnTypeがXPathConstantsに定義された型でない場合、IllegalArgumentExceptionがスローされます。
    
    expression、source、またはreturnTypeがnullの場合、NullPointerExceptionがスローされます。
    
    パラメータ:
    
    expression - XPath式。
    
    source - 評価するドキュメントの入力ソース。
    
    returnType - 目的の戻り値の型。
    
    戻り値:
    
    式の評価の結果をカプセル化するObject。
    
    例外:
    
    XPathExpressionException - expressionを評価できない場合。
    
    IllegalArgumentException - returnTypeがXPathConstantsに定義された型でない場合。
    
    NullPointerException - expression、source、またはreturnTypeがnullの場合。
  - evaluate
```
String evaluate(String expression,
                InputSource source)
         throws XPathExpressionException
```
    指定されたInputSourceのコンテキストでXPath式を評価し、結果をStringとして返します。
    
    このメソッドは、XPathConstants.STRINGのreturnTypeを指定してevaluate(String expression, InputSource source, QName returnType)を呼び出します。
    
    コンテキスト項目の評価、変数、関数、およびQNameの解決と戻り値の型の変換については「XPath式の評価」を参照してください。
    
    expressionまたはsourceがnullの場合、NullPointerExceptionがスローされます。
    
    パラメータ:
    
    expression - XPath式。
    
    source - 評価するドキュメントのInputSource。
    
    戻り値:
    
    式を評価し、結果をStringに変換した結果であるString。
    
    例外:
    
    XPathExpressionException - expressionを評価できない場合。
    
    NullPointerException - expressionまたはsourceがnullの場合。

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

インタフェースXPath

メソッドのサマリー

メソッドの詳細

reset

setXPathVariableResolver

getXPathVariableResolver

setXPathFunctionResolver

getXPathFunctionResolver

setNamespaceContext

getNamespaceContext

compile

evaluate

evaluate

evaluate

evaluate