software.amazon.smithy.model.traits

Class AbstractTrait

java.lang.Object

software.amazon.smithy.model.traits.AbstractTrait

All Implemented Interfaces:

FromSourceLocation, ToNode, ToShapeId, Trait

Direct Known Subclasses:

AuthDefinitionTrait, AuthTrait, CorsTrait, DeprecatedTrait, DynamicTrait, EndpointTrait, EnumTrait, ExamplesTrait, ExternalDocumentationTrait, HttpApiKeyAuthTrait, HttpChecksumTrait, HttpErrorTrait, HttpTrait, IdRefTrait, LengthTrait, PaginatedTrait, ProtocolDefinitionTrait, RangeTrait, RecommendedTrait, ReferencesTrait, RetryableTrait, StringListTrait, StringTrait, TraitDefinition, XmlNamespaceTrait

public abstract class AbstractTrait
extends java.lang.Object
implements Trait

Base implementation of traits.

This implementation provides an equals(java.lang.Object) and hashCode() that should work for most traits that extend from this base class. Note that equality for traits that extend from this type are not based on the concrete class, but rather the trait name and the trait's ToNode representation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractTrait.Provider Basic provider implementation that returns the name of the provided trait.

Constructor Summary

Constructors

Constructor and Description
AbstractTrait(ShapeId id, FromSourceLocation sourceLocation)

Method Summary

Modifier and Type	Method and Description
protected abstract Node	createNode() The result of toNode is used for hashCodes and equality.
boolean	equals(java.lang.Object other)
SourceLocation	getSourceLocation() Gets the source location of a value.
int	hashCode()
Node	toNode() Converts a value to a Node.
ShapeId	toShapeId() Gets the shape ID of the trait.
java.lang.String	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, makeAbsoluteName, makeAbsoluteName

Constructor Detail

AbstractTrait

public AbstractTrait(ShapeId id,
                     FromSourceLocation sourceLocation)

Parameters:

id - ID of the trait.

sourceLocation - Where the trait was defined.

Method Detail

toShapeId

public final ShapeId toShapeId()

Description copied from interface: Trait

Gets the shape ID of the trait.

Specified by:

toShapeId in interface ToShapeId

Specified by:

toShapeId in interface Trait

Returns:

Returns the fully-qualified shape ID of the trait.

getSourceLocation

public final SourceLocation getSourceLocation()

Description copied from interface: FromSourceLocation

Gets the source location of a value.

Specified by:

getSourceLocation in interface FromSourceLocation

Returns:

Returns the source location of the value.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toNode

public final Node toNode()

Description copied from interface: ToNode

Converts a value to a Node.

Specified by:

toNode in interface ToNode

Returns:

Returns the creates Node.

createNode

protected abstract Node createNode()

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.

Returns:

Returns the trait as a node.