src/main/java/com/ozacc/mail/MailBuilder.java

   1 package com.ozacc.mail;
   2
   3 import java.io.File;
   4
   5 /**
   6  * メールデータが記述されたファイルからMailインスタンスを生成するインスターフェース。
   7  * サポートするファイルの種類やメールデータ書式は実装クラスに依存します。
   8  *
   9  * @see com.ozacc.mail.impl.XMLMailBuilderImpl
  10  * @see com.ozacc.mail.impl.JDomXMLMailBuilder
  11  *
  12  * @since 1.0
  13  * @author Tomohiro Otsuka
  14  * @version $Id: MailBuilder.java,v 1.7 2004/09/17 23:07:01 otsuka Exp $
  15  */
  16 public interface MailBuilder {
  17
  18         /**
  19          * 指定されたクラスパス上のファイルを読み込んでMailインスタンスを生成します。
  20          *
  21          * @param classPath メール内容を記述したファイルのパス
  22          * @return 生成されたMailインスタンス
  23          * @throws MailBuildException Mailインスタンスの生成に失敗した場合
  24          */
  25         Mail buildMail(String classPath) throws MailBuildException;
  26
  27         /**
  28          * 指定されたファイルを読み込んでMailインスタンスを生成します。
  29          *
  30          * @param file メール内容を記述したファイル
  31          * @return 生成されたMailインスタンス
  32          * @throws MailBuildException Mailインスタンスの生成に失敗した場合
  33          */
  34         Mail buildMail(File file) throws MailBuildException;
  35
  36 }