com.helger.commons.state

Class SuccessWithValue<DATATYPE>

java.lang.Object

com.helger.commons.state.SuccessWithValue<DATATYPE>

Type Parameters:

DATATYPE - The data type that is wrapped together with the success indicator

All Implemented Interfaces:

ISuccessIndicator, IWrapper<DATATYPE>

@Immutable
public class SuccessWithValue<DATATYPE>
extends Object
implements ISuccessIndicator, IWrapper<DATATYPE>

Wraps a success indicator and an arbitrary value.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor and Description
SuccessWithValue(ISuccessIndicator aSuccessIndicator) Constructor
SuccessWithValue(ISuccessIndicator aSuccessIndicator, DATATYPE aObj) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
static <DATATYPE> SuccessWithValue<DATATYPE>	create(ISuccessIndicator aSuccessIndicator, DATATYPE aValue) Create a new object with the given value.
static <DATATYPE> SuccessWithValue<DATATYPE>	createFailure(DATATYPE aValue) Create a new failure object with the given value.
static <DATATYPE> SuccessWithValue<DATATYPE>	createSuccess(DATATYPE aValue) Create a new success object with the given value.
boolean	equals(Object o)
DATATYPE	get()
DATATYPE	getIfFailure(DATATYPE aSuccessValue) Get the store value if this is a failure.
DATATYPE	getIfFailureOrNull() Get the store value if this is a failure.
DATATYPE	getIfSuccess(DATATYPE aFailureValue) Get the store value if this is a success.
DATATYPE	getIfSuccessOrNull() Get the store value if this is a success.
int	hashCode()
boolean	isFailure()
boolean	isSet()
boolean	isSuccess()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SuccessWithValue

public SuccessWithValue(@Nonnull
                ISuccessIndicator aSuccessIndicator)

Constructor

Parameters:

aSuccessIndicator - The success indicator. May not be null.

SuccessWithValue

public SuccessWithValue(@Nonnull
                ISuccessIndicator aSuccessIndicator,
                @Nullable
                DATATYPE aObj)

Constructor

Parameters:

aSuccessIndicator - The success indicator. May not be null.

aObj - The assigned value. May be null.

Method Detail

isSuccess

public boolean isSuccess()

Specified by:

isSuccess in interface ISuccessIndicator

Returns:

true on success and false on failure.

isFailure

public boolean isFailure()

Specified by:

isFailure in interface ISuccessIndicator

Returns:

true on failure and false on success.

get

@Nullable
public DATATYPE get()

Specified by:

get in interface IWrapper<DATATYPE>

Returns:

The currently wrapped object. May be null.

isSet

public boolean isSet()

Specified by:

isSet in interface IWrapper<DATATYPE>

Returns:

true if the contained value is not null, false if it is null.

getIfSuccess

@Nullable
public DATATYPE getIfSuccess(@Nullable
                             DATATYPE aFailureValue)

Get the store value if this is a success. Otherwise the passed failure value is returned.

Parameters:

aFailureValue - The failure value to be used. May be null.

Returns:

Either the stored value or the failure value. May be null.

getIfSuccessOrNull

@Nullable
public DATATYPE getIfSuccessOrNull()

Get the store value if this is a success. Otherwise null is returned.

Returns:

Either the stored value or null.

getIfFailure

@Nullable
public DATATYPE getIfFailure(@Nullable
                             DATATYPE aSuccessValue)

Get the store value if this is a failure. Otherwise the passed success value is returned.

Parameters:

aSuccessValue - The failure value to be used. May be null.

Returns:

Either the stored value or the failure value. May be null.

getIfFailureOrNull

@Nullable
public DATATYPE getIfFailureOrNull()

Get the store value if this is a failure. Otherwise null is returned.

Returns:

Either the stored value or null.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

create

@Nonnull
public static <DATATYPE> SuccessWithValue<DATATYPE> create(@Nonnull
                                                   ISuccessIndicator aSuccessIndicator,
                                                   @Nullable
                                                   DATATYPE aValue)

Create a new object with the given value.

Type Parameters:

DATATYPE - The data type that is wrapped together with the success indicator

Parameters:

aSuccessIndicator - The success indicator. May not be null.

aValue - The value to be used. May be null.

Returns:

Never null.

createSuccess

@Nonnull
public static <DATATYPE> SuccessWithValue<DATATYPE> createSuccess(@Nullable
                                                          DATATYPE aValue)

Create a new success object with the given value.

Type Parameters:

DATATYPE - The data type that is wrapped together with the success indicator

Parameters:

aValue - The value to be used. May be null.

Returns:

Never null.

createFailure

@Nonnull
public static <DATATYPE> SuccessWithValue<DATATYPE> createFailure(@Nullable
                                                          DATATYPE aValue)

Create a new failure object with the given value.

Type Parameters:

DATATYPE - The data type that is wrapped together with the success indicator

Parameters:

aValue - The value to be used. May be null.

Returns:

Never null.