org.hawkular.inventory.api.model

Interface InventoryStructure<Root extends Entity.Blueprint>

All Known Implementing Classes:

InventoryStructure.Offline

public interface InventoryStructure<Root extends Entity.Blueprint>

Represents the structure of an inventory. It is supposed that the structure is loaded lazily. The structure is represented using entity blueprints instead of entity types themselves so that this structure can be computed offline, without access to all information up to the tenant.

Since:

0.11.0

Author:

Lukas Krejci

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	InventoryStructure.AbstractBuilder<This extends InventoryStructure.AbstractBuilder<?>>
static class	InventoryStructure.Builder<Root extends Entity.Blueprint>
static class	InventoryStructure.ChildBuilder<ParentBuilder extends InventoryStructure.AbstractBuilder<?>>
static class	InventoryStructure.EntityType This enum lists all the entity types that can be part of a inventory structure.
static class	InventoryStructure.FullNode Represents an entity in the inventory structure together with the attachment assigned to it by the inventory structure builder.
static class	InventoryStructure.Offline<Root extends Entity.Blueprint> Represents the structure of the inventory off-line, without access to an inventory instance.

Method Summary

Modifier and Type	Method and Description
Entity.Blueprint	get(RelativePath path) Gets a blueprint on the given path.
default Stream<InventoryStructure.FullNode>	getAllChildNodes(RelativePath parent) Returns all direct children of the specified parent.
default Stream<Entity.Blueprint>	getAllChildren(RelativePath parent) Returns all direct children of the specified parent.
default Stream<InventoryStructure.FullNode>	getAllChildrenWithAttachments(RelativePath parent) Deprecated.
default <E extends Entity,B extends Entity.Blueprint> Stream<InventoryStructure.FullNode>	getChildNodes(RelativePath parent, Class<E> childType)
<E extends Entity,B extends Entity.Blueprint> Stream<B>	getChildren(RelativePath parent, Class<E> childType) Returns the direct children of given type under the supplied path to the parent entity, which is relative to some root entity for which this structure was instantiated.
default InventoryStructure.FullNode	getNode(RelativePath path) By providing an empty relative path, one can retrieve the attachment of the root entity.
Root	getRoot()
static <B extends Entity.Blueprint> InventoryStructure.Builder<B>	of(B root) Shortcut method, exactly identical to calling InventoryStructure.Offline.of(Entity.Blueprint).
static <B extends Entity.Blueprint> InventoryStructure.Builder<B>	of(B root, Object attachment) Shortcut method, exactly identical to calling InventoryStructure.Offline.of(Entity.Blueprint, Object).

Method Detail

of

static <B extends Entity.Blueprint> InventoryStructure.Builder<B> of(B root)

Shortcut method, exactly identical to calling InventoryStructure.Offline.of(Entity.Blueprint).

Type Parameters:

B - the type of the blueprint

Parameters:

root - the root blueprint

Returns:

the builder to build an offline inventory structure

of

static <B extends Entity.Blueprint> InventoryStructure.Builder<B> of(B root,
                                                                     Object attachment)

Shortcut method, exactly identical to calling InventoryStructure.Offline.of(Entity.Blueprint, Object).

Type Parameters:

B - the type of the blueprint

Parameters:

root - the root blueprint

attachment - the attachment of the blueprint

Returns:

the builder to build an offline inventory structure

getRoot

Root getRoot()

Returns:

the root entity

getChildren

<E extends Entity,B extends Entity.Blueprint> Stream<B> getChildren(RelativePath parent,
                                                                    Class<E> childType)

Returns the direct children of given type under the supplied path to the parent entity, which is relative to some root entity for which this structure was instantiated.

WARNING: the returned stream MUST BE closed after processing.

Type Parameters:

E - the type of the child entities

B - the type of the child entity blueprint

Parameters:

parent - the path to the parent entity, relative to the root entity

childType - the type of the child entities to retrieve

Returns:

a stream of blueprints corresponding to the child entities.

getChildNodes

default <E extends Entity,B extends Entity.Blueprint> Stream<InventoryStructure.FullNode> getChildNodes(RelativePath parent,
                                                                                                        Class<E> childType)

get

Entity.Blueprint get(RelativePath path)

Gets a blueprint on the given path.

Parameters:

path - the path under the root of the structure

Returns:

the blueprint describing the entity on the given path

getNode

default InventoryStructure.FullNode getNode(RelativePath path)

By providing an empty relative path, one can retrieve the attachment of the root entity.

Parameters:

path - the path to the entity in the inventory structure

Returns:

the object attached to the entity by the inventory structure builder or null if the path is not known

getAllChildren

default Stream<Entity.Blueprint> getAllChildren(RelativePath parent)

Returns all direct children of the specified parent. WARNING: the returned stream MUST BE closed after processing.

Parameters:

parent - the parent of which to return the children

Returns:

the stream of all children of the parent

getAllChildNodes

default Stream<InventoryStructure.FullNode> getAllChildNodes(RelativePath parent)

Returns all direct children of the specified parent. WARNING: the returned stream MUST BE closed after processing.

Parameters:

parent - the parent of which to return the children

Returns:

the stream of all children of the parent

getAllChildrenWithAttachments

@Deprecated
default Stream<InventoryStructure.FullNode> getAllChildrenWithAttachments(RelativePath parent)

Deprecated.

This had an out-of-place name. Use getAllChildNodes(RelativePath) instead.

Parameters:

parent - the parent of which to return the children

Returns:

the stream of all children of the parent