com.ozacc.mail
インタフェース VelocityMailBuilder

すべてのスーパーインタフェース:
MailBuilder
既知の実装クラスの一覧:
JDomXMLMailBuilder, XMLVelocityMailBuilderImpl

public interface VelocityMailBuilder
extends MailBuilder

Velocityと連携して動的にメールデータを生成し、そのデータからMailインスタンスを生成するインターフェース。

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

メソッドの概要
 Mail buildMail(File file, VelocityContext context)
          指定されたファイルを読み込んでMailインスタンスを生成します。
 Mail buildMail(String classPath, VelocityContext context)
          指定されたクラスパス上のファイルを読み込んでMailインスタンスを生成します。
 void clearCache()
          メールデータキャッシュをクリアします。
 boolean isCacheEnabled()
          VelocityContextとマージする前のメールデータをキャッシュする設定かどうか判定します。
 void setCacheEnabled(boolean cacheEnabled)
          VelocityContextとマージする前のメールデータをキャッシュするかどうかを設定します。
 
インタフェース com.ozacc.mail.MailBuilder から継承したメソッド
buildMail, buildMail
 

メソッドの詳細

buildMail

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

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

buildMail

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

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

clearCache

public void clearCache()
メールデータキャッシュをクリアします。

導入されたバージョン:
1.1.2

setCacheEnabled

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

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

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

パラメータ:
cacheEnabled - メールデータをキャッシュする場合は true
導入されたバージョン:
1.1.2

isCacheEnabled

public boolean isCacheEnabled()
VelocityContextとマージする前のメールデータをキャッシュする設定かどうか判定します。

戻り値:
メールデータをキャッシュする設定の場合は true
導入されたバージョン:
1.1.2


Copyright © 2004-2005 OZACC. All Rights Reserved.