org.hawkular.inventory.base

Class BaseRelationships.Single<BE>

java.lang.Object

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

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

All Implemented Interfaces:

Relationships.Single, ResolvableToMany<Relationship>, ResolvableToSingle<Relationship,Relationship.Update>

Enclosing class:

BaseRelationships

public static class BaseRelationships.Single<BE>
extends Traversal<BE,E>
implements Relationships.Single

Field Summary

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

context

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	delete() Deletes the entity.
Page<E>	entities(Pager pager)
E	entity() Resolves the entity and returns it.
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.ResolvableToMany

anyExists, entities

Constructor Detail

Single

public Single(TraversalContext<BE,Relationship> context)

Method Detail

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