Fix checkstyle issues reported by odlparent-3.0.0's checkstyle

[yangtools.git] / yang / yang-common / src / main / java / org / opendaylight / yangtools / yang / common / RpcResultBuilder.java

diff --git a/yang/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/RpcResultBuilder.java b/yang/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/RpcResultBuilder.java
index c063366a476945a068e3795718712085d8c0aa04..7b877ecb2ee315c500f8a935f9f77cc032b9723f 100644 (file)
--- a/yang/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/RpcResultBuilder.java
+++ b/yang/yang-common/src/main/java/org/opendaylight/yangtools/yang/common/RpcResultBuilder.java
@@ -11,11 +11,9 @@ package org.opendaylight.yangtools.yang.common;
 import com.google.common.collect.ImmutableList;
 import com.google.common.util.concurrent.Futures;
 import com.google.common.util.concurrent.ListenableFuture;
-
 import java.io.Serializable;
 import java.util.Collection;
 import java.util.Collections;
-
 import org.opendaylight.yangtools.concepts.Builder;
 import org.opendaylight.yangtools.yang.common.RpcError.ErrorSeverity;
 import org.opendaylight.yangtools.yang.common.RpcError.ErrorType;
@@ -36,8 +34,8 @@ public final class RpcResultBuilder<T> implements Builder<RpcResult<T>> {
         private final T result;
         private final boolean successful;
 
-        RpcResultImpl( final boolean successful, final T result,
-                       final Collection<RpcError> errors ) {
+        RpcResultImpl(final boolean successful, final T result,
+                       final Collection<RpcError> errors) {
             this.successful = successful;
             this.result = result;
             this.errors = errors;
@@ -59,7 +57,7 @@ public final class RpcResultBuilder<T> implements Builder<RpcResult<T>> {
         }
 
         @Override
-        public String toString(){
+        public String toString() {
             return "RpcResult [successful=" + successful + ", result="
                     + result + ", errors=" + errors + "]";
         }
@@ -76,9 +74,9 @@ public final class RpcResultBuilder<T> implements Builder<RpcResult<T>> {
         private final ErrorType errorType;
         private final Throwable cause;
 
-        RpcErrorImpl( final ErrorSeverity severity, final ErrorType errorType,
+        RpcErrorImpl(final ErrorSeverity severity, final ErrorType errorType,
                 final String tag, final String message, final String applicationTag, final String info,
-                final Throwable cause ) {
+                final Throwable cause) {
             this.severity = severity;
             this.errorType = errorType;
             this.tag = tag;
@@ -109,7 +107,7 @@ public final class RpcResultBuilder<T> implements Builder<RpcResult<T>> {
         }
 
         @Override
-        public String getMessage(){
+        public String getMessage() {
             return message;
         }
 
@@ -124,7 +122,7 @@ public final class RpcResultBuilder<T> implements Builder<RpcResult<T>> {
         }
 
         @Override
-        public String toString(){
+        public String toString() {
             return "RpcError [message=" + message + ", severity="
                     + severity + ", errorType=" + errorType + ", tag=" + tag
                     + ", applicationTag=" + applicationTag + ", info=" + info
@@ -136,7 +134,7 @@ public final class RpcResultBuilder<T> implements Builder<RpcResult<T>> {
     private T result;
     private final boolean successful;
 
-    private RpcResultBuilder( final boolean successful, final T result ) {
+    private RpcResultBuilder(final boolean successful, final T result) {
         this.successful = successful;
         this.result = result;
     }
@@ -145,7 +143,7 @@ public final class RpcResultBuilder<T> implements Builder<RpcResult<T>> {
      * Returns a builder for a successful result.
      */
     public static <T> RpcResultBuilder<T> success() {
-        return new RpcResultBuilder<T>( true, null );
+        return new RpcResultBuilder<>(true, null);
     }
 
     /**
@@ -153,8 +151,8 @@ public final class RpcResultBuilder<T> implements Builder<RpcResult<T>> {
      *
      * @param result the result value
      */
-    public static <T> RpcResultBuilder<T> success( final T result ) {
-         return new RpcResultBuilder<T>( true, result );
+    public static <T> RpcResultBuilder<T> success(final T result) {
+        return new RpcResultBuilder<>(true, result);
     }
 
     /**
@@ -162,7 +160,7 @@ public final class RpcResultBuilder<T> implements Builder<RpcResult<T>> {
      *
      * @param builder builder for the result value
      */
-    public static <T> RpcResultBuilder<T> success( final Builder<T> builder ) {
+    public static <T> RpcResultBuilder<T> success(final Builder<T> builder) {
         return success(builder.build());
     }
 
@@ -170,7 +168,7 @@ public final class RpcResultBuilder<T> implements Builder<RpcResult<T>> {
      * Returns a builder for a failed result.
      */
     public static <T> RpcResultBuilder<T> failed() {
-        return new RpcResultBuilder<T>( false, null );
+        return new RpcResultBuilder<>(false, null);
     }
 
     /**
@@ -178,8 +176,8 @@ public final class RpcResultBuilder<T> implements Builder<RpcResult<T>> {
      *
      * @param success true if successful, false otherwise.
      */
-    public static <T> RpcResultBuilder<T> status( final boolean success ) {
-        return new RpcResultBuilder<T>( success, null );
+    public static <T> RpcResultBuilder<T> status(final boolean success) {
+        return new RpcResultBuilder<>(success, null);
     }
 
     /**
@@ -187,9 +185,9 @@ public final class RpcResultBuilder<T> implements Builder<RpcResult<T>> {
      *
      * @param other the other RpcResult.
      */
-    public static <T> RpcResultBuilder<T> from( final RpcResult<T> other ) {
-        return new RpcResultBuilder<T>( other.isSuccessful(), other.getResult() )
-                                                      .withRpcErrors( other.getErrors() );
+    public static <T> RpcResultBuilder<T> from(final RpcResult<T> other) {
+        return new RpcResultBuilder<>(other.isSuccessful(), other.getResult())
+                                                      .withRpcErrors(other.getErrors());
     }
 
     /**
@@ -202,9 +200,9 @@ public final class RpcResultBuilder<T> implements Builder<RpcResult<T>> {
      *
      * @return an RpcError
      */
-    public static RpcError newError( final ErrorType errorType, final String tag, final String message ) {
-        return new RpcErrorImpl( ErrorSeverity.ERROR, errorType,
-                tag != null ? tag : "operation-failed", message, null, null, null );
+    public static RpcError newError(final ErrorType errorType, final String tag, final String message) {
+        return new RpcErrorImpl(ErrorSeverity.ERROR, errorType,
+                tag != null ? tag : "operation-failed", message, null, null, null);
     }
 
     /**
@@ -214,17 +212,17 @@ public final class RpcResultBuilder<T> implements Builder<RpcResult<T>> {
      * @param tag a short string that identifies the general type of error condition. See
      *        {@link RpcError#getTag} for a list of suggested values.
      * @param message a string suitable for human display that describes the error condition.
-     * * @param applicationTag a short string that identifies the specific type of error condition.
+     * @param applicationTag a short string that identifies the specific type of error condition.
      * @param info a string containing additional information to provide extended
      *        and/or implementation-specific debugging information.
      * @param cause the exception that triggered the error.
      *
      * @return an RpcError
      */
-    public static RpcError newError(  final ErrorType errorType, final String tag, final String message,
-            final String applicationTag, final String info, final Throwable cause ) {
-        return new RpcErrorImpl( ErrorSeverity.ERROR, errorType,
-                tag != null ? tag : "operation-failed", message, applicationTag, info, cause );
+    public static RpcError newError(final ErrorType errorType, final String tag, final String message,
+            final String applicationTag, final String info, final Throwable cause) {
+        return new RpcErrorImpl(ErrorSeverity.ERROR, errorType,
+                tag != null ? tag : "operation-failed", message, applicationTag, info, cause);
     }
 
     /**
@@ -237,8 +235,8 @@ public final class RpcResultBuilder<T> implements Builder<RpcResult<T>> {
      *
      * @return an RpcError
      */
-    public static RpcError newWarning( final ErrorType errorType, final String tag, final String message ) {
-        return new RpcErrorImpl( ErrorSeverity.WARNING, errorType, tag, message, null, null, null );
+    public static RpcError newWarning(final ErrorType errorType, final String tag, final String message) {
+        return new RpcErrorImpl(ErrorSeverity.WARNING, errorType, tag, message, null, null, null);
     }
 
     /**
@@ -248,17 +246,17 @@ public final class RpcResultBuilder<T> implements Builder<RpcResult<T>> {
      * @param tag a short string that identifies the general type of warning condition. See
      *        {@link RpcError#getTag} for a list of suggested values.
      * @param message a string suitable for human display that describes the warning condition.
-     * * @param applicationTag a short string that identifies the specific type of warning condition.
+     * @param applicationTag a short string that identifies the specific type of warning condition.
      * @param info a string containing additional information to provide extended
      *        and/or implementation-specific debugging information.
      * @param cause the exception that triggered the warning.
      *
      * @return an RpcError
      */
-    public static RpcError newWarning(  final ErrorType errorType, final String tag, final String message,
-            final String applicationTag, final String info, final Throwable cause ) {
-        return new RpcErrorImpl( ErrorSeverity.WARNING, errorType, tag, message,
-                                 applicationTag, info, cause );
+    public static RpcError newWarning(final ErrorType errorType, final String tag, final String message,
+            final String applicationTag, final String info, final Throwable cause) {
+        return new RpcErrorImpl(ErrorSeverity.WARNING, errorType, tag, message,
+                                 applicationTag, info, cause);
     }
 
     /**
@@ -266,7 +264,8 @@ public final class RpcResultBuilder<T> implements Builder<RpcResult<T>> {
      *
      * @param result the result value
      */
-    public RpcResultBuilder<T> withResult( final T result ) {
+    @SuppressWarnings("checkstyle:hiddenField")
+    public RpcResultBuilder<T> withResult(final T result) {
         this.result = result;
         return this;
     }
@@ -276,26 +275,26 @@ public final class RpcResultBuilder<T> implements Builder<RpcResult<T>> {
      *
      * @param builder builder for the result value
      */
-    public RpcResultBuilder<T> withResult( final Builder<T> builder ) {
+    public RpcResultBuilder<T> withResult(final Builder<T> builder) {
         return withResult(builder.build());
     }
 
-    private void addError( final ErrorSeverity severity, final ErrorType errorType,
+    private void addError(final ErrorSeverity severity, final ErrorType errorType,
             final String tag, final String message, final String applicationTag, final String info,
-            final Throwable cause ) {
+            final Throwable cause) {
 
-        addError( new RpcErrorImpl( severity, errorType,
+        addError(new RpcErrorImpl(severity, errorType,
                                     tag != null ? tag : "operation-failed", message,
-                                    applicationTag, info, cause ) );
+                                    applicationTag, info, cause));
     }
 
-    private void addError( final RpcError error ) {
+    private void addError(final RpcError error) {
 
-        if( errors == null ) {
-            errors = new ImmutableList.Builder<RpcError>();
+        if (errors == null) {
+            errors = new ImmutableList.Builder<>();
         }
 
-        errors.add( error );
+        errors.add(error);
     }
 
     /**
@@ -306,8 +305,8 @@ public final class RpcResultBuilder<T> implements Builder<RpcResult<T>> {
      *        {@link RpcError#getTag} for a list of suggested values.
      * @param message a string suitable for human display that describes the warning condition.
      */
-    public RpcResultBuilder<T> withWarning( final ErrorType errorType, final String tag, final String message ) {
-        addError( ErrorSeverity.WARNING, errorType, tag, message, null, null, null );
+    public RpcResultBuilder<T> withWarning(final ErrorType errorType, final String tag, final String message) {
+        addError(ErrorSeverity.WARNING, errorType, tag, message, null, null, null);
         return this;
     }
 
@@ -323,9 +322,9 @@ public final class RpcResultBuilder<T> implements Builder<RpcResult<T>> {
      *        and/or implementation-specific debugging information.
      * @param cause the exception that triggered the warning.
      */
-    public RpcResultBuilder<T> withWarning( final ErrorType errorType, final String tag, final String message,
-            final String applicationTag, final String info, final Throwable cause ) {
-        addError( ErrorSeverity.WARNING, errorType, tag, message, applicationTag, info, cause );
+    public RpcResultBuilder<T> withWarning(final ErrorType errorType, final String tag, final String message,
+            final String applicationTag, final String info, final Throwable cause) {
+        addError(ErrorSeverity.WARNING, errorType, tag, message, applicationTag, info, cause);
         return this;
     }
 
@@ -335,8 +334,8 @@ public final class RpcResultBuilder<T> implements Builder<RpcResult<T>> {
      * @param errorType the conceptual layer at which the error occurred.
      * @param message a string suitable for human display that describes the error condition.
      */
-    public RpcResultBuilder<T> withError( final ErrorType errorType, final String message ) {
-        addError( ErrorSeverity.ERROR, errorType, null, message, null, null, null );
+    public RpcResultBuilder<T> withError(final ErrorType errorType, final String message) {
+        addError(ErrorSeverity.ERROR, errorType, null, message, null, null, null);
         return this;
     }
 
@@ -348,8 +347,8 @@ public final class RpcResultBuilder<T> implements Builder<RpcResult<T>> {
      *        {@link RpcError#getTag} for a list of suggested values.
      * @param message a string suitable for human display that describes the error condition.
      */
-    public RpcResultBuilder<T> withError( final ErrorType errorType, final String tag, final String message ) {
-        addError( ErrorSeverity.ERROR, errorType, tag, message, null, null, null );
+    public RpcResultBuilder<T> withError(final ErrorType errorType, final String tag, final String message) {
+        addError(ErrorSeverity.ERROR, errorType, tag, message, null, null, null);
         return this;
     }
 
@@ -360,9 +359,9 @@ public final class RpcResultBuilder<T> implements Builder<RpcResult<T>> {
      * @param message a string suitable for human display that describes the error condition.
      * @param cause the exception that triggered the error.
      */
-    public RpcResultBuilder<T> withError( final ErrorType errorType, final String message,
-                                          final Throwable cause ) {
-        addError( ErrorSeverity.ERROR, errorType, null, message, null, null, cause );
+    public RpcResultBuilder<T> withError(final ErrorType errorType, final String message,
+                                          final Throwable cause) {
+        addError(ErrorSeverity.ERROR, errorType, null, message, null, null, cause);
         return this;
     }
 
@@ -378,9 +377,9 @@ public final class RpcResultBuilder<T> implements Builder<RpcResult<T>> {
      *        and/or implementation-specific debugging information.
      * @param cause the exception that triggered the error.
      */
-    public RpcResultBuilder<T> withError( final ErrorType errorType, final String tag, final String message,
-            final String applicationTag, final String info, final Throwable cause ) {
-        addError( ErrorSeverity.ERROR, errorType, tag, message, applicationTag, info, cause );
+    public RpcResultBuilder<T> withError(final ErrorType errorType, final String tag, final String message,
+            final String applicationTag, final String info, final Throwable cause) {
+        addError(ErrorSeverity.ERROR, errorType, tag, message, applicationTag, info, cause);
         return this;
     }
 
@@ -389,20 +388,20 @@ public final class RpcResultBuilder<T> implements Builder<RpcResult<T>> {
      *
      * @param error the RpcError
      */
-    public RpcResultBuilder<T> withRpcError( final RpcError error ) {
-        addError( error );
+    public RpcResultBuilder<T> withRpcError(final RpcError error) {
+        addError(error);
         return this;
     }
 
     /**
      * Adds RpcErrors.
      *
-     * @param errors the list of RpcErrors
+     * @param rpcErrors the list of RpcErrors
      */
-    public RpcResultBuilder<T> withRpcErrors( final Collection<RpcError> errors ) {
-        if( errors != null ) {
-            for( RpcError error: errors ) {
-                addError( error );
+    public RpcResultBuilder<T> withRpcErrors(final Collection<RpcError> rpcErrors) {
+        if (rpcErrors != null) {
+            for (RpcError error : rpcErrors) {
+                addError(error);
             }
         }
         return this;
@@ -411,21 +410,20 @@ public final class RpcResultBuilder<T> implements Builder<RpcResult<T>> {
     @Override
     public RpcResult<T> build() {
 
-        return new RpcResultImpl<T>( successful, result,
-                errors != null ? errors.build() : Collections.<RpcError>emptyList() );
+        return new RpcResultImpl<>(successful, result,
+                errors != null ? errors.build() : Collections.emptyList());
     }
 
     /**
      * Builds RpcResult and wraps it in a Future
      *
+     * <p>
      * This is a convenience method to assist those writing rpcs
      * that produce immediate results.  It allows you to replace
      *
-     * Futures.immediateFuture(rpcResult.build())
-     *
+     * {@code Futures.immediateFuture(rpcResult.build())}
      * with
-     *
-     * rpcResult.buildFuture();
+     * {@code rpcResult.buildFuture();}
      *
      * @return Future for RpcResult built by RpcResultBuilder
      *