org.hawkular.inventory.api

Class EmptyInventory.DatasSingle

java.lang.Object

org.hawkular.inventory.api.EmptyInventory.DatasSingle

All Implemented Interfaces:

Data.Single, ResolvableToSingle<DataEntity,DataEntity.Update>

Enclosing class:

EmptyInventory

public static class EmptyInventory.DatasSingle
extends Object
implements Data.Single

Constructor Summary

Constructors

Constructor and Description
DatasSingle()

Method Summary

Modifier and Type	Method and Description
StructuredData	data(RelativePath dataPath) Returns the data on the path relative to the entity.
void	delete() Deletes the entity.
DataEntity	entity() Loads the data entity on the current position in the inventory traversal along with its data.
StructuredData	flatData(RelativePath dataPath) This is very similar to Data.Single.data(RelativePath) but this method doesn't load the child data.
void	update(DataEntity.Update update) Updates the entity.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hawkular.inventory.api.Data.Single

exists

Constructor Detail

DatasSingle

public DatasSingle()

Method Detail

flatData

public StructuredData flatData(RelativePath dataPath)

Description copied from interface: Data.Single

This is very similar to Data.Single.data(RelativePath) but this method doesn't load the child data.

If the data on the path contains a "primitive" value, the value is loaded. If the data contains a list, the returned instance will contain an empty list and if the data contains a map the returned instance will contain an empty map.

Specified by:

flatData in interface Data.Single

Parameters:

dataPath - the path to the subset of the data to return

Returns:

the subset of the data stored with the data entity

entity

public DataEntity entity()
                  throws EntityNotFoundException

Description copied from interface: Data.Single

Loads the data entity on the current position in the inventory traversal along with its data.

Note that this might be a potentially expensive operation because of the attached data structure being loaded.

Specified by:

entity in interface Data.Single

Specified by:

entity in interface ResolvableToSingle<DataEntity,DataEntity.Update>

Returns:

the fully loaded structured data on the current position in the inventory traversal

Throws:

EntityNotFoundException - if there is no structured data on the current position in the inventory

See Also:

ResolvableToSingle.entity()

data

public StructuredData data(RelativePath dataPath)

Description copied from interface: Data.Single

Returns the data on the path relative to the entity. In another words, you can use this method to obtain only a subset of the data stored on the data entity.

I.e if you have an data entity which contains a map with a key "foo", which contains a list and you want to obtain a third element of that list, you'd do: ...data(RelativePath.to().structuredData().key("foo").index(2).get());

If you want to obtain the whole data structure, use an empty path: RelativePath.empty().get().

Specified by:

data in interface Data.Single

Parameters:

dataPath - the path to the subset of the data.

Returns:

the subset of the data stored with the data entity

See Also:

Data.Single.flatData(RelativePath)

update

public void update(DataEntity.Update update)
            throws EntityNotFoundException,
                   RelationNotFoundException

Description copied from interface: ResolvableToSingle

Updates the entity.

Specified by:

update in interface Data.Single

Specified by:

update in interface ResolvableToSingle<DataEntity,DataEntity.Update>

Parameters:

update - the update to be applied

Throws:

EntityNotFoundException - if there is no entity corresponding to the traversal

RelationNotFoundException - if there is no relation corresponding to the traversal

delete

public void delete()

Description copied from interface: ResolvableToSingle

Deletes the entity.

Specified by:

delete in interface ResolvableToSingle<DataEntity,DataEntity.Update>