ReferencesTrait (smithy-model 0.9.8 API)

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

All Implemented Interfaces:

FromSourceLocation, ToNode, ToShapeId, Trait, software.amazon.smithy.utils.ToSmithyBuilder<ReferencesTrait>
```
public final class ReferencesTrait
extends AbstractTrait
implements software.amazon.smithy.utils.ToSmithyBuilder<ReferencesTrait>
```
Defines references to resources within a structure.

See Also:

ReferencesTraitValidator

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`ReferencesTrait.Builder`	Builder use to create the references trait.
`static class`	`ReferencesTrait.Provider`
`static class`	`ReferencesTrait.Reference`	Reference to a resource.

Field Summary

Fields
Modifier and Type Field Description

static ShapeId ID

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ReferencesTrait.Builder`	`builder()`
`protected Node`	`createNode()`	The result of toNode is used for hashCodes and equality.
`java.util.List<ReferencesTrait.Reference>`	`getReferences()`	Gets the references.
`java.util.List<ReferencesTrait.Reference>`	`getResourceReferences(ShapeId shapeId)`	Gets a list of all references to a particular shape.
`ReferencesTrait.Builder`	`toBuilder()`

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
```
- Method Detail
  - getReferences
```
public java.util.List<ReferencesTrait.Reference> getReferences()
```
    Gets the references.
    
    Returns:
    
    Returns the unmodifiable list of references.
  - getResourceReferences
```
public java.util.List<ReferencesTrait.Reference> getResourceReferences(ShapeId shapeId)
```
    Gets a list of all references to a particular shape.
    
    Parameters:
    
    shapeId - Shape ID to search for.
    
    Returns:
    
    Returns the list of found references.
  - 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 ReferencesTrait.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface software.amazon.smithy.utils.ToSmithyBuilder<ReferencesTrait>
  - builder
```
public static ReferencesTrait.Builder builder()
```
    Returns:
    
    Returns a builder used to create a references trait.