Cleanedup more checkstyle reported errors/warnings.
authorKarl Heinz Marbaise <khmarbaise@apache.org>
Tue, 8 Dec 2015 13:37:31 +0000 (13:37 +0000)
committerKarl Heinz Marbaise <khmarbaise@apache.org>
Tue, 8 Dec 2015 13:37:31 +0000 (13:37 +0000)
git-svn-id: https://svn.apache.org/repos/asf/maven/shared/trunk@1718601 13f79535-47bb-0310-9956-ffa450edef68

src/main/java/org/apache/maven/shared/io/logging/DefaultMessageHolder.java
src/main/java/org/apache/maven/shared/io/logging/MessageHolder.java
src/main/java/org/apache/maven/shared/io/logging/MessageLevels.java
src/main/java/org/apache/maven/shared/io/logging/MessageSink.java
src/main/java/org/apache/maven/shared/io/logging/PlexusLoggerSink.java

index b06a447..0bdc8fe 100644 (file)
@@ -25,6 +25,10 @@ import java.util.ArrayList;
 import java.util.Iterator;
 import java.util.List;
 
+/**
+ * Default Message Holder.
+ *
+ */
 public class DefaultMessageHolder
     implements MessageHolder
 {
@@ -39,17 +43,29 @@ public class DefaultMessageHolder
 
     private MessageSink onDemandSink;
 
+    /**
+     * Create instance.
+     */
     public DefaultMessageHolder()
     {
         this.messageLevelStates = MessageLevels.getLevelStates( MessageLevels.LEVEL_INFO );
     }
 
+    /**
+     * @param maxMessageLevel max message level.
+     * @param defaultMessageLevel default message level.
+     */
     public DefaultMessageHolder( int maxMessageLevel, int defaultMessageLevel )
     {
         this.defaultMessageLevel = defaultMessageLevel;
         this.messageLevelStates = MessageLevels.getLevelStates( maxMessageLevel );
     }
 
+    /**
+     * @param maxMessageLevel max message level.
+     * @param defaultMessageLevel default message level.
+     * @param onDemandSink {@link MessageSink}
+     */
     public DefaultMessageHolder( int maxMessageLevel, int defaultMessageLevel, MessageSink onDemandSink )
     {
         this.defaultMessageLevel = defaultMessageLevel;
@@ -57,11 +73,18 @@ public class DefaultMessageHolder
         this.messageLevelStates = MessageLevels.getLevelStates( maxMessageLevel );
     }
 
+    /** {@inheritDoc} */
     public MessageHolder addMessage( CharSequence messagePart, Throwable error )
     {
         return addMessage( defaultMessageLevel, messagePart, error );
     }
 
+    /**
+     * @param level Level.
+     * @param messagePart Message part.
+     * @param error {@link Throwable}
+     * @return {@link MessageHolder}
+     */
     protected MessageHolder addMessage( int level, CharSequence messagePart, Throwable error )
     {
         newMessage( level );
@@ -71,11 +94,17 @@ public class DefaultMessageHolder
         return this;
     }
 
+    /** {@inheritDoc} */
     public MessageHolder addMessage( CharSequence messagePart )
     {
         return addMessage( defaultMessageLevel, messagePart );
     }
 
+    /**
+     * @param level level.
+     * @param messagePart message part.
+     * @return {@link MessageHolder}
+     */
     protected MessageHolder addMessage( int level, CharSequence messagePart )
     {
         newMessage( level );
@@ -84,11 +113,17 @@ public class DefaultMessageHolder
         return this;
     }
 
+    /** {@inheritDoc} */
     public MessageHolder addMessage( Throwable error )
     {
         return addMessage( defaultMessageLevel, error );
     }
 
+    /**
+     * @param level level.
+     * @param error {@link Throwable}
+     * @return {@link MessageHolder}
+     */
     protected MessageHolder addMessage( int level, Throwable error )
     {
         newMessage( level );
@@ -97,6 +132,7 @@ public class DefaultMessageHolder
         return this;
     }
 
+    /** {@inheritDoc} */
     public MessageHolder append( CharSequence messagePart )
     {
         if ( currentMessage == null )
@@ -109,6 +145,7 @@ public class DefaultMessageHolder
         return this;
     }
 
+    /** {@inheritDoc} */
     public MessageHolder append( Throwable error )
     {
         if ( currentMessage == null )
@@ -121,11 +158,13 @@ public class DefaultMessageHolder
         return this;
     }
 
+    /** {@inheritDoc} */
     public boolean isEmpty()
     {
         return messages.isEmpty();
     }
 
+    /** {@inheritDoc} */
     public MessageHolder newMessage()
     {
         newMessage( defaultMessageLevel );
@@ -133,6 +172,9 @@ public class DefaultMessageHolder
         return this;
     }
 
+    /**
+     * @param messageLevel message level.
+     */
     protected void newMessage( int messageLevel )
     {
         if ( onDemandSink != null && currentMessage != null )
@@ -144,6 +186,7 @@ public class DefaultMessageHolder
         messages.add( currentMessage );
     }
 
+    /** {@inheritDoc} */
     public String render()
     {
         StringBuffer buffer = new StringBuffer();
@@ -183,6 +226,7 @@ public class DefaultMessageHolder
         return buffer.toString();
     }
 
+    /** {@inheritDoc} */
     public int size()
     {
         return messages.size();
@@ -217,11 +261,17 @@ public class DefaultMessageHolder
             return this;
         }
 
+        /**
+         * @return message level.
+         */
         public int getMessageLevel()
         {
             return messageLevel;
         }
 
+        /**
+         * @return Sequence.
+         */
         public CharSequence render()
         {
             StringBuffer buffer = new StringBuffer();
@@ -255,111 +305,136 @@ public class DefaultMessageHolder
         }
     }
 
+    /** {@inheritDoc} */
     public MessageHolder addDebugMessage( CharSequence messagePart, Throwable error )
     {
         return addMessage( MessageLevels.LEVEL_DEBUG, messagePart, error );
     }
 
+    /** {@inheritDoc} */
     public MessageHolder addDebugMessage( CharSequence messagePart )
     {
         return addMessage( MessageLevels.LEVEL_DEBUG, messagePart );
     }
 
+    /** {@inheritDoc} */
     public MessageHolder addDebugMessage( Throwable error )
     {
         return addMessage( MessageLevels.LEVEL_DEBUG, error );
     }
 
+    /** {@inheritDoc} */
     public MessageHolder addErrorMessage( CharSequence messagePart, Throwable error )
     {
         return addMessage( MessageLevels.LEVEL_ERROR, messagePart, error );
     }
 
+    /** {@inheritDoc} */
     public MessageHolder addErrorMessage( CharSequence messagePart )
     {
         return addMessage( MessageLevels.LEVEL_ERROR, messagePart );
     }
 
+    /** {@inheritDoc} */
     public MessageHolder addErrorMessage( Throwable error )
     {
         return addMessage( MessageLevels.LEVEL_ERROR, error );
     }
 
+    /** {@inheritDoc} */
     public MessageHolder addInfoMessage( CharSequence messagePart, Throwable error )
     {
         return addMessage( MessageLevels.LEVEL_INFO, messagePart, error );
     }
 
+    /** {@inheritDoc} */
     public MessageHolder addInfoMessage( CharSequence messagePart )
     {
         return addMessage( MessageLevels.LEVEL_INFO, messagePart );
     }
 
+    /** {@inheritDoc} */
     public MessageHolder addInfoMessage( Throwable error )
     {
         return addMessage( MessageLevels.LEVEL_INFO, error );
     }
 
+    /** {@inheritDoc} */
     public MessageHolder addSevereMessage( CharSequence messagePart, Throwable error )
     {
         return addMessage( MessageLevels.LEVEL_SEVERE, messagePart, error );
     }
 
+    /** {@inheritDoc} */
     public MessageHolder addSevereMessage( CharSequence messagePart )
     {
         return addMessage( MessageLevels.LEVEL_SEVERE, messagePart );
     }
 
+    /** {@inheritDoc} */
     public MessageHolder addSevereMessage( Throwable error )
     {
         return addMessage( MessageLevels.LEVEL_SEVERE, error );
     }
 
+    /** {@inheritDoc} */
     public MessageHolder addWarningMessage( CharSequence messagePart, Throwable error )
     {
         return addMessage( MessageLevels.LEVEL_WARNING, messagePart, error );
     }
 
+    /** {@inheritDoc} */
     public MessageHolder addWarningMessage( CharSequence messagePart )
     {
         return addMessage( MessageLevels.LEVEL_WARNING, messagePart );
     }
 
+    /** {@inheritDoc} */
     public MessageHolder addWarningMessage( Throwable error )
     {
         return addMessage( MessageLevels.LEVEL_WARNING, error );
     }
 
+    /** {@inheritDoc} */
     public int countDebugMessages()
     {
         return countMessagesOfType( MessageLevels.LEVEL_DEBUG );
     }
 
+    /** {@inheritDoc} */
     public int countErrorMessages()
     {
         return countMessagesOfType( MessageLevels.LEVEL_ERROR );
     }
 
+    /** {@inheritDoc} */
     public int countInfoMessages()
     {
         return countMessagesOfType( MessageLevels.LEVEL_INFO );
     }
 
+    /** {@inheritDoc} */
     public int countMessages()
     {
         return size();
     }
 
+    /** {@inheritDoc} */
     public int countSevereMessages()
     {
         return countMessagesOfType( MessageLevels.LEVEL_SEVERE );
     }
 
+    /** {@inheritDoc} */
     public int countWarningMessages()
     {
         return countMessagesOfType( MessageLevels.LEVEL_WARNING );
     }
 
+    /**
+     * @param messageLevel leve.
+     * @return number of messages.
+     */
     private int countMessagesOfType( int messageLevel )
     {
         int count = 0;
@@ -375,31 +450,37 @@ public class DefaultMessageHolder
         return count;
     }
 
+    /** {@inheritDoc} */
     public boolean isDebugEnabled()
     {
         return messageLevelStates[MessageLevels.LEVEL_DEBUG];
     }
 
+    /** {@inheritDoc} */
     public boolean isErrorEnabled()
     {
         return messageLevelStates[MessageLevels.LEVEL_ERROR];
     }
 
+    /** {@inheritDoc} */
     public boolean isInfoEnabled()
     {
         return messageLevelStates[MessageLevels.LEVEL_INFO];
     }
 
+    /** {@inheritDoc} */
     public boolean isSevereEnabled()
     {
         return messageLevelStates[MessageLevels.LEVEL_SEVERE];
     }
 
+    /** {@inheritDoc} */
     public boolean isWarningEnabled()
     {
         return messageLevelStates[MessageLevels.LEVEL_WARNING];
     }
 
+    /** {@inheritDoc} */
     public MessageHolder newDebugMessage()
     {
         if ( isDebugEnabled() )
@@ -410,6 +491,7 @@ public class DefaultMessageHolder
         return this;
     }
 
+    /** {@inheritDoc} */
     public MessageHolder newErrorMessage()
     {
         if ( isErrorEnabled() )
@@ -420,6 +502,7 @@ public class DefaultMessageHolder
         return this;
     }
 
+    /** {@inheritDoc} */
     public MessageHolder newInfoMessage()
     {
         if ( isInfoEnabled() )
@@ -430,6 +513,7 @@ public class DefaultMessageHolder
         return this;
     }
 
+    /** {@inheritDoc} */
     public MessageHolder newSevereMessage()
     {
         if ( isSevereEnabled() )
@@ -440,6 +524,7 @@ public class DefaultMessageHolder
         return this;
     }
 
+    /** {@inheritDoc} */
     public MessageHolder newWarningMessage()
     {
         if ( isWarningEnabled() )
@@ -450,31 +535,37 @@ public class DefaultMessageHolder
         return this;
     }
 
+    /** {@inheritDoc} */
     public void setDebugEnabled( boolean enabled )
     {
         messageLevelStates[MessageLevels.LEVEL_DEBUG] = enabled;
     }
 
+    /** {@inheritDoc} */
     public void setErrorEnabled( boolean enabled )
     {
         messageLevelStates[MessageLevels.LEVEL_ERROR] = enabled;
     }
 
+    /** {@inheritDoc} */
     public void setInfoEnabled( boolean enabled )
     {
         messageLevelStates[MessageLevels.LEVEL_INFO] = enabled;
     }
 
+    /** {@inheritDoc} */
     public void setSevereEnabled( boolean enabled )
     {
         messageLevelStates[MessageLevels.LEVEL_SEVERE] = enabled;
     }
 
+    /** {@inheritDoc} */
     public void setWarningEnabled( boolean enabled )
     {
         messageLevelStates[MessageLevels.LEVEL_WARNING] = enabled;
     }
 
+    /** {@inheritDoc} */
     public void flush()
     {
         if ( onDemandSink != null && currentMessage != null )
@@ -484,6 +575,7 @@ public class DefaultMessageHolder
         }
     }
 
+    /** {@inheritDoc} */
     public void render( MessageSink sink )
     {
         for ( Message message : messages )
@@ -492,6 +584,10 @@ public class DefaultMessageHolder
         }
     }
 
+    /**
+     * @param message {@link Message}
+     * @param sink {@link MessageSink}
+     */
     protected void renderTo( Message message, MessageSink sink )
     {
         switch ( message.getMessageLevel() )
index 75b0890..99d52d4 100644 (file)
@@ -19,101 +19,272 @@ package org.apache.maven.shared.io.logging;
  * under the License.
  */
 
+/**
+ * Message Holder class.
+ *
+ */
 public interface MessageHolder
 {
 
+    /**
+     * @return {@link MessageHolder}
+     */
     MessageHolder newMessage();
 
+    /**
+     * @return {@link MessageHolder}
+     */
     MessageHolder newDebugMessage();
 
+    /**
+     * @return {@link MessageHolder}
+     */
     MessageHolder newInfoMessage();
 
+    /**
+     * @return {@link MessageHolder}
+     */
     MessageHolder newWarningMessage();
 
+    /**
+     * @return {@link MessageHolder}
+     */
     MessageHolder newErrorMessage();
 
+    /**
+     * @return {@link MessageHolder}
+     */
     MessageHolder newSevereMessage();
 
+    /**
+     * @param messagePart message part.
+     * @return {@link MessageHolder}
+     */
     MessageHolder append( CharSequence messagePart );
 
+    /**
+     * @param error {@link Throwable}
+     * @return {@link MessageHolder}
+     */
     MessageHolder append( Throwable error );
 
+    /**
+     * @param messagePart Message Part.
+     * @param error {@link Throwable}
+     * @return {@link MessageHolder}
+     */
     MessageHolder addMessage( CharSequence messagePart, Throwable error );
 
+    /**
+     * @param messagePart message part.
+     * @return {@link MessageHolder}
+     */
     MessageHolder addMessage( CharSequence messagePart );
 
+    /**
+     * @param error {@link Throwable}
+     * @return {@link MessageHolder}
+     */
     MessageHolder addMessage( Throwable error );
 
+    /**
+     * @param messagePart message part.
+     * @param error {@link Throwable}
+     * @return {@link MessageHolder}
+     */
     MessageHolder addDebugMessage( CharSequence messagePart, Throwable error );
 
+    /**
+     * @param messagePart messages part.
+     * @return {@link MessageHolder}
+     */
     MessageHolder addDebugMessage( CharSequence messagePart );
 
+    /**
+     * @param error messages part.
+     * @return {@link MessageHolder}
+     */
     MessageHolder addDebugMessage( Throwable error );
 
+    /**
+     * @param messagePart message part.
+     * @param error {@link Throwable}
+     * @return {@link MessageHolder}
+     */
     MessageHolder addInfoMessage( CharSequence messagePart, Throwable error );
 
+    /**
+     * @param messagePart messages part.
+     * @return {@link MessageHolder}
+     */
     MessageHolder addInfoMessage( CharSequence messagePart );
 
+    /**
+     * @param error {@link Throwable}
+     * @return {@link MessageHolder}
+     */
     MessageHolder addInfoMessage( Throwable error );
 
+    /**
+     * @param messagePart message part.
+     * @param error {@link Throwable}
+     * @return {@link MessageHolder}
+     */
     MessageHolder addWarningMessage( CharSequence messagePart, Throwable error );
 
+    /**
+     * @param messagePart message part.
+     * @return {@link MessageHolder}
+     */
     MessageHolder addWarningMessage( CharSequence messagePart );
 
+    /**
+     * @param error {@link Throwable}
+     * @return {@link MessageHolder}
+     */
     MessageHolder addWarningMessage( Throwable error );
 
+    /**
+     * @param messagePart message part.
+     * @param error {@link Throwable}
+     * @return {@link MessageHolder}
+     */
     MessageHolder addErrorMessage( CharSequence messagePart, Throwable error );
 
+    /**
+     * @param messagePart message part.
+     * @return {@link MessageHolder}
+     */
     MessageHolder addErrorMessage( CharSequence messagePart );
 
+    /**
+     * @param error {@link Throwable}
+     * @return {@link MessageHolder}
+     */
     MessageHolder addErrorMessage( Throwable error );
 
+    /**
+     * @param messagePart message part.
+     * @param error {@link Throwable}
+     * @return {@link MessageHolder}
+     */
     MessageHolder addSevereMessage( CharSequence messagePart, Throwable error );
 
+    /**
+     * @param messagePart message part.
+     * @return {@link MessageHolder}
+     */
     MessageHolder addSevereMessage( CharSequence messagePart );
 
+    /**
+     * @param error
+     * @return {@link MessageHolder}
+     */
     MessageHolder addSevereMessage( Throwable error );
 
+    /**
+     * @return the size.
+     */
     int size();
 
+    /**
+     * @return count number of messages.
+     */
     int countMessages();
 
+    /**
+     * @return count number of debug messages.
+     */
     int countDebugMessages();
 
+    /**
+     * @return count number of info messages.
+     */
     int countInfoMessages();
 
+    /**
+     * @return count number of warning messages.
+     */
     int countWarningMessages();
 
+    /**
+     * @return count number of error messages.
+     */
     int countErrorMessages();
 
+    /**
+     * @return count number of server messages.
+     */
     int countSevereMessages();
 
+    /**
+     * @return true / false.
+     */
     boolean isDebugEnabled();
 
+    /**
+     * @param enabled enable debug
+     */
     void setDebugEnabled( boolean enabled );
 
+    /**
+     * @return true if info is enabled false otherwise.
+     */
     boolean isInfoEnabled();
 
+    /**
+     * @param enabled true info enable false otherwise.
+     */
     void setInfoEnabled( boolean enabled );
 
+    /**
+     * @return true if warning is enabled false otherwise.
+     */
     boolean isWarningEnabled();
 
+    /**
+     * @param enabled enable warning or disable.
+     */
     void setWarningEnabled( boolean enabled );
 
+    /**
+     * @return true if error is enabled false otherwise.
+     */
     boolean isErrorEnabled();
 
+    /**
+     * @param enabled enable error or disable.
+     */
     void setErrorEnabled( boolean enabled );
 
+    /**
+     * @return true if server is enabled false otherwise.
+     */
     boolean isSevereEnabled();
 
+    /**
+     * @param enabled enable server or disable.
+     */
     void setSevereEnabled( boolean enabled );
 
+    /**
+     * @return true if empty false otherwise.
+     */
     boolean isEmpty();
 
+    /**
+     * @return rendered.
+     */
     String render();
 
+    /**
+     * @param sink {@link MessageSink}
+     */
     void render( MessageSink sink );
 
+    /**
+     * flush.
+     */
     void flush();
 
 }
index cd20b6e..06fe3de 100644 (file)
@@ -30,11 +30,29 @@ import java.util.List;
 public final class MessageLevels
 {
 
+    /**
+     * Debug.
+     */
     public static final int LEVEL_DEBUG = 0;
+    /**
+     * Info
+     */
     public static final int LEVEL_INFO = 1;
+    /**
+     * Warning.
+     */
     public static final int LEVEL_WARNING = 2;
+    /**
+     * Error
+     */
     public static final int LEVEL_ERROR = 3;
+    /**
+     * Severe
+     */
     public static final int LEVEL_SEVERE = 4;
+    /**
+     * Disabled.
+     */
     public static final int LEVEL_DISABLED = 5;
 
     private static final List<String> LEVEL_NAMES;
@@ -55,6 +73,10 @@ public final class MessageLevels
     {
     }
 
+    /**
+     * @param maxMessageLevel for which level.
+     * @return level states.
+     */
     public static boolean[] getLevelStates( int maxMessageLevel )
     {
         boolean[] states = new boolean[5];
@@ -79,6 +101,10 @@ public final class MessageLevels
         return states;
     }
 
+    /**
+     * @param messageLevel the message leve.
+     * @return The label.
+     */
     public static String getLevelLabel( int messageLevel )
     {
         if ( messageLevel > -1 && LEVEL_NAMES.size() > messageLevel )
index 79dae34..3856e21 100644 (file)
@@ -20,17 +20,36 @@ package org.apache.maven.shared.io.logging;
  */
 
 
+/**
+ * Message Sink interface.
+ *
+ */
 public interface MessageSink
 {
 
+    /**
+     * @param message The message.
+     */
     void debug( String message );
 
+    /**
+     * @param message The message.
+     */
     void info( String message );
 
+    /**
+     * @param message The message.
+     */
     void warning( String message );
 
+    /**
+     * @param message The message.
+     */
     void error( String message );
 
+    /**
+     * @param message The message.
+     */
     void severe( String message );
 
 }
index a9ebdbd..495c794 100644 (file)
@@ -22,7 +22,7 @@ package org.apache.maven.shared.io.logging;
 import org.codehaus.plexus.logging.Logger;
 
 /**
- * 
+ * The plexus logger sing implementation.
  */
 public class PlexusLoggerSink
     implements MessageSink
@@ -30,31 +30,39 @@ public class PlexusLoggerSink
 
     private final Logger logger;
 
+    /**
+     * @param logger The logger.
+     */
     public PlexusLoggerSink( Logger logger )
     {
         this.logger = logger;
     }
 
+    /** {@inheritDoc} */
     public void debug( String message )
     {
         logger.debug( message );
     }
 
+    /** {@inheritDoc} */
     public void error( String message )
     {
         logger.error( message );
     }
 
+    /** {@inheritDoc} */
     public void info( String message )
     {
         logger.info( message );
     }
 
+    /** {@inheritDoc} */
     public void severe( String message )
     {
         logger.fatalError( message );
     }
 
+    /** {@inheritDoc} */
     public void warning( String message )
     {
         logger.warn( message );