/*
 * blanco Framework
 * Copyright (C) 2004-2007 IGA Tosiki
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 */
package blanco.mail.core;

/**
 * メール受信クラス実装を取得するためのファクトリクラス。
 * 
 * @author IGA Tosiki
 */
public class BlancoMailReceiverFactory {
    /**
     * コンストラクタは隠します。
     */
    protected BlancoMailReceiverFactory() {
    }

    /**
     * メール受信クラスのインスタンスを取得します。
     * 
     * TODO 将来的には BlancoMailReceiverImpl を取替え可能なように機能強化します。
     * 
     * <p>
     * 典型的なメール受信は下記のようになります。
     * </p>
     * 
     * <pre>
     * // プロパティファイルにメールサーバの各種接続情報が格納されている場合。
     * BlancoMailSetting setting = BlancoMailSettingFactory.getInstance();
     * 
     * System.out.println(&quot;メール受信: 開始&quot;);
     * BlancoMailReceiver receiver = BlancoMailReceiverFactory.getInstance();
     * BlancoMailMessage message = receiver.receive(setting);
     * if (message != null) {
     *     System.out.println(&quot;受信メッセージ [&quot; + message.getSubject() + &quot;] :&quot;
     *             + message.getText());
     * }
     * System.out.println(&quot;メール受信: 終了&quot;);
     * </pre>
     * 
     * @return メール受信クラスのインスタンス。
     */
    public static BlancoMailReceiver getInstance() {
        return new BlancoMailReceiverImpl();
    }
}