com.phloc.commons.mutable

Class Wrapper<DATATYPE>

java.lang.Object

com.phloc.commons.mutable.Wrapper<DATATYPE>

Type Parameters:

DATATYPE - The type of object to be wrapped.

All Implemented Interfaces:

ICloneable<Wrapper<DATATYPE>>, IReadonlyWrapper<DATATYPE>, IWrapper<DATATYPE>

@NotThreadSafe
public class Wrapper<DATATYPE>
extends Object
implements IWrapper<DATATYPE>, ICloneable<Wrapper<DATATYPE>>

This is a stupid wrapper around any object. Its original purpose was the encapsulation of return values from within an anonymous class.

Author:

Philip

Constructor Summary

Constructors

Constructor and Description
Wrapper() Default constructor.
Wrapper(DATATYPE aObj) Constructor with an existing object.
Wrapper(IReadonlyWrapper<DATATYPE> aRhs) Copy constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static <DATATYPE> Wrapper<DATATYPE>	create(DATATYPE aObj) Static factory method with automatic type deduction.
boolean	equals(Object o)
DATATYPE	get()
Wrapper<DATATYPE>	getClone()
int	hashCode()
boolean	isSet()
EChange	set(DATATYPE aObj) Change the wrapped object.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Wrapper

public Wrapper()

Default constructor.

Wrapper

public Wrapper(@Nullable
       DATATYPE aObj)

Constructor with an existing object.

Parameters:

aObj - The existing object. May be null.

Wrapper

public Wrapper(@Nonnull
       IReadonlyWrapper<DATATYPE> aRhs)

Copy constructor. Only takes wrappers of the same type.

Parameters:

aRhs - The other wrapper to use. May not be null.

Method Detail

get

@Nullable
public DATATYPE get()

Specified by:

get in interface IReadonlyWrapper<DATATYPE>

Returns:

The currently wrapped object. May be null.

isSet

public boolean isSet()

Specified by:

isSet in interface IReadonlyWrapper<DATATYPE>

Returns:

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

set

@Nonnull
public EChange set(@Nullable
                  DATATYPE aObj)

Description copied from interface: IWrapper

Change the wrapped object.

Specified by:

set in interface IWrapper<DATATYPE>

Parameters:

aObj - The new object to be wrapped. May be null.

Returns:

EChange

getClone

@Nonnull
@ReturnsMutableCopy
public Wrapper<DATATYPE> getClone()

Specified by:

getClone in interface ICloneable<Wrapper<DATATYPE>>

Returns:

A 100% deep-copy of the implementing class.

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> Wrapper<DATATYPE> create(@Nullable
                                          DATATYPE aObj)

Static factory method with automatic type deduction.

Type Parameters:

DATATYPE - The type to be wrapped.

Parameters:

aObj - The object to be wrapped.

Returns:

The wrapped object.