Package software.amazon.smithy.protocoltests.traits.eventstream

Class EventStreamTestsTrait

java.lang.Object

software.amazon.smithy.model.traits.AbstractTrait

software.amazon.smithy.protocoltests.traits.eventstream.EventStreamTestsTrait

All Implemented Interfaces:

FromSourceLocation, ToNode, ToShapeId, Trait

public final class EventStreamTestsTrait
extends AbstractTrait

Defines a list of protocol tests that enforce how an event stream is serialized / deserialized for a specific protocol.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	EventStreamTestsTrait.Provider

Field Summary

Fields

Modifier and Type	Field	Description
static final ShapeId	ID

Constructor Summary

Constructors

Constructor	Description
EventStreamTestsTrait(List<EventStreamTestCase> testCases)
EventStreamTestsTrait(SourceLocation sourceLocation, List<EventStreamTestCase> testCases)

Method Summary

Modifier and Type	Method	Description
protected Node	createNode()	The result of toNode is used for hashCodes and equality.
boolean	equals(Object o)
List<EventStreamTestCase>	getTestCases()
List<EventStreamTestCase>	getTestCasesFor(AppliesTo appliesTo)	Gets all test cases that apply to a client or server.
int	hashCode()

Methods inherited from class software.amazon.smithy.model.traits.AbstractTrait

getSourceLocation, 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

public static final ShapeId ID

Constructor Details

EventStreamTestsTrait

public EventStreamTestsTrait(List<EventStreamTestCase> testCases)

EventStreamTestsTrait

public EventStreamTestsTrait(SourceLocation sourceLocation,
 List<EventStreamTestCase> testCases)

Method Details

getTestCases

public List<EventStreamTestCase> getTestCases()

Returns:

Returns all test cases.

getTestCasesFor

public List<EventStreamTestCase> getTestCasesFor(AppliesTo appliesTo)

Gets all test cases that apply to a client or server.

Test cases that define an appliesTo member are tests that should only be implemented by clients or servers. It is assumed that test cases that do not define an appliesTo member are implemented by both client and server implementations.

Parameters:

appliesTo - The type of test case to retrieve.

Returns:

Returns the matching test cases.

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractTrait

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractTrait

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.