Enum Class RelationshipType
- All Implemented Interfaces:
Serializable
,Comparable<RelationshipType>
,Constable
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionDeprecated.A collection operation relationship exists between a resource and the operations bound to the resource in the "collectionOperations" property.Relationships that exist between a resource and the create lifecycle operation.Relationships that exist between a resource and the delete lifecycle operation.Relationships that exist onenum
shapes to theirmember shapes
.Relationships that exist onoperation
shapes.Relationships that exist between a shape and another shape referenced by anIdRefTrait
.Relationships that exist between amember
and the shapes that are referenced by its identifiers property.Relationships that exist onoperation
shapes.Deprecated.Relationships that exist onintEnum
shapes to theirmember shapes
.Relationships that exist between a resource and the list lifecycle operation.Relationships that exist onlist
shapes to theirmember shapes
.Relationships that exist onmap
shapes.Relationships that exist onmap
shapes.Relationships exist onmember
shapes.Relationships exist onmember
shapes.Relationship that exists between a structure or union and a mixin applied to the shape.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.Relationships that exist onoperation
shapes.Relationships that exist between amember
and the shapes that are referenced by its properties property.Relationships that exist between a resource and the put lifecycle operation.Relationships that exist between a resource and the get lifecycle operation.A resource relationship exists between a service or resource and the resources bound through the "resources" property.Deprecated.Relationships that exist onstructure
shapes.Relationships that exist between a shape and traits bound to the shape.Relationships that exist onunion
shapes.Relationships that exist between a resource and the update lifecycle operation. -
Method Summary
Modifier and TypeMethodDescriptionGets the direction of the relationship.Gets the token that is used inSelector
expressions when referring to the relationship or an emptyOptional
if this relationship is not used directly in a selector.boolean
Returns true if relationship connects a resource to a collection operation.boolean
Returns true if relationship connects a resource to an instance operation.boolean
Checks if the given relationship connects a container shape to a member.boolean
Checks if the binding is to an operation (create|read|update|delete|put|list|operation|collectionOperation).static RelationshipType
Returns the enum constant of this class with the specified name.static RelationshipType[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
RESOURCE
A resource relationship exists between a service or resource and the resources bound through the "resources" property. -
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. -
COLLECTION_OPERATION
A collection operation relationship exists between a resource and the operations bound to the resource in the "collectionOperations" property. -
INSTANCE_OPERATION
Deprecated. -
BOUND
Deprecated. -
PUT
Relationships that exist between a resource and the put lifecycle operation. -
CREATE
Relationships that exist between a resource and the create lifecycle operation. -
READ
Relationships that exist between a resource and the get lifecycle operation. -
UPDATE
Relationships that exist between a resource and the update lifecycle operation. -
DELETE
Relationships that exist between a resource and the delete lifecycle operation. -
LIST
Relationships that exist between a resource and the list lifecycle operation. -
IDENTIFIER
Relationships that exist between amember
and the shapes that are referenced by its identifiers property. -
PROPERTY
Relationships that exist between amember
and the shapes that are referenced by its properties property. -
MEMBER_CONTAINER
Relationships exist onmember
shapes. The subject of the relationship is the member shape, and the neighbor is the aggregate shape that contains the member. -
MEMBER_TARGET
Relationships exist onmember
shapes. The subject of the relationship is the member shape, and the neighbor is the shape that the member targets. -
INPUT
-
OUTPUT
-
ERROR
-
ENUM_MEMBER
Relationships that exist onenum
shapes to theirmember shapes
. -
INT_ENUM_MEMBER
Relationships that exist onintEnum
shapes to theirmember shapes
. -
LIST_MEMBER
Relationships that exist onlist
shapes to theirmember shapes
. -
SET_MEMBER
Deprecated.Relationships that exist onset
shapes to theirmember shapes
. -
MAP_KEY
-
MAP_VALUE
-
STRUCTURE_MEMBER
-
UNION_MEMBER
-
TRAIT
Relationships that exist between a shape and traits bound to the shape. They reference shapes marked with theTraitDefinition
trait.This kind of relationship is not returned by default from a
NeighborProvider
. You must explicitly wrap aNeighborProvider
withNeighborProvider.withTraitRelationships(Model, NeighborProvider)
in order to yield trait relationships. -
MIXIN
Relationship that exists between a structure or union and a mixin applied to the shape. -
ID_REF
Relationships that exist between a shape and another shape referenced by anIdRefTrait
.This relationship is formed by applying a trait with a value containing a reference to another
ShapeId
. For example:@trait structure myRef { @idRef shape: String } // @myRef trait applied, and the value references the shape `Referenced` @myRef(shape: Referenced) structure WithMyRef {} string Referenced
This kind of relationship is not returned by default from a
NeighborProvider
. You must explicitly wrap aNeighborProvider
withNeighborProvider.withIdRefRelationships(Model, NeighborProvider)
in order to yield idRef relationships.
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException
- if the argument is null
-
getSelectorLabel
Gets the token that is used inSelector
expressions when referring to the relationship or an emptyOptional
if this relationship is not used directly in a selector.- Returns:
- Returns the optionally present selector token for this relationship.
-
getDirection
Gets the direction of the relationship.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.- Returns:
- Returns the direction of the relationship.
-
isMemberBinding
public boolean isMemberBinding()Checks if the given relationship connects a container shape to a member.- Returns:
- Returns true if a member.
-
isOperationBinding
public boolean isOperationBinding()Checks if the binding is to an operation (create|read|update|delete|put|list|operation|collectionOperation).- Returns:
- Returns true if the binding is for any kind of operation binding.
-
isInstanceOperationBinding
public boolean isInstanceOperationBinding()Returns true if relationship connects a resource to an instance operation.- Returns:
- True if an instance operation.
-
isCollectionOperationBinding
public boolean isCollectionOperationBinding()Returns true if relationship connects a resource to a collection operation.- Returns:
- True if a collection operation.
-