Author: elecharny
Date: Fri Nov 18 17:39:20 2016
New Revision: 1770417
URL: http://svn.apache.org/viewvc?rev=1770417&view=rev
Log:
o Added some missing Javadoc
o Fixed some SonarQube warnings
Modified:
directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/exception/Exceptions.java
directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/exception/InvalidCharacterException.java
directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/exception/MultiException.java
directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/exception/NotImplementedException.java
directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/exception/RuntimeMultiException.java
Modified: directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/exception/Exceptions.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/exception/Exceptions.java?rev=1770417&r1=1770416&r2=1770417&view=diff
==============================================================================
--- directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/exception/Exceptions.java
(original)
+++ directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/exception/Exceptions.java
Fri Nov 18 17:39:20 2016
@@ -24,10 +24,8 @@ import java.util.List;
/**
- * <p>
* Provides utilities for manipulating and examining <code>Throwable</code>
* objects.
- * </p>
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
Modified: directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/exception/InvalidCharacterException.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/exception/InvalidCharacterException.java?rev=1770417&r1=1770416&r2=1770417&view=diff
==============================================================================
--- directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/exception/InvalidCharacterException.java
(original)
+++ directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/exception/InvalidCharacterException.java
Fri Nov 18 17:39:20 2016
@@ -31,15 +31,22 @@ import org.apache.directory.api.i18n.I18
public class InvalidCharacterException extends IOException
{
private static final long serialVersionUID = 1L;
- private int input;
-
+ private final int input;
+ /**
+ * Creates a new instance of an InvalidCharacterException
+ *
+ * @param input The char that has caused the exception
+ */
public InvalidCharacterException( int input )
{
this.input = input;
}
+ /**
+ * {@inheritDoc}
+ */
@Override
public String getMessage()
{
Modified: directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/exception/MultiException.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/exception/MultiException.java?rev=1770417&r1=1770416&r2=1770417&view=diff
==============================================================================
--- directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/exception/MultiException.java
(original)
+++ directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/exception/MultiException.java
Fri Nov 18 17:39:20 2016
@@ -39,7 +39,7 @@ public class MultiException extends Exce
static final long serialVersionUID = 2889747406899775761L;
/** Collection of nested exceptions. */
- private Collection<Throwable> nestedExceptions = new ArrayList<>();
+ private final Collection<Throwable> nestedExceptions = new ArrayList<>();
/**
@@ -54,8 +54,7 @@ public class MultiException extends Exce
/**
* Constructs an Exception with a detailed message.
*
- * @param message
- * The message associated with the exception.
+ * @param message The message associated with the exception.
*/
public MultiException( String message )
{
@@ -99,10 +98,9 @@ public class MultiException extends Exce
/**
- * Add an exeception to this multiexception.
+ * Add an exception to this multiexception.
*
- * @param nested
- * exception to add to this MultiException.
+ * @param nested exception to add to this MultiException.
*/
public void addThrowable( Throwable nested )
{
@@ -118,8 +116,7 @@ public class MultiException extends Exce
* Beside printing out the standard stack trace this method prints out the
* stack traces of all the nested exceptions.
*
- * @param out
- * PrintWriter to write the nested stack trace to.
+ * @param out PrintWriter to write the nested stack trace to.
*/
@Override
public void printStackTrace( PrintWriter out )
@@ -151,8 +148,7 @@ public class MultiException extends Exce
* Beside printing out the standard stack trace this method prints out the
* stack traces of all the nested exceptions.
*
- * @param out
- * PrintStream to write the nested stack trace to.
+ * @param out PrintStream to write the nested stack trace to.
*/
@Override
public void printStackTrace( PrintStream out )
Modified: directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/exception/NotImplementedException.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/exception/NotImplementedException.java?rev=1770417&r1=1770416&r2=1770417&view=diff
==============================================================================
--- directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/exception/NotImplementedException.java
(original)
+++ directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/exception/NotImplementedException.java
Fri Nov 18 17:39:20 2016
@@ -47,8 +47,7 @@ public class NotImplementedException ext
/**
* Constructs an Exception with a detailed message.
*
- * @param msg
- * The message associated with the exception.
+ * @param msg The message associated with the exception.
*/
public NotImplementedException( String msg )
{
Modified: directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/exception/RuntimeMultiException.java
URL: http://svn.apache.org/viewvc/directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/exception/RuntimeMultiException.java?rev=1770417&r1=1770416&r2=1770417&view=diff
==============================================================================
--- directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/exception/RuntimeMultiException.java
(original)
+++ directory/shared/branches/shared-value/util/src/main/java/org/apache/directory/api/util/exception/RuntimeMultiException.java
Fri Nov 18 17:39:20 2016
@@ -39,7 +39,7 @@ public class RuntimeMultiException exten
private static final long serialVersionUID = 8582253398936366771L;
/** Collection of nested exceptions. */
- private Collection<Throwable> nestedExceptions = new ArrayList<>();
+ private final Collection<Throwable> nestedExceptions = new ArrayList<>();
/**
@@ -111,8 +111,7 @@ public class RuntimeMultiException exten
/**
* Add an exeception to this multiexception.
*
- * @param nested
- * exception to add to this MultiException.
+ * @param nested exception to add to this MultiException.
*/
public void addThrowable( Throwable nested )
{
@@ -128,8 +127,7 @@ public class RuntimeMultiException exten
* Beside printing out the standard stack trace this method prints out the
* stack traces of all the nested exceptions.
*
- * @param out
- * PrintWriter to write the nested stack trace to.
+ * @param out PrintWriter to write the nested stack trace to.
*/
@Override
public void printStackTrace( PrintWriter out )
@@ -161,8 +159,7 @@ public class RuntimeMultiException exten
* Beside printing out the standard stack trace this method prints out the
* stack traces of all the nested exceptions.
*
- * @param out
- * PrintStream to write the nested stack trace to.
+ * @param out PrintStream to write the nested stack trace to.
*/
@Override
public void printStackTrace( PrintStream out )
|