Class ExternalDocumentationTrait
java.lang.Object
software.amazon.smithy.model.traits.AbstractTrait
software.amazon.smithy.model.traits.ExternalDocumentationTrait
- All Implemented Interfaces:
FromSourceLocation
,ToNode
,ToShapeId
,Trait
,software.amazon.smithy.utils.ToSmithyBuilder<ExternalDocumentationTrait>
public final class ExternalDocumentationTrait
extends AbstractTrait
implements software.amazon.smithy.utils.ToSmithyBuilder<ExternalDocumentationTrait>
Provides named links to external documentation.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
Builder used to create the external documentation trait.static final class
-
Field Summary
-
Constructor Summary
-
Method Summary
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
-
-
Constructor Details
-
ExternalDocumentationTrait
-
-
Method Details
-
getUrls
Gets the external documentation names and links.- Returns:
- returns the external documentation mapping.
-
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 classAbstractTrait
- Returns:
- Returns the trait as a node.
-
toBuilder
- Specified by:
toBuilder
in interfacesoftware.amazon.smithy.utils.ToSmithyBuilder<ExternalDocumentationTrait>
-
builder
- Returns:
- Returns an external documentation trait builder.
-