org.hawkular.inventory.api.model

Class StructuredData

java.lang.Object

org.hawkular.inventory.api.model.StructuredData

public final class StructuredData
extends Object

Represents structured data. This is used to store configuration, operation params, etc.

Instances of structured data are built using a builder pattern starting with the get() method.

Since:

0.3.0

Author:

Lukas Krejci

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StructuredData.AbstractListBuilder<This extends StructuredData.AbstractListBuilder<This>>
static class	StructuredData.AbstractListUpdater<This extends StructuredData.AbstractListUpdater<This>>
static class	StructuredData.AbstractMapBuilder<This extends StructuredData.AbstractMapBuilder<This>>
static class	StructuredData.Builder
static class	StructuredData.InnerListBuilder<Parent extends org.hawkular.inventory.api.model.StructuredData.AbstractHierarchyBuilder>
static class	StructuredData.InnerListUpdater<Parent extends org.hawkular.inventory.api.model.StructuredData.AbstractHierarchyBuilder>
static class	StructuredData.InnerMapBuilder<Parent extends org.hawkular.inventory.api.model.StructuredData.AbstractHierarchyBuilder>
static class	StructuredData.InnerMapUpdater<Parent extends org.hawkular.inventory.api.model.StructuredData.AbstractHierarchyBuilder>
static class	StructuredData.ListBuilder
static class	StructuredData.ListUpdater
static class	StructuredData.MapBuilder
static class	StructuredData.MapUpdater
static class	StructuredData.Type
static class	StructuredData.Updater
static interface	StructuredData.Visitor<R,P>

Method Summary

Modifier and Type	Method and Description
<R,P> R	accept(StructuredData.Visitor<R,P> visitor, P parameter)
boolean	bool()
boolean	equals(Object o)
double	floatingPoint()
static StructuredData.Builder	get()
StructuredData.Type	getType()
Serializable	getValue() Returns the value without much type information.
int	hashCode()
long	integral()
boolean	isUndefined()
List<StructuredData>	list()
Map<String,StructuredData>	map()
String	string()
String	toString()
StructuredData.Updater	update() This instance WILL NOT be modified, the updates will be present in the newly constructed instance.

Methods inherited from class java.lang.Object

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

Method Detail

get

public static StructuredData.Builder get()

getValue

public Serializable getValue()

Returns the value without much type information. If you need to specialize your behavior based on the type of the value, consider using accept(Visitor, Object) method.

Returns:

the value (possibly null for an undefined structured data)

isUndefined

public boolean isUndefined()

Returns:

true, if this data represents no value

accept

public <R,P> R accept(StructuredData.Visitor<R,P> visitor,
                      P parameter)

bool

public boolean bool()

Returns:

the value as a boolean

Throws:

NullPointerException - if the value is undefined

ClassCastException - if the value is not a boolean

integral

public long integral()

Returns:

the value as a long

Throws:

NullPointerException - if the value is undefined

ClassCastException - if the value is not integral

floatingPoint

public double floatingPoint()

Returns:

the value as a double

Throws:

NullPointerException - if the value is undefined

ClassCastException - if the value is not a floating point number

string

public String string()

Returns:

the value as a string

Throws:

NullPointerException - if the value is undefined

ClassCastException - if the value is not a string

list

public List<StructuredData> list()

Returns:

the value as a list

Throws:

NullPointerException - if the value is undefined

ClassCastException - if the value is not a list

map

public Map<String,StructuredData> map()

Returns:

the value as a list

Throws:

NullPointerException - if the value is undefined

ClassCastException - if the value is not a map

getType

public StructuredData.Type getType()

update

public StructuredData.Updater update()

This instance WILL NOT be modified, the updates will be present in the newly constructed instance.

Returns:

an updater object to create modification of the this instance

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