software.amazon.smithy.model.traits

Class PropertyTrait

java.lang.Object

software.amazon.smithy.model.traits.AbstractTrait

software.amazon.smithy.model.traits.PropertyTrait

All Implemented Interfaces:

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

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

Configures how a structure member maps to a resource property.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PropertyTrait.Builder
static class	PropertyTrait.Provider

Field Summary

Fields

Modifier and Type	Field and Description
static ShapeId	ID

Method Summary

Modifier and Type	Method and Description
static PropertyTrait.Builder	builder()
protected Node	createNode() The result of toNode is used for hashCodes and equality.
java.util.Optional<java.lang.String>	getName()
PropertyTrait.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

flatMapStream, getIdiomaticTraitName, getIdiomaticTraitName, isSynthetic, makeAbsoluteName, makeAbsoluteName

Methods inherited from interface software.amazon.smithy.model.FromSourceLocation

compare

Field Detail

ID

public static final ShapeId ID

Method Detail

getName

public java.util.Optional<java.lang.String> getName()

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.

builder

public static PropertyTrait.Builder builder()

toBuilder

public PropertyTrait.Builder toBuilder()

Specified by:

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