org.pepstock.charba.client.commons

Class ImmutableEnvelop<T>

java.lang.Object

org.pepstock.charba.client.commons.ImmutableEnvelop<T>

Type Parameters:

T - type of envelop content.

All Implemented Interfaces:

Envelop

Direct Known Subclasses:

AnnotationEnvelop, BaseEnvelop, CallbacksEnvelop, ConfigurationEnvelop, DataEnvelop, DataLabelsEnvelop, ItemsEnvelop, LabelsEnvelop, OptionsEnvelop, PluginsEnvelop

public abstract class ImmutableEnvelop<T>
extends Object
implements Envelop

This object is a container of hidden object which can set by constructor and immutable afterwards.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ImmutableEnvelop(T content) Create an envelop with the content passed as argument.
protected	ImmutableEnvelop(T content, boolean nullable) Create an envelop with the content passed as argument and a flag to set if the content can be nullable.

Method Summary

Modifier and Type	Method and Description
T	getContent() Returns the content of envelop.
boolean	hasContent() Returns true if the content of envelop is not null.
boolean	isNullable() Returns true if the content of envelop can be null.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pepstock.charba.client.commons.Envelop

checkAndGetIfValid, checkIfValid, isValid

Constructor Detail

ImmutableEnvelop

protected ImmutableEnvelop(T content)

Create an envelop with the content passed as argument.

Parameters:

content - content to set as initial value

ImmutableEnvelop

protected ImmutableEnvelop(T content,
                           boolean nullable)

Create an envelop with the content passed as argument and a flag to set if the content can be nullable.

Parameters:

content - content to set as initial value

nullable - if true, the content can be null

Method Detail

getContent

public final T getContent()

Returns the content of envelop.

Returns:

the content of envelop

hasContent

public final boolean hasContent()

Description copied from interface: Envelop

Returns true if the content of envelop is not null.

Specified by:

hasContent in interface Envelop

Returns:

true if the content of envelop is not null

isNullable

public final boolean isNullable()

Description copied from interface: Envelop

Returns true if the content of envelop can be null.

Specified by:

isNullable in interface Envelop

Returns:

true if the content of envelop can be null