ExternalDocumentationTrait (Smithy API 1.0.6)

java.lang.Object
- software.amazon.smithy.model.traits.AbstractTrait
- - software.amazon.smithy.model.traits.ExternalDocumentationTrait

All Implemented Interfaces:

FromSourceLocation, ToNode, ToShapeId, Trait, ToSmithyBuilder<ExternalDocumentationTrait>
```
public final class ExternalDocumentationTrait
extends AbstractTrait
implements ToSmithyBuilder<ExternalDocumentationTrait>
```
Provides named links to external documentation.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`ExternalDocumentationTrait.Builder`	Builder used to create the external documentation trait.
`static class`	`ExternalDocumentationTrait.Provider`

Field Summary

Fields
Modifier and Type Field Description

static ShapeId ID

Constructor Summary

Constructors
Constructor Description

ExternalDocumentationTrait(ExternalDocumentationTrait.Builder builder)

Method Summary

Modifier and Type	Method	Description
`static ExternalDocumentationTrait.Builder`	`builder()`
`protected Node`	`createNode()`	The result of toNode is used for hashCodes and equality.
`java.util.Map<java.lang.String,java.lang.String>`	`getUrls()`	Gets the external documentation names and links.
`ExternalDocumentationTrait.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, toNode, toShapeId, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - ID
```
public static final ShapeId ID
```
- Constructor Detail
  - ExternalDocumentationTrait
```
public ExternalDocumentationTrait(ExternalDocumentationTrait.Builder builder)
```
- Method Detail
  - getUrls
```
public java.util.Map<java.lang.String,java.lang.String> getUrls()
```
    Gets the external documentation names and links.
    
    Returns:
    
    returns the external documentation mapping.
  - 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 ExternalDocumentationTrait.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<ExternalDocumentationTrait>
    
    Returns:
    
    a builder for type T
  - builder
```
public static ExternalDocumentationTrait.Builder builder()
```
    Returns:
    
    Returns an external documentation trait builder.