shohaku.ginkgo
クラス DocumentContext

java.lang.Object
  拡張shohaku.ginkgo.DocumentContext

public class DocumentContext
extends java.lang.Object

XMLドキュメントの解析コンテキスト情報を提供します。


メソッドの概要
 boolean addImport(java.lang.Class c)
          クラスをインポートします。
 boolean containsName(java.lang.String name)
          引数の名前を持つ属性が存在する場合は true を返却します。
 java.lang.Class forClass(java.lang.String name)
          クラス名に対応するクラスの参照を返却します。
 java.lang.Object getAttribute(java.lang.String name)
          引数の名前を持つ属性値を返却します。
 java.lang.Object getAttribute(java.lang.String name, java.lang.Object defaultValue)
          引数の名前を持つ属性が存在する場合その属性値を存在しない場合は第二引数を返却します。
 java.util.Map getAttributeMapView()
          属性の読み取り専用のマップビューを返却します。
 java.util.Map getAttributePrefix(java.lang.String prefix)
          接頭辞の一致する属性を Map に格納して返却します。
 java.lang.ClassLoader getClassLoader()
          解析処理に使用する ClassLoader を返却します.
 Ginkgo getGinkgo()
          Ginkgo を返却します。
 java.util.Map getImportMapView()
          インポートされたクラスの読み取り専用のマップビューを返却します。
 NodeCompositeRule getNodeCompositeRule()
          ドキュメント解析の構成ルールを返却します。
 TagNode getRoot()
          ドキュメントのルートノードを返却します。
 java.lang.Object removeAttribute(java.lang.String name)
          属性を削除し削除された属性値を返却します。
 void removeAttributeAll()
          属性を全て削除します。
 java.util.Map removeAttributePrefix(java.lang.String prefix)
          接頭辞の一致する属性を削除し削除された属性を Map に格納して返却します。
 java.lang.Object setAttribute(java.lang.String name, java.lang.Object value)
          属性を登録します、既存の属性が存在する場合は既存の属性値を返却し上書きします。
 void setAttributeAll(java.util.Map map)
          マップの全ての要素を属性に追加します、既存の属性が存在する場合は既存の属性値を上書きします。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

メソッドの詳細

getNodeCompositeRule

public NodeCompositeRule getNodeCompositeRule()
ドキュメント解析の構成ルールを返却します。

戻り値:
ドキュメント解析の構成ルール

getGinkgo

public Ginkgo getGinkgo()
Ginkgo を返却します。

戻り値:
Ginkgo

getClassLoader

public java.lang.ClassLoader getClassLoader()
解析処理に使用する ClassLoader を返却します.

戻り値:
解析処理に使用する ClassLoader

getRoot

public TagNode getRoot()
ドキュメントのルートノードを返却します。

戻り値:
ドキュメントのルートノード

getImportMapView

public java.util.Map getImportMapView()
インポートされたクラスの読み取り専用のマップビューを返却します。

戻り値:
インポートされたクラスの読み取り専用のマップビュー

addImport

public boolean addImport(java.lang.Class c)
クラスをインポートします。
ドキュメント内でパッケージ名を除いたクラス名で参照することが出来る様になります。

パラメータ:
c - インポートするクラス
戻り値:
インポートが上書きされた場合は true

forClass

public java.lang.Class forClass(java.lang.String name)
クラス名に対応するクラスの参照を返却します。

パラメータ:
name - クラス名
戻り値:
クラス名に対応するクラスの参照、該当クラスが無い場合は null

getAttributeMapView

public java.util.Map getAttributeMapView()
属性の読み取り専用のマップビューを返却します。

戻り値:
属性の読み取り専用のマップビュー

containsName

public boolean containsName(java.lang.String name)
引数の名前を持つ属性が存在する場合は true を返却します。

パラメータ:
name - 属性名
戻り値:
引数の名前を持つ属性が存在する場合は true

getAttribute

public java.lang.Object getAttribute(java.lang.String name)
引数の名前を持つ属性値を返却します。
指定された属性が存在しない場合は null が返されます。

パラメータ:
name - 属性名
戻り値:
属性値

getAttribute

public java.lang.Object getAttribute(java.lang.String name,
                                     java.lang.Object defaultValue)
引数の名前を持つ属性が存在する場合その属性値を存在しない場合は第二引数を返却します。

パラメータ:
name - 属性名
defaultValue - 属性が存在しない場合に返却される値
戻り値:
属性値

getAttributePrefix

public java.util.Map getAttributePrefix(java.lang.String prefix)
接頭辞の一致する属性を Map に格納して返却します。

パラメータ:
prefix - 属性名の接頭辞
戻り値:
接頭辞の一致する属性を格納する Map

setAttribute

public java.lang.Object setAttribute(java.lang.String name,
                                     java.lang.Object value)
属性を登録します、既存の属性が存在する場合は既存の属性値を返却し上書きします。
既存の属性が存在しない場合は null が返されます。

パラメータ:
name - 属性名
value - 属性値
戻り値:
既存の属性値、存在しない場合は null

setAttributeAll

public void setAttributeAll(java.util.Map map)
マップの全ての要素を属性に追加します、既存の属性が存在する場合は既存の属性値を上書きします。

パラメータ:
map - 属性に追加するマップ

removeAttribute

public java.lang.Object removeAttribute(java.lang.String name)
属性を削除し削除された属性値を返却します。 属性が存在しない場合は null が返されます。

パラメータ:
name - 属性名
戻り値:
属性値

removeAttributePrefix

public java.util.Map removeAttributePrefix(java.lang.String prefix)
接頭辞の一致する属性を削除し削除された属性を Map に格納して返却します。

パラメータ:
prefix - 属性名の接頭辞
戻り値:
接頭辞の一致する属性の Map

removeAttributeAll

public void removeAttributeAll()
属性を全て削除します。