XML Library 1.0

org.koiroha.xml.parser
クラス LocatorReader

java.lang.Object
  上位を拡張 java.io.Reader
      上位を拡張 java.io.FilterReader
          上位を拡張 java.io.PushbackReader
              上位を拡張 org.koiroha.xml.parser.LocatorReader
すべての実装されたインタフェース:
Closeable, Readable, Locator2, Locator

public class LocatorReader
extends PushbackReader
implements Locator2

Locator 機能を備えた入力ストリームクラスです。現在の読み出し位置をマークする事が出来ます。

導入されたバージョン:
2009/03/31 Java2 SE 5.0
バージョン:
$Revision: 1.2 $ $Date: 2010/02/24 13:59:38 $
作成者:
torao

フィールドの概要
 
クラス java.io.FilterReader から継承されたフィールド
in
 
クラス java.io.Reader から継承されたフィールド
lock
 
メソッドの概要
 int getColumnNumber()
          列番号を参照します。
 String getEncoding()
          エンコーディングを参照します。
 int getLineNumber()
          行番号を参照します。
 Short getNextType()
          現在のストリームから読み出される次のデータの型を判定します。
 String getPublicId()
          このストリームの PUBLIC ID を参照します。
 String getSystemId()
          このストリームの SYSTEM ID を参照します。
 String getXMLVersion()
          XML バージョンを参照します。
 boolean isEOF()
          ストリームが EOF に達しているかどうかを判定します。
 boolean isTextMode()
          現在のストリームがテキストモードかどうかを判定します。
 void markLocation()
          現在の読み出し位置をマークし getLineNumber(), getColumnNumber() で返すように設定します。
 int read()
          文字を読み込みます。
 int read(char[] cbuf)
          ストリームから指定されたバッファに読み込みます。
 int read(char[] cbuf, int off, int len)
          ストリームから指定されたバッファに読み込みます。
 void setEncoding(String encoding)
          エンコーディングを設定します。
 void setTextModeEnd(String textModeEnd)
          現在のストリーム以降、指定された要素の終了を検知するまで getNextType() で テキストとコメントのみを認識するよう設定します。
 void setXmlVersion(String xmlVersion)
          XML バージョンを設定します。
 String skipSequence(String sequence, boolean validate)
          ストリームから指定された文字シーケンスを読み飛ばします。
 String skipSequence(String sequence, boolean validate, boolean ignoreCase)
          ストリームから指定された文字シーケンスを読み飛ばします。
 void skipWhitespace()
          ストリーム中の空白文字を読み飛ばします。
 boolean startsWith(String sequence)
          現在のストリームの先頭が指定された文字シーケンスで開始しているかを判定します。
 boolean startsWith(String sequence, boolean ignoreCase)
          現在のストリームの先頭が指定された文字シーケンスで開始しているかを判定します。
 void unread(char[] cbuf)
          指定されたバッファの読み込みをキャンセルします。
 void unread(char[] cbuf, int off, int len)
          指定されたバッファの読み込みをキャンセルします。
 void unread(int c)
          指定された文字の読み込みをキャンセルします。
 
クラス java.io.PushbackReader から継承されたメソッド
close, mark, markSupported, ready, reset, skip
 
クラス java.io.Reader から継承されたメソッド
read
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

メソッドの詳細

markLocation

public void markLocation()
現在の読み出し位置をマークし getLineNumber(), getColumnNumber() で返すように設定します。


getXMLVersion

public String getXMLVersion()
XML バージョンを参照します。

定義:
インタフェース Locator2 内の getXMLVersion
戻り値:
XML バージョン

setXmlVersion

public void setXmlVersion(String xmlVersion)
XML バージョンを設定します。

パラメータ:
xmlVersion - XML バージョン

getEncoding

public String getEncoding()
エンコーディングを参照します。

定義:
インタフェース Locator2 内の getEncoding
戻り値:
エンコーディング

setEncoding

public void setEncoding(String encoding)
エンコーディングを設定します。

パラメータ:
encoding - エンコーディング

getPublicId

public String getPublicId()
このストリームの PUBLIC ID を参照します。

定義:
インタフェース Locator 内の getPublicId
戻り値:
PUBLIC ID

getSystemId

public String getSystemId()
このストリームの SYSTEM ID を参照します。

定義:
インタフェース Locator 内の getSystemId
戻り値:
SYSTEM ID

getLineNumber

public int getLineNumber()
行番号を参照します。

定義:
インタフェース Locator 内の getLineNumber
戻り値:
行番号

getColumnNumber

public int getColumnNumber()
列番号を参照します。

定義:
インタフェース Locator 内の getColumnNumber
戻り値:
列番号

read

public int read()
         throws IOException
文字を読み込みます。

オーバーライド:
クラス PushbackReader 内の read
戻り値:
文字
例外:
IOException - 読み込みに失敗した場合

read

public int read(char[] cbuf)
         throws IOException
ストリームから指定されたバッファに読み込みます。

オーバーライド:
クラス Reader 内の read
パラメータ:
cbuf - 読み込みバッファ
戻り値:
読み込んだ長さ
例外:
IOException - 読み込みに失敗した場合

read

public int read(char[] cbuf,
                int off,
                int len)
         throws IOException
ストリームから指定されたバッファに読み込みます。

オーバーライド:
クラス PushbackReader 内の read
パラメータ:
cbuf - 読み込みバッファ
off - バッファのオフセット
len - 読み込む長さ
戻り値:
読み込んだ長さ
例外:
IOException - 読み込みに失敗した場合

unread

public void unread(int c)
            throws IOException
指定された文字の読み込みをキャンセルします。

オーバーライド:
クラス PushbackReader 内の unread
パラメータ:
c - 戻す文字
例外:
IOException - 戻しに失敗した場合

unread

public void unread(char[] cbuf)
            throws IOException
指定されたバッファの読み込みをキャンセルします。

オーバーライド:
クラス PushbackReader 内の unread
パラメータ:
cbuf - バッファ
例外:
IOException

unread

public void unread(char[] cbuf,
                   int off,
                   int len)
            throws IOException
指定されたバッファの読み込みをキャンセルします。

オーバーライド:
クラス PushbackReader 内の unread
パラメータ:
cbuf - バッファ
off - 開始オフセット
len - 長さ
例外:
IOException

isEOF

public boolean isEOF()
              throws IOException
ストリームが EOF に達しているかどうかを判定します。

戻り値:
EOF に達している場合 true
例外:
IOException - 読み込みに失敗した場合

getNextType

public Short getNextType()
                  throws IOException
現在のストリームから読み出される次のデータの型を判定します。EOF に達している場合は null を返します。

戻り値:
次のデータの型
例外:
IOException - 読み込みに失敗した場合

setTextModeEnd

public void setTextModeEnd(String textModeEnd)
現在のストリーム以降、指定された要素の終了を検知するまで getNextType() で テキストとコメントのみを認識するよう設定します。このメソッドは HTML の <script> や <style> の内部を適切に読み込むために使用します。

null を指定するとテキストモードを終了します。

パラメータ:
textModeEnd - テキストモードを終了する要素の名前

isTextMode

public boolean isTextMode()
現在のストリームがテキストモードかどうかを判定します。

戻り値:
テキストモードの場合 true

startsWith

public boolean startsWith(String sequence)
                   throws IOException
現在のストリームの先頭が指定された文字シーケンスで開始しているかを判定します。

パラメータ:
sequence - 評価する文字シーケンス
戻り値:
開始している場合 true
例外:
IOException - 読み込みに失敗した場合

startsWith

public boolean startsWith(String sequence,
                          boolean ignoreCase)
                   throws IOException
現在のストリームの先頭が指定された文字シーケンスで開始しているかを判定します。

パラメータ:
sequence - 評価する文字シーケンス
ignoreCase - 大文字と小文字を無視する場合 true
戻り値:
開始している場合 true
例外:
IOException - 読み込みに失敗した場合

skipSequence

public String skipSequence(String sequence,
                           boolean validate)
                    throws IOException
ストリームから指定された文字シーケンスを読み飛ばします。

パラメータ:
sequence - 読み飛ばす文字シーケンス
validate - 読み飛ばす文字を検証する場合 true
戻り値:
実際に読み飛ばした文字列
例外:
IOException - 読み込みに失敗した場合

skipSequence

public String skipSequence(String sequence,
                           boolean validate,
                           boolean ignoreCase)
                    throws IOException
ストリームから指定された文字シーケンスを読み飛ばします。

パラメータ:
sequence - 読み飛ばす文字シーケンス
validate - 読み飛ばす文字を検証する場合 true
ignoreCase - 大文字と小文字を無視する場合 true
戻り値:
実際に読み飛ばした文字列
例外:
IOException - 読み込みに失敗した場合

skipWhitespace

public void skipWhitespace()
                    throws IOException
ストリーム中の空白文字を読み飛ばします。

例外:
IOException - 読み込みに失敗した場合

koiroha.org by takami torao