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:

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	Description
static 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.
java.util.Optional<StructureShape>	asStructureShape()
static StructureShape.Builder	builder()
boolean	equals(java.lang.Object other)
java.util.Map<java.lang.String,MemberShape>	getAllMembers()	Gets the members of the structure.
java.util.Optional<MemberShape>	getMember(java.lang.String name)	Get a specific member by name.
java.util.List<java.lang.String>	getMemberNames()	Returns a list of member names in the order in which they were added.
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, findTrait, findTrait, getAllTraits, getId, getSourceLocation, getTags, getTrait, getType, 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, visitor

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 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 java.util.Optional<StructureShape> asStructureShape()

Overrides:

asStructureShape in class Shape

Returns:

Optionally returns the shape as a StructureShape.

getAllMembers

public java.util.Map<java.lang.String,MemberShape> getAllMembers()

Gets the members of the structure.

Returns:

Returns the immutable member map.

getMemberNames

public java.util.List<java.lang.String> getMemberNames()

Returns a list of member names in the order in which they were added.

Returns:

Returns list of member names.

getMember

public java.util.Optional<MemberShape> getMember(java.lang.String name)

Get a specific member by name.

Parameters:

name - Name of the member to retrieve.

Returns:

Returns the optional member.

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class Shape