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:

java.lang.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 and Description
static class	StructureShape.Builder Builder used to create a StructureShape.

Method Summary

Modifier and Type	Method and Description
<R> R	accept(ShapeVisitor<R> visitor) Dispatches the shape to the appropriate ShapeVisitor method.
java.util.Optional<StructureShape>	asStructureShape()
static StructureShape.Builder	builder()
java.util.Map<java.lang.String,MemberShape>	getAllMembers() Gets the members of the shape, including mixin members.
ShapeType	getType() Gets the type of the shape.
StructureShape.Builder	toBuilder()

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

asBigDecimalShape, asBigIntegerShape, asBlobShape, asBooleanShape, asByteShape, asDocumentShape, asDoubleShape, asEnumShape, asFloatShape, asIntegerShape, asIntEnumShape, asListShape, asLongShape, asMapShape, asMemberShape, asOperationShape, asResourceShape, asServiceShape, asSetShape, asShortShape, asStringShape, asTimestampShape, asUnionShape, compareTo, equals, expectTrait, findMemberTrait, findTrait, findTrait, getAllTraits, getId, getIntroducedTraits, getMember, getMemberNames, getMemberTrait, getMixins, getRequiredMembers, getSourceLocation, getTags, getTrait, hashCode, hasTrait, hasTrait, hasTrait, isBigDecimalShape, isBigIntegerShape, isBlobShape, isBooleanShape, isByteShape, isDocumentShape, isDoubleShape, isEnumShape, isFloatShape, isIntegerShape, isIntEnumShape, isListShape, isLongShape, isMapShape, isMemberShape, isOperationShape, isResourceShape, isServiceShape, isSetShape, isShortShape, isStringShape, isStructureShape, isTimestampShape, isUnionShape, members, shapeToBuilder, toShapeId, toString, validateMemberShapeIds, validateMixins

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.smithy.model.FromSourceLocation

compare

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

hasTag

Method Detail

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> visitor)

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:

visitor - ShapeVisitor to use.

Returns:

Returns the result.

asStructureShape

public java.util.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 java.util.Map<java.lang.String,MemberShape> getAllMembers()

Description copied from class: Shape

Gets the members of the shape, including mixin members.

Overrides:

getAllMembers in class Shape

Returns:

Returns the immutable member map.