Package software.amazon.smithy.model.shapes

Class OperationShape.Builder

java.lang.Object

software.amazon.smithy.model.shapes.AbstractShapeBuilder<OperationShape.Builder,OperationShape>

software.amazon.smithy.model.shapes.OperationShape.Builder

All Implemented Interfaces:

FromSourceLocation, SmithyBuilder<OperationShape>

Enclosing class:

OperationShape

public static final class OperationShape.Builder
extends AbstractShapeBuilder<OperationShape.Builder,OperationShape>

Builder used to create a OperationShape.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
OperationShape.Builder	addError(java.lang.String errorShapeId)	Adds an error to the operation.
OperationShape.Builder	addError(ToShapeId errorShapeId)	Adds an error to the operation.
OperationShape.Builder	addErrors(java.util.Collection<ShapeId> errorShapeIds)	Adds an each of the errors to the operation.
OperationShape	build()	Creates an immutable object that is created from the properties that have been set on the builder.
OperationShape.Builder	clearErrors()	Removes all errors.
OperationShape.Builder	errors(java.util.Collection<ShapeId> errorShapeIds)	Sets and replaces the errors of the operation.
OperationShape.Builder	flattenMixins()	Removes mixins from a shape and flattens them into the shape.
ShapeType	getShapeType()	Gets the type of shape being built.
OperationShape.Builder	input(ToShapeId inputShape)	Sets the input shape ID of the operation.
OperationShape.Builder	output(ToShapeId outputShape)	Sets the output shape ID of the operation.
OperationShape.Builder	removeError(ToShapeId errorShapeId)	Removes an error by Shape ID.

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

addMember, addMixin, addTrait, addTraits, clearMembers, clearMixins, clearTraits, getAllTraits, getId, getSourceLocation, id, id, mixins, removeMixin, removeTrait, removeTrait, source, source, traits

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

getShapeType

public ShapeType getShapeType()

Description copied from class: AbstractShapeBuilder

Gets the type of shape being built.

Specified by:

getShapeType in class AbstractShapeBuilder<OperationShape.Builder,OperationShape>

Returns:

Returns the shape type.

input

public OperationShape.Builder input(ToShapeId inputShape)

Sets the input shape ID of the operation.

Parameters:

inputShape - Shape ID that MUST reference a structure.

Returns:

Returns the builder.

output

public OperationShape.Builder output(ToShapeId outputShape)

Sets the output shape ID of the operation.

Parameters:

outputShape - Shape ID that MUST reference a structure.

Returns:

Returns the builder.

errors

public OperationShape.Builder errors(java.util.Collection<ShapeId> errorShapeIds)

Sets and replaces the errors of the operation.

Parameters:

errorShapeIds - Error shape IDs to set.

Returns:

Returns the builder.

addError

public OperationShape.Builder addError(ToShapeId errorShapeId)

Adds an error to the operation.

Parameters:

errorShapeId - Error shape ID to add.

Returns:

Returns the builder.

addError

public OperationShape.Builder addError(java.lang.String errorShapeId)

Adds an error to the operation.

Parameters:

errorShapeId - Error shape ID to add.

Returns:

Returns the builder.

Throws:

ShapeIdSyntaxException - if the shape ID is invalid.

addErrors

public OperationShape.Builder addErrors(java.util.Collection<ShapeId> errorShapeIds)

Adds an each of the errors to the operation.

Parameters:

errorShapeIds - Error shape IDs to add.

Returns:

Returns the builder.

removeError

public OperationShape.Builder removeError(ToShapeId errorShapeId)

Removes an error by Shape ID.

Parameters:

errorShapeId - Error shape ID to remove.

Returns:

Returns the builder.

clearErrors

public OperationShape.Builder clearErrors()

Removes all errors.

Returns:

Returns the builder.

build

public OperationShape 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

flattenMixins

public OperationShape.Builder flattenMixins()

Description copied from class: AbstractShapeBuilder

Removes mixins from a shape and flattens them into the shape.

Flattening a mixin into a shape copies the traits and members of a mixin onto the shape, effectively resulting in the same shape but with no trace of the mixin relationship.

Overrides:

flattenMixins in class AbstractShapeBuilder<OperationShape.Builder,OperationShape>

Returns:

Returns the updated builder.