Index (smithy-diff 1.61.0 API)

A B C D E F G H I M N O P R S T U W
All Classes and Interfaces|All Packages|Serialized Form

A

AbstractDiffEvaluator - Class in software.amazon.smithy.diff.evaluators: Provides a default diff evaluator implementation with utility methods for emitting events of different severities.
AbstractDiffEvaluator() - Constructor for class software.amazon.smithy.diff.evaluators.AbstractDiffEvaluator
AddedEntityBinding - Class in software.amazon.smithy.diff.evaluators: A meta-validator that emits a NOTE when an operation resource is added to a service or resource entity.
AddedEntityBinding() - Constructor for class software.amazon.smithy.diff.evaluators.AddedEntityBinding
addedMetadata() - Method in class software.amazon.smithy.diff.Differences: Gets all added metadata.
AddedMetadata - Class in software.amazon.smithy.diff.evaluators: Creates a NOTE event when metadata is added.
AddedMetadata() - Constructor for class software.amazon.smithy.diff.evaluators.AddedMetadata
AddedOperationError - Class in software.amazon.smithy.diff.evaluators: Emits a warning when an error is added to an operation.
AddedOperationError() - Constructor for class software.amazon.smithy.diff.evaluators.AddedOperationError
AddedRequiredMember - Class in software.amazon.smithy.diff.evaluators: Validates that no members are newly created with the required trait (but no default trait) in existing structures.
AddedRequiredMember() - Constructor for class software.amazon.smithy.diff.evaluators.AddedRequiredMember
AddedServiceError - Class in software.amazon.smithy.diff.evaluators: Emits a warning when an error is added to a service.
AddedServiceError() - Constructor for class software.amazon.smithy.diff.evaluators.AddedServiceError
AddedShape - Class in software.amazon.smithy.diff.evaluators: Creates a NOTE event when a shape is added.
AddedShape() - Constructor for class software.amazon.smithy.diff.evaluators.AddedShape
addedShapes() - Method in class software.amazon.smithy.diff.Differences: Gets all added shapes.
addedShapes(Class<T>) - Method in class software.amazon.smithy.diff.Differences: Gets all of the added shapes of a specific type.
AddedTraitDefinition - Class in software.amazon.smithy.diff.evaluators: Creates a NOTE event when a trait definition is added.
AddedTraitDefinition() - Constructor for class software.amazon.smithy.diff.evaluators.AddedTraitDefinition
addedTraits() - Method in class software.amazon.smithy.diff.ChangedShape: Gets a stream of added traits.
addTestCase(SmithyDiffTestCase) - Method in class software.amazon.smithy.diff.testrunner.SmithyDiffTestSuite: Adds a test case to the test suite.
addTestCasesFromDirectory(Path) - Method in class software.amazon.smithy.diff.testrunner.SmithyDiffTestSuite: Adds test cases by crawling a directory and looking for events files that end with ".events".
addTestCasesFromUrl(URL) - Method in class software.amazon.smithy.diff.testrunner.SmithyDiffTestSuite: Convenience method for supplying a directory using a class loader.

B

builder() - Static method in class software.amazon.smithy.diff.ModelDiff: Creates a new ModelDiff.Builder that provides in-depth diff analysis.

C

ChangedDefault - Class in software.amazon.smithy.diff.evaluators
ChangedDefault() - Constructor for class software.amazon.smithy.diff.evaluators.ChangedDefault
ChangedEnumTrait - Class in software.amazon.smithy.diff.evaluators: Emits a NOTE when a new enum value is appended, emits an ERROR when an enum value is removed, emits an ERROR when an enum name changes, and emits an ERROR when a new enum value is inserted before the end of the list of existing values.
ChangedEnumTrait() - Constructor for class software.amazon.smithy.diff.evaluators.ChangedEnumTrait
ChangedLengthTrait - Class in software.amazon.smithy.diff.evaluators: Detects when the Length trait is made more restrictive by either raising the min or lowering the max.
ChangedLengthTrait() - Constructor for class software.amazon.smithy.diff.evaluators.ChangedLengthTrait
ChangedMemberOrder - Class in software.amazon.smithy.diff.evaluators: Creates a DANGER event when a structure or union member is added anywhere other than the end of the previous definition or the member order is changed.
ChangedMemberOrder() - Constructor for class software.amazon.smithy.diff.evaluators.ChangedMemberOrder
ChangedMemberTarget - Class in software.amazon.smithy.diff.evaluators: Checks for changes in the shapes targeted by a member.
ChangedMemberTarget() - Constructor for class software.amazon.smithy.diff.evaluators.ChangedMemberTarget
changedMetadata() - Method in class software.amazon.smithy.diff.Differences: Gets a stream of all changed metadata.
ChangedMetadata - Class in software.amazon.smithy.diff: Represents a change in metadata.
ChangedMetadata - Class in software.amazon.smithy.diff.evaluators: Creates a WARNING event when metadata is changed.
ChangedMetadata() - Constructor for class software.amazon.smithy.diff.evaluators.ChangedMetadata
ChangedNullability - Class in software.amazon.smithy.diff.evaluators: Validates that only backward compatible changes are made to structure member nullability to ensure that if something was previously nullable to clients then it continue to be nullable and vice versa.
ChangedNullability() - Constructor for class software.amazon.smithy.diff.evaluators.ChangedNullability
ChangedOperationInput - Class in software.amazon.smithy.diff.evaluators: Emits an ERROR when the input shape of an operation is changed to another shape.
ChangedOperationInput() - Constructor for class software.amazon.smithy.diff.evaluators.ChangedOperationInput
ChangedOperationOutput - Class in software.amazon.smithy.diff.evaluators: Emits an ERROR when the output shape of an operation is changed to another shape.
ChangedOperationOutput() - Constructor for class software.amazon.smithy.diff.evaluators.ChangedOperationOutput
ChangedRangeTrait - Class in software.amazon.smithy.diff.evaluators: Detects when the Range trait is made more restrictive by either raising the min or lowering the max.
ChangedRangeTrait() - Constructor for class software.amazon.smithy.diff.evaluators.ChangedRangeTrait
ChangedResourceIdentifiers - Class in software.amazon.smithy.diff.evaluators: Creates an ERROR event when the identifiers of a resource changes.
ChangedResourceIdentifiers() - Constructor for class software.amazon.smithy.diff.evaluators.ChangedResourceIdentifiers
ChangedShape<S extends software.amazon.smithy.model.shapes.Shape> - Class in software.amazon.smithy.diff: Represents a changed shape.
ChangedShape(S, S) - Constructor for class software.amazon.smithy.diff.ChangedShape
changedShapes() - Method in class software.amazon.smithy.diff.Differences: Gets all changed shapes.
changedShapes(Class<T>) - Method in class software.amazon.smithy.diff.Differences: Gets all changed shapes of a specific type.
ChangedShapeType - Class in software.amazon.smithy.diff.evaluators: Creates an ERROR event when the type of a shape changes.
ChangedShapeType() - Constructor for class software.amazon.smithy.diff.evaluators.ChangedShapeType
changedTraits() - Method in class software.amazon.smithy.diff.ChangedShape: Gets a stream of changed traits.
classLoader(ClassLoader) - Method in class software.amazon.smithy.diff.ModelDiff.Builder: Sets the ClassLoader used to find DiffEvaluator service providers.
compare() - Method in class software.amazon.smithy.diff.ModelDiff.Builder: Performs the diff of the old and new models.
compare(ClassLoader, Model, Model) - Static method in class software.amazon.smithy.diff.ModelDiff: Evaluates the differences between two models.
compare(Model, Model) - Static method in class software.amazon.smithy.diff.ModelDiff: Evaluates the differences between two models.
createResult(List<ValidationEvent>) - Method in class software.amazon.smithy.diff.testrunner.SmithyDiffTestCase: Creates a test case result from a list of model diff events.

D

danger(Shape, String) - Method in class software.amazon.smithy.diff.evaluators.AbstractDiffEvaluator
danger(Shape, FromSourceLocation, String) - Method in class software.amazon.smithy.diff.evaluators.AbstractDiffEvaluator
defaultParameterizedTestSource(Class<?>) - Static method in class software.amazon.smithy.diff.testrunner.SmithyDiffTestSuite: Factory method used to easily create a JUnit 5 ParameterizedTest MethodSource based on the given Class.
determineIntroducedEvents() - Method in class software.amazon.smithy.diff.ModelDiff.Result: Gets the validation events that were introduced by whatever changes were made to the new model.
determineResolvedEvents() - Method in class software.amazon.smithy.diff.ModelDiff.Result: Gets the validation events that were present in the old model but are no longer an issue in the new model.
Differences - Class in software.amazon.smithy.diff: Queryable container for detected structural differences between two models.
DiffEvaluator - Interface in software.amazon.smithy.diff: Interface used to evaluate two models and their normalized differences and return ValidationEvents that are relative to the new model.

E

equals(Object) - Method in class software.amazon.smithy.diff.ChangedMetadata
equals(Object) - Method in class software.amazon.smithy.diff.ChangedShape
equals(Object) - Method in class software.amazon.smithy.diff.Differences
equals(Object) - Method in class software.amazon.smithy.diff.ModelDiff.Result
error(Shape, String) - Method in class software.amazon.smithy.diff.evaluators.AbstractDiffEvaluator
error(Shape, FromSourceLocation, String) - Method in class software.amazon.smithy.diff.evaluators.AbstractDiffEvaluator
evaluate(Differences) - Method in interface software.amazon.smithy.diff.DiffEvaluator: Returns validation events given two models and the detected differences between them.
evaluate(Differences) - Method in class software.amazon.smithy.diff.evaluators.ChangedRangeTrait
evaluate(Differences) - Method in class software.amazon.smithy.diff.evaluators.AddedEntityBinding
evaluate(Differences) - Method in class software.amazon.smithy.diff.evaluators.AddedMetadata
evaluate(Differences) - Method in class software.amazon.smithy.diff.evaluators.AddedOperationError
evaluate(Differences) - Method in class software.amazon.smithy.diff.evaluators.AddedRequiredMember
evaluate(Differences) - Method in class software.amazon.smithy.diff.evaluators.AddedServiceError
evaluate(Differences) - Method in class software.amazon.smithy.diff.evaluators.AddedShape
evaluate(Differences) - Method in class software.amazon.smithy.diff.evaluators.AddedTraitDefinition
evaluate(Differences) - Method in class software.amazon.smithy.diff.evaluators.ChangedDefault
evaluate(Differences) - Method in class software.amazon.smithy.diff.evaluators.ChangedEnumTrait
evaluate(Differences) - Method in class software.amazon.smithy.diff.evaluators.ChangedMemberOrder
evaluate(Differences) - Method in class software.amazon.smithy.diff.evaluators.ChangedMemberTarget
evaluate(Differences) - Method in class software.amazon.smithy.diff.evaluators.ChangedMetadata
evaluate(Differences) - Method in class software.amazon.smithy.diff.evaluators.ChangedNullability
evaluate(Differences) - Method in class software.amazon.smithy.diff.evaluators.ChangedOperationInput
evaluate(Differences) - Method in class software.amazon.smithy.diff.evaluators.ChangedOperationOutput
evaluate(Differences) - Method in class software.amazon.smithy.diff.evaluators.ChangedResourceIdentifiers
evaluate(Differences) - Method in class software.amazon.smithy.diff.evaluators.ChangedShapeType
evaluate(Differences) - Method in class software.amazon.smithy.diff.evaluators.ModifiedTrait
evaluate(Differences) - Method in class software.amazon.smithy.diff.evaluators.RemovedAuthenticationScheme
evaluate(Differences) - Method in class software.amazon.smithy.diff.evaluators.RemovedEntityBinding
evaluate(Differences) - Method in class software.amazon.smithy.diff.evaluators.RemovedMetadata
evaluate(Differences) - Method in class software.amazon.smithy.diff.evaluators.RemovedOperationError
evaluate(Differences) - Method in class software.amazon.smithy.diff.evaluators.RemovedServiceError
evaluate(Differences) - Method in class software.amazon.smithy.diff.evaluators.RemovedShape
evaluate(Differences) - Method in class software.amazon.smithy.diff.evaluators.RemovedTraitDefinition
evaluate(Differences) - Method in class software.amazon.smithy.diff.evaluators.ServiceRename
evaluate(Differences) - Method in class software.amazon.smithy.diff.evaluators.TraitBreakingChange

F

from(Path, String) - Static method in class software.amazon.smithy.diff.testrunner.SmithyDiffTestCase: Creates a test case from a test case path and name.

G

getChangedTrait(Class<T>) - Method in class software.amazon.smithy.diff.ChangedShape: Gets a changed trait of a specific type.
getDifferences() - Method in class software.amazon.smithy.diff.ModelDiff.Result: Gets a queryable set of differences between two models.
getDiffEvents() - Method in class software.amazon.smithy.diff.ModelDiff.Result: Gets the diff analysis as a list of ValidationEvents.
getEventId() - Method in class software.amazon.smithy.diff.evaluators.AbstractDiffEvaluator: Gets the event ID of the evaluator.
getExpectedEvents() - Method in class software.amazon.smithy.diff.testrunner.SmithyDiffTestCase: Gets the expected validation events.
getExtraEvents() - Method in class software.amazon.smithy.diff.testrunner.SmithyDiffTestCase.Result
getFailedResults() - Method in class software.amazon.smithy.diff.testrunner.SmithyDiffTestSuite.Result
getKey() - Method in class software.amazon.smithy.diff.ChangedMetadata: Gets the key of the metadata that changed.
getMax(LengthTrait) - Method in class software.amazon.smithy.diff.evaluators.ChangedLengthTrait
getMax(RangeTrait) - Method in class software.amazon.smithy.diff.evaluators.ChangedRangeTrait
getMin(LengthTrait) - Method in class software.amazon.smithy.diff.evaluators.ChangedLengthTrait
getMin(RangeTrait) - Method in class software.amazon.smithy.diff.evaluators.ChangedRangeTrait
getName() - Method in class software.amazon.smithy.diff.testrunner.SmithyDiffTestCase: Gets the name of the test case.
getName() - Method in class software.amazon.smithy.diff.testrunner.SmithyDiffTestCase.Result
getNewModel() - Method in class software.amazon.smithy.diff.Differences: Gets the new model.
getNewModelEvents() - Method in class software.amazon.smithy.diff.ModelDiff.Result: Gets the validation events emitted when validating the new model.
getNewShape() - Method in class software.amazon.smithy.diff.ChangedShape: Gets the new shape value.
getNewValue() - Method in class software.amazon.smithy.diff.ChangedMetadata: Gets the new metadata value for this key.
getOldModel() - Method in class software.amazon.smithy.diff.Differences: Gets the old model.
getOldModelEvents() - Method in class software.amazon.smithy.diff.ModelDiff.Result: Gets the validation events emitted when validating the old model.
getOldShape() - Method in class software.amazon.smithy.diff.ChangedShape: Gets the old shape value.
getOldValue() - Method in class software.amazon.smithy.diff.ChangedMetadata: Gets the old metadata value for this key.
getPath() - Method in class software.amazon.smithy.diff.testrunner.SmithyDiffTestCase: Gets the parent path of the test case.
getShapeId() - Method in class software.amazon.smithy.diff.ChangedShape: Gets the shape ID of the changed shape.
getSourceLocation() - Method in class software.amazon.smithy.diff.ChangedMetadata
getSourceLocation() - Method in class software.amazon.smithy.diff.ChangedShape
getSuccessCount() - Method in class software.amazon.smithy.diff.testrunner.SmithyDiffTestSuite.Result
getTraitDifferences() - Method in class software.amazon.smithy.diff.ChangedShape: Gets the trait differences between the old and new shape.
getTraitType() - Method in class software.amazon.smithy.diff.evaluators.ChangedLengthTrait
getTraitType() - Method in class software.amazon.smithy.diff.evaluators.ChangedRangeTrait
getUnmatchedEvents() - Method in class software.amazon.smithy.diff.testrunner.SmithyDiffTestCase.Result

H

hashCode() - Method in class software.amazon.smithy.diff.ChangedMetadata
hashCode() - Method in class software.amazon.smithy.diff.ChangedShape
hashCode() - Method in class software.amazon.smithy.diff.Differences
hashCode() - Method in class software.amazon.smithy.diff.ModelDiff.Result

I

isDiffBreaking() - Method in class software.amazon.smithy.diff.ModelDiff.Result: Determines if the diff events contain any DANGER or ERROR events.
isInvalid() - Method in class software.amazon.smithy.diff.testrunner.SmithyDiffTestCase.Result: Checks if the result does not match expected results.
isTraitAdded(ShapeId) - Method in class software.amazon.smithy.diff.ChangedShape: Checks if the trait was added.
isTraitInBoth(ShapeId) - Method in class software.amazon.smithy.diff.ChangedShape: Checks if the given trait is in the old shape and new shape.
isTraitRemoved(ShapeId) - Method in class software.amazon.smithy.diff.ChangedShape: Checks if the trait was removed.

M

ModelDiff - Class in software.amazon.smithy.diff: Computes the difference between two models and any problems that might occur due to those differences.
ModelDiff.Builder - Class in software.amazon.smithy.diff: Builder used to construct a diff of two Smithy models.
ModelDiff.Result - Class in software.amazon.smithy.diff: The result of comparing two Smithy models.
ModifiedTrait - Class in software.amazon.smithy.diff.evaluators: Finds breaking changes related to when a trait is added, removed, or updated.
ModifiedTrait() - Constructor for class software.amazon.smithy.diff.evaluators.ModifiedTrait

N

newModel(Model) - Method in class software.amazon.smithy.diff.ModelDiff.Builder: Sets the new model to compare against.
newModel(ValidatedResult<Model>) - Method in class software.amazon.smithy.diff.ModelDiff.Builder: Sets the new model to compare against along with the validation events encountered while loading the model.
note(Shape, String) - Method in class software.amazon.smithy.diff.evaluators.AbstractDiffEvaluator
note(Shape, FromSourceLocation, String) - Method in class software.amazon.smithy.diff.evaluators.AbstractDiffEvaluator

O

oldModel(Model) - Method in class software.amazon.smithy.diff.ModelDiff.Builder: Sets the old model to compare against.
oldModel(ValidatedResult<Model>) - Method in class software.amazon.smithy.diff.ModelDiff.Builder: Sets the old model to compare against along with the validation events encountered while loading the model.

P

parameterizedTestSource() - Method in class software.amazon.smithy.diff.testrunner.SmithyDiffTestSuite: Factory method used to create a JUnit 5 ParameterizedTest MethodSource.

R

RemovedAuthenticationScheme - Class in software.amazon.smithy.diff.evaluators: TODO: Implement evaluator to find removed authentication schemes.
RemovedAuthenticationScheme() - Constructor for class software.amazon.smithy.diff.evaluators.RemovedAuthenticationScheme
RemovedEntityBinding - Class in software.amazon.smithy.diff.evaluators: A meta-validator that checks for the removal of an operation or resource binding from a service or resource.
RemovedEntityBinding() - Constructor for class software.amazon.smithy.diff.evaluators.RemovedEntityBinding
removedMetadata() - Method in class software.amazon.smithy.diff.Differences: Gets all removed metadata.
RemovedMetadata - Class in software.amazon.smithy.diff.evaluators: Creates a DANGER event when metadata is removed.
RemovedMetadata() - Constructor for class software.amazon.smithy.diff.evaluators.RemovedMetadata
RemovedOperationError - Class in software.amazon.smithy.diff.evaluators: Emits a warning when an error is removed from an operation.
RemovedOperationError() - Constructor for class software.amazon.smithy.diff.evaluators.RemovedOperationError
RemovedServiceError - Class in software.amazon.smithy.diff.evaluators: Emits a warning when an error is removed from a service.
RemovedServiceError() - Constructor for class software.amazon.smithy.diff.evaluators.RemovedServiceError
RemovedShape - Class in software.amazon.smithy.diff.evaluators: Creates an ERROR event when a non-private non-scalar shape is removed.
RemovedShape() - Constructor for class software.amazon.smithy.diff.evaluators.RemovedShape
removedShapes() - Method in class software.amazon.smithy.diff.Differences: Gets all removed shapes.
removedShapes(Class<T>) - Method in class software.amazon.smithy.diff.Differences: Gets all of the removed shapes of a specific type.
RemovedTraitDefinition - Class in software.amazon.smithy.diff.evaluators: Creates an ERROR event when a trait definition is removed.
RemovedTraitDefinition() - Constructor for class software.amazon.smithy.diff.evaluators.RemovedTraitDefinition
removedTraits() - Method in class software.amazon.smithy.diff.ChangedShape: Gets a stream of removed traits.
result - Variable in exception software.amazon.smithy.diff.testrunner.SmithyDiffTestCase.Error
result - Variable in exception software.amazon.smithy.diff.testrunner.SmithyDiffTestSuite.Error
Result(Differences, List<ValidationEvent>, List<ValidationEvent>, List<ValidationEvent>) - Constructor for class software.amazon.smithy.diff.ModelDiff.Result
run() - Method in class software.amazon.smithy.diff.testrunner.SmithyDiffTestSuite: Executes the test runner.
run(ExecutorService) - Method in class software.amazon.smithy.diff.testrunner.SmithyDiffTestSuite: Executes the test runner with a specific ExecutorService.
runner() - Static method in class software.amazon.smithy.diff.testrunner.SmithyDiffTestSuite: Creates a new Smithy diff test suite.

S

ServiceRename - Class in software.amazon.smithy.diff.evaluators: Creates an ERROR event when a shape is renamed that was already part of the service, when a rename changes for a shape, or when a rename is removed for a shape.
ServiceRename() - Constructor for class software.amazon.smithy.diff.evaluators.ServiceRename
setModelAssemblerFactory(Supplier<ModelAssembler>) - Method in class software.amazon.smithy.diff.testrunner.SmithyDiffTestSuite: Sets a custom ModelAssembler factory to use to create a ModelAssembler for each test case.
SmithyDiffTestCase - Class in software.amazon.smithy.diff.testrunner: Runs a single test case by loading corresponding models `a` and `b` and ensuring the resulting events match the diff events stored in a `-----` separated file.
SmithyDiffTestCase(Path, String, List<ValidationEvent>) - Constructor for class software.amazon.smithy.diff.testrunner.SmithyDiffTestCase
SmithyDiffTestCase.Error - Exception in software.amazon.smithy.diff.testrunner: Thrown when errors are encountered while unwrapping a test case.
SmithyDiffTestCase.Result - Class in software.amazon.smithy.diff.testrunner: Output of diffing a model against a test case.
SmithyDiffTestSuite - Class in software.amazon.smithy.diff.testrunner: Runs diff test cases against corresponding model `a`, model `b`, and validation `events` files.
SmithyDiffTestSuite.Error - Exception in software.amazon.smithy.diff.testrunner: Thrown when errors are encountered in the test runner.
SmithyDiffTestSuite.Result - Class in software.amazon.smithy.diff.testrunner: Value result of executing the test suite.
software.amazon.smithy.diff - package software.amazon.smithy.diff
software.amazon.smithy.diff.evaluators - package software.amazon.smithy.diff.evaluators
software.amazon.smithy.diff.testrunner - package software.amazon.smithy.diff.testrunner

T

testCaseCallables() - Method in class software.amazon.smithy.diff.testrunner.SmithyDiffTestSuite: Creates a Stream of Callable objects that can be used to execute each test case.
toString() - Method in class software.amazon.smithy.diff.testrunner.SmithyDiffTestCase.Result
toString() - Method in class software.amazon.smithy.diff.testrunner.SmithyDiffTestSuite.Result
TraitBreakingChange - Class in software.amazon.smithy.diff.evaluators: Finds breaking changes related to when a trait is added, removed, or updated based on the breakingChanges property of traits.
TraitBreakingChange() - Constructor for class software.amazon.smithy.diff.evaluators.TraitBreakingChange

U

unwrap() - Method in class software.amazon.smithy.diff.testrunner.SmithyDiffTestCase.Result: Throws an exception if the result is invalid, otherwise returns the result.

W

warning(Shape, String) - Method in class software.amazon.smithy.diff.evaluators.AbstractDiffEvaluator
warning(Shape, FromSourceLocation, String) - Method in class software.amazon.smithy.diff.evaluators.AbstractDiffEvaluator

A B C D E F G H I M N O P R S T U W
All Classes and Interfaces|All Packages|Serialized Form