You are viewing a plain text version of this content. The canonical link for it is here.
Posted to server-dev@james.apache.org by bt...@apache.org on 2019/11/20 01:56:58 UTC

[james-project] 30/49: [Refactoring] Clean mailetcontainer-api javadoc

This is an automated email from the ASF dual-hosted git repository.

btellier pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/james-project.git

commit e3a4d3bec6f17d429e5fcea3f6b6a1952daf880c
Author: Benoit Tellier <bt...@linagora.com>
AuthorDate: Sun Nov 17 15:23:53 2019 +0700

    [Refactoring] Clean mailetcontainer-api javadoc
---
 .../org/apache/james/mailetcontainer/api/MailetLoader.java   |  3 +--
 .../org/apache/james/mailetcontainer/api/MatcherLoader.java  |  3 +--
 .../api/jmx/MailProcessorManagementMBean.java                | 12 ------------
 .../james/mailetcontainer/api/jmx/MailSpoolerMBean.java      |  3 ---
 .../james/mailetcontainer/api/jmx/MailetManagementMBean.java |  4 ----
 .../mailetcontainer/api/jmx/MatcherManagementMBean.java      |  8 --------
 6 files changed, 2 insertions(+), 31 deletions(-)

diff --git a/server/mailet/mailetcontainer-api/src/main/java/org/apache/james/mailetcontainer/api/MailetLoader.java b/server/mailet/mailetcontainer-api/src/main/java/org/apache/james/mailetcontainer/api/MailetLoader.java
index 27bea5a..6abae37 100644
--- a/server/mailet/mailetcontainer-api/src/main/java/org/apache/james/mailetcontainer/api/MailetLoader.java
+++ b/server/mailet/mailetcontainer-api/src/main/java/org/apache/james/mailetcontainer/api/MailetLoader.java
@@ -34,8 +34,7 @@ public interface MailetLoader {
      * Get a new {@link Mailet} instance for the given {@link MailetConfig}. The
      * returned {@link Mailet} needs to be fully initialized, so the returned
      * instance is "read-to-use"
-     * 
-     * @param config
+     *
      * @throws MessagingException
      *             if an error occurs
      */
diff --git a/server/mailet/mailetcontainer-api/src/main/java/org/apache/james/mailetcontainer/api/MatcherLoader.java b/server/mailet/mailetcontainer-api/src/main/java/org/apache/james/mailetcontainer/api/MatcherLoader.java
index 5d4e084..64f5520 100644
--- a/server/mailet/mailetcontainer-api/src/main/java/org/apache/james/mailetcontainer/api/MatcherLoader.java
+++ b/server/mailet/mailetcontainer-api/src/main/java/org/apache/james/mailetcontainer/api/MatcherLoader.java
@@ -34,8 +34,7 @@ public interface MatcherLoader {
      * Get a new {@link Matcher} for the given {@link MatcherConfig}. The
      * returned {@link Matcher} needs to be fully initialized, so the returned
      * instance is "read-to-use"
-     * 
-     * @param config
+     *
      * @throws MessagingException
      *             if an error occurs
      */
diff --git a/server/mailet/mailetcontainer-api/src/main/java/org/apache/james/mailetcontainer/api/jmx/MailProcessorManagementMBean.java b/server/mailet/mailetcontainer-api/src/main/java/org/apache/james/mailetcontainer/api/jmx/MailProcessorManagementMBean.java
index 29eed47..b43a13a 100644
--- a/server/mailet/mailetcontainer-api/src/main/java/org/apache/james/mailetcontainer/api/jmx/MailProcessorManagementMBean.java
+++ b/server/mailet/mailetcontainer-api/src/main/java/org/apache/james/mailetcontainer/api/jmx/MailProcessorManagementMBean.java
@@ -26,44 +26,32 @@ public interface MailProcessorManagementMBean {
 
     /**
      * Return the count of handled mail
-     * 
-     * @return handledCount
      */
     long getHandledMailCount();
 
     /**
      * Return the time in ms of the fastest processing
-     * 
-     * @return fastest
      */
     long getFastestProcessing();
 
     /**
      * Return the time in ms of the slowest processing
-     * 
-     * @return slowest
      */
     long getSlowestProcessing();
 
     /**
      * Return the count of how many time the processing was done without and
      * error
-     * 
-     * @return successCount
      */
     long getSuccessCount();
 
     /**
      * Return the count of how many times an error was detected while processing
-     * 
-     * @return errorCount
      */
     long getErrorCount();
 
     /**
      * Return the time in ms of the last processing
-     * 
-     * @return last
      */
     long getLastProcessing();
 
diff --git a/server/mailet/mailetcontainer-api/src/main/java/org/apache/james/mailetcontainer/api/jmx/MailSpoolerMBean.java b/server/mailet/mailetcontainer-api/src/main/java/org/apache/james/mailetcontainer/api/jmx/MailSpoolerMBean.java
index 8347a0d..838f4a4 100644
--- a/server/mailet/mailetcontainer-api/src/main/java/org/apache/james/mailetcontainer/api/jmx/MailSpoolerMBean.java
+++ b/server/mailet/mailetcontainer-api/src/main/java/org/apache/james/mailetcontainer/api/jmx/MailSpoolerMBean.java
@@ -25,13 +25,10 @@ public interface MailSpoolerMBean {
 
     /**
      * Return the number of threads used for spooling
-     * 
-     * @return threadCount
      */
     int getThreadCount();
 
     /**
-     * 
      * @return current spool count
      */
     int getCurrentSpoolCount();
diff --git a/server/mailet/mailetcontainer-api/src/main/java/org/apache/james/mailetcontainer/api/jmx/MailetManagementMBean.java b/server/mailet/mailetcontainer-api/src/main/java/org/apache/james/mailetcontainer/api/jmx/MailetManagementMBean.java
index af986f5..d880798 100644
--- a/server/mailet/mailetcontainer-api/src/main/java/org/apache/james/mailetcontainer/api/jmx/MailetManagementMBean.java
+++ b/server/mailet/mailetcontainer-api/src/main/java/org/apache/james/mailetcontainer/api/jmx/MailetManagementMBean.java
@@ -26,15 +26,11 @@ public interface MailetManagementMBean extends MailProcessorManagementMBean {
 
     /**
      * Return the name of the mailet
-     * 
-     * @return mailet
      */
     String getMailetName();
 
     /**
      * Return the parameters which are configured for the mailet
-     * 
-     * @return params
      */
     String[] getMailetParameters();
 }
diff --git a/server/mailet/mailetcontainer-api/src/main/java/org/apache/james/mailetcontainer/api/jmx/MatcherManagementMBean.java b/server/mailet/mailetcontainer-api/src/main/java/org/apache/james/mailetcontainer/api/jmx/MatcherManagementMBean.java
index 1de758f..5dc23fc 100644
--- a/server/mailet/mailetcontainer-api/src/main/java/org/apache/james/mailetcontainer/api/jmx/MatcherManagementMBean.java
+++ b/server/mailet/mailetcontainer-api/src/main/java/org/apache/james/mailetcontainer/api/jmx/MatcherManagementMBean.java
@@ -26,29 +26,21 @@ public interface MatcherManagementMBean extends MailProcessorManagementMBean {
 
     /**
      * Return the name of the Matcher
-     * 
-     * @return name
      */
     String getMatcherName();
 
     /**
      * Return the matcher condition
-     * 
-     * @return condition
      */
     String getMatcherCondition();
 
     /**
      * Return the count of how many times the Matcher matched
-     * 
-     * @return matched
      */
     long getMatchedCount();
 
     /**
      * Return the count of how many times the Matcher not matches
-     * 
-     * @return notmatched
      */
     long getNotMatchedCount();
 


---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org