org.hawkular.inventory.base

Class BaseResources.Single<BE>

java.lang.Object

org.hawkular.inventory.base.Traversal<BE,E>

org.hawkular.inventory.base.BaseResources.Single<BE>

All Implemented Interfaces:

Relatable<Relationships.ReadWrite>, ResolvableToMany<Resource>, ResolvableToSingle<Resource,Resource.Update>, ResolvableToSingleWithRelationships<Resource,Resource.Update>, Resources.Single

Enclosing class:

BaseResources

public static class BaseResources.Single<BE>
extends Traversal<BE,E>
implements Resources.Single

Field Summary

Fields inherited from class org.hawkular.inventory.base.Traversal

context

Constructor Summary

Constructors

Constructor and Description
Single(TraversalContext<BE,Resource> context)

Method Summary

Modifier and Type	Method and Description
Resources.ReadAssociate	allChildren() Access to all children.
Resources.ReadWrite	containedChildren()
void	delete() Deletes the entity.
Page<E>	entities(Pager pager)
E	entity() Resolves the entity and returns it.
Metrics.ReadAssociate	metrics()
Resources.Single	parent()
Resources.Read	parents()
Relationships.ReadWrite	relationships()
Relationships.ReadWrite	relationships(Relationships.Direction direction)
void	update(U u) Updates the entity.

Methods inherited from class org.hawkular.inventory.base.Traversal

getSingle, isApplicable, mutating, readOnly

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.ResolvableToSingle

delete, entity, exists, update

Methods inherited from interface org.hawkular.inventory.api.Relatable

relationships, relationships

Methods inherited from interface org.hawkular.inventory.api.ResolvableToMany

anyExists, entities

Constructor Detail

Single

public Single(TraversalContext<BE,Resource> context)

Method Detail

metrics

public Metrics.ReadAssociate metrics()

Returns:

access to metrics owned by the resource(s)

allChildren

public Resources.ReadAssociate allChildren()

Access to all children. Note that children that are existentially bound to this resource (i.e. in addition to Relationships.WellKnown.isParentOf there also exists the Relationships.WellKnown.contains relationship) cannot be disassociated using this interface.

Returns:

access to all children of this/these resource(s) (superset of containedChildren(), also includes the resources bound merely by Relationships.WellKnown.isParentOf).

containedChildren

public Resources.ReadWrite containedChildren()

Returns:

access to children that are existentially bound to this/these resource(s)

parent

public Resources.Single parent()

Specified by:

parent in interface Resources.Single

Returns:

access to the parent resource (if any) that contains the resource on the current position in the path traversal. This resource will not exist for top-level resources living directly under an environment or feed.

parents

public Resources.Read parents()

Returns:

the parent resource(s) of the current resource(s)

relationships

public Relationships.ReadWrite relationships()

relationships

public Relationships.ReadWrite relationships(Relationships.Direction direction)

entity

public E entity()
         throws EntityNotFoundException,
                RelationNotFoundException

Description copied from interface: ResolvableToSingle

Resolves the entity and returns it.

Specified by:

entity in interface ResolvableToSingle<E extends AbstractElement<?,U>,U extends AbstractElement.Update>

Returns:

the entity at the current position in the inventory traversal

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<E extends AbstractElement<?,U>,U extends AbstractElement.Update>

update

public void update(U u)
            throws EntityNotFoundException,
                   RelationNotFoundException

Description copied from interface: ResolvableToSingle

Updates the entity.

Specified by:

update in interface ResolvableToSingle<E extends AbstractElement<?,U>,U extends AbstractElement.Update>

Parameters:

u - 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

entities

public Page<E> entities(Pager pager)

Specified by:

entities in interface ResolvableToMany<E extends AbstractElement<?,U>>

Parameters:

pager - the pager object describing the subset of the entities to return

Returns:

resolves all entities on the current position in the inventory traversal and produces a single "page" of those entities according to the provided pager