software.amazon.smithy.model.shapes

Class MemberShape

java.lang.Object

software.amazon.smithy.model.shapes.Shape

software.amazon.smithy.model.shapes.MemberShape

All Implemented Interfaces:

java.lang.Comparable<Shape>, FromSourceLocation, ToShapeId, Tagged, ToSmithyBuilder<MemberShape>

public final class MemberShape
extends Shape
implements ToSmithyBuilder<MemberShape>

Represents a member that targets another shape by ID.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MemberShape.Builder Builder used to create a MemberShape.

Method Summary

Modifier and Type	Method and Description
<R> R	accept(ShapeVisitor<R> cases) Dispatches the shape to the appropriate ShapeVisitor method.
java.util.Optional<MemberShape>	asMemberShape()
static MemberShape.Builder	builder()
boolean	equals(java.lang.Object other)
java.util.Optional<Trait>	findMemberTrait(Model model, java.lang.String traitName) Gets a trait from the member shape or from the shape targeted by the member.
ShapeId	getContainer() Gets the shape in which the member is contained.
java.lang.String	getMemberName() Get the member name of the member.
<T extends Trait> java.util.Optional<T>	getMemberTrait(Model model, java.lang.Class<T> trait) Gets a trait from the member shape or from the shape targeted by the member.
ShapeId	getTarget() Get the targeted member shape ID.
ShapeType	getType() Gets the type of the shape.
boolean	isOptional()
boolean	isRequired()
MemberShape.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.

Methods inherited from class software.amazon.smithy.model.shapes.Shape

asBigDecimalShape, asBigIntegerShape, asBlobShape, asBooleanShape, asByteShape, asDocumentShape, asDoubleShape, asFloatShape, asIntegerShape, asListShape, asLongShape, asMapShape, asOperationShape, asResourceShape, asServiceShape, asSetShape, asShortShape, asStringShape, asStructureShape, asTimestampShape, asUnionShape, compareTo, expectTrait, findTrait, findTrait, getAllTraits, getId, getSourceLocation, getTags, getTrait, hashCode, hasTrait, hasTrait, hasTrait, isBigDecimalShape, isBigIntegerShape, isBlobShape, isBooleanShape, isByteShape, isDocumentShape, isDoubleShape, isFloatShape, isIntegerShape, isListShape, isLongShape, isMapShape, isMemberShape, isOperationShape, isResourceShape, isServiceShape, isSetShape, isShortShape, isStringShape, isStructureShape, isTimestampShape, isUnionShape, members, shapeToBuilder, toShapeId, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.smithy.utils.Tagged

hasTag

Method Detail

builder

public static MemberShape.Builder builder()

toBuilder

public MemberShape.Builder toBuilder()

Description copied from interface: ToSmithyBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToSmithyBuilder<MemberShape>

Returns:

a builder for type T

getContainer

public ShapeId getContainer()

Gets the shape in which the member is contained.

Returns:

Returns the containing shape id.

accept

public <R> R accept(ShapeVisitor<R> cases)

Description copied from class: Shape

Dispatches the shape to the appropriate ShapeVisitor method.

Specified by:

accept in class Shape

Type Parameters:

R - Return type of the accept.

Parameters:

cases - NeighborVisitor to use.

Returns:

Returns the result.

asMemberShape

public java.util.Optional<MemberShape> asMemberShape()

Overrides:

asMemberShape in class Shape

Returns:

Optionally returns the shape as a MemberShape.

getType

public ShapeType getType()

Description copied from class: Shape

Gets the type of the shape.

Specified by:

getType in class Shape

Returns:

Returns the type;

getTarget

public ShapeId getTarget()

Get the targeted member shape ID.

Returns:

Returns the member shape ID.

getMemberName

public java.lang.String getMemberName()

Get the member name of the member.

Returns:

Returns the member name.

isRequired

public boolean isRequired()

Returns:

Returns true if the member has the required trait.

isOptional

public boolean isOptional()

Returns:

Returns true if the member is not required.

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class Shape

getMemberTrait

public <T extends Trait> java.util.Optional<T> getMemberTrait(Model model,
                                                              java.lang.Class<T> trait)

Description copied from class: Shape

Gets a trait from the member shape or from the shape targeted by the member.

If the shape is not a member, then the method functions the same as Shape.getTrait(Class).

Overrides:

getMemberTrait in class Shape

Type Parameters:

T - Trait type to get.

Parameters:

model - Model used to find member targets.

trait - Trait type to get.

Returns:

Returns the optionally found trait on the shape or member.

See Also:

Shape.getTrait(Class)

findMemberTrait

public java.util.Optional<Trait> findMemberTrait(Model model,
                                                 java.lang.String traitName)

Description copied from class: Shape

Gets a trait from the member shape or from the shape targeted by the member.

If the shape is not a member, then the method functions the same as Shape.findTrait(String).

Overrides:

findMemberTrait in class Shape

Parameters:

model - Model used to find member targets.

traitName - Trait name to get.

Returns:

Returns the optionally found trait on the shape or member.

See Also:

Shape.findTrait(String)