jp.hishidama.ant.types.htlex
クラス HtLexerConverter

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.types.DataType
          jp.hishidama.ant.types.htlex.HtLexerConverter

すべての実装されたインタフェース:

Cloneable

public class HtLexerConverter
extends org.apache.tools.ant.types.DataType

HtHtmlLexerコンバーター.

HtLexerを使用した、HTMLファイル内の検索・置換を行うデータタイプ。

導入されたバージョン:

2009.01.18

バージョン:

2010.02.06

作成者:

ひしだま

コンストラクタの概要

HtLexerConverter()

メソッドの概要

void	addConfigured(FileCondType file) ファイル条件追加.
void	addConfigured(TagType tag) タグ条件追加.
void	addConfigured(TextType text) テキスト条件追加.
boolean	convert(HtListElement elist) 推奨されていません。 当メソッドの機能はFileCondTypeに移管された。
boolean	convert(ListToken tlist) 推奨されていません。 当メソッドの機能はFileCondTypeに移管された。
boolean	equals(String s1, String s2) 文字列比較.
void	execute(File rf, File wf, File bf) 処理本体.
HtLexer	getLexer(String s) 指定された文字列用のHtLexerを返す。
HtLexerPropertyHelper	getPropertyHelper() プロパティーヘルパー取得.
File	getReadFile() 処理対象ファイル名取得.
void	initPropertyHelper(HtLexerPropertyHelper helper) プロパティーヘルパー設定.
void	logConvert(String msg, int line, Token token) ログ出力（置換時）.
void	logMatch(Token token) ログ出力（マッチ時）.
void	logReadFile(String msg, int level) ログ出力（読込ファイル）.
void	logUnmatch() ログ出力（アンマッチ時）.
void	logWriteFile(File f) ログ出力（出力ファイル）.
void	setDumpParseNotFix(org.apache.tools.ant.types.LogLevel level) デバッグダンプ（未確定タグ）設定.
void	setEncoding(String encoding) 入力ファイル文字コード設定.
void	setForce(boolean b) 強制出力指定.
void	setLogConvert(org.apache.tools.ant.types.LogLevel level) ログ出力設定（置換時）.
void	setLogEval(org.apache.tools.ant.types.LogLevel level) ログ出力設定（演算実行時）.
void	setLogMatch(org.apache.tools.ant.types.LogLevel level) ログ出力設定（マッチ時）.
void	setLogReadFile(org.apache.tools.ant.types.LogLevel level) ログ出力設定（読込ファイル）.
void	setLogUnmatch(org.apache.tools.ant.types.LogLevel level) ログ出力設定（アンマッチ時）.
void	setLogWriteFile(org.apache.tools.ant.types.LogLevel level) ログ出力設定（出力ファイル）.
void	setNoWrite(boolean b) 非出力指定.
void	setOutputEncoding(String encoding) 出力ファイル文字コード設定.
void	setUseParser(boolean b) HtHtmlParser使用有無設定.
void	validate() 精査実行.

クラス org.apache.tools.ant.types.DataType から継承されたメソッド

clone, getRefid, invokeCircularReferenceCheck, isReference, setRefid, toString

クラス org.apache.tools.ant.ProjectComponent から継承されたメソッド

getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject

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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

コンストラクタの詳細

HtLexerConverter

public HtLexerConverter()

メソッドの詳細

setEncoding

public void setEncoding(String encoding)

入力ファイル文字コード設定.

設定されない場合はJavaVMデフォルトの文字コードとなる。

パラメータ:

encoding - 文字コード

setOutputEncoding

public void setOutputEncoding(String encoding)

出力ファイル文字コード設定.

設定されない場合は入力ファイルと同じ文字コードとなる。

パラメータ:

encoding - 文字コード

setForce

public void setForce(boolean b)

強制出力指定.

パラメータ:

b - trueの場合、変更が無くてもファイルを出力する。

setNoWrite

public void setNoWrite(boolean b)

非出力指定.

パラメータ:

b - trueの場合、変更があってもファイルを出力しない。

導入されたバージョン:

2009.02.08

setLogReadFile

public void setLogReadFile(org.apache.tools.ant.types.LogLevel level)

ログ出力設定（読込ファイル）.

この設定をすると、読み込んだファイル名をログ出力する。

パラメータ:

level - ログレベル

setLogMatch

public void setLogMatch(org.apache.tools.ant.types.LogLevel level)

ログ出力設定（マッチ時）.

この設定をすると、条件にマッチした場合にマッチング内容をログ出力する。

パラメータ:

level - ログレベル

setLogUnmatch

public void setLogUnmatch(org.apache.tools.ant.types.LogLevel level)

ログ出力設定（アンマッチ時）.

この設定をすると、条件に1つもマッチしなかった場合にファイル名をログ出力する。

パラメータ:

level - ログレベル

setLogConvert

public void setLogConvert(org.apache.tools.ant.types.LogLevel level)

ログ出力設定（置換時）.

この設定をすると、置換を行った場合に置換内容をログ出力する。

パラメータ:

level - ログレベル

setLogWriteFile

public void setLogWriteFile(org.apache.tools.ant.types.LogLevel level)

ログ出力設定（出力ファイル）.

この設定をすると、ファイル出力したファイル名をログ出力する。

パラメータ:

level - ログレベル

setLogEval

public void setLogEval(org.apache.tools.ant.types.LogLevel level)

ログ出力設定（演算実行時）.

この設定をすると、演算時に演算内容をログ出力する。

パラメータ:

level - ログレベル

導入されたバージョン:

2010.01.31

setUseParser

public void setUseParser(boolean b)

HtHtmlParser使用有無設定.

HtHtmlParserによる構文解析結果を使用するオプションを別途指定している場合は、自動でtrueとなる。

パラメータ:

b - HtHtmlParserを使用する場合、true

導入されたバージョン:

2009.02.17

setDumpParseNotFix

public void setDumpParseNotFix(org.apache.tools.ant.types.LogLevel level)

デバッグダンプ（未確定タグ）設定.

HtHtmlParserによる構文解析で未確定のタグがあったらそれを出力する。

パラメータ:

level - ログレベル

導入されたバージョン:

2009.02.15

initPropertyHelper

public void initPropertyHelper(HtLexerPropertyHelper helper)

プロパティーヘルパー設定.

パラメータ:

helper - プロパティーヘルパー

導入されたバージョン:

2010.01.23

getPropertyHelper

public HtLexerPropertyHelper getPropertyHelper()

プロパティーヘルパー取得.

戻り値:

プロパティーヘルパー

導入されたバージョン:

2010.01.23

addConfigured

public void addConfigured(TagType tag)

タグ条件追加.

パラメータ:

tag - タグタイプ

addConfigured

public void addConfigured(TextType text)

テキスト条件追加.

パラメータ:

text - テキストタイプ

addConfigured

public void addConfigured(FileCondType file)

ファイル条件追加.

パラメータ:

file - ファイル条件タイプ

導入されたバージョン:

2010.02.06

validate

public void validate()
              throws org.apache.tools.ant.BuildException

精査実行.

例外:

org.apache.tools.ant.BuildException - 精査エラー時

logReadFile

public void logReadFile(String msg,
                        int level)

ログ出力（読込ファイル）.

パラメータ:

msg - メッセージ

level - ログレベル

logMatch

public void logMatch(Token token)

ログ出力（マッチ時）.

パラメータ:

token - トークン

logUnmatch

public void logUnmatch()

ログ出力（アンマッチ時）.

logConvert

public void logConvert(String msg,
                       int line,
                       Token token)

ログ出力（置換時）.

パラメータ:

msg - メッセージ

line - 行番号

token - トークン

logWriteFile

public void logWriteFile(File f)

ログ出力（出力ファイル）.

パラメータ:

f - ファイル名

getLexer

public HtLexer getLexer(String s)

指定された文字列用のHtLexerを返す。

インスタンスを共有している為、重複使用は不可。

パラメータ:

s - 解釈対象

戻り値:

HtLexer

execute

public void execute(File rf,
                    File wf,
                    File bf)
             throws org.apache.tools.ant.BuildException

処理本体.

HTMLファイルを読み込み、文字列検索や置換を行う。

パラメータ:

rf - 読込ファイル名

wf - 出力ファイル名

bf - バックアップ用ファイル名

例外:

org.apache.tools.ant.BuildException

getReadFile

public File getReadFile()

処理対象ファイル名取得.

戻り値:

読込ファイル名

convert

@Deprecated
public boolean convert(ListToken tlist)

推奨されていません。 当メソッドの機能はFileCondTypeに移管された。

HTML変更.

HtLexerTask によってHTMLが読み込まれた後に呼ばれる。
（HtHtmlParserによって構文解析されていない場合に当メソッドが呼ばれる）
引数の内容を変更してtrueを返すと、その内容をファイルに出力する。

独自の変換を行いたい場合は、当メソッドをオーバーライドしてHTMLの変換ロジックを実装する。

パラメータ:

tlist - 読み込まれたHTML

戻り値:

tlistの内容を変更した場合、true

関連項目:

setUseParser(boolean)

convert

@Deprecated
public boolean convert(HtListElement elist)

推奨されていません。 当メソッドの機能はFileCondTypeに移管された。

HTML変更.

HtLexerTask によってHTMLが読み込まれた後に呼ばれる。
（HtHtmlParserによって構文解析された場合に当メソッドが呼ばれる）
引数の内容を変更してtrueを返すと、その内容をファイルに出力する。

独自の変換を行いたい場合は、当メソッドをオーバーライドしてHTMLの変換ロジックを実装する。

パラメータ:

elist - 構文解析されたHTML

戻り値:

elistの内容を変更した場合、true

導入されたバージョン:

2009.02.17

関連項目:

setUseParser(boolean)

equals

public boolean equals(String s1,
                      String s2)

文字列比較.

パラメータ:

s1 - 文字列

s2 - 文字列

戻り値:

文字列が等しい場合、true（nullは空文字列として比較する）