Package software.amazon.smithy.model.traits

Class LengthTrait

java.lang.Object

software.amazon.smithy.model.traits.AbstractTrait

software.amazon.smithy.model.traits.LengthTrait

All Implemented Interfaces:

FromSourceLocation, ToNode, ToShapeId, Trait, software.amazon.smithy.utils.ToSmithyBuilder<LengthTrait>

public final class LengthTrait
extends AbstractTrait
implements software.amazon.smithy.utils.ToSmithyBuilder<LengthTrait>

Constrains a shape to minimum and maximum number of elements or size.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	LengthTrait.Builder	Builder used to create a LongTrait.
static final class	LengthTrait.Provider

Field Summary

Fields

Modifier and Type	Field	Description
static final ShapeId	ID

Method Summary

Modifier and Type	Method	Description
static LengthTrait.Builder	builder()
protected Node	createNode()	The result of toNode is used for hashCodes and equality.
Optional<Long>	getMax()	Gets the max value.
Optional<Long>	getMin()	Gets the min value.
LengthTrait.Builder	toBuilder()

Methods inherited from class software.amazon.smithy.model.traits.AbstractTrait

equals, getSourceLocation, hashCode, setNodeCache, toNode, toShapeId, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.smithy.model.traits.Trait

isSynthetic

Field Details

ID

public static final ShapeId ID

Method Details

getMin

public Optional<Long> getMin()

Gets the min value.

Returns:

returns the optional min value.

getMax

public Optional<Long> getMax()

Gets the max value.

Returns:

returns the optional max value.

createNode

protected Node createNode()

Description copied from class: AbstractTrait

The result of toNode is used for hashCodes and equality. Subclasses must implement createNode to turn the trait into a Node. This is then cached for subsequent retrievals.

Specified by:

createNode in class AbstractTrait

Returns:

Returns the trait as a node.

toBuilder

public LengthTrait.Builder toBuilder()

Specified by:

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

builder

public static LengthTrait.Builder builder()

Returns:

Returns a builder used to create a length trait.