Package software.amazon.smithy.model.shapes

Class UnionShape

java.lang.Object

software.amazon.smithy.model.shapes.Shape

software.amazon.smithy.model.shapes.UnionShape

All Implemented Interfaces:

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

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

Tagged union shape that maps member names to member definitions.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
<R> R	accept(ShapeVisitor<R> cases)	Dispatches the shape to the appropriate ShapeVisitor method.
java.util.Optional<UnionShape>	asUnionShape()
static UnionShape.Builder	builder()
boolean	equals(java.lang.Object other)
java.util.Map<java.lang.String,MemberShape>	getAllMembers()	Gets the members of the shape.
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.
java.util.Collection<MemberShape>	members()	Gets all of the members contained in the shape.
UnionShape.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, asStructureShape, asTimestampShape, compareTo, expectTrait, findMemberTrait, findMemberTrait, findTrait, findTrait, getAllTraits, getId, getMemberTrait, getMemberTrait, 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 UnionShape.Builder builder()

toBuilder

public UnionShape.Builder toBuilder()

Specified by:

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

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.

asUnionShape

public java.util.Optional<UnionShape> asUnionShape()

Overrides:

asUnionShape in class Shape

Returns:

Optionally returns the shape as a UnionShape.

getAllMembers

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

Gets the members of the shape.

Returns:

Returns the immutable member map.

getMemberNames

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

Returns a list of member names.

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.

members

public java.util.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(java.lang.Object other)

Overrides:

equals in class Shape