public enum RelationshipType extends java.lang.Enum<RelationshipType>
| Enum Constant and Description |
|---|
BOUND
A BINDING relationship exists between the following shapes:
Between an operation and the service or resource that the
operation is bound to (through operations or a lifecycle).
Between a resource and the resource or service that the
resource is bound to in the "resources" property.
The subject of the relationship is that shape that was bound, and the
target is the shape that declared the binding.
|
COLLECTION_OPERATION
A collection operation relationship exists between a resource and the
operations bound to the resource in the "collectionOperations", "create",
and "list" properties.
|
CREATE
Relationships that exist between a resource and the create lifecycle
operation.
|
DELETE
Relationships that exist between a resource and the delete lifecycle
operation.
|
ENUM_MEMBER
Relationships that exist on
enum shapes to their
member shapes. |
ERROR
Relationships that exist on
operation shapes. |
IDENTIFIER
Relationships that exist between a
member and
the shapes that are referenced by its identifiers property. |
INPUT
Relationships that exist on
operation shapes. |
INSTANCE_OPERATION
An instance operation relationship exists between a resource and the
operations bound to the resource in the "Operations", "put", "read",
"update", and "delete" properties.
|
INT_ENUM_MEMBER
Relationships that exist on
intEnum shapes to their
member shapes. |
LIST
Relationships that exist between a resource and the list lifecycle
operation.
|
LIST_MEMBER
Relationships that exist on
list shapes to their
member shapes. |
MAP_KEY
Relationships that exist on
map shapes. |
MAP_VALUE
Relationships that exist on
map shapes. |
MEMBER_CONTAINER
Relationships exist on
member shapes. |
MEMBER_TARGET
Relationships exist on
member shapes. |
MIXIN
Relationship that exists between a structure or union and a mixin applied
to the shape.
|
OPERATION
An operation relationship exists between a service and the operations
bound to the service in the "operations" property, and between a
resource and the operations bound to the resource in the
"operations", "collectionOperations", and lifecycle properties.
|
OUTPUT
Relationships that exist on
operation shapes. |
PROPERTY
Relationships that exist between a
member and
the shapes that are referenced by its properties property. |
PUT
Relationships that exist between a resource and the put lifecycle
operation.
|
READ
Relationships that exist between a resource and the get lifecycle
operation.
|
RESOURCE
A resource relationship exists between a service or resource and the
resources bound through the "resources" property.
|
SET_MEMBER
Deprecated.
|
STRUCTURE_MEMBER
Relationships that exist on
structure shapes. |
TRAIT
Relationships that exist between a shape and traits bound to the
shape.
|
UNION_MEMBER
Relationships that exist on
union
shapes. |
UPDATE
Relationships that exist between a resource and the update lifecycle
operation.
|
| Modifier and Type | Method and Description |
|---|---|
RelationshipDirection |
getDirection()
Gets the direction of the relationship.
|
java.util.Optional<java.lang.String> |
getSelectorLabel()
Gets the token that is used in
Selector expressions when
referring to the relationship or an empty Optional if this
relationship is not used directly in a selector. |
static RelationshipType |
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.
|
static RelationshipType[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final RelationshipType RESOURCE
public static final RelationshipType OPERATION
public static final RelationshipType COLLECTION_OPERATION
public static final RelationshipType INSTANCE_OPERATION
public static final RelationshipType BOUND
public static final RelationshipType PUT
public static final RelationshipType CREATE
public static final RelationshipType READ
public static final RelationshipType UPDATE
public static final RelationshipType DELETE
public static final RelationshipType LIST
public static final RelationshipType IDENTIFIER
member and
the shapes that are referenced by its identifiers property.public static final RelationshipType PROPERTY
member and
the shapes that are referenced by its properties property.public static final RelationshipType MEMBER_CONTAINER
member shapes. The subject
of the relationship is the member shape, and the neighbor is the
aggregate shape that contains the member.public static final RelationshipType MEMBER_TARGET
member shapes. The subject
of the relationship is the member shape, and the neighbor is the shape
that the member targets.public static final RelationshipType INPUT
public static final RelationshipType OUTPUT
public static final RelationshipType ERROR
public static final RelationshipType ENUM_MEMBER
enum shapes to their
member shapes.public static final RelationshipType INT_ENUM_MEMBER
intEnum shapes to their
member shapes.public static final RelationshipType LIST_MEMBER
list shapes to their
member shapes.@Deprecated public static final RelationshipType SET_MEMBER
set shapes to their
member shapes.public static final RelationshipType MAP_KEY
public static final RelationshipType MAP_VALUE
public static final RelationshipType STRUCTURE_MEMBER
public static final RelationshipType UNION_MEMBER
public static final RelationshipType TRAIT
TraitDefinition
trait.
This kind of relationship is not returned by default from a
NeighborProvider. You must explicitly wrap a NeighborProvider
with NeighborProvider.withTraitRelationships(Model, NeighborProvider)
in order to yield trait relationships.
public static final RelationshipType MIXIN
public static RelationshipType[] values()
for (RelationshipType c : RelationshipType.values()) System.out.println(c);
public static RelationshipType valueOf(java.lang.String name)
name - the name of the enum constant to be returned.java.lang.IllegalArgumentException - if this enum type has no constant with the specified namejava.lang.NullPointerException - if the argument is nullpublic java.util.Optional<java.lang.String> getSelectorLabel()
Selector expressions when
referring to the relationship or an empty Optional if this
relationship is not used directly in a selector.public RelationshipDirection getDirection()
A RelationshipDirection.DIRECTED direction is formed from a shape
that defines a reference to another shape (for example, when a resource
defines operations or resources it contains).
A RelationshipDirection.INVERTED relationship is a relationship
from a shape to a shape that defines a relationship to it. The target
of such a relationship doesn't define the relationship, but is the
target of the relationship.