InventoryStructure.Offline (Hawkular Commons: Inventory API 0.9.4.Final API)

java.lang.Object
- org.hawkular.inventory.api.model.InventoryStructure.Offline<Root>

All Implemented Interfaces:

Serializable, InventoryStructure<Root>

Enclosing interface:

InventoryStructure<Root extends Entity.Blueprint>
```
public static class InventoryStructure.Offline<Root extends Entity.Blueprint>
extends Object
implements InventoryStructure<Root>, Serializable
```
Represents the structure of the inventory off-line, without access to an inventory instance. This implies that an instance holds on to all data required and thus can occupy a lot of memory. On the other hand, it is serializable.
This is not directly instantiable but rather can be either copied from another structure (possibly lazily loaded) or built using a InventoryStructure.Builder.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface org.hawkular.inventory.api.model.InventoryStructure
  InventoryStructure.AbstractBuilder<This extends InventoryStructure.AbstractBuilder<?>>, InventoryStructure.Builder<Root extends Entity.Blueprint>, InventoryStructure.ChildBuilder<ParentBuilder extends InventoryStructure.AbstractBuilder<?>>, InventoryStructure.EntityType, InventoryStructure.FullNode, InventoryStructure.Offline<Root extends Entity.Blueprint>

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InventoryStructure.Builder<Root>`	`asBuilder()` You can use this method if you have an existing inventory structure and want to make modifications to it.
`static <R extends Entity.Blueprint> InventoryStructure.Offline<R>`	`copy(InventoryStructure<R> other)`
`static <R extends Entity.Blueprint> InventoryStructure.Offline<R>`	`copy(InventoryStructure<R> other, boolean withAttachments)`
`boolean`	`equals(Object o)`
`Entity.Blueprint`	`get(RelativePath path)` Gets a blueprint on the given path.
`<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.
`InventoryStructure.FullNode`	`getNode(RelativePath path)` By providing an empty relative path, one can retrieve the attachment of the root entity.
`Root`	`getRoot()`
`int`	`hashCode()`
`static <R extends Entity.Blueprint> InventoryStructure.Builder<R>`	`of(R root)` Shortcut method, exactly identical to calling `of(Entity.Blueprint)`.
`static <R extends Entity.Blueprint> InventoryStructure.Builder<R>`	`of(R root, Object attachment)` Shortcut method, exactly identical to calling `of(Entity.Blueprint, Object)`.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hawkular.inventory.api.model.InventoryStructure
getAllChildNodes, getAllChildren, getAllChildrenWithAttachments, getChildNodes

- Method Detail
  - copy
```
public static <R extends Entity.Blueprint> InventoryStructure.Offline<R> copy(InventoryStructure<R> other)
```
  - copy
```
public static <R extends Entity.Blueprint> InventoryStructure.Offline<R> copy(InventoryStructure<R> other,
                                                                              boolean withAttachments)
```
  - asBuilder
```
public InventoryStructure.Builder<Root> asBuilder()
```
    You can use this method if you have an existing inventory structure and want to make modifications to it.
    
    Returns:
    
    a builder seeded with this inventory structure
  - of
```
public static <R extends Entity.Blueprint> InventoryStructure.Builder<R> of(R root)
```
    Description copied from interface: InventoryStructure
    
    Shortcut method, exactly identical to calling of(Entity.Blueprint).
    
    Specified by:
    
    of in interface InventoryStructure<Root extends Entity.Blueprint>
    
    Type Parameters:
    
    R - the type of the blueprint
    
    Parameters:
    
    root - the root blueprint
    
    Returns:
    
    the builder to build an offline inventory structure
  - of
```
public static <R extends Entity.Blueprint> InventoryStructure.Builder<R> of(R root,
                                                                            Object attachment)
```
    Description copied from interface: InventoryStructure
    
    Shortcut method, exactly identical to calling of(Entity.Blueprint, Object).
    
    Specified by:
    
    of in interface InventoryStructure<Root extends Entity.Blueprint>
    
    Type Parameters:
    
    R - 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
```
public Root getRoot()
```
    Specified by:
    
    getRoot in interface InventoryStructure<Root extends Entity.Blueprint>
    
    Returns:
    
    the root entity
  - getChildren
```
public <E extends Entity,B extends Entity.Blueprint> Stream<B> getChildren(RelativePath parent,
                                                                           Class<E> childType)
```
    Description copied from interface: InventoryStructure
    
    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.
    
    Specified by:
    
    getChildren in interface InventoryStructure<Root extends Entity.Blueprint>
    
    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.
  - get
```
public Entity.Blueprint get(RelativePath path)
```
    Description copied from interface: InventoryStructure
    
    Gets a blueprint on the given path.
    
    Specified by:
    
    get in interface InventoryStructure<Root extends Entity.Blueprint>
    
    Parameters:
    
    path - the path under the root of the structure
    
    Returns:
    
    the blueprint describing the entity on the given path
  - getNode
```
public InventoryStructure.FullNode getNode(RelativePath path)
```
    Description copied from interface: InventoryStructure
    
    By providing an empty relative path, one can retrieve the attachment of the root entity.
    
    Specified by:
    
    getNode in interface InventoryStructure<Root extends Entity.Blueprint>
    
    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
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class InventoryStructure.Offline<Root extends Entity.Blueprint>

Nested Class Summary

Nested classes/interfaces inherited from interface org.hawkular.inventory.api.model.InventoryStructure

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.hawkular.inventory.api.model.InventoryStructure

Method Detail

copy

copy

asBuilder

of

of

getRoot

getChildren

get

getNode

equals

hashCode