org.hawkular.inventory.api.model

Class Relationship

java.lang.Object

org.hawkular.inventory.api.model.AbstractElement<Relationship.Blueprint,Relationship.Update>

org.hawkular.inventory.api.model.Relationship

public final class Relationship
extends AbstractElement<Relationship.Blueprint,Relationship.Update>

Represents a relationship between 2 entities. A relationship has a source and target entities (somewhat obviously), a name, id (multiple relationships of the same name can exist between the same source and target) and also a map of properties.

Since:

1.0

Author:

Lukas Krejci, Jirka Kremser

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Relationship.Blueprint
static class	Relationship.Update

Nested classes/interfaces inherited from class org.hawkular.inventory.api.model.AbstractElement

AbstractElement.Updater<U extends AbstractElement.Update,E extends AbstractElement<?,U>>

Field Summary

Fields inherited from class org.hawkular.inventory.api.model.AbstractElement

ID_PROPERTY, properties

Constructor Summary

Constructors

Constructor and Description
Relationship(String id, String name, CanonicalPath source, CanonicalPath target)
Relationship(String id, String name, CanonicalPath source, CanonicalPath target, Map<String,Object> properties)

Method Summary

Modifier and Type	Method and Description
<R,P> R	accept(ElementVisitor<R,P> visitor, P parameter) Accepts the provided visitor.
String	getId()
String	getName()
CanonicalPath	getSource()
CanonicalPath	getTarget()
String	toString()
AbstractElement.Updater<Relationship.Update,Relationship>	update()

Methods inherited from class org.hawkular.inventory.api.model.AbstractElement

equals, getPath, getProperties, hashCode, valueOrDefault

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Relationship

public Relationship(String id,
                    String name,
                    CanonicalPath source,
                    CanonicalPath target)

Relationship

public Relationship(String id,
                    String name,
                    CanonicalPath source,
                    CanonicalPath target,
                    Map<String,Object> properties)

Method Detail

accept

public <R,P> R accept(ElementVisitor<R,P> visitor,
                      P parameter)

Description copied from class: AbstractElement

Accepts the provided visitor.

Specified by:

accept in class AbstractElement<Relationship.Blueprint,Relationship.Update>

Type Parameters:

R - the return type

P - the type of the parameter

Parameters:

visitor - the visitor to visit this entity

parameter - the parameter to pass on to the visitor

Returns:

the return value provided by the visitor

update

public AbstractElement.Updater<Relationship.Update,Relationship> update()

Specified by:

update in class AbstractElement<Relationship.Blueprint,Relationship.Update>

Returns:

a new updater object to modify this entity and produce a new one.

getId

public String getId()

Overrides:

getId in class AbstractElement<Relationship.Blueprint,Relationship.Update>

Returns:

the id of the element.

getName

public String getName()

getSource

public CanonicalPath getSource()

getTarget

public CanonicalPath getTarget()

toString

public String toString()

Overrides:

toString in class Object