src/main/java/com/ozacc/mail/xml/XMLBuilder.java

   1 package com.ozacc.mail.xml;
   2
   3 import java.io.File;
   4
   5 import org.w3c.dom.Document;
   6
   7 import com.ozacc.mail.Mail;
   8
   9 /**
  10  * MailインスタンスからXMLドキュメントを生成します。
  11  *
  12  * @see com.ozacc.mail.xml.impl.XMLBuilderImpl
  13  * @see com.ozacc.mail.xml.impl.JDomXMLBuilder
  14  *
  15  * @since 1.0
  16  * @author Tomohiro Otsuka
  17  * @version $Id: XMLBuilder.java,v 1.2 2004/09/13 07:13:31 otsuka Exp $
  18  */
  19 public interface XMLBuilder {
  20
  21         /**
  22          * 指定されたMailインスタンスからXMLドキュメントを生成します。
  23          *
  24          * @param mail
  25          * @return DOM Document
  26          * @throws XMLBuildException
  27          */
  28         Document buildDocument(Mail mail) throws XMLBuildException;
  29
  30         /**
  31          * 指定されたMailインスタンスからXMLドキュメントを生成し、
  32          * 指定されたファイルに保存します。
  33          *
  34          * @param mail
  35          * @param destFile MailデータXMLの保存先ファイル
  36          * @throws XMLBuildException
  37          */
  38         void saveDocument(Mail mail, File destFile) throws XMLBuildException;
  39
  40 }