Package software.amazon.smithy.model.knowledge

Class IdentifierBindingIndex

java.lang.Object

software.amazon.smithy.model.knowledge.IdentifierBindingIndex

All Implemented Interfaces:

KnowledgeIndex

public final class IdentifierBindingIndex
extends java.lang.Object
implements KnowledgeIndex

Index of operation shapes to the identifiers bound to the operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IdentifierBindingIndex.BindingType

Constructor Summary

Constructors

Constructor	Description
IdentifierBindingIndex(Model model)

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,java.lang.String>	getOperationBindings(ToShapeId resource, ToShapeId operation)	Deprecated. Use getOperationInputBindings(software.amazon.smithy.model.shapes.ToShapeId, software.amazon.smithy.model.shapes.ToShapeId) instead.
IdentifierBindingIndex.BindingType	getOperationBindingType(ToShapeId resource, ToShapeId operation)	Gets the identifier binding type of an operation to a resource.
java.util.Map<java.lang.String,java.lang.String>	getOperationInputBindings(ToShapeId resource, ToShapeId operation)	Gets a map of identifier names to input member names that provide a value for that identifier.
java.util.Map<java.lang.String,java.lang.String>	getOperationOutputBindings(ToShapeId resource, ToShapeId operation)	Gets a map of identifier names to output member names that provide a value for that identifier.
static IdentifierBindingIndex	of(Model model)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IdentifierBindingIndex

public IdentifierBindingIndex(Model model)

Method Detail

of

public static IdentifierBindingIndex of(Model model)

getOperationBindingType

public IdentifierBindingIndex.BindingType getOperationBindingType(ToShapeId resource,
                                                                  ToShapeId operation)

Gets the identifier binding type of an operation to a resource.

The NONE Binding type is returned if the resource can't be found, the operation can't be found, or if the operation is not bound to the resource.

Parameters:

resource - Shape ID of a resource.

operation - Shape ID of an operation.

Returns:

Returns the binding type of the operation.

getOperationInputBindings

public java.util.Map<java.lang.String,java.lang.String> getOperationInputBindings(ToShapeId resource,
                                                                                        ToShapeId operation)

Gets a map of identifier names to input member names that provide a value for that identifier.

Parameters:

resource - Shape ID of a resource.

operation - Shape ID of an operation.

Returns:

Returns the identifier bindings map or an empty map if the binding is invalid or cannot be found.

getOperationOutputBindings

public java.util.Map<java.lang.String,java.lang.String> getOperationOutputBindings(ToShapeId resource,
                                                                                         ToShapeId operation)

Gets a map of identifier names to output member names that provide a value for that identifier.

Parameters:

resource - Shape ID of a resource.

operation - Shape ID of an operation.

Returns:

Returns the identifier bindings map or an empty map if the binding is invalid or cannot be found.

getOperationBindings

@Deprecated
public java.util.Map<java.lang.String,java.lang.String> getOperationBindings(ToShapeId resource,
                                                                                   ToShapeId operation)

Deprecated.

Use getOperationInputBindings(software.amazon.smithy.model.shapes.ToShapeId, software.amazon.smithy.model.shapes.ToShapeId) instead.

Gets a map of identifier names to input member names that provide a value for that identifier.

Parameters:

resource - Shape ID of a resource.

operation - Shape ID of an operation.

Returns:

Returns the identifier bindings map or an empty map if the binding is invalid or cannot be found.