org.hawkular.inventory.api

Interface ResolvableToSingle<Entity>

Type Parameters:

Entity - the type of the entity being browsed

All Known Subinterfaces:

Environments.Single, Feeds.Single, Metrics.Single, MetricTypes.Single, Relationships.Single, org.hawkular.inventory.api.ResolvableToSingleWithRelationships<Entity>, Resources.Single, ResourceTypes.Single, Tenants.Single

All Known Implementing Classes:

EmptyInventory.EnvironmentsSingle, EmptyInventory.FeedsSingle, EmptyInventory.MetricsSingle, EmptyInventory.MetricTypesSingle, EmptyInventory.RelationshipsSingle, EmptyInventory.ResourcesSingle, EmptyInventory.ResourceTypesSingle, EmptyInventory.TenantsSingle

public interface ResolvableToSingle<Entity>

Base interface for all browser interfaces over a single entity.

Since:

1.0

Author:

Lukas Krejci

Method Summary

Modifier and Type	Method and Description
Entity	entity() Resolves the entity and returns it.
default boolean	exists() Similar to entity() but merely checks whether the entity exists on the position in the inventory traversal.

Method Detail

entity

Entity entity()
       throws EntityNotFoundException,
              RelationNotFoundException

Resolves the entity and returns it.

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

exists

default boolean exists()

Similar to entity() but merely checks whether the entity exists on the position in the inventory traversal.

Note that the default implementation might not be optimal performance-wise because it tries to fully resolve the entity using the entity() method but discards that result right after.

Returns:

true if there is an entity, false otherwise.