Package software.amazon.smithy.model.shapes

Class UnionShape.Builder

java.lang.Object

software.amazon.smithy.model.shapes.AbstractShapeBuilder<B,S>

software.amazon.smithy.model.shapes.UnionShape.Builder

All Implemented Interfaces:

FromSourceLocation, SmithyBuilder<UnionShape>

Enclosing class:

UnionShape

public static final class UnionShape.Builder
extends AbstractShapeBuilder<B,S>

Builder used to create a UnionShape.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
UnionShape.Builder	addMember(String memberName, ShapeId target)	Adds a member to the builder.
UnionShape.Builder	addMember(String memberName, ShapeId target, Consumer<MemberShape.Builder> memberUpdater)	Adds a member to the builder.
UnionShape.Builder	addMember(MemberShape member)	Adds a member to the builder.
UnionShape	build()	Creates an immutable object that is created from the properties that have been set on the builder.
UnionShape.Builder	clearMembers()	Removes all members from the shape.
ShapeType	getShapeType()	Gets the type of shape being built.
final UnionShape.Builder	id(ShapeId shapeId)	Sets the shape ID of the shape.
UnionShape.Builder	members(Collection<MemberShape> members)	Replaces the members of the builder.
UnionShape.Builder	removeMember(String member)	Removes a member by name.

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

addTrait, addTraits, clearTraits, getId, getSourceLocation, id, removeTrait, removeTrait, source, source, traits

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

build

public UnionShape build()

Description copied from interface: SmithyBuilder

Creates an immutable object that is created from the properties that have been set on the builder.

Returns:

an instance of T

getShapeType

public ShapeType getShapeType()

Description copied from class: AbstractShapeBuilder

Gets the type of shape being built.

Specified by:

getShapeType in class AbstractShapeBuilder<UnionShape.Builder,UnionShape>

Returns:

Returns the shape type.

id

public final UnionShape.Builder id(ShapeId shapeId)

Description copied from class: AbstractShapeBuilder

Sets the shape ID of the shape.

Overrides:

id in class AbstractShapeBuilder<B extends software.amazon.smithy.model.shapes.NamedMembersShape.Builder<?,?>,S extends software.amazon.smithy.model.shapes.NamedMembersShape>

Parameters:

shapeId - Shape ID to set.

Returns:

Returns the builder.

members

public UnionShape.Builder members(Collection<MemberShape> members)

Replaces the members of the builder.

Parameters:

members - Members to add to the builder.

Returns:

Returns the builder.

clearMembers

public UnionShape.Builder clearMembers()

Removes all members from the shape.

Returns:

Returns the builder.

addMember

public UnionShape.Builder addMember(MemberShape member)

Adds a member to the builder.

Overrides:

addMember in class AbstractShapeBuilder<B extends software.amazon.smithy.model.shapes.NamedMembersShape.Builder<?,?>,S extends software.amazon.smithy.model.shapes.NamedMembersShape>

Parameters:

member - Shape targeted by the member.

Returns:

Returns the builder.

addMember

public UnionShape.Builder addMember(String memberName,
 ShapeId target)

Adds a member to the builder.

Parameters:

memberName - Member name to add.

target - Target of the member.

Returns:

Returns the builder.

addMember

public UnionShape.Builder addMember(String memberName,
 ShapeId target,
 Consumer<MemberShape.Builder> memberUpdater)

Adds a member to the builder.

Parameters:

memberName - Member name to add.

target - Target of the member.

memberUpdater - Consumer that can update the created member shape.

Returns:

Returns the builder.

removeMember

public UnionShape.Builder removeMember(String member)

Removes a member by name.

Parameters:

member - Member name to remove.

Returns:

Returns the builder.