Package software.amazon.smithy.model.traits

Class UnstableFeaturesTrait

java.lang.Object

software.amazon.smithy.model.traits.AbstractTrait

software.amazon.smithy.model.traits.UnstableFeaturesTrait

All Implemented Interfaces:

FromSourceLocation, ToNode, ToShapeId, Trait, ToSmithyBuilder<UnstableFeaturesTrait>

public final class UnstableFeaturesTrait
extends AbstractTrait
implements ToSmithyBuilder<UnstableFeaturesTrait>

Defines the preview features offered by a service, keyed by feature id.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	UnstableFeaturesTrait.Builder
static final class	UnstableFeaturesTrait.Provider
static final class	UnstableFeaturesTrait.UnstableFeatureInfo	The metadata describing a single unstable feature.
static enum	UnstableFeaturesTrait.UnstableReason	The reason why a feature is unstable.

Field Summary

Fields

Modifier and Type	Field	Description
static final ShapeId	ID

Method Summary

Modifier and Type	Method	Description
static UnstableFeaturesTrait.Builder	builder()
protected Node	createNode()	The result of toNode is used for hashCodes and equality.
Optional<UnstableFeaturesTrait.UnstableFeatureInfo>	getFeature(String featureId)	Gets the metadata for a specific feature id.
Map<String,UnstableFeaturesTrait.UnstableFeatureInfo>	getFeatures()	Gets the map of feature id to feature metadata.
UnstableFeaturesTrait.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.

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

builder

public static UnstableFeaturesTrait.Builder builder()

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 UnstableFeaturesTrait.Builder toBuilder()

Description copied from interface: ToSmithyBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToSmithyBuilder<UnstableFeaturesTrait>

Returns:

a builder for type T

getFeatures

public Map<String,UnstableFeaturesTrait.UnstableFeatureInfo> getFeatures()

Gets the map of feature id to feature metadata.

Returns:

Returns an unmodifiable map.

getFeature

public Optional<UnstableFeaturesTrait.UnstableFeatureInfo> getFeature(String featureId)

Gets the metadata for a specific feature id.

Parameters:

featureId - Feature id to look up.

Returns:

Returns the optional feature metadata.