husted 2004/04/08 16:23:47 Modified: chain/apps/mailreader/src/java/org/apache/commons/chain/mailreader MailReader.java Log: Javadoc, refactorings Revision Changes Path 1.3 +82 -22 jakarta-commons-sandbox/chain/apps/mailreader/src/java/org/apache/commons/chain/mailreader/MailReader.java Index: MailReader.java =================================================================== RCS file: /home/cvs/jakarta-commons-sandbox/chain/apps/mailreader/src/java/org/apache/commons/chain/mailreader/MailReader.java,v retrieving revision 1.2 retrieving revision 1.3 diff -u -r1.2 -r1.3 --- MailReader.java 29 Mar 2004 02:34:19 -0000 1.2 +++ MailReader.java 8 Apr 2004 23:23:47 -0000 1.3 @@ -19,57 +19,117 @@ */ package org.apache.commons.chain.mailreader; -import org.apache.struts.webapp.example.UserDatabase; import org.apache.struts.webapp.example.User; +import org.apache.struts.webapp.example.UserDatabase; +import org.apache.commons.chain.Context; +import org.apache.commons.chain.impl.ContextBase; + +import java.util.Locale; /** - * Application interface for MailReader Commands. + * Context for MailReader Commands. */ -public interface MailReader extends ClientContext { +public class MailReader extends ContextBase { /** * Property name for the country field of a Locale. */ - static String PN_COUNTRY = "country"; + public static String PN_COUNTRY = "country"; /** * Property name for the language field of a Locale. */ - static String PN_LANGUAGE = "language"; + public static String PN_LANGUAGE = "language"; /** * Property name for username. */ - static String PN_USERNAME = "username"; + public static String PN_USERNAME = "username"; /** * Property name for password. */ - static String PN_PASSWORD = "password"; + public static String PN_PASSWORD = "password"; + + /** + * <p>Default constructor.</p> + */ + public MailReader() { + super(); + } + + /** + * <p>Convenience constructor to create and populate instance.</p> + * @param locale + * @param input + */ + public MailReader(Locale locale, Context input, UserDatabase database) { + super(); + this.locale = locale; + this.input = input; + this.database = database; + } /** - * <p>Return user database or null.</p> - * @return user database or null. + * <p>Field for Locale property.</p> */ - public UserDatabase getDatabase(); + private Locale locale; + + // See ContextContext interface for JavaDoc + public Locale getLocale() { + return locale; + } + + // See ContextContext interface for JavaDoc + public void setLocale(Locale locale) { + this.locale = locale; + } /** - * <p>Assign user database.</p> - * @param database The new database instance + * <p>Field for Input property.</p> */ - public void setDatabase(UserDatabase database); + private Context input; + + // See ContextContext interface for JavaDoc + public Context getInput() { + return input; + } + + // See ContextContext interface for JavaDoc + public void setInput(Context input) { + this.input = input; + } /** - * <p>Return current user, if any</p> - * @return + * <p>Field for database property.</p> */ - public User getUser(); + private UserDatabase database; + + // See MailReader interface for JavaDoc + public UserDatabase getDatabase() { + return database; + } + + // See MailReader interface for JavaDoc + public void setDatabase(UserDatabase database) { + this.database = database; + } /** - * <p>Assign current user.</p> - * @param user The new user + * <p>Field for user property.</p> */ - public void setUser(User user); + private User user; + + // See MailReader interface for JavaDoc + public User getUser() { + return user; + } + + // See MailReader interface for JavaDoc + public void setUser(User user) { + this.user = user; + } + }
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]