jp.hishidama.ant.types
クラス MapMapper

java.lang.Object
  上位を拡張 org.apache.tools.ant.ProjectComponent
      上位を拡張 org.apache.tools.ant.types.DataType
          上位を拡張 jp.hishidama.ant.types.MapMapper
すべての実装されたインタフェース:
Cloneable, org.apache.tools.ant.util.FileNameMapper

public class MapMapper
extends org.apache.tools.ant.types.DataType
implements org.apache.tools.ant.util.FileNameMapper

マップを使用したマッパー.

copy・moveタスクのmapperに使用する。
コピー・移動時の変換元ファイル名・変換先ファイル名をマップ(キー:変換元ファイル名、値:変換先ファイル名)で保持する。
指定されたマップの変換元ファイル名に存在しないファイルは、copy・move対象から除外される。

導入されたバージョン:
2010.02.11
作成者:
ひしだま

コンストラクタの概要
MapMapper()
           
 
メソッドの概要
 void addConfiguredEntry(MapPropertyTask.MapEntry entry)
          マップエントリー追加.
 void addConfiguredMapProperty(MapPropertyTask mptask)
          マッププロパティー追加.
 String[] mapFileName(String sourceFileName)
          ファイル名を変換する.
 void setFile(File f)
          プロパティーファイル名設定.
 void setFrom(String from)
          マップのキーとなる変換元ファイル名を保持.
 void setPrefix(String s)
          除去する接頭辞を設定.
 void setProperty(String name)
          マッププロパティー名設定.
 void setTo(String to)
          マップの値となる変換先ファイル名を保持.
 
クラス 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
 

コンストラクタの詳細

MapMapper

public MapMapper()
メソッドの詳細

setPrefix

public void setPrefix(String s)
除去する接頭辞を設定.

mapFileName(String)にはファイル名が相対パスで入ってくる。
マップに絶対パスで指定する場合、当接頭辞を設定しておくと、絶対パスの接頭辞部分を除去して判定する。

パラメータ:
s - 接頭辞

setFrom

public void setFrom(String from)
マップのキーとなる変換元ファイル名を保持.

定義:
インタフェース org.apache.tools.ant.util.FileNameMapper 内の setFrom
パラメータ:
from - 変換元ファイル名
関連項目:
addConfiguredEntry(MapPropertyTask.MapEntry)

setTo

public void setTo(String to)
マップの値となる変換先ファイル名を保持.

定義:
インタフェース org.apache.tools.ant.util.FileNameMapper 内の setTo
パラメータ:
to - 変換先ファイル名
関連項目:
addConfiguredEntry(MapPropertyTask.MapEntry)

setProperty

public void setProperty(String name)
マッププロパティー名設定.

このプロパティーの値は、Mapでなければならない。

パラメータ:
name - プロパティー名
関連項目:
MapPropertyTask

setFile

public void setFile(File f)
プロパティーファイル名設定.

プロパティーファイル内のプロパティー名が変換元ファイル名、値が変換先ファイル名として扱われる。

パラメータ:
f - プロパティーファイル

addConfiguredMapProperty

public void addConfiguredMapProperty(MapPropertyTask mptask)
マッププロパティー追加.

パラメータ:
mptask - マッププロパティータスク

addConfiguredEntry

public void addConfiguredEntry(MapPropertyTask.MapEntry entry)
マップエントリー追加.

パラメータ:
entry - マップエントリー(キーは変換元ファイル名、値は変換先ファイル名)

mapFileName

public String[] mapFileName(String sourceFileName)
ファイル名を変換する.

sourceFileNameは絶対パスではなく、filesetのdirからの相対パス。
ディレクトリーの区切り文字は機種依存(Windowsの場合は「\」)。

当クラスでは、sourceFileNameがマップ(のキー)に無かったら、操作(コピー・移動)の対象外とする(nullを返す)。

定義:
インタフェース org.apache.tools.ant.util.FileNameMapper 内の mapFileName
パラメータ:
sourceFileName - 変換元ファイル名
戻り値:
変換先ファイル名を保持した配列(nullの場合、コピーや移動の対象にならない)