From cvs-return-28735-apmail-cocoon-cvs-archive=cocoon.apache.org@cocoon.apache.org Fri Oct 27 15:45:24 2006 Return-Path: Delivered-To: apmail-cocoon-cvs-archive@www.apache.org Received: (qmail 97812 invoked from network); 27 Oct 2006 15:45:21 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.2) by minotaur.apache.org with SMTP; 27 Oct 2006 15:45:21 -0000 Received: (qmail 88535 invoked by uid 500); 27 Oct 2006 15:45:32 -0000 Delivered-To: apmail-cocoon-cvs-archive@cocoon.apache.org Received: (qmail 88476 invoked by uid 500); 27 Oct 2006 15:45:31 -0000 Mailing-List: contact cvs-help@cocoon.apache.org; run by ezmlm Precedence: bulk Reply-To: dev@cocoon.apache.org list-help: list-unsubscribe: List-Post: List-Id: Delivered-To: mailing list cvs@cocoon.apache.org Received: (qmail 88465 invoked by uid 99); 27 Oct 2006 15:45:31 -0000 Received: from herse.apache.org (HELO herse.apache.org) (140.211.11.133) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 27 Oct 2006 08:45:31 -0700 X-ASF-Spam-Status: No, hits=0.6 required=10.0 tests=NO_REAL_NAME X-Spam-Check-By: apache.org Received-SPF: pass (herse.apache.org: local policy) Received: from [140.211.11.3] (HELO eris.apache.org) (140.211.11.3) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 27 Oct 2006 08:45:17 -0700 Received: by eris.apache.org (Postfix, from userid 65534) id B84CA1A9846; Fri, 27 Oct 2006 08:44:55 -0700 (PDT) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r468424 - in /cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail: ./ command/ datasource/ transformation/ Date: Fri, 27 Oct 2006 15:44:55 -0000 To: cvs@cocoon.apache.org From: vgritsenko@apache.org X-Mailer: svnmailer-1.1.0 Message-Id: <20061027154455.B84CA1A9846@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: vgritsenko Date: Fri Oct 27 08:44:53 2006 New Revision: 468424 URL: http://svn.apache.org/viewvc?view=rev&rev=468424 Log: whitespace Modified: cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/ContentTypePreference.java cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/IndexerCtPref.java cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/MailAction.java cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/MailCommandBuilder.java cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/MailCommandManager.java cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/MailCommandSelector.java cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/MailContentHandlerDelegate.java cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/MailContext.java cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/MimeMessageUtil.java cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/command/AbstractMailCommand.java cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/command/MailCommand.java cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/command/MailCommands.java cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/datasource/FilePartDataSource.java cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/datasource/SourceDataSource.java cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/transformation/SendMailTransformer.java Modified: cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/ContentTypePreference.java URL: http://svn.apache.org/viewvc/cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/ContentTypePreference.java?view=diff&rev=468424&r1=468423&r2=468424 ============================================================================== --- cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/ContentTypePreference.java (original) +++ cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/ContentTypePreference.java Fri Oct 27 08:44:53 2006 @@ -19,19 +19,11 @@ import javax.mail.internet.MimePart; /** - * Description of the Interface - * * @author Bernhard Huber * @since 26 October 2002 * @version $Id$ */ public interface ContentTypePreference { - /** - * Description of the Method - * - *@param mimepart Description of the Parameter - *@return Description of the Return Value - */ int preference(MimePart mimepart); } Modified: cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/IndexerCtPref.java URL: http://svn.apache.org/viewvc/cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/IndexerCtPref.java?view=diff&rev=468424&r1=468423&r2=468424 ============================================================================== --- cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/IndexerCtPref.java (original) +++ cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/IndexerCtPref.java Fri Oct 27 08:44:53 2006 @@ -20,19 +20,12 @@ import javax.mail.internet.MimePart; /** - * Description of the Class - * * @author Bernhard Huber * @since 26 October 2002 * @version $Id$ */ public class IndexerCtPref implements ContentTypePreference { - /** - * Description of the Method - * - *@param part Description of the Parameter - *@return Description of the Return Value - */ + public int preference(MimePart part) { try { if (part.isMimeType("text/html")) { Modified: cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/MailAction.java URL: http://svn.apache.org/viewvc/cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/MailAction.java?view=diff&rev=468424&r1=468423&r2=468424 ============================================================================== --- cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/MailAction.java (original) +++ cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/MailAction.java Fri Oct 27 08:44:53 2006 @@ -62,14 +62,17 @@ * Request attribute name of a XMLizable folder */ public final static String REQUEST_ATTRIBUTE_FOLDER = "folder"; + /** * Request attribute name of a XMLizable folders object */ public final static String REQUEST_ATTRIBUTE_FOLDERS = "folders"; + /** * Request attribute name of a XMLizable message object */ public final static String REQUEST_ATTRIBUTE_MESSAGE = "message"; + /** * Request attribute name of a XMLizable messages object */ @@ -79,14 +82,15 @@ /** * Execute mail commands. * - *@param redirector Cocoon's redirector - *@param resolver Cocoon's source resolver, used for testing if a source is resolvable - *@param source the source, e.g.: index.html - *@param objectModel Description of the Parameter - *@param par Description of the Parameter - *@exception Exception Description of the Exception + * @param redirector Cocoon's redirector + * @param resolver Cocoon's source resolver, used for testing if a source is resolvable + * @param source the source, e.g.: index.html + * @param objectModel Description of the Parameter + * @param par Description of the Parameter + * @exception Exception Description of the Exception */ - public Map act(Redirector redirector, SourceResolver resolver, Map objectModel, String source, Parameters par) throws Exception { + public Map act(Redirector redirector, SourceResolver resolver, Map objectModel, String source, Parameters par) + throws Exception { Map actionMap = new HashMap(); Request request = ObjectModelHelper.getRequest(objectModel); @@ -108,8 +112,8 @@ } // assert mailSession is available - javax.mail.Session mailSession = null; - Store mailStore = null; + javax.mail.Session mailSession; + Store mailStore; try { try { mailSession = (javax.mail.Session) mailContext.get(MailContext.MAIL_SESSION_ENTRY); @@ -195,12 +199,12 @@ /** - * Gets the uRLNameExpanded attribute of the MailGenerator object + * Gets the uRLNameExpanded attribute of the MailGenerator object * - *@param storeURLNameTemplate Description of the Parameter - *@param userid Description of the Parameter - *@param password Description of the Parameter - *@return The uRLNameExpanded value + * @param storeURLNameTemplate Description of the Parameter + * @param userid Description of the Parameter + * @param password Description of the Parameter + * @return The uRLNameExpanded value */ protected String getURLNameExpanded(String storeURLNameTemplate, String userid, String password) { String tokenStart = "''"; @@ -209,19 +213,18 @@ filters.put("mail-userid", userid); filters.put("mail-passwd", password); - String filteredURLName = filter(tokenStart, tokenEnd, storeURLNameTemplate, filters); - return filteredURLName; + return filter(tokenStart, tokenEnd, storeURLNameTemplate, filters); } /** - * replace occurences of TOKEN_STARTxxxTOKEN_END by value of entry xxx in tokens table. + * Replace occurences of TOKEN_STARTxxxTOKEN_END by value of entry xxx in tokens table. * - *@param tokenStart token start marker - *@param tokenEnd token end marker - *@param s the string examined - *@param tokens Description of the Parameter - *@return String replaced all tokenized entries of original String s. + * @param tokenStart token start marker + * @param tokenEnd token end marker + * @param s the string examined + * @param tokens Description of the Parameter + * @return String replaced all tokenized entries of original String s. */ protected String filter(final String tokenStart, final String tokenEnd, String s, Properties tokens) { int index = s.indexOf(tokenStart); @@ -230,8 +233,8 @@ try { StringBuffer b = new StringBuffer(); int i = 0; - String token = null; - String value = null; + String token; + String value; do { int endIndex = s.indexOf(tokenEnd, index + tokenStart.length() + 1); @@ -263,9 +266,9 @@ /** - * Check that the provider need is available + * Check that the provider need is available * - *@param session The javamail Session used for checking its providers. + * @param session The javamail Session used for checking its providers. */ protected void checkProviders(javax.mail.Session session) { Provider[] providers = session.getProviders(); @@ -277,15 +280,15 @@ /** - * Populate request attribute map. - *

+ * Populate request attribute map. + *

* Execute mail command, and populate request attribute map with * XMLizable javamail objects, created by the mail command - *

+ *

* - *@param request triggering the creation of javamail objects - *@param mailContext javamail context, store, session, folders - *@exception Exception Description of the Exception + * @param request triggering the creation of javamail objects + * @param mailContext javamail context, store, session, folders + * @exception Exception Description of the Exception */ protected void populateRequestAttribute(Request request, MailContext mailContext) throws Exception { String folderName = (String) mailContext.get(MailContext.MAIL_CURRENT_WORKING_FOLDER_ENTRY); @@ -305,10 +308,10 @@ /** - * Put XMLizable javamail objects into request attribute map + * Put XMLizable javamail objects into request attribute map * - *@param request holding the destination attribute map - *@param resultIterator Iterator of + * @param request holding the destination attribute map + * @param resultIterator Iterator of */ protected void putXMLizerToRequestAttribute(Request request, Iterator resultIterator) { if (resultIterator != null) { @@ -354,15 +357,15 @@ /** - * Retrieve javamail objects + * Retrieve javamail objects * - *@param mailContext Description of the Parameter - *@return List of retrieved javamail objects - *@exception ProcessingException thrown iff retrieval fails + * @param mailContext Description of the Parameter + * @return List of retrieved javamail objects + * @exception ProcessingException thrown iff retrieval fails */ protected List retrieveJavaMailObjects(MailContext mailContext) throws ProcessingException { - List result = null; + List result; try { // do we have a MailCommandManager ? MailCommandManager mam = new MailCommandManager(); Modified: cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/MailCommandBuilder.java URL: http://svn.apache.org/viewvc/cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/MailCommandBuilder.java?view=diff&rev=468424&r1=468423&r2=468424 ============================================================================== --- cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/MailCommandBuilder.java (original) +++ cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/MailCommandBuilder.java Fri Oct 27 08:44:53 2006 @@ -32,7 +32,7 @@ *

* * @author Bernhard Huber - * @since 28. Dezember 2002 + * @since 28 December 2002 * @version $Id$ */ public class MailCommandBuilder extends AbstractLogEnabled { @@ -41,7 +41,7 @@ private Map cmdMap; /** - *Constructor for the MailCommandBuilder object + * Constructor for the MailCommandBuilder object */ public MailCommandBuilder() { configure(); @@ -49,10 +49,10 @@ /** - * Build a mail command. + * Build a mail command. * - *@param mailContext Description of the Parameter - *@return Description of the Return Value + * @param mailContext Description of the Parameter + * @return Description of the Return Value */ public AbstractMailCommand buildAbstractMailCommand(MailContext mailContext) { AbstractMailCommand ama = null; @@ -85,18 +85,17 @@ /** - * get Class for a command + * Get Class for a command * * @param cmd the command * @return Class associated with cmd, or null iff cmd is not mapped to any class */ protected Class getClassForCommand( String cmd ) { - Class clazz = (Class)cmdMap.get( cmd ); - return clazz; + return (Class) cmdMap.get(cmd); } /** - * test if command is mapped to a Command class + * Test if command is mapped to a Command class * * @param cmd the command * @return true iff command is mapped to a Class, otherwise return false @@ -106,11 +105,10 @@ } /** - * configure the cmd to mail command class mapping. - *

- * New commands are registered here. A command name is associated with - * each command class. - *

+ * Configure the cmd to mail command class mapping. + * + *

New commands are registered here. A command name is associated with + * each command class.

*/ public void configure() { cmdMap = new HashMap(); Modified: cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/MailCommandManager.java URL: http://svn.apache.org/viewvc/cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/MailCommandManager.java?view=diff&rev=468424&r1=468423&r2=468424 ============================================================================== --- cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/MailCommandManager.java (original) +++ cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/MailCommandManager.java Fri Oct 27 08:44:53 2006 @@ -60,22 +60,27 @@ * Context key specifying the foldername. */ public final static String CONTEXT_FOLDER_ENTRY = "folder"; + /** * Description of the Field */ public final static String CONTEXT_UID_ENTRY = "uid"; + /** * Description of the Field */ public final static String CONTEXT_ID_ENTRY = "id"; + /** * Description of the Field */ public final static String CONTEXT_PARTID_ENTRY = "part-id"; + /** * Description of the Field */ public final static String CONTEXT_FOLDER_PATTERN_ENTRY = "folder-pattern"; + /** * Description of the Field */ @@ -83,17 +88,17 @@ /** - * Creates a new instance of MailHeaderList + * Creates a new instance of MailHeaderList */ public MailCommandManager() { } /** - * Open a javamail folder + * Open a javamail folder * - *@param f Description of the Parameter - *@param mode folder opening mode, use Folder.READ_WRITE, or Folder.READ_ONLY - *@exception MessagingException Description of the Exception + * @param f Description of the Parameter + * @param mode folder opening mode, use Folder.READ_WRITE, or Folder.READ_ONLY + * @exception MessagingException Description of the Exception */ public static void openFolder(Folder f, int mode) throws MessagingException { if (!f.isOpen()) { @@ -103,10 +108,10 @@ /** - * Close a javamail folder + * Close a javamail folder * - *@param f Description of the Parameter - *@exception MessagingException Description of the Exception + * @param f Description of the Parameter + * @exception MessagingException Description of the Exception */ public static void closeFolder(Folder f) throws MessagingException { if (f != null && f.isOpen()) { @@ -117,10 +122,10 @@ /** - * Open a javamail store + * Open a javamail store * - *@param s Description of the Parameter - *@exception MessagingException Description of the Exception + * @param s Description of the Parameter + * @exception MessagingException Description of the Exception */ public static void openStore(Store s) throws MessagingException { if (!s.isConnected()) { @@ -130,10 +135,10 @@ /** - * Close a javamail store + * Close a javamail store * - *@param s Description of the Parameter - *@exception MessagingException Description of the Exception + * @param s Description of the Parameter + * @exception MessagingException Description of the Exception */ public static void closeStore(Store s) throws MessagingException { if (s != null && s.isConnected()) { @@ -143,10 +148,10 @@ /** - * Description of the Method + * Description of the Method * - *@param aList Description of the Parameter - *@return Description of the Return Value + * @param aList Description of the Parameter + * @return Description of the Return Value */ public List execute(List aList) { MailCommands folderCommands = new MailCommands(aList); @@ -161,10 +166,10 @@ /** - * Description of the Method + * Description of the Method * - *@param amfa Description of the Parameter - *@return Description of the Return Value + * @param amfa Description of the Parameter + * @return Description of the Return Value */ public List execute(AbstractMailCommand amfa) { try { @@ -178,25 +183,25 @@ /** - * Retrieve folder, and put it as command result. - * + * Retrieve folder, and put it as command result. */ - public static class MailFolderCatCommand extends AbstractMailCommand implements Contextualizable { + public static class MailFolderCatCommand extends AbstractMailCommand + implements Contextualizable { private Folder aFolder; /** - *Constructor for the MailFolderCommand object + * Constructor for the MailFolderCommand object */ public MailFolderCatCommand() { } /** - * Description of the Method + * Description of the Method * - *@param ctx Description of the Parameter - *@exception ContextException Description of the Exception + * @param ctx Description of the Parameter + * @exception ContextException Description of the Exception */ public void contextualize(Context ctx) throws ContextException { MailContext mctx = (MailContext) ctx; @@ -205,9 +210,9 @@ /** - * Description of the Method + * Description of the Method * - *@exception MessagingException Description of the Exception + * @exception MessagingException Description of the Exception */ public void execute() throws MessagingException { MailCommandManager.openFolder(aFolder, Folder.READ_ONLY); @@ -217,25 +222,25 @@ /** - * Retrieve folder, and put it as command result. - * + * Retrieve folder, and put it as command result. */ - public static class MailRefreshFolderCommand extends AbstractMailCommand implements Contextualizable { + public static class MailRefreshFolderCommand extends AbstractMailCommand + implements Contextualizable { private Folder aFolder; /** - *Constructor for the MailFolderCommand object + * Constructor for the MailFolderCommand object */ public MailRefreshFolderCommand() { } /** - * Description of the Method + * Description of the Method * - *@param ctx Description of the Parameter - *@exception ContextException Description of the Exception + * @param ctx Description of the Parameter + * @exception ContextException Description of the Exception */ public void contextualize(Context ctx) throws ContextException { MailContext mctx = (MailContext) ctx; @@ -244,9 +249,9 @@ /** - * Description of the Method + * Description of the Method * - *@exception MessagingException Description of the Exception + * @exception MessagingException Description of the Exception */ public void execute() throws MessagingException { MailCommandManager.closeFolder(aFolder); @@ -257,26 +262,26 @@ /** - * Retrieved headers of all messages of a folder, put - * retrieved messages as command result. - * + * Retrieved headers of all messages of a folder, put + * retrieved messages as command result. */ - public static class MailListMessagesCommand extends AbstractMailCommand implements Contextualizable { + public static class MailListMessagesCommand extends AbstractMailCommand + implements Contextualizable { private Folder aFolder; /** - *Constructor for the MailAllHeadersCommand object + * Constructor for the MailAllHeadersCommand object */ public MailListMessagesCommand() { } /** - * Description of the Method + * Description of the Method * - *@param ctx Description of the Parameter - *@exception ContextException Description of the Exception + * @param ctx Description of the Parameter + * @exception ContextException Description of the Exception */ public void contextualize(Context ctx) throws ContextException { // try to get the folder object @@ -286,9 +291,9 @@ /** - * Description of the Method + * Description of the Method * - *@exception MessagingException Description of the Exception + * @exception MessagingException Description of the Exception */ public void execute() throws MessagingException { MailCommandManager.openFolder(aFolder, Folder.READ_ONLY); @@ -313,26 +318,26 @@ /** - * List all subfolders of a folder, put - * all retrieved folders as command result. - * + * List all subfolders of a folder, put + * all retrieved folders as command result. */ - public static class MailListFolderCommand extends AbstractMailCommand implements Contextualizable { + public static class MailListFolderCommand extends AbstractMailCommand + implements Contextualizable { private Folder aFolder; private String folderPattern = MailCommandManager.DEFAULT_FOLDER_PATTERN; /** - *Constructor for the MailFoldersCommand object + * Constructor for the MailFoldersCommand object */ public MailListFolderCommand() { } /** - * Gets the folderPattern attribute of the ListFolderCommand object + * Gets the folderPattern attribute of the ListFolderCommand object * - *@return The folderPattern value + * @return The folderPattern value */ public String getFolderPattern() { return this.folderPattern; @@ -340,10 +345,10 @@ /** - * Description of the Method + * Description of the Method * - *@param ctx Description of the Parameter - *@exception ContextException Description of the Exception + * @param ctx Description of the Parameter + * @exception ContextException Description of the Exception */ public void contextualize(Context ctx) throws ContextException { MailContext mctx = (MailContext) ctx; @@ -359,9 +364,9 @@ /** - * Description of the Method + * Description of the Method * - *@exception MessagingException Description of the Exception + * @exception MessagingException Description of the Exception */ public void execute() throws MessagingException { // spec say: folder list can be invoked on closed folder MailCommandManager.openFolder(aFolder,Folder.READ_ONLY); @@ -377,27 +382,27 @@ /** - * Retrieved a message (envelope plus content) of a folder by its uid, put - * retrieved message as command result. - * + * Retrieved a message (envelope plus content) of a folder by its uid, put + * retrieved message as command result. */ - public static class MailCatMessageByUIDCommand extends AbstractMailCommand implements Contextualizable { + public static class MailCatMessageByUIDCommand extends AbstractMailCommand + implements Contextualizable { private int msgUID = 1; private Folder aFolder; /** - *Constructor for the MailMessageByUIDCommand object + * Constructor for the MailMessageByUIDCommand object */ public MailCatMessageByUIDCommand() { } /** - * Description of the Method + * Description of the Method * - *@param ctx Description of the Parameter - *@exception ContextException Description of the Exception + * @param ctx Description of the Parameter + * @exception ContextException Description of the Exception */ public void contextualize(Context ctx) throws ContextException { MailContext mctx = (MailContext) ctx; @@ -413,9 +418,9 @@ /** - * Description of the Method + * Description of the Method * - *@exception MessagingException Description of the Exception + * @exception MessagingException Description of the Exception */ public void execute() throws MessagingException { UIDFolder uidFolder = (UIDFolder) aFolder; @@ -431,27 +436,27 @@ /** - * Retrieved a message (envelope plus content) of a folder by its id, put - * retrieved message as command result. - * + * Retrieved a message (envelope plus content) of a folder by its id, put + * retrieved message as command result. */ - public static class MailCatMessageByIdCommand extends AbstractMailCommand implements Contextualizable { + public static class MailCatMessageByIdCommand extends AbstractMailCommand + implements Contextualizable { private int msgId = 1; private Folder aFolder; /** - *Constructor for the MailMessageByIdCommand object + * Constructor for the MailMessageByIdCommand object */ public MailCatMessageByIdCommand() { } /** - * Description of the Method + * Description of the Method * - *@param ctx Description of the Parameter - *@exception ContextException Description of the Exception + * @param ctx Description of the Parameter + * @exception ContextException Description of the Exception */ public void contextualize(Context ctx) throws ContextException { MailContext mctx = (MailContext) ctx; @@ -468,9 +473,9 @@ /** - * Description of the Method + * Description of the Method * - *@exception MessagingException Description of the Exception + * @exception MessagingException Description of the Exception */ public void execute() throws MessagingException { MailCommandManager.openFolder(aFolder, Folder.READ_ONLY); @@ -485,11 +490,11 @@ /** - * Retrieved a message part by its part id, specifying the message by id, put - * retrieved part as command result. - * + * Retrieved a message part by its part id, specifying the message by id, put + * retrieved part as command result. */ - public static class MailCatAttachmentMessageByIdCommand extends AbstractMailCommand implements Contextualizable { + public static class MailCatAttachmentMessageByIdCommand extends AbstractMailCommand + implements Contextualizable { private int msgId = -1; private int partId = -1; @@ -497,16 +502,16 @@ /** - *Constructor for the MailCatAttachmentMessageByIdCommand object + * Constructor for the MailCatAttachmentMessageByIdCommand object */ public MailCatAttachmentMessageByIdCommand() { } /** - * Description of the Method + * Description of the Method * - *@param ctx Description of the Parameter - *@exception ContextException Description of the Exception + * @param ctx Description of the Parameter + * @exception ContextException Description of the Exception */ public void contextualize(Context ctx) throws ContextException { MailContext mctx = (MailContext) ctx; @@ -529,9 +534,9 @@ /** - * Description of the Method + * Description of the Method * - *@exception MessagingException Description of the Exception + * @exception MessagingException Description of the Exception */ public void execute() throws MessagingException { MailCommandManager.openFolder(aFolder, Folder.READ_ONLY); @@ -575,19 +580,20 @@ /** - * Description of the Class - * + * Description of the Class */ - public static class MailSearchMessagesCommand extends AbstractMailCommand implements Contextualizable { + public static class MailSearchMessagesCommand extends AbstractMailCommand + implements Contextualizable { + private Folder aFolder; private SearchTerm searchTerm; /** - * Description of the Method + * Description of the Method * - *@param ctx Description of the Parameter - *@exception ContextException Description of the Exception + * @param ctx Description of the Parameter + * @exception ContextException Description of the Exception */ public void contextualize(Context ctx) throws ContextException { MailContext mctx = (MailContext) ctx; @@ -621,9 +627,9 @@ /** - * Description of the Method + * Description of the Method * - *@exception MessagingException Description of the Exception + * @exception MessagingException Description of the Exception */ public void execute() throws MessagingException { MailCommandManager.openFolder(aFolder, Folder.READ_ONLY); Modified: cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/MailCommandSelector.java URL: http://svn.apache.org/viewvc/cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/MailCommandSelector.java?view=diff&rev=468424&r1=468423&r2=468424 ============================================================================== --- cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/MailCommandSelector.java (original) +++ cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/MailCommandSelector.java Fri Oct 27 08:44:53 2006 @@ -5,9 +5,9 @@ * The ASF licenses this file to You under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -24,39 +24,40 @@ import org.apache.cocoon.environment.ObjectModelHelper; import org.apache.cocoon.environment.Session; import org.apache.avalon.framework.context.ContextException; + /* usage: - + - + - + - + * * @author Bernhard Huber - * @since 24. Oktober 2002 + * @since 24 October 2002 * @version $Id$ */ @@ -122,12 +122,12 @@ public class MailContentHandlerDelegate extends AbstractLogEnabled { /** - * URI of the generated XML elements + * URI of the generated XML elements */ public final static String URI = "http://apache.org/cocoon/mail/1.0"; /** - * PREFIX of the generated XML elements + * PREFIX of the generated XML elements */ public final static String PREFIX = "mail"; @@ -138,8 +138,8 @@ private ContentHandler contentHandler; /** - * use this attributes for startElement attributes invocation, reusing - * attributes object for all elements + * use this attributes for startElement attributes invocation, reusing + * attributes object for all elements */ private AttributesImpl attributes = null; @@ -149,9 +149,9 @@ /** - * Constructor for the MailContentHandler object + * Constructor for the MailContentHandler object * - *@param contentHandler Description of Parameter + * @param contentHandler Description of Parameter */ public MailContentHandlerDelegate(ContentHandler contentHandler) { this.contentHandler = contentHandler; @@ -159,9 +159,9 @@ /** - * Sets the simpleDateFormatter attribute of the MailContentHandlerDelegate object + * Sets the simpleDateFormatter attribute of the MailContentHandlerDelegate object * - *@param sdf The new simpleDateFormat value + * @param sdf The new simpleDateFormat value */ public void setSimpleDateFormat(SimpleDateFormat sdf) { this.sdf = sdf; @@ -169,9 +169,9 @@ /** - * Gets the simpleDateFormat attribute of the MailContentHandlerDelegate object + * Gets the simpleDateFormat attribute of the MailContentHandlerDelegate object * - *@return The simpleDateFormat value + * @return The simpleDateFormat value */ public SimpleDateFormat getSimpleDateFormat() { return sdf; @@ -179,9 +179,9 @@ /** - * Emit starting SAX events sequence, including SAX startDocument event + * Emit starting SAX events sequence, including SAX startDocument event * - *@exception SAXException thrown iff generating SAX events fails + * @exception SAXException thrown iff generating SAX events fails */ public void startDocument() throws SAXException { startDocumentInternal(true); @@ -189,9 +189,9 @@ /** - * Emit starting SAX events sequence, excluding SAX startDocument event + * Emit starting SAX events sequence, excluding SAX startDocument event * - *@exception SAXException thrown iff generating SAX events fails + * @exception SAXException thrown iff generating SAX events fails */ public void startDocumentXMLizer() throws SAXException { startDocumentInternal(false); @@ -199,9 +199,9 @@ /** - * Emit starting SAX events sequence, including SAX endDocument event + * Emit starting SAX events sequence, including SAX endDocument event * - *@exception SAXException thrown iff generating SAX events fails + * @exception SAXException thrown iff generating SAX events fails */ public void endDocument() throws SAXException { endDocumentInternal(true); @@ -209,9 +209,9 @@ /** - * Emit starting SAX events sequence, excluding SAX endDocument event + * Emit starting SAX events sequence, excluding SAX endDocument event * - *@exception SAXException thrown iff generating SAX events fails + * @exception SAXException thrown iff generating SAX events fails */ public void endDocumentXMLizer() throws SAXException { endDocumentInternal(false); @@ -219,9 +219,9 @@ /** - * Emit a folder as a sequence of SAX events + * Emit a folder as a sequence of SAX events * - *@param folder emit this folder + * @param folder emit this folder */ public void marshalFolderToSAX(Folder folder) { try { @@ -233,9 +233,9 @@ /** - * Emit folders as a sequence of SAX events + * Emit folders as a sequence of SAX events * - *@param folders emit these folders + * @param folders emit these folders */ public void marshalFolderToSAX(Folder[] folders) { try { @@ -249,9 +249,9 @@ /** - * Emit a message envelope as a sequence of SAX events + * Emit a message envelope as a sequence of SAX events * - *@param message emit envelope of this message + * @param message emit envelope of this message */ public void marshalMessageEnvelopeToSAX(Message message) { try { @@ -263,9 +263,9 @@ /** - * Emit a message envelope, and message content as a sequence of SAX events + * Emit a message envelope, and message content as a sequence of SAX events * - *@param message emit envelope, and content of this message + * @param message emit envelope, and content of this message */ public void marshalMessageToSAX(Message message) { try { @@ -278,9 +278,9 @@ /** - * Emit a message content as a sequence of SAX events + * Emit a message content as a sequence of SAX events * - *@param part Description of the Parameter + * @param part Description of the Parameter */ public void marshalPartToSAX(Part part) { try { @@ -292,10 +292,10 @@ /** - * Emit start document sequence + * Emit start document sequence * - *@param emitStartDocument flag controlling invocation of SAX startDocument - *@exception SAXException thrown iff generating SAX events fails + * @param emitStartDocument flag controlling invocation of SAX startDocument + * @exception SAXException thrown iff generating SAX events fails */ protected void startDocumentInternal(boolean emitStartDocument) throws SAXException { if (emitStartDocument) { @@ -310,10 +310,10 @@ /** - * Emit end document sequence + * Emit end document sequence * - *@param emitEndDocument flag controlling invocation of SAX endDocument - *@exception SAXException thrown iff generating SAX events fails + * @param emitEndDocument flag controlling invocation of SAX endDocument + * @exception SAXException thrown iff generating SAX events fails */ protected void endDocumentInternal(boolean emitEndDocument) throws SAXException { endElement("mail"); @@ -326,12 +326,12 @@ /** - * Emit folder as sequence of SAX events + * Emit folder as sequence of SAX events * - *@param folder emit this folder - *@param contentHandler specifies sink of SAX events - *@exception MessagingException thrown iff accessing javamail data fails - *@exception SAXException thrown iff generating SAX events fails + * @param folder emit this folder + * @param contentHandler specifies sink of SAX events + * @exception MessagingException thrown iff accessing javamail data fails + * @exception SAXException thrown iff generating SAX events fails */ protected void folderToSAX(ContentHandler contentHandler, Folder folder) throws MessagingException, SAXException { attributes.clear(); @@ -356,12 +356,12 @@ /** - * Emit message envelope as sequence of SAX events + * Emit message envelope as sequence of SAX events * - *@param message emit envelope of this message - *@param contentHandler specifies sink of SAX events - *@exception MessagingException thrown iff accessing javamail data fails - *@exception SAXException thrown iff generating SAX events fails + * @param message emit envelope of this message + * @param contentHandler specifies sink of SAX events + * @exception MessagingException thrown iff accessing javamail data fails + * @exception SAXException thrown iff generating SAX events fails */ protected void messageEnvelopeToSAX(ContentHandler contentHandler, Message message) throws MessagingException, SAXException { attributes.clear(); @@ -485,14 +485,14 @@ /** - * Emit part as sequence of SAX events + * Emit part as sequence of SAX events * - *@param part Description of the Parameter - *@param contentHandler specifies sink of SAX events - *@param i Description of the Parameter - *@exception MessagingException thrown iff accessing javamail data fails - *@exception IOException thrown iff accessing content fails - *@exception SAXException thrown iff generating SAX events fails + * @param part Description of the Parameter + * @param contentHandler specifies sink of SAX events + * @param i Description of the Parameter + * @exception MessagingException thrown iff accessing javamail data fails + * @exception IOException thrown iff accessing content fails + * @exception SAXException thrown iff generating SAX events fails */ protected void partToSAX(ContentHandler contentHandler, Part part, int i) throws MessagingException, IOException, SAXException { attributes.clear(); @@ -568,23 +568,23 @@ /** - * Emit content of message part as sequence of SAX events + * Emit content of message part as sequence of SAX events * - *@param contentHandler specifies sink of SAX events - *@param part emit this part as sequence of SAX events - *@exception SAXException thrown iff generating SAX events fails - *@exception MessagingException thrown iff accessing javamail data fails - *@exception IOException thrown iff accessing content fails + * @param contentHandler specifies sink of SAX events + * @param part emit this part as sequence of SAX events + * @exception SAXException thrown iff generating SAX events fails + * @exception MessagingException thrown iff accessing javamail data fails + * @exception IOException thrown iff accessing content fails */ protected void contentToSAX(ContentHandler contentHandler, Part part) throws MessagingException, IOException, SAXException { attributes.clear(); startElement("content", attributes); /* - * Using isMimeType to determine the content type avoids - * fetching the actual content data until we need it. + * Using isMimeType to determine the content type avoids + * fetching the actual content data until we need it. * - * todo: recheck this code for all circumstances......... + * todo: recheck this code for all circumstances......... */ if (part.getContent() instanceof String && (part.isMimeType("text/plain"))) { characters((String) part.getContent()); @@ -614,8 +614,8 @@ partToSAX(contentHandler, (Part) part.getContent(), 0); } else { /* - * If we actually want to see the data, and it's not a - * MIME type we know, fetch it and check its Java type. + * If we actually want to see the data, and it's not a + * MIME type we know, fetch it and check its Java type. Object o = part.getContent(); if (o instanceof String) { characters((String) o); @@ -633,11 +633,11 @@ /** - * Helper method emitting SAX events representing an internet address + * Helper method emitting SAX events representing an internet address * - *@param nodeName emitted element node name - *@param address emitted address data - *@exception SAXException thrown iff generating SAX events fails + * @param nodeName emitted element node name + * @param address emitted address data + * @exception SAXException thrown iff generating SAX events fails */ protected void emitAddress(String nodeName, Address address) throws SAXException { @@ -663,11 +663,11 @@ /** - * Helper method emitting SAX events representing a date + * Helper method emitting SAX events representing a date * - *@param nodeName emitted element node name - *@param d Description of the Parameter - *@exception SAXException thrown iff generating SAX events fails + * @param nodeName emitted element node name + * @param d Description of the Parameter + * @exception SAXException thrown iff generating SAX events fails */ protected void emitDate(String nodeName, Date d) throws SAXException { attributes.clear(); @@ -685,11 +685,11 @@ /** - * Helper method emitting SAX startElement event + * Helper method emitting SAX startElement event * - *@param nodeName Description of the Parameter - *@param attributes Description of the Parameter - *@exception SAXException thrown iff generating SAX events fails + * @param nodeName Description of the Parameter + * @param attributes Description of the Parameter + * @exception SAXException thrown iff generating SAX events fails */ private void startElement(String nodeName, Attributes attributes) throws SAXException { this.contentHandler.startElement(URI, nodeName, PREFIX + ":" + nodeName, attributes); @@ -697,10 +697,10 @@ /** - * Helper method emitting SAX characters event + * Helper method emitting SAX characters event * - *@param s Description of the Parameter - *@exception SAXException thrown iff generating SAX events fails + * @param s Description of the Parameter + * @exception SAXException thrown iff generating SAX events fails */ private void characters(String s) throws SAXException { if (s != null) { @@ -721,10 +721,10 @@ /** - * Helper method emitting SAX endElement event + * Helper method emitting SAX endElement event * - *@param nodeName Description of the Parameter - *@exception SAXException thrown iff generating SAX events fails + * @param nodeName Description of the Parameter + * @exception SAXException thrown iff generating SAX events fails */ private void endElement(String nodeName) throws SAXException { this.contentHandler.endElement(URI, nodeName, PREFIX + ":" + nodeName); @@ -732,10 +732,10 @@ /** - * Helper method adding an attribute name-value pair + * Helper method adding an attribute name-value pair * - *@param nodeName The feature to be added to the Attribute attribute - *@param nodeValue The feature to be added to the Attribute attribute + * @param nodeName The feature to be added to the Attribute attribute + * @param nodeValue The feature to be added to the Attribute attribute */ private void addAttribute(String nodeName, String nodeValue) { attributes.addAttribute("", nodeName, nodeName, "CDATA", nodeValue); @@ -743,11 +743,11 @@ /* - * Description of the Method + * Description of the Method * - *@param is Description of Parameter - *@exception IOException Description of Exception - *@exception SAXException thrown iff generating SAX events fails + * @param is Description of Parameter + * @exception IOException Description of Exception + * @exception SAXException thrown iff generating SAX events fails */ /* FIXME (SM) This method doesn't appear to be used private void encodeInputStreamForXML(InputStream is) throws IOException, SAXException { @@ -769,12 +769,12 @@ /* - * A simple byte as hex encodeing + * A simple byte as hex encodeing * - *@param bytes Description of Parameter - *@param offset Description of Parameter - *@param length Description of Parameter - *@return Description of the Returned Value + * @param bytes Description of Parameter + * @param offset Description of Parameter + * @param length Description of Parameter + * @return Description of the Returned Value */ /* FIXME (SM) This method doesn't appear to be used private String encodeBytes(final byte[] bytes, final int offset, final int length) { @@ -797,7 +797,7 @@ /** - * XMLizable Wrapper for one or more folders, saxing folders. + * XMLizable Wrapper for one or more folders, saxing folders. * */ static class FolderXMLizer extends AbstractLogEnabled @@ -809,7 +809,7 @@ /** *Constructor for the FolderSAX object * - *@param folder Description of the Parameter + * @param folder Description of the Parameter */ FolderXMLizer(Folder folder) { this.folders = new Folder[]{folder}; @@ -819,7 +819,7 @@ /** *Constructor for the FolderXMLizer object * - *@param folders Description of the Parameter + * @param folders Description of the Parameter */ FolderXMLizer(Folder[] folders) { this.folders = folders; @@ -827,10 +827,10 @@ /** - * Generate SAX events from one or more folders + * Generate SAX events from one or more folders * - *@param handler Description of the Parameter - *@exception SAXException thrown iff generating SAX events fails + * @param handler Description of the Parameter + * @exception SAXException thrown iff generating SAX events fails */ public void toSAX(ContentHandler handler) throws SAXException { MailContentHandlerDelegate mailContentHandlerDelegate = new MailContentHandlerDelegate(handler); @@ -845,7 +845,7 @@ /** - * XMLizable Wrapper for one or more messages, saxing envelope only of messages. + * XMLizable Wrapper for one or more messages, saxing envelope only of messages. */ static class MessageEnvelopeXMLizer extends AbstractLogEnabled implements XMLizable { @@ -857,7 +857,7 @@ /** *Constructor for the MessageEnvelopeXMLizer object * - *@param message Description of the Parameter + * @param message Description of the Parameter */ public MessageEnvelopeXMLizer(Message message) { this.messages = new Message[1]; @@ -868,7 +868,7 @@ /** *Constructor for the MessageEnvelopeXMLize object * - *@param messages Description of the Parameter + * @param messages Description of the Parameter */ public MessageEnvelopeXMLizer(Message[] messages) { this.messages = messages; @@ -876,9 +876,9 @@ /** - * Sets the simpleDateFormat attribute of the MessageEnvelopeXMLizer object + * Sets the simpleDateFormat attribute of the MessageEnvelopeXMLizer object * - *@param sdf The new simpleDateFormat value + * @param sdf The new simpleDateFormat value */ public void setSimpleDateFormat(SimpleDateFormat sdf) { this.sdf = sdf; @@ -886,9 +886,9 @@ /** - * Gets the simpleDateFormat attribute of the MessageEnvelopeXMLizer object + * Gets the simpleDateFormat attribute of the MessageEnvelopeXMLizer object * - *@param sdf Description of the Parameter + * @param sdf Description of the Parameter */ public void getSimpleDateFormat(SimpleDateFormat sdf) { this.sdf = sdf; @@ -896,10 +896,10 @@ /** - * Generate SAX events from one or more messages + * Generate SAX events from one or more messages * - *@param handler Description of the Parameter - *@exception SAXException thrown iff generating SAX events fails + * @param handler Description of the Parameter + * @exception SAXException thrown iff generating SAX events fails */ public void toSAX(ContentHandler handler) throws SAXException { MailContentHandlerDelegate mailContentHandlerDelegate = new MailContentHandlerDelegate(handler); @@ -917,7 +917,7 @@ /** - * XMLizable Wrapper for a message, saxing a message envelope, plus content. + * XMLizable Wrapper for a message, saxing a message envelope, plus content. */ static class MessageXMLizer extends AbstractLogEnabled implements XMLizable { @@ -929,7 +929,7 @@ /** *Constructor for the MessageXMLizer object * - *@param message Description of the Parameter + * @param message Description of the Parameter */ public MessageXMLizer(Message message) { this.message = message; @@ -937,9 +937,9 @@ /** - * Sets the simpleDateFormat attribute of the MessageXMLizer object + * Sets the simpleDateFormat attribute of the MessageXMLizer object * - *@param sdf The new simpleDateFormat value + * @param sdf The new simpleDateFormat value */ public void setSimpleDateFormat(SimpleDateFormat sdf) { this.sdf = sdf; @@ -947,9 +947,9 @@ /** - * Gets the simpleDateFormat attribute of the MessageXMLizer object + * Gets the simpleDateFormat attribute of the MessageXMLizer object * - *@param sdf Description of the Parameter + * @param sdf Description of the Parameter */ public void getSimpleDateFormat(SimpleDateFormat sdf) { this.sdf = sdf; @@ -957,10 +957,10 @@ /** - * Generate SAX events from a message + * Generate SAX events from a message * - *@param handler Description of the Parameter - *@exception SAXException thrown iff generating SAX events fails + * @param handler Description of the Parameter + * @exception SAXException thrown iff generating SAX events fails */ public void toSAX(ContentHandler handler) throws SAXException { MailContentHandlerDelegate mailContentHandlerDelegate = new MailContentHandlerDelegate(handler); @@ -972,4 +972,3 @@ } } } - Modified: cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/MailContext.java URL: http://svn.apache.org/viewvc/cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/MailContext.java?view=diff&rev=468424&r1=468423&r2=468424 ============================================================================== --- cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/MailContext.java (original) +++ cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/MailContext.java Fri Oct 27 08:44:53 2006 @@ -38,6 +38,7 @@ * @version $Id$ */ public class MailContext extends DefaultContext implements LogEnabled { + /** * attribute name of MailContext object in an application session, eg http-session */ @@ -47,6 +48,7 @@ * Description of the Field */ public final static String MAIL_SESSION_ENTRY = "mail-session"; + /** * Description of the Field */ @@ -68,7 +70,7 @@ /** *Constructor for the MailContext object * - *@param parent Description of the Parameter + * @param parent Description of the Parameter */ MailContext(Context parent) { super(parent); @@ -78,7 +80,7 @@ /** * Sets the request attribute of the MailContext object * - *@param request The new request value + * @param request The new request value */ public void setRequest(Request request) { this.request = request; @@ -102,9 +104,9 @@ * * * - *@param key Description of the Parameter - *@return Description of the Return Value - *@exception ContextException Description of the Exception + * @param key Description of the Parameter + * @return Description of the Return Value + * @exception ContextException Description of the Exception */ public Object get(Object key) throws ContextException { String keyString = (String) key; @@ -124,8 +126,7 @@ } else if (keyString.startsWith(PARAM_INTEGER_PREFIX_ENTRY)) { String paramName = keyString.substring(PARAM_INTEGER_PREFIX_ENTRY.length()); try { - Integer paramValue = getParameterAsInteger(paramName); - return paramValue; + return getParameterAsInteger(paramName); } catch (NumberFormatException nfe) { String message = "Cannot create Integer for parameter " + String.valueOf(keyString); throw new ContextException(message, nfe); @@ -147,7 +148,7 @@ } // get folder object, folderName is okay - Folder folder = null; + Folder folder; try { folder = (Folder) getFolder(folderName); } catch (ContextException ce) { @@ -185,9 +186,9 @@ /** * Gets the theFolder attribute of the MailContext object * - *@param entry Description of the Parameter - *@return The theFolder value - *@exception ContextException Description of the Exception + * @param entry Description of the Parameter + * @return The theFolder value + * @exception ContextException Description of the Exception */ public Folder getTheFolder(String entry) throws ContextException { Folder f; @@ -204,9 +205,9 @@ /** * Gets the folder attribute of the MailContext object * - *@param folderName Description of the Parameter - *@return The folder value - *@exception ContextException Description of the Exception + * @param folderName Description of the Parameter + * @return The folder value + * @exception ContextException Description of the Exception */ public Object getFolder(String folderName) throws ContextException { // canonicalize folder name @@ -270,8 +271,8 @@ /** * put a folder in this MailContext object map * - *@param folder Description of the Parameter - *@exception ContextException Description of the Exception + * @param folder Description of the Parameter + * @exception ContextException Description of the Exception */ public void putFolder(Folder folder) throws ContextException { String folderName = folder.getFullName(); @@ -309,8 +310,8 @@ /** * Description of the Method * - *@param folders Description of the Parameter - *@exception ContextException Description of the Exception + * @param folders Description of the Parameter + * @exception ContextException Description of the Exception */ public void putFolder(Folder[] folders) throws ContextException { for (int i = 0; i < folders.length; i++) { @@ -322,7 +323,7 @@ /** * Description of the Method * - *@param logger Description of the Parameter + * @param logger Description of the Parameter */ public void enableLogging(Logger logger) { this.logger = logger; @@ -333,32 +334,30 @@ /** * Gets the parameter attribute of the MailContext object * - *@param key Description of the Parameter - *@return The parameter value + * @param key Description of the Parameter + * @return The parameter value */ protected String getParameter(String key) { - String value = request.getParameter(key); - return value; + return request.getParameter(key); } /** * Gets the parameterAsInteger attribute of the MailContext object * - *@param key Description of the Parameter - *@return The parameterAsInteger value + * @param key Description of the Parameter + * @return The parameterAsInteger value */ protected Integer getParameterAsInteger(String key) { String value = request.getParameter(key); - Integer i = new Integer(value); - return i; + return new Integer(value); } /** * Gets the logger attribute of the MailContext object * - *@return The logger value + * @return The logger value */ protected Logger getLogger() { return this.logger; @@ -368,8 +367,8 @@ /** * Description of the Method * - *@param fn Description of the Parameter - *@return Description of the Return Value + * @param fn Description of the Parameter + * @return Description of the Return Value */ protected String canoncializeFoldername(String fn) { // Modified: cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/MimeMessageUtil.java URL: http://svn.apache.org/viewvc/cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/MimeMessageUtil.java?view=diff&rev=468424&r1=468423&r2=468424 ============================================================================== --- cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/MimeMessageUtil.java (original) +++ cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/MimeMessageUtil.java Fri Oct 27 08:44:53 2006 @@ -36,10 +36,12 @@ * @version $Id$ */ public class MimeMessageUtil { + /** * Description of the Field */ public final static String SENDER_NOT_AVAILABLE = "-not available-"; + /** * Description of the Field */ Modified: cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/command/AbstractMailCommand.java URL: http://svn.apache.org/viewvc/cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/command/AbstractMailCommand.java?view=diff&rev=468424&r1=468423&r2=468424 ============================================================================== --- cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/command/AbstractMailCommand.java (original) +++ cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/command/AbstractMailCommand.java Fri Oct 27 08:44:53 2006 @@ -5,9 +5,9 @@ * The ASF licenses this file to You under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -23,14 +23,14 @@ import org.apache.avalon.framework.logger.AbstractLogEnabled; /** - * An abstract MailCommand template + * An abstract MailCommand template * * @author Bernhard Huber - * @since 23. Oktober 2002 - * @version CVS $Id$ + * @since 23 October 2002 + * @version $Id$ */ public abstract class AbstractMailCommand extends AbstractLogEnabled - implements MailCommand { + implements MailCommand { /** * List of result objects @@ -93,5 +93,3 @@ */ public abstract void execute() throws MessagingException; } - - Modified: cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/command/MailCommand.java URL: http://svn.apache.org/viewvc/cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/command/MailCommand.java?view=diff&rev=468424&r1=468423&r2=468424 ============================================================================== --- cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/command/MailCommand.java (original) +++ cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/command/MailCommand.java Fri Oct 27 08:44:53 2006 @@ -5,9 +5,9 @@ * The ASF licenses this file to You under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -22,10 +22,11 @@ * This interface the basic contract of a MailCommand * * @author Bernhard Huber - * @since 23. Oktober 2002 - * @version CVS $Id$ + * @since 23 October 2002 + * @version $Id$ */ public interface MailCommand { + /** * Execute this MailCommand * @@ -33,5 +34,3 @@ */ void execute() throws MessagingException; } - - Modified: cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/command/MailCommands.java URL: http://svn.apache.org/viewvc/cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/command/MailCommands.java?view=diff&rev=468424&r1=468423&r2=468424 ============================================================================== --- cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/command/MailCommands.java (original) +++ cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/command/MailCommands.java Fri Oct 27 08:44:53 2006 @@ -5,9 +5,9 @@ * The ASF licenses this file to You under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -21,11 +21,11 @@ import javax.mail.MessagingException; /** - * Execute a list of commands. + * Execute a list of commands. * * @author Bernhard Huber - * @since 23. Oktober 2002 - * @version CVS $Id$ + * @since 23 October 2002 + * @version $Id$ */ public class MailCommands extends AbstractMailCommand { @@ -62,5 +62,3 @@ } } } - - Modified: cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/datasource/FilePartDataSource.java URL: http://svn.apache.org/viewvc/cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/datasource/FilePartDataSource.java?view=diff&rev=468424&r1=468423&r2=468424 ============================================================================== --- cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/datasource/FilePartDataSource.java (original) +++ cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/datasource/FilePartDataSource.java Fri Oct 27 08:44:53 2006 @@ -5,9 +5,9 @@ * The ASF licenses this file to You under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -25,21 +25,24 @@ import org.apache.cocoon.servlet.multipart.Part; -/** The FilePartDataSource class provides an object, that wraps a +/** + * The FilePartDataSource class provides an object, that wraps a * Cocoon {@link Part} * object in a DataSource interface. * @see javax.activation.DataSource * * @author Frank Ridderbusch * @author Christian Haul - * @version CVS $Id$ + * @version $Id$ */ public class FilePartDataSource implements DataSource { + private Part part; - private String contentType = null; - private String name = null; + private String contentType; + private String name; - /** Creates a new instance of FilePartDataSource from an + /** + * Creates a new instance of FilePartDataSource from an * {@link Part} object. * @param part An {@link Part} object. */ @@ -47,7 +50,8 @@ this(part,null,null); } - /** Creates a new instance of FilePartDataSource from an + /** + * Creates a new instance of FilePartDataSource from an * {@link Part} object. * @param part An {@link Part} object. */ @@ -60,22 +64,23 @@ } /** - * Check String for null or empty. - * @param str - * @return true if str is null, empty string, or equals "null" - */ + * Check String for null or empty. + * @param str + * @return true if str is null, empty string, or equals "null" + */ private boolean isNullOrEmpty(String str) { return (str == null || "".equals(str) || "null".equals(str)); } - /** Return the content type (mime type) obtained from + /** + * Return the content type (mime type) obtained from * {@link Part#getMimeType()}. * Return application/octet-stream if getMimeType() * returns null. * @return The content type (mime type) for this DataSource object. - */ + */ public String getContentType() { - if (this.contentType != null) { + if (this.contentType != null) { return this.contentType; } String mimeType = part.getMimeType(); @@ -85,12 +90,13 @@ return mimeType; } - /** The InputStream object obtained from + /** + * The InputStream object obtained from * {@link Part#getInputStream()} * object. * @throws java.io.IOException if an I/O error occurs. * @return The InputStream object for this DataSource object. - */ + */ public InputStream getInputStream() throws IOException { InputStream inp; try { @@ -101,21 +107,23 @@ return inp; } - /** Returns the name for this DataSource object. This is + /** + * Returns the name for this DataSource object. This is * what is returned by * {@link Part#getFileName()}. * @return the name for this DataSource object. - */ + */ public String getName() { String name = (this.name != null ? this.name : part.getFileName()); if (isNullOrEmpty(name)) name="attachment"; return name; } - /** Unimplemented. Directly throws IOException. + /** + * Unimplemented. Directly throws IOException. * @throws java.io.IOException since unimplemented * @return nothing - */ + */ public OutputStream getOutputStream() throws IOException { throw new IOException("no data sink available"); } Modified: cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/datasource/SourceDataSource.java URL: http://svn.apache.org/viewvc/cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/datasource/SourceDataSource.java?view=diff&rev=468424&r1=468423&r2=468424 ============================================================================== --- cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/datasource/SourceDataSource.java (original) +++ cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/datasource/SourceDataSource.java Fri Oct 27 08:44:53 2006 @@ -37,6 +37,7 @@ */ public class SourceDataSource extends AbstractLogEnabled implements DataSource { + private Source src; private String contentType; private String name; Modified: cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/transformation/SendMailTransformer.java URL: http://svn.apache.org/viewvc/cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/transformation/SendMailTransformer.java?view=diff&rev=468424&r1=468423&r2=468424 ============================================================================== --- cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/transformation/SendMailTransformer.java (original) +++ cocoon/branches/BRANCH_2_1_X/src/blocks/mail/java/org/apache/cocoon/mail/transformation/SendMailTransformer.java Fri Oct 27 08:44:53 2006 @@ -198,7 +198,7 @@ *

* * @author Peter Klassen - * @version CVS $Id$ + * @version $Id$ */ public class SendMailTransformer extends AbstractSAXTransformer {