org.opendaylight.yangtools.yang.common

Class RpcResultBuilder<T>

java.lang.Object

org.opendaylight.yangtools.yang.common.RpcResultBuilder<T>

Type Parameters:

T - the result value type

All Implemented Interfaces:

Builder<RpcResult<T>>, Mutable, MutationBehaviour<Mutable>

public final class RpcResultBuilder<T>
extends Object
implements Builder<RpcResult<T>>

A builder for creating RpcResult instances.

Author:

Thomas Pantelis

Method Summary

Modifier and Type	Method and Description
RpcResult<T>	build() Returns instance of the product.
com.google.common.util.concurrent.ListenableFuture<RpcResult<T>>	buildFuture() Builds RpcResult and wraps it in a Future This is a convenience method to assist those writing rpcs that produce immediate results.
static <T> RpcResultBuilder<T>	failed() Returns a builder for a failed result.
static <T> RpcResultBuilder<T>	from(RpcResult<T> other) Returns a builder from another RpcResult.
static RpcError	newError(RpcError.ErrorType errorType, String tag, String message) Creates an RpcError with severity ERROR for reuse.
static RpcError	newError(RpcError.ErrorType errorType, String tag, String message, String applicationTag, String info, Throwable cause) Creates an RpcError with severity ERROR for reuse.
static RpcError	newWarning(RpcError.ErrorType errorType, String tag, String message) Creates an RpcError with severity WARNING for reuse.
static RpcError	newWarning(RpcError.ErrorType errorType, String tag, String message, String applicationTag, String info, Throwable cause) Creates an RpcError with severity WARNING for reuse.
static <T> RpcResultBuilder<T>	status(boolean success) Returns a builder based on the given status.
static <T> RpcResultBuilder<T>	success() Returns a builder for a successful result.
static <T> RpcResultBuilder<T>	success(Builder<T> builder) Returns a builder for a successful result.
static <T> RpcResultBuilder<T>	success(T result) Returns a builder for a successful result.
RpcResultBuilder<T>	withError(RpcError.ErrorType errorType, String message) Adds an error to the result.
RpcResultBuilder<T>	withError(RpcError.ErrorType errorType, String tag, String message) Adds an error to the result.
RpcResultBuilder<T>	withError(RpcError.ErrorType errorType, String tag, String message, String applicationTag, String info, Throwable cause) Adds an error to the result.
RpcResultBuilder<T>	withError(RpcError.ErrorType errorType, String message, Throwable cause) Adds an error to the result.
RpcResultBuilder<T>	withResult(Builder<T> builder) Sets the value of the result.
RpcResultBuilder<T>	withResult(T result) Sets the value of the result.
RpcResultBuilder<T>	withRpcError(RpcError error) Adds an RpcError.
RpcResultBuilder<T>	withRpcErrors(Collection<RpcError> errors) Adds RpcErrors.
RpcResultBuilder<T>	withWarning(RpcError.ErrorType errorType, String tag, String message) Adds a warning to the result.
RpcResultBuilder<T>	withWarning(RpcError.ErrorType errorType, String tag, String message, String applicationTag, String info, Throwable cause) Adds a warning to the result.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

success

public static <T> RpcResultBuilder<T> success()

Returns a builder for a successful result.

success

public static <T> RpcResultBuilder<T> success(T result)

Returns a builder for a successful result.

Parameters:

result - the result value

success

public static <T> RpcResultBuilder<T> success(Builder<T> builder)

Returns a builder for a successful result.

Parameters:

builder - builder for the result value

failed

public static <T> RpcResultBuilder<T> failed()

Returns a builder for a failed result.

status

public static <T> RpcResultBuilder<T> status(boolean success)

Returns a builder based on the given status.

Parameters:

success - true if successful, false otherwise.

from

public static <T> RpcResultBuilder<T> from(RpcResult<T> other)

Returns a builder from another RpcResult.

Parameters:

other - the other RpcResult.

newError

public static RpcError newError(RpcError.ErrorType errorType,
                                String tag,
                                String message)

Creates an RpcError with severity ERROR for reuse.

Parameters:

errorType - the conceptual layer at which the error occurred.

tag - a short string that identifies the general type of error condition. See RpcError.getTag() for a list of suggested values.

message - a string suitable for human display that describes the error condition.

Returns:

an RpcError

newError

public static RpcError newError(RpcError.ErrorType errorType,
                                String tag,
                                String message,
                                String applicationTag,
                                String info,
                                Throwable cause)

Creates an RpcError with severity ERROR for reuse.

Parameters:

errorType - the conceptual layer at which the error occurred.

tag - a short string that identifies the general type of error condition. See RpcError.getTag() for a list of suggested values.

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.

info - a string containing additional information to provide extended and/or implementation-specific debugging information.

cause - the exception that triggered the error.

Returns:

an RpcError

newWarning

public static RpcError newWarning(RpcError.ErrorType errorType,
                                  String tag,
                                  String message)

Creates an RpcError with severity WARNING for reuse.

Parameters:

errorType - the conceptual layer at which the warning occurred.

tag - a short string that identifies the general type of warning condition. See RpcError.getTag() for a list of suggested values.

message - a string suitable for human display that describes the warning condition.

Returns:

an RpcError

newWarning

public static RpcError newWarning(RpcError.ErrorType errorType,
                                  String tag,
                                  String message,
                                  String applicationTag,
                                  String info,
                                  Throwable cause)

Creates an RpcError with severity WARNING for reuse.

Parameters:

errorType - the conceptual layer at which the warning occurred.

tag - a short string that identifies the general type of warning condition. See RpcError.getTag() for a list of suggested values.

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.

info - a string containing additional information to provide extended and/or implementation-specific debugging information.

cause - the exception that triggered the warning.

Returns:

an RpcError

withResult

public RpcResultBuilder<T> withResult(T result)

Sets the value of the result.

Parameters:

result - the result value

withResult

public RpcResultBuilder<T> withResult(Builder<T> builder)

Sets the value of the result.

Parameters:

builder - builder for the result value

withWarning

public RpcResultBuilder<T> withWarning(RpcError.ErrorType errorType,
                                       String tag,
                                       String message)

Adds a warning to the result.

Parameters:

errorType - the conceptual layer at which the warning occurred.

tag - a short string that identifies the general type of warning condition. See RpcError.getTag() for a list of suggested values.

message - a string suitable for human display that describes the warning condition.

withWarning

public RpcResultBuilder<T> withWarning(RpcError.ErrorType errorType,
                                       String tag,
                                       String message,
                                       String applicationTag,
                                       String info,
                                       Throwable cause)

Adds a warning to the result.

Parameters:

errorType - the conceptual layer at which the warning occurred.

tag - a short string that identifies the general type of warning condition. See RpcError.getTag() for a list of suggested values.

message - a string suitable for human display that describes the warning condition.

applicationTag - a short string that identifies the specific type of warning condition.

info - a string containing additional information to provide extended and/or implementation-specific debugging information.

cause - the exception that triggered the warning.

withError

public RpcResultBuilder<T> withError(RpcError.ErrorType errorType,
                                     String message)

Adds an error to the result. The general error tag defaults to "operation-failed".

Parameters:

errorType - the conceptual layer at which the error occurred.

message - a string suitable for human display that describes the error condition.

withError

public RpcResultBuilder<T> withError(RpcError.ErrorType errorType,
                                     String tag,
                                     String message)

Adds an error to the result.

Parameters:

errorType - the conceptual layer at which the error occurred.

tag - a short string that identifies the general type of error condition. See RpcError.getTag() for a list of suggested values.

message - a string suitable for human display that describes the error condition.

withError

public RpcResultBuilder<T> withError(RpcError.ErrorType errorType,
                                     String message,
                                     Throwable cause)

Adds an error to the result. The general error tag defaults to "operation-failed".

Parameters:

errorType - the conceptual layer at which the error occurred.

message - a string suitable for human display that describes the error condition.

cause - the exception that triggered the error.

withError

public RpcResultBuilder<T> withError(RpcError.ErrorType errorType,
                                     String tag,
                                     String message,
                                     String applicationTag,
                                     String info,
                                     Throwable cause)

Adds an error to the result.

Parameters:

errorType - the conceptual layer at which the error occurred.

tag - a short string that identifies the general type of error condition. See RpcError.getTag() for a list of suggested values.

message - a string suitable for human display that describes the error condition.

applicationTag - a short string that identifies the specific type of error condition.

info - a string containing additional information to provide extended and/or implementation-specific debugging information.

cause - the exception that triggered the error.

withRpcError

public RpcResultBuilder<T> withRpcError(RpcError error)

Adds an RpcError.

Parameters:

error - the RpcError

withRpcErrors

public RpcResultBuilder<T> withRpcErrors(Collection<RpcError> errors)

Adds RpcErrors.

Parameters:

errors - the list of RpcErrors

build

public RpcResult<T> build()

Description copied from interface: Builder

Returns instance of the product. Multiple calls to this method are not required to return same instance if the state of the builder has changed.

Specified by:

build in interface Builder<RpcResult<T>>

Returns:

Newly-built instance

buildFuture

public com.google.common.util.concurrent.ListenableFuture<RpcResult<T>> buildFuture()

Builds RpcResult and wraps it in a Future This is a convenience method to assist those writing rpcs that produce immediate results. It allows you to replace Futures.immediateFuture(rpcResult.build()) with rpcResult.buildFuture();

Returns:

Future for RpcResult built by RpcResultBuilder