Package software.amazon.smithy.model.shapes

Class MapShape

java.lang.Object

software.amazon.smithy.model.shapes.Shape

software.amazon.smithy.model.shapes.MapShape

All Implemented Interfaces:

Comparable<Shape>, FromSourceLocation, ToShapeId, Tagged, ToSmithyBuilder<MapShape>

public final class MapShape
extends Shape
implements ToSmithyBuilder<MapShape>

Represents a map shape.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
<R> R	accept(ShapeVisitor<R> visitor)	Dispatches the shape to the appropriate ShapeVisitor method.
Optional<MapShape>	asMapShape()
static MapShape.Builder	builder()
Map<String,MemberShape>	getAllMembers()	Gets the members of the shape, including mixin members.
MemberShape	getKey()	Get the key member shape of the map.
Optional<MemberShape>	getMember(String memberName)	Get a specific member by name.
ShapeType	getType()	Gets the type of the shape.
MemberShape	getValue()	Get the value member shape of the map.
MapShape.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, asEnumShape, asFloatShape, asIntegerShape, asIntEnumShape, asListShape, asLongShape, asMemberShape, asOperationShape, asResourceShape, asServiceShape, asSetShape, asShortShape, asStringShape, asStructureShape, asTimestampShape, asUnionShape, compareTo, equals, expectTrait, findMemberTrait, findTrait, findTrait, getAllTraits, getId, getIntroducedTraits, 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.utils.Tagged

hasTag

Method Details

builder

public static MapShape.Builder builder()

toBuilder

public MapShape.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<MapShape>

Returns:

a builder for type T

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.

asMapShape

public Optional<MapShape> asMapShape()

Overrides:

asMapShape in class Shape

Returns:

Optionally returns the shape as a MapShape.

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;

getValue

public MemberShape getValue()

Get the value member shape of the map.

Returns:

Returns the value member shape.

getKey

public MemberShape getKey()

Get the key member shape of the map.

Returns:

Returns the key member shape.

getMember

public Optional<MemberShape> getMember(String memberName)

Description copied from class: Shape

Get a specific member by name.

Shapes with no members return an empty Optional.

Overrides:

getMember in class Shape

Parameters:

memberName - Name of the member to retrieve.

Returns:

Returns the optional member.

getAllMembers

public Map<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.