org.hawkular.inventory.api.model

Class InventoryStructure.AbstractBuilder<This extends InventoryStructure.AbstractBuilder<?>>

java.lang.Object

org.hawkular.inventory.api.model.InventoryStructure.AbstractBuilder<This>

Direct Known Subclasses:

InventoryStructure.Builder, InventoryStructure.ChildBuilder

Enclosing interface:

InventoryStructure<Root extends Entity.Blueprint>

public abstract static class InventoryStructure.AbstractBuilder<This extends InventoryStructure.AbstractBuilder<?>>
extends Object

Method Summary

Modifier and Type	Method and Description
This	addChild(Entity.Blueprint child) Adds a new child to this entity without the possibility to add further grand-children to the child.
This	addChild(Entity.Blueprint child, Object attachment)
Entity.Blueprint	getBlueprint()
InventoryStructure.ChildBuilder<This>	getChild(Path.Segment childPath) Returns a child builder of a pre-existing child.
Set<Path.Segment>	getChildrenPaths()
InventoryStructure.FullNode	getNode()
RelativePath	getPath()
This	removeAllChildren()
This	removeChild(Path.Segment childPath)
This	replace(Entity.Blueprint blueprint)
This	replace(Entity.Blueprint blueprint, Object attachment) Replaces the blueprint on this position in the structure with another.
InventoryStructure.ChildBuilder<This>	startChild(Entity.Blueprint child) Equivalent to calling startChilld(child, null).
InventoryStructure.ChildBuilder<This>	startChild(Entity.Blueprint child, Object childAttachment) Starts building a new child of the currently built entity.

Methods inherited from class java.lang.Object

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

Method Detail

startChild

public InventoryStructure.ChildBuilder<This> startChild(Entity.Blueprint child)

Equivalent to calling startChilld(child, null).

See Also:

startChild(Entity.Blueprint, Object)

startChild

public InventoryStructure.ChildBuilder<This> startChild(Entity.Blueprint child,
                                                        Object childAttachment)

Starts building a new child of the currently built entity.

Parameters:

child - the child entity blueprint

childAttachment - the attachment to store along with the child

Returns:

a new child builder

Throws:

IllegalArgumentException - if the provided child cannot be contained in the currently built entity (i.e. a resource type cannot be contained in a resource for example).

getPath

public RelativePath getPath()

getBlueprint

public Entity.Blueprint getBlueprint()

getNode

public InventoryStructure.FullNode getNode()

getChild

public InventoryStructure.ChildBuilder<This> getChild(Path.Segment childPath)

Returns a child builder of a pre-existing child.

Parameters:

childPath - the path to the child

Returns:

the child builder or null

removeChild

public This removeChild(Path.Segment childPath)

getChildrenPaths

public Set<Path.Segment> getChildrenPaths()

removeAllChildren

public This removeAllChildren()

replace

public This replace(Entity.Blueprint blueprint)

replace

public This replace(Entity.Blueprint blueprint,
                    Object attachment)

Replaces the blueprint on this position in the structure with another. The blueprint must have the same type as the original one.

Parameters:

blueprint - the blueprint to replace the current with

attachment - the object to attach to the entity blueprint

Returns:

this builder

addChild

public This addChild(Entity.Blueprint child)

Adds a new child to this entity without the possibility to add further grand-children to the child.

Parameters:

child - the child to add to this entity

Returns:

this builder

Throws:

IllegalArgumentException - if the provided child cannot be contained in the currently built entity (i.e. a resource type cannot be contained in a resource for example).

addChild

public This addChild(Entity.Blueprint child,
                     Object attachment)