com.ozacc.mail.impl
クラス JDomXMLMailBuilder

java.lang.Object
  拡張com.ozacc.mail.impl.JDomXMLMailBuilder
すべての実装インタフェース:
MailBuilder, VelocityMailBuilder

public class JDomXMLMailBuilder
extends Object
implements VelocityMailBuilder

JDOMを利用してXMLファイルからMailインスタンスを生成するクラス。

ソースXMLを読み込む際に、DTDバリデーションが実行されますので妥当なXMLデータ(Valid XML Document)でなければいけません。

導入されたバージョン:
1.0
バージョン:
$Id: JDomXMLMailBuilder.java,v 1.11 2004/10/22 00:50:18 otsuka Exp $
作成者:
Tomohiro Otsuka

コンストラクタの概要
JDomXMLMailBuilder()
          コンストラクタ。
 
メソッドの概要
 Mail buildMail(File file)
          指定されたXMLファイルからMailインスタンスを生成します。
 Mail buildMail(File file, VelocityContext context)
          指定されたXMLファイルからMailインスタンスを生成します。
 Mail buildMail(String classPath)
          指定されたクラスパス上のXMLファイルからMailインスタンスを生成します。
 Mail buildMail(String classPath, VelocityContext context)
          指定されたクラスパス上のXMLファイルからMailインスタンスを生成します。
 void clearCache()
          メールデータキャッシュをクリアします。
 boolean isCacheEnabled()
          VelocityContextとマージする前のメールデータをキャッシュする設定かどうか判定します。
 void setCacheEnabled(boolean cacheEnabled)
          VelocityContextとマージする前のメールデータをキャッシュするかどうかを設定します。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

JDomXMLMailBuilder

public JDomXMLMailBuilder()
コンストラクタ。

メソッドの詳細

buildMail

public Mail buildMail(String classPath)
               throws MailBuildException
指定されたクラスパス上のXMLファイルからMailインスタンスを生成します。

定義:
インタフェース MailBuilder 内の buildMail
パラメータ:
classPath - メール内容を記述したXMLファイルのパス
戻り値:
生成されたMailインスタンス
例外:
MailBuildException - Mailインスタンスの生成に失敗した場合

buildMail

public Mail buildMail(String classPath,
                      VelocityContext context)
               throws MailBuildException
指定されたクラスパス上のXMLファイルからMailインスタンスを生成します。 指定されたVelocityContextを使って、XMLファイルの内容を動的に生成できます。

定義:
インタフェース VelocityMailBuilder 内の buildMail
パラメータ:
classPath - メール内容を記述したXMLファイルのパス
context - VelocityContext
戻り値:
生成されたMailインスタンス
例外:
MailBuildException - Mailインスタンスの生成に失敗した場合

buildMail

public Mail buildMail(File file)
               throws MailBuildException
指定されたXMLファイルからMailインスタンスを生成します。

定義:
インタフェース MailBuilder 内の buildMail
パラメータ:
file - メール内容を記述したXMLファイル
戻り値:
生成されたMailインスタンス
例外:
MailBuildException - Mailインスタンスの生成に失敗した場合

buildMail

public Mail buildMail(File file,
                      VelocityContext context)
               throws MailBuildException
指定されたXMLファイルからMailインスタンスを生成します。 指定されたVelocityContextを使って、XMLファイルの内容を動的に生成できます。

定義:
インタフェース VelocityMailBuilder 内の buildMail
パラメータ:
file - メール内容を記述したXMLファイル
context - VelocityContext
戻り値:
生成されたMailインスタンス
例外:
MailBuildException - Mailインスタンスの生成に失敗した場合

clearCache

public void clearCache()
インタフェース VelocityMailBuilder の記述:
メールデータキャッシュをクリアします。

定義:
インタフェース VelocityMailBuilder 内の clearCache
関連項目:
VelocityMailBuilder.clearCache()

isCacheEnabled

public boolean isCacheEnabled()
インタフェース VelocityMailBuilder の記述:
VelocityContextとマージする前のメールデータをキャッシュする設定かどうか判定します。

定義:
インタフェース VelocityMailBuilder 内の isCacheEnabled
戻り値:
メールデータをキャッシュする設定の場合は true
関連項目:
VelocityMailBuilder.isCacheEnabled()

setCacheEnabled

public void setCacheEnabled(boolean cacheEnabled)
インタフェース VelocityMailBuilder の記述:
VelocityContextとマージする前のメールデータをキャッシュするかどうかを設定します。 デフォルトはキャッシュしない設定です。

キャッシュのキーは、buildMail()メソッド引数のメールデータファイルのクラスパス或いはファイルパスです。 キャッシュに有効期限はありません。 また、メールデータファイルの内容が途中で更新されても、キャッシュされているメールデータは更新されませんので注意してください。

falseを指定してこのメソッドを呼ぶとメールデータキャッシュはクリアされます。

定義:
インタフェース VelocityMailBuilder 内の setCacheEnabled
パラメータ:
cacheEnabled - メールデータをキャッシュする場合は true
関連項目:
VelocityMailBuilder.setCacheEnabled(boolean)


Copyright © 2004 OZACC. All Rights Reserved.