software.amazon.smithy.model.shapes

Class CollectionShape

java.lang.Object

software.amazon.smithy.model.shapes.Shape

software.amazon.smithy.model.shapes.CollectionShape

All Implemented Interfaces:

java.lang.Comparable<Shape>, FromSourceLocation, ToShapeId, software.amazon.smithy.utils.Tagged

Direct Known Subclasses:

ListShape

public abstract class CollectionShape
extends Shape

Abstract class representing Set and List shapes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CollectionShape.Builder<B extends CollectionShape.Builder<B,S>,S extends CollectionShape> Builder used to create a List or Set shape.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,MemberShape>	getAllMembers() Gets the members of the shape, including mixin members.
MemberShape	getMember() Get the member shape of the collection.
java.util.Optional<MemberShape>	getMember(java.lang.String memberName) Get a specific member by name.

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

accept, asBigDecimalShape, asBigIntegerShape, asBlobShape, asBooleanShape, asByteShape, asDocumentShape, asDoubleShape, asEnumShape, asFloatShape, asIntegerShape, asIntEnumShape, asListShape, asLongShape, asMapShape, 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, getType, 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

getMember

public final MemberShape getMember()

Get the member shape of the collection.

Returns:

Returns the member shape.

getMember

public java.util.Optional<MemberShape> getMember(java.lang.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 final 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.