org.hawkular.inventory.api.model

Class Relationship

java.lang.Object

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

org.hawkular.inventory.api.model.Relationship

public final class Relationship
extends AbstractElement<Void,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.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, ID_PROPERTY, properties

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getName()
Entity	getSource()
Entity	getTarget()
String	toString()
AbstractElement.Updater<Relationship.Update,Relationship>	update()

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

equals, getId, 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,
                    Entity source,
                    Entity target)

Relationship

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

Method Detail

update

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

Specified by:

update in class AbstractElement<Void,Relationship.Update>

Returns:

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

getName

public String getName()

getSource

public Entity getSource()

getTarget

public Entity getTarget()

toString

public String toString()

Overrides:

toString in class Object