org.hawkular.inventory.base

Class BaseEnvironments.Single<BE>

java.lang.Object

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

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

All Implemented Interfaces:

Environments.Single, Relatable<Relationships.ReadWrite>, ResolvableToMany<Environment>, ResolvableToSingle<Environment,Environment.Update>, ResolvableToSingleWithRelationships<Environment,Environment.Update>

Enclosing class:

BaseEnvironments

public static class BaseEnvironments.Single<BE>
extends Traversal<BE,E>
implements Environments.Single

Field Summary

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

context

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Metrics.Read	allMetrics() Returns access to all metrics in this environment regardless of whether they are under some feed or directly under the environment.
Resources.Read	allResources() Returns access to all resources in this environment regardless of whether they are under some feed or directly under the environment.
void	delete() Deletes the entity.
Page<E>	entities(Pager pager)
E	entity() Resolves the entity and returns it.
Metrics.ReadWrite	feedlessMetrics()
Resources.ReadWrite	feedlessResources()
Feeds.ReadWrite	feeds()
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,Environment> context)

Method Detail

feeds

public Feeds.ReadWrite feeds()

Returns:

feeds in the environment(s)

feedlessResources

public Resources.ReadWrite feedlessResources()

Returns:

resources in the environment(s) that do not come from any feed

feedlessMetrics

public Metrics.ReadWrite feedlessMetrics()

Returns:

metrics in the environment(s) that do not come from any feed

allResources

public Resources.Read allResources()

Returns access to all resources in this environment regardless of whether they are under some feed or directly under the environment.

Returns:

the access interface to all resources in this environment

allMetrics

public Metrics.Read allMetrics()

Returns access to all metrics in this environment regardless of whether they are under some feed or directly under the environment.

Note that it is not possible to get a single metric from this access interface because the id is not guaranteed to be unique amongst metrics under different feeds.

Returns:

the access interface to all metrics in this environment

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