Package software.amazon.smithy.model.shapes

Class StructureShape

java.lang.Object

software.amazon.smithy.model.shapes.Shape

software.amazon.smithy.model.shapes.StructureShape

All Implemented Interfaces:

Comparable<Shape>, FromSourceLocation, ToShapeId, software.amazon.smithy.utils.Tagged, software.amazon.smithy.utils.ToSmithyBuilder<StructureShape>

public final class StructureShape
extends Shape
implements software.amazon.smithy.utils.ToSmithyBuilder<StructureShape>

Structure shape that maps shape names to members.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
<R> R	accept(ShapeVisitor<R> cases)	Dispatches the shape to the appropriate ShapeVisitor method.
Optional<StructureShape>	asStructureShape()
static StructureShape.Builder	builder()
boolean	equals(Object other)
Map<String,MemberShape>	getAllMembers()	Gets the members of the shape.
Optional<MemberShape>	getMember(String name)	Get a specific member by name.
List<String>	getMemberNames()	Returns an ordered list of member names based on the order they are defined in the model.
ShapeType	getType()	Gets the type of the shape.
Collection<MemberShape>	members()	Gets all of the members contained in the shape.
StructureShape.Builder	toBuilder()

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

asBigDecimalShape, asBigIntegerShape, asBlobShape, asBooleanShape, asByteShape, asDocumentShape, asDoubleShape, asFloatShape, asIntegerShape, asListShape, asLongShape, asMapShape, asMemberShape, asOperationShape, asResourceShape, asServiceShape, asSetShape, asShortShape, asStringShape, asTimestampShape, asUnionShape, compareTo, expectTrait, findMemberTrait, findTrait, findTrait, getAllTraits, getId, getMemberTrait, 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, 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 Details

builder

public static StructureShape.Builder builder()

Returns:

Creates a new StructureShape builder.

toBuilder

public StructureShape.Builder toBuilder()

Specified by:

toBuilder in interface software.amazon.smithy.utils.ToSmithyBuilder<StructureShape>

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.

asStructureShape

public Optional<StructureShape> asStructureShape()

Overrides:

asStructureShape in class Shape

Returns:

Optionally returns the shape as a StructureShape.

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;

getAllMembers

public Map<String,MemberShape> getAllMembers()

Gets the members of the shape.

Returns:

Returns the immutable member map.

getMemberNames

public List<String> getMemberNames()

Returns an ordered list of member names based on the order they are defined in the model.

Returns:

Returns an immutable list of member names.

getMember

public Optional<MemberShape> getMember(String name)

Get a specific member by name.

Parameters:

name - Name of the member to retrieve.

Returns:

Returns the optional member.

members

public Collection<MemberShape> members()

Description copied from class: Shape

Gets all of the members contained in the shape.

Overrides:

members in class Shape

Returns:

Returns the members contained in the shape (if any).

equals

public boolean equals(Object other)

Overrides:

equals in class Shape