org.hawkular.inventory.api

Enum Relationships.WellKnown

java.lang.Object

java.lang.Enum<Relationships.WellKnown>

org.hawkular.inventory.api.Relationships.WellKnown

All Implemented Interfaces:

Serializable, Comparable<Relationships.WellKnown>

Enclosing class:

Relationships

public static enum Relationships.WellKnown
extends Enum<Relationships.WellKnown>

The list of well-known relationships (aka edges) between entities (aka vertices).

Enum Constant Summary

Enum Constants

Enum Constant and Description
contains Expresses encapsulation of a set of entities in another entity.
defines Expresses "instantiation" of some entity based on the definition provided by "source" entity.
owns Expresses ownership.

Method Summary

Modifier and Type	Method and Description
static Relationships.WellKnown	valueOf(String name) Returns the enum constant of this type with the specified name.
static Relationships.WellKnown[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

contains

public static final Relationships.WellKnown contains

Expresses encapsulation of a set of entities in another entity. Used for example to express the relationship between a tenant and the set of its environments.

Note that entities that are contained within another entity (by the virtue of there being this relationship between them) are deleted along with it.

Note also that it is prohibited to create loops in the contains relationships, i.e. an entity cannot (indirectly) contain itself. Also, containment is unique and therefore 1 entity cannot be contained in 2 or more other entities.

defines

public static final Relationships.WellKnown defines

Expresses "instantiation" of some entity based on the definition provided by "source" entity. For example, there is a defines relationship between a metric definition and all metrics that conform to it.

Note that as long as an entity defines other entities, it cannot be deleted.

owns

public static final Relationships.WellKnown owns

Expresses ownership. For example a resource owns a set of metrics, or a resource type owns a set of metric definitions. They do not contain it though, because more resources can own a single metric for example.

Method Detail

values

public static Relationships.WellKnown[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Relationships.WellKnown c : Relationships.WellKnown.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Relationships.WellKnown valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null