From 8c98e0fae6b786059889ac4031f4b9010cac3e05 Mon Sep 17 00:00:00 2001 From: smithy-automation Date: Thu, 28 Mar 2024 18:41:44 +0000 Subject: [PATCH] Update documentation --- .../http-protocol-compliance-tests.rst.txt | 13 +- 1.0/_static/basic.css | 47 +- 1.0/guides/building-models/build-config.html | 48 +- 1.0/guides/building-models/gradle-plugin.html | 14 +- 1.0/guides/converting-to-openapi.html | 12 +- .../generating-cloudformation-resources.html | 8 +- 1.0/guides/model-linters.html | 28 +- 1.0/quickstart.html | 6 +- 1.0/searchindex.js | 2 +- 1.0/spec/aws/amazon-apigateway.html | 22 +- 1.0/spec/aws/aws-auth.html | 4 +- 1.0/spec/aws/aws-cloudformation.html | 8 +- 1.0/spec/aws/aws-core.html | 16 +- 1.0/spec/aws/aws-ec2-query-protocol.html | 14 +- 1.0/spec/aws/aws-iam.html | 8 +- 1.0/spec/aws/aws-json-1_0-protocol.html | 12 +- 1.0/spec/aws/aws-json-1_1-protocol.html | 12 +- 1.0/spec/aws/aws-query-protocol.html | 18 +- 1.0/spec/aws/aws-restjson1-protocol.html | 10 +- 1.0/spec/aws/aws-restxml-protocol.html | 10 +- .../aws/customizations/s3-customizations.html | 8 +- 1.0/spec/core/auth-traits.html | 4 +- 1.0/spec/core/behavior-traits.html | 6 +- 1.0/spec/core/constraint-traits.html | 8 +- 1.0/spec/core/documentation-traits.html | 8 +- 1.0/spec/core/endpoint-traits.html | 2 +- 1.0/spec/core/http-traits.html | 20 +- 1.0/spec/core/idl.html | 4 +- 1.0/spec/core/json-ast.html | 8 +- 1.0/spec/core/model-validation.html | 14 +- 1.0/spec/core/model.html | 20 +- 1.0/spec/core/protocol-traits.html | 4 +- 1.0/spec/core/resource-traits.html | 2 +- 1.0/spec/core/selectors.html | 14 +- 1.0/spec/core/xml-traits.html | 4 +- 1.0/spec/http-protocol-compliance-tests.html | 29 +- 1.0/spec/mqtt.html | 2 +- 1.0/spec/waiters.html | 12 +- .../http-protocol-compliance-tests.rst.txt | 13 +- 2.0/_sources/additional-specs/index.rst.txt | 1 + .../additional-specs/protocols/index.rst.txt | 10 + .../protocols/smithy-rpc-v2.rst.txt | 484 + .../aws/protocols/aws-query-protocol.rst.txt | 28 +- 2.0/_static/basic.css | 47 +- .../http-protocol-compliance-tests.html | 43 +- 2.0/additional-specs/index.html | 15 +- 2.0/additional-specs/mqtt.html | 16 +- 2.0/additional-specs/protocols/index.html | 422 + .../protocols/smithy-rpc-v2.html | 964 + 2.0/additional-specs/rules-engine/index.html | 14 +- .../rules-engine/parameters.html | 24 +- .../rules-engine/specification.html | 36 +- .../rules-engine/standard-library.html | 26 +- 2.0/additional-specs/smoke-tests.html | 20 +- 2.0/additional-specs/waiters.html | 26 +- 2.0/aws/amazon-apigateway.html | 36 +- 2.0/aws/aws-auth.html | 20 +- 2.0/aws/aws-cloudformation.html | 22 +- 2.0/aws/aws-core.html | 36 +- 2.0/aws/aws-endpoints-region.html | 26 +- 2.0/aws/aws-iam.html | 28 +- .../apigateway-customizations.html | 14 +- .../glacier-customizations.html | 14 +- 2.0/aws/customizations/index.html | 14 +- .../machinelearning-customizations.html | 14 +- 2.0/aws/customizations/s3-customizations.html | 22 +- 2.0/aws/index.html | 20 +- 2.0/aws/protocols/aws-ec2-query-protocol.html | 28 +- 2.0/aws/protocols/aws-json-1_0-protocol.html | 26 +- 2.0/aws/protocols/aws-json-1_1-protocol.html | 26 +- 2.0/aws/protocols/aws-query-protocol.html | 54 +- 2.0/aws/protocols/aws-restjson1-protocol.html | 24 +- 2.0/aws/protocols/aws-restxml-protocol.html | 24 +- 2.0/aws/protocols/index.html | 14 +- 2.0/aws/rules-engine/auth-schemes.html | 24 +- 2.0/aws/rules-engine/built-ins.html | 20 +- 2.0/aws/rules-engine/index.html | 14 +- 2.0/aws/rules-engine/library-functions.html | 26 +- 2.0/genindex.html | 36 +- .../configuring-the-generator.html | 14 +- .../creating-codegen-repo.html | 14 +- .../decoupling-codegen-with-symbols.html | 14 +- .../building-codegen/generating-code.html | 14 +- .../implementing-the-generator.html | 14 +- 2.0/guides/building-codegen/index.html | 14 +- .../making-codegen-pluggable.html | 14 +- .../mapping-shapes-to-languages.html | 14 +- .../overview-and-concepts.html | 14 +- .../using-the-semantic-model.html | 14 +- 2.0/guides/evolving-models.html | 14 +- 2.0/guides/glossary.html | 14 +- .../gradle-plugin/gradle-migration-guide.html | 30 +- 2.0/guides/gradle-plugin/index.html | 44 +- 2.0/guides/index.html | 14 +- 2.0/guides/model-linters.html | 54 +- .../converting-to-openapi.html | 68 +- .../generating-cloudformation-resources.html | 40 +- 2.0/guides/model-translations/index.html | 14 +- .../migrating-idl-1-to-2.html | 14 +- 2.0/guides/model-validation-examples.html | 14 +- 2.0/guides/smithy-build-json.html | 82 +- 2.0/guides/smithy-cli/cli_installation.html | 56 +- 2.0/guides/smithy-cli/index.html | 14 +- 2.0/guides/style-guide.html | 14 +- .../generating-a-client.html | 20 +- 2.0/guides/using-code-generation/index.html | 14 +- .../using-code-generation/update-model.html | 20 +- 2.0/index.html | 14 +- 2.0/objects.inv | Bin 12532 -> 12651 bytes 2.0/quickstart.html | 20 +- 2.0/search.html | 14 +- 2.0/searchindex.js | 2 +- 2.0/spec/aggregate-types.html | 16 +- 2.0/spec/authentication-traits.html | 18 +- 2.0/spec/behavior-traits.html | 20 +- 2.0/spec/constraint-traits.html | 22 +- 2.0/spec/documentation-traits.html | 22 +- 2.0/spec/endpoint-traits.html | 16 +- 2.0/spec/http-bindings.html | 34 +- 2.0/spec/idl.html | 18 +- 2.0/spec/index.html | 14 +- 2.0/spec/json-ast.html | 22 +- 2.0/spec/mixins.html | 14 +- 2.0/spec/model-validation.html | 32 +- 2.0/spec/model.html | 31 +- 2.0/spec/protocol-traits.html | 22 +- 2.0/spec/resource-traits.html | 18 +- 2.0/spec/selectors.html | 28 +- 2.0/spec/service-types.html | 20 +- 2.0/spec/simple-types.html | 14 +- 2.0/spec/streaming.html | 14 +- 2.0/spec/type-refinement-traits.html | 16 +- 2.0/trait-index.html | 15 +- 2.0/ts-ssdk/error-handling.html | 14 +- 2.0/ts-ssdk/handlers.html | 14 +- 2.0/ts-ssdk/index.html | 14 +- 2.0/ts-ssdk/introduction.html | 14 +- 2.0/ts-ssdk/supported-endpoints.html | 14 +- 2.0/ts-ssdk/validation.html | 14 +- javadoc/1.47.0/allclasses-index.html | 7783 +++++ javadoc/1.47.0/allclasses.html | 1376 + javadoc/1.47.0/allpackages-index.html | 574 + javadoc/1.47.0/constant-values.html | 1209 + javadoc/1.47.0/deprecated-list.html | 543 + javadoc/1.47.0/element-list | 95 + javadoc/1.47.0/help-doc.html | 272 + javadoc/1.47.0/index-all.html | 27635 ++++++++++++++++ javadoc/1.47.0/index.html | 570 + javadoc/1.47.0/jquery-ui.overrides.css | 35 + .../1.47.0/jquery/external/jquery/jquery.js | 10872 ++++++ javadoc/1.47.0/jquery/jquery-3.6.1.min.js | 2 + javadoc/1.47.0/jquery/jquery-ui.min.css | 6 + javadoc/1.47.0/jquery/jquery-ui.min.js | 6 + .../jquery/jszip-utils/dist/jszip-utils-ie.js | 56 + .../jszip-utils/dist/jszip-utils-ie.min.js | 10 + .../jquery/jszip-utils/dist/jszip-utils.js | 118 + .../jszip-utils/dist/jszip-utils.min.js | 10 + javadoc/1.47.0/jquery/jszip/dist/jszip.js | 11370 +++++++ javadoc/1.47.0/jquery/jszip/dist/jszip.min.js | 13 + javadoc/1.47.0/legal/ADDITIONAL_LICENSE_INFO | 37 + javadoc/1.47.0/legal/ASSEMBLY_EXCEPTION | 27 + javadoc/1.47.0/legal/LICENSE | 347 + javadoc/1.47.0/legal/jquery.md | 72 + javadoc/1.47.0/legal/jqueryUI.md | 49 + javadoc/1.47.0/legal/jszip.md | 653 + javadoc/1.47.0/legal/pako.md | 45 + javadoc/1.47.0/member-search-index.js | 1 + javadoc/1.47.0/member-search-index.zip | Bin 0 -> 92888 bytes javadoc/1.47.0/overview-summary.html | 23 + javadoc/1.47.0/overview-tree.html | 1900 ++ javadoc/1.47.0/package-search-index.js | 1 + javadoc/1.47.0/package-search-index.zip | Bin 0 -> 871 bytes javadoc/1.47.0/resources/glass.png | Bin 0 -> 499 bytes javadoc/1.47.0/resources/x.png | Bin 0 -> 394 bytes javadoc/1.47.0/script.js | 149 + javadoc/1.47.0/search.js | 326 + javadoc/1.47.0/serialized-form.html | 548 + .../openapi/ApiGatewayConfig.ApiType.html | 416 + .../apigateway/openapi/ApiGatewayConfig.html | 488 + .../openapi/ApiGatewayDefaults.html | 408 + .../openapi/ApiGatewayExtension.html | 352 + .../apigateway/openapi/ApiGatewayMapper.html | 305 + .../openapi/CorsHttpIntegration.html | 391 + .../apigateway/openapi/package-summary.html | 217 + .../aws/apigateway/openapi/package-tree.html | 188 + .../traits/ApiKeySourceTrait.Provider.html | 298 + .../apigateway/traits/ApiKeySourceTrait.html | 381 + .../traits/AuthorizerDefinition.Builder.html | 583 + .../traits/AuthorizerDefinition.html | 628 + .../apigateway/traits/AuthorizerIndex.html | 415 + .../traits/AuthorizerTrait.Provider.html | 298 + .../apigateway/traits/AuthorizerTrait.html | 382 + .../traits/AuthorizersTrait.Builder.html | 428 + .../traits/AuthorizersTrait.Provider.html | 337 + .../apigateway/traits/AuthorizersTrait.html | 477 + .../traits/AuthorizersTraitValidator.html | 348 + .../traits/IntegrationResponse.Builder.html | 528 + .../traits/IntegrationResponse.html | 531 + .../traits/IntegrationTrait.Builder.html | 922 + .../traits/IntegrationTrait.Provider.html | 337 + .../apigateway/traits/IntegrationTrait.html | 895 + .../traits/IntegrationTraitIndex.html | 377 + .../traits/MockIntegrationTrait.Builder.html | 622 + .../traits/MockIntegrationTrait.Provider.html | 337 + .../traits/MockIntegrationTrait.html | 602 + .../RequestValidatorTrait.Provider.html | 298 + .../traits/RequestValidatorTrait.html | 381 + .../apigateway/traits/package-summary.html | 275 + .../aws/apigateway/traits/package-tree.html | 206 + .../aws/cloudformation/schema/CfnConfig.html | 903 + .../cloudformation/schema/CfnException.html | 324 + .../schema/fromsmithy/CfnConverter.html | 395 + .../schema/fromsmithy/CfnMapper.html | 350 + .../schema/fromsmithy/Context.html | 425 + .../schema/fromsmithy/Smithy2Cfn.html | 350 + .../fromsmithy/Smithy2CfnExtension.html | 288 + .../fromsmithy/mappers/CoreExtension.html | 329 + .../mappers/HandlerPermissionMapper.html | 335 + .../fromsmithy/mappers/RequiredMapper.html | 335 + .../fromsmithy/mappers/package-summary.html | 186 + .../fromsmithy/mappers/package-tree.html | 163 + .../schema/fromsmithy/package-summary.html | 205 + .../schema/fromsmithy/package-tree.html | 170 + .../schema/model/Handler.Builder.html | 327 + .../cloudformation/schema/model/Handler.html | 494 + .../schema/model/Property.Builder.html | 355 + .../cloudformation/schema/model/Property.html | 390 + .../schema/model/Remote.Builder.html | 401 + .../cloudformation/schema/model/Remote.html | 376 + .../schema/model/ResourceSchema.Builder.html | 881 + .../schema/model/ResourceSchema.html | 558 + .../schema/model/Tagging.Builder.html | 395 + .../cloudformation/schema/model/Tagging.html | 424 + .../schema/model/package-summary.html | 215 + .../schema/model/package-tree.html | 170 + .../schema/package-summary.html | 187 + .../cloudformation/schema/package-tree.html | 178 + ...CfnAdditionalIdentifierTrait.Provider.html | 298 + .../traits/CfnAdditionalIdentifierTrait.html | 369 + .../traits/CfnDefaultValueTrait.Provider.html | 298 + .../traits/CfnDefaultValueTrait.html | 369 + .../CfnExcludePropertyTrait.Provider.html | 298 + .../traits/CfnExcludePropertyTrait.html | 369 + .../traits/CfnMutabilityTrait.Provider.html | 298 + .../traits/CfnMutabilityTrait.html | 464 + .../traits/CfnMutabilityTraitValidator.html | 349 + .../traits/CfnNameTrait.Provider.html | 298 + .../cloudformation/traits/CfnNameTrait.html | 381 + .../traits/CfnResource.Builder.html | 429 + .../cloudformation/traits/CfnResource.html | 522 + .../traits/CfnResourceIndex.Mutability.html | 423 + .../traits/CfnResourceIndex.html | 361 + .../traits/CfnResourceProperty.Builder.html | 395 + .../traits/CfnResourceProperty.html | 393 + .../traits/CfnResourcePropertyValidator.html | 348 + .../traits/CfnResourceTrait.Builder.html | 336 + .../traits/CfnResourceTrait.Provider.html | 337 + .../traits/CfnResourceTrait.html | 453 + .../traits/package-summary.html | 288 + .../cloudformation/traits/package-tree.html | 226 + .../iam/traits/ActionNameTrait.Provider.html | 298 + .../aws/iam/traits/ActionNameTrait.html | 397 + ...onPermissionDescriptionTrait.Provider.html | 298 + .../ActionPermissionDescriptionTrait.html | 397 + .../iam/traits/ActionResource.Builder.html | 381 + .../smithy/aws/iam/traits/ActionResource.html | 414 + .../iam/traits/ActionResources.Builder.html | 441 + .../aws/iam/traits/ActionResources.html | 425 + .../ConditionKeyDefinition.Builder.html | 381 + .../iam/traits/ConditionKeyDefinition.html | 469 + .../ConditionKeyValueTrait.Provider.html | 298 + .../iam/traits/ConditionKeyValueTrait.html | 381 + .../aws/iam/traits/ConditionKeysIndex.html | 421 + .../traits/ConditionKeysTrait.Builder.html | 306 + .../traits/ConditionKeysTrait.Provider.html | 298 + .../aws/iam/traits/ConditionKeysTrait.html | 459 + .../iam/traits/ConditionKeysValidator.html | 354 + .../DefineConditionKeysTrait.Builder.html | 324 + .../DefineConditionKeysTrait.Provider.html | 337 + .../iam/traits/DefineConditionKeysTrait.html | 455 + ...leConditionKeyInferenceTrait.Provider.html | 298 + .../DisableConditionKeyInferenceTrait.html | 368 + .../iam/traits/IamActionTrait.Builder.html | 462 + .../iam/traits/IamActionTrait.Provider.html | 337 + .../smithy/aws/iam/traits/IamActionTrait.html | 633 + .../aws/iam/traits/IamActionValidator.html | 347 + .../iam/traits/IamResourceTrait.Builder.html | 336 + .../iam/traits/IamResourceTrait.Provider.html | 337 + .../aws/iam/traits/IamResourceTrait.html | 507 + .../iam/traits/IamResourceTraitValidator.html | 350 + .../traits/RequiredActionsTrait.Builder.html | 346 + .../traits/RequiredActionsTrait.Provider.html | 298 + .../aws/iam/traits/RequiredActionsTrait.html | 481 + ...ceResolvedConditionKeysTrait.Provider.html | 298 + .../ServiceResolvedConditionKeysTrait.html | 388 + .../SupportedPrincipalTypesTrait.Builder.html | 306 + ...SupportedPrincipalTypesTrait.Provider.html | 298 + .../traits/SupportedPrincipalTypesTrait.html | 458 + .../aws/iam/traits/package-summary.html | 344 + .../smithy/aws/iam/traits/package-tree.html | 242 + .../smoketests/model/AwsSmokeTestModel.html | 346 + .../aws/smoketests/model/AwsVendorParams.html | 281 + .../smoketests/model/BaseAwsVendorParams.html | 367 + .../aws/smoketests/model/S3VendorParams.html | 399 + .../aws/smoketests/model/package-summary.html | 185 + .../aws/smoketests/model/package-tree.html | 167 + .../amazon/smithy/aws/traits/ArnIndex.html | 433 + .../aws/traits/ArnReferenceTrait.Builder.html | 337 + .../traits/ArnReferenceTrait.Provider.html | 337 + .../smithy/aws/traits/ArnReferenceTrait.html | 512 + .../aws/traits/ArnTemplateValidator.html | 349 + .../smithy/aws/traits/ArnTrait.Builder.html | 351 + .../smithy/aws/traits/ArnTrait.Provider.html | 337 + .../amazon/smithy/aws/traits/ArnTrait.html | 544 + .../traits/ControlPlaneTrait.Provider.html | 298 + .../smithy/aws/traits/ControlPlaneTrait.html | 367 + .../aws/traits/DataPlaneTrait.Provider.html | 298 + .../smithy/aws/traits/DataPlaneTrait.html | 367 + .../smithy/aws/traits/DataTrait.Provider.html | 298 + .../amazon/smithy/aws/traits/DataTrait.html | 368 + .../aws/traits/ErrorRenameValidator.html | 347 + .../aws/traits/EventSourceValidator.html | 350 + .../aws/traits/HttpChecksumTrait.Builder.html | 378 + .../traits/HttpChecksumTrait.Provider.html | 337 + .../smithy/aws/traits/HttpChecksumTrait.html | 638 + .../traits/HttpChecksumTraitValidator.html | 360 + .../amazon/smithy/aws/traits/PlaneIndex.html | 467 + .../aws/traits/SdkServiceIdValidator.html | 403 + .../aws/traits/ServiceTrait.Builder.html | 471 + .../aws/traits/ServiceTrait.Provider.html | 337 + .../smithy/aws/traits/ServiceTrait.html | 636 + .../auth/CognitoUserPoolsTrait.Builder.html | 362 + .../auth/CognitoUserPoolsTrait.Provider.html | 337 + .../traits/auth/CognitoUserPoolsTrait.html | 438 + .../aws/traits/auth/SigV4ATrait.Builder.html | 308 + .../aws/traits/auth/SigV4ATrait.Provider.html | 337 + .../smithy/aws/traits/auth/SigV4ATrait.html | 432 + .../aws/traits/auth/SigV4Trait.Builder.html | 308 + .../aws/traits/auth/SigV4Trait.Provider.html | 337 + .../smithy/aws/traits/auth/SigV4Trait.html | 429 + .../aws/traits/auth/SigV4TraitsValidator.html | 348 + .../auth/UnsignedPayloadTrait.Provider.html | 298 + .../aws/traits/auth/UnsignedPayloadTrait.html | 368 + .../aws/traits/auth/package-summary.html | 220 + .../smithy/aws/traits/auth/package-tree.html | 196 + .../CleanClientDiscoveryTraitTransformer.html | 328 + ...ClientDiscoveredEndpointTrait.Builder.html | 309 + ...lientDiscoveredEndpointTrait.Provider.html | 337 + .../ClientDiscoveredEndpointTrait.html | 436 + ...ientEndpointDiscoveryIdTrait.Provider.html | 298 + .../ClientEndpointDiscoveryIdTrait.html | 369 + .../ClientEndpointDiscoveryIndex.html | 339 + .../ClientEndpointDiscoveryInfo.html | 353 + .../ClientEndpointDiscoveryTrait.Builder.html | 348 + ...ClientEndpointDiscoveryTrait.Provider.html | 337 + .../ClientEndpointDiscoveryTrait.html | 525 + .../ClientEndpointDiscoveryValidator.html | 347 + .../package-summary.html | 222 + .../clientendpointdiscovery/package-tree.html | 196 + .../S3UnwrappedXmlOutputTrait.Provider.html | 298 + .../S3UnwrappedXmlOutputTrait.html | 367 + .../customizations/package-summary.html | 168 + .../traits/customizations/package-tree.html | 174 + .../smithy/aws/traits/package-summary.html | 292 + .../smithy/aws/traits/package-tree.html | 217 + .../protocols/AwsJson1_0Trait.Builder.html | 306 + .../protocols/AwsJson1_0Trait.Provider.html | 337 + .../aws/traits/protocols/AwsJson1_0Trait.html | 372 + .../protocols/AwsJson1_1Trait.Builder.html | 306 + .../protocols/AwsJson1_1Trait.Provider.html | 337 + .../aws/traits/protocols/AwsJson1_1Trait.html | 372 + .../protocols/AwsProtocolTrait.Builder.html | 396 + .../traits/protocols/AwsProtocolTrait.html | 383 + .../AwsQueryCompatibleTrait.Provider.html | 298 + .../protocols/AwsQueryCompatibleTrait.html | 367 + .../protocols/AwsQueryErrorTrait.Builder.html | 363 + .../AwsQueryErrorTrait.Provider.html | 337 + .../traits/protocols/AwsQueryErrorTrait.html | 486 + .../protocols/AwsQueryTrait.Provider.html | 298 + .../aws/traits/protocols/AwsQueryTrait.html | 371 + .../protocols/Ec2QueryNameTrait.Provider.html | 298 + .../traits/protocols/Ec2QueryNameTrait.html | 383 + .../protocols/Ec2QueryTrait.Provider.html | 298 + .../aws/traits/protocols/Ec2QueryTrait.html | 372 + .../ProtocolHttpPayloadValidator.html | 349 + .../protocols/ProtocolHttpValidator.html | 349 + .../protocols/RestJson1Trait.Builder.html | 306 + .../protocols/RestJson1Trait.Provider.html | 337 + .../aws/traits/protocols/RestJson1Trait.html | 370 + .../protocols/RestXmlTrait.Builder.html | 346 + .../protocols/RestXmlTrait.Provider.html | 337 + .../aws/traits/protocols/RestXmlTrait.html | 414 + .../aws/traits/protocols/package-summary.html | 299 + .../aws/traits/protocols/package-tree.html | 225 + .../aws/traits/tagging/AwsTagIndex.html | 536 + .../tagging/ServiceTaggingValidator.html | 348 + .../tagging/TagEnabledServiceValidator.html | 348 + .../tagging/TagEnabledTrait.Builder.html | 348 + .../tagging/TagEnabledTrait.Provider.html | 348 + .../aws/traits/tagging/TagEnabledTrait.html | 465 + .../TagResourcePropertyNameValidator.html | 348 + .../TagResourcePropertyTypeValidator.html | 348 + .../tagging/TaggableApiConfig.Builder.html | 326 + .../aws/traits/tagging/TaggableApiConfig.html | 477 + .../tagging/TaggableResourceValidator.html | 348 + .../traits/tagging/TaggableTrait.Builder.html | 376 + .../tagging/TaggableTrait.Provider.html | 348 + .../aws/traits/tagging/TaggableTrait.html | 474 + .../aws/traits/tagging/package-summary.html | 237 + .../aws/traits/tagging/package-tree.html | 186 + .../amazon/smithy/build/FileManifest.html | 759 + .../smithy/build/JsonSubstitutions.html | 341 + .../smithy/build/MockManifest.StoreMode.html | 387 + .../amazon/smithy/build/MockManifest.html | 711 + .../smithy/build/PluginContext.Builder.html | 507 + .../amazon/smithy/build/PluginContext.html | 644 + .../build/ProjectionResult.Builder.html | 447 + .../amazon/smithy/build/ProjectionResult.html | 428 + .../smithy/build/ProjectionTransformer.html | 385 + .../amazon/smithy/build/SmithyBuild.html | 942 + .../smithy/build/SmithyBuildException.html | 329 + .../smithy/build/SmithyBuildPlugin.html | 414 + .../build/SmithyBuildResult.Builder.html | 312 + .../smithy/build/SmithyBuildResult.html | 469 + .../build/SourcesConflictException.html | 302 + .../build/TransformContext.Builder.html | 384 + .../amazon/smithy/build/TransformContext.html | 488 + .../build/UnknownProjectionException.html | 317 + .../build/UnknownTransformException.html | 317 + .../build/model/MavenConfig.Builder.html | 313 + .../smithy/build/model/MavenConfig.html | 424 + .../build/model/MavenRepository.Builder.html | 355 + .../smithy/build/model/MavenRepository.html | 478 + .../build/model/ProjectionConfig.Builder.html | 377 + .../smithy/build/model/ProjectionConfig.html | 410 + .../model/SmithyBuildConfig.Builder.html | 521 + .../smithy/build/model/SmithyBuildConfig.html | 606 + .../build/model/TransformConfig.Builder.html | 337 + .../smithy/build/model/TransformConfig.html | 338 + .../smithy/build/model/package-summary.html | 211 + .../smithy/build/model/package-tree.html | 170 + .../amazon/smithy/build/package-summary.html | 309 + .../amazon/smithy/build/package-tree.html | 212 + .../smithy/build/plugins/BuildInfo.html | 647 + .../smithy/build/plugins/BuildInfoPlugin.html | 435 + .../ConfigurableSmithyBuildPlugin.html | 396 + .../smithy/build/plugins/ModelPlugin.html | 351 + .../plugins/NullabilityReportPlugin.html | 382 + .../build/plugins/RunPlugin.Settings.html | 378 + .../smithy/build/plugins/RunPlugin.html | 404 + .../smithy/build/plugins/SourcesPlugin.html | 364 + .../smithy/build/plugins/package-summary.html | 208 + .../smithy/build/plugins/package-tree.html | 168 + .../processor/SmithyAnnotationProcessor.html | 471 + .../build/processor/package-summary.html | 166 + .../smithy/build/processor/package-tree.html | 165 + .../smithy/build/transforms/Apply.Config.html | 337 + .../amazon/smithy/build/transforms/Apply.html | 489 + .../ChangeStringEnumsToEnumShapes.Config.html | 327 + .../ChangeStringEnumsToEnumShapes.html | 419 + .../build/transforms/ChangeTypes.Config.html | 365 + .../smithy/build/transforms/ChangeTypes.html | 418 + .../ConfigurableProjectionTransformer.html | 457 + .../transforms/ExcludeMetadata.Config.html | 334 + .../build/transforms/ExcludeMetadata.html | 477 + .../ExcludeShapesBySelector.Config.html | 337 + .../transforms/ExcludeShapesBySelector.html | 420 + .../transforms/ExcludeShapesByTag.Config.html | 337 + .../build/transforms/ExcludeShapesByTag.html | 479 + .../ExcludeShapesByTrait.Config.html | 338 + .../transforms/ExcludeShapesByTrait.html | 416 + .../build/transforms/ExcludeTags.Config.html | 337 + .../smithy/build/transforms/ExcludeTags.html | 477 + .../transforms/ExcludeTraits.Config.html | 341 + .../build/transforms/ExcludeTraits.html | 482 + .../transforms/ExcludeTraitsByTag.Config.html | 334 + .../build/transforms/ExcludeTraitsByTag.html | 480 + .../transforms/FilterSuppressions.Config.html | 577 + .../build/transforms/FilterSuppressions.html | 418 + .../transforms/FlattenNamespaces.Config.html | 425 + .../build/transforms/FlattenNamespaces.html | 424 + .../transforms/IncludeMetadata.Config.html | 334 + .../build/transforms/IncludeMetadata.html | 477 + .../transforms/IncludeNamespaces.Config.html | 334 + .../build/transforms/IncludeNamespaces.html | 479 + .../transforms/IncludeServices.Config.html | 334 + .../build/transforms/IncludeServices.html | 478 + .../IncludeShapesBySelector.Config.html | 337 + .../transforms/IncludeShapesBySelector.html | 420 + .../transforms/IncludeShapesByTag.Config.html | 337 + .../build/transforms/IncludeShapesByTag.html | 480 + .../build/transforms/IncludeTags.Config.html | 337 + .../smithy/build/transforms/IncludeTags.html | 478 + .../transforms/IncludeTraits.Config.html | 341 + .../build/transforms/IncludeTraits.html | 482 + .../transforms/IncludeTraitsByTag.Config.html | 336 + .../build/transforms/IncludeTraitsByTag.html | 479 + .../RemoveTraitDefinitions.Config.html | 342 + .../transforms/RemoveTraitDefinitions.html | 422 + .../transforms/RemoveUnusedShapes.Config.html | 341 + .../build/transforms/RemoveUnusedShapes.html | 494 + .../build/transforms/RenameShapes.Config.html | 339 + .../smithy/build/transforms/RenameShapes.html | 422 + .../build/transforms/package-summary.html | 463 + .../smithy/build/transforms/package-tree.html | 210 + .../amazon/smithy/cli/AnsiColorFormatter.html | 431 + .../amazon/smithy/cli/ArgumentReceiver.html | 321 + .../software/amazon/smithy/cli/Arguments.html | 466 + ...dParameterBuilder.ClassPathTagMatcher.html | 269 + ...terBuilder.JarFileClassPathTagMatcher.html | 330 + .../cli/BuildParameterBuilder.Result.html | 337 + .../smithy/cli/BuildParameterBuilder.html | 762 + .../software/amazon/smithy/cli/Cli.html | 374 + .../software/amazon/smithy/cli/CliError.html | 438 + .../amazon/smithy/cli/CliPrinter.html | 363 + .../amazon/smithy/cli/ColorBuffer.html | 502 + .../amazon/smithy/cli/ColorFormatter.html | 371 + .../amazon/smithy/cli/ColorTheme.html | 549 + .../amazon/smithy/cli/Command.Env.html | 385 + .../software/amazon/smithy/cli/Command.html | 355 + .../smithy/cli/EnvironmentVariable.html | 638 + .../amazon/smithy/cli/HelpPrinter.html | 494 + .../software/amazon/smithy/cli/SmithyCli.html | 430 + .../amazon/smithy/cli/StandardOptions.html | 637 + .../amazon/smithy/cli/Style.Constant.html | 351 + .../amazon/smithy/cli/Style.Multi.html | 351 + .../software/amazon/smithy/cli/Style.html | 831 + .../smithy/cli/commands/SmithyCommand.html | 398 + .../smithy/cli/commands/package-summary.html | 164 + .../smithy/cli/commands/package-tree.html | 161 + .../DependencyResolver.Factory.html | 271 + .../cli/dependencies/DependencyResolver.html | 339 + .../DependencyResolverException.html | 325 + .../cli/dependencies/FileCacheResolver.html | 402 + .../FilterCliVersionResolver.html | 400 + .../dependencies/MavenDependencyResolver.html | 407 + .../cli/dependencies/ResolvedArtifact.html | 567 + .../cli/dependencies/package-summary.html | 228 + .../smithy/cli/dependencies/package-tree.html | 184 + .../amazon/smithy/cli/package-summary.html | 330 + .../amazon/smithy/cli/package-tree.html | 221 + .../smithy/codegen/core/CodegenContext.html | 362 + .../smithy/codegen/core/CodegenException.html | 330 + .../codegen/core/DependencyTracker.html | 617 + .../smithy/codegen/core/ImportContainer.html | 329 + .../core/MappedReservedWords.Builder.html | 342 + .../codegen/core/MappedReservedWords.html | 428 + .../ReservedWordSymbolProvider.Builder.html | 517 + .../ReservedWordSymbolProvider.Escaper.html | 306 + .../core/ReservedWordSymbolProvider.html | 404 + .../smithy/codegen/core/ReservedWords.html | 355 + .../codegen/core/ReservedWordsBuilder.html | 452 + .../codegen/core/ShapeGenerationOrder.html | 401 + .../codegen/core/SmithyIntegration.html | 581 + .../smithy/codegen/core/Symbol.Builder.html | 698 + .../amazon/smithy/codegen/core/Symbol.html | 897 + .../smithy/codegen/core/SymbolContainer.html | 260 + .../core/SymbolDependency.Builder.html | 429 + .../smithy/codegen/core/SymbolDependency.html | 735 + .../core/SymbolDependencyContainer.html | 266 + .../smithy/codegen/core/SymbolProvider.html | 352 + .../codegen/core/SymbolReference.Builder.html | 454 + .../core/SymbolReference.ContextOption.html | 393 + .../codegen/core/SymbolReference.Option.html | 197 + .../smithy/codegen/core/SymbolReference.html | 750 + .../codegen/core/SymbolWriter.Factory.html | 308 + .../smithy/codegen/core/SymbolWriter.html | 616 + .../smithy/codegen/core/TopologicalIndex.html | 440 + .../smithy/codegen/core/WriterDelegator.html | 569 + .../core/directed/CodegenDirector.html | 759 + .../core/directed/ContextualDirective.html | 328 + .../core/directed/CreateContextDirective.html | 351 + .../CreateSymbolProviderDirective.html | 241 + .../core/directed/CustomizeDirective.html | 255 + .../core/directed/DirectedCodegen.html | 547 + .../codegen/core/directed/Directive.html | 355 + .../GenerateEnumDirective.EnumType.html | 385 + .../core/directed/GenerateEnumDirective.html | 385 + .../core/directed/GenerateErrorDirective.html | 319 + .../directed/GenerateIntEnumDirective.html | 310 + .../directed/GenerateOperationDirective.html | 266 + .../directed/GenerateResourceDirective.html | 266 + .../directed/GenerateServiceDirective.html | 390 + .../directed/GenerateStructureDirective.html | 354 + .../core/directed/GenerateUnionDirective.html | 317 + .../codegen/core/directed/ShapeDirective.html | 329 + .../core/directed/package-summary.html | 289 + .../codegen/core/directed/package-tree.html | 204 + .../smithy/codegen/core/package-summary.html | 374 + .../smithy/codegen/core/package-tree.html | 230 + .../trace/ArtifactDefinitions.Builder.html | 405 + .../core/trace/ArtifactDefinitions.html | 483 + .../codegen/core/trace/ShapeLink.Builder.html | 468 + .../smithy/codegen/core/trace/ShapeLink.html | 640 + .../codegen/core/trace/TraceFile.Builder.html | 510 + .../smithy/codegen/core/trace/TraceFile.html | 606 + .../core/trace/TraceMetadata.Builder.html | 448 + .../codegen/core/trace/TraceMetadata.html | 637 + .../trace/TracingSymbolProvider.Builder.html | 460 + .../core/trace/TracingSymbolProvider.html | 383 + .../codegen/core/trace/package-summary.html | 221 + .../codegen/core/trace/package-tree.html | 170 + .../codegen/core/writer/CodegenWriter.html | 710 + .../core/writer/CodegenWriterDelegator.html | 561 + .../core/writer/CodegenWriterFactory.html | 312 + .../smithy/codegen/core/writer/DocWriter.html | 298 + .../core/writer/DocumentationWriter.html | 296 + .../codegen/core/writer/ImportContainer.html | 306 + .../JavaStyleDocumentationWriterBuilder.html | 464 + .../codegen/core/writer/SymbolWriter.html | 653 + .../codegen/core/writer/package-summary.html | 221 + .../codegen/core/writer/package-tree.html | 185 + .../amazon/smithy/diff/ChangedMetadata.html | 379 + .../amazon/smithy/diff/ChangedShape.html | 613 + .../amazon/smithy/diff/DiffEvaluator.html | 278 + .../amazon/smithy/diff/Differences.html | 536 + .../amazon/smithy/diff/ModelDiff.Builder.html | 399 + .../amazon/smithy/diff/ModelDiff.Result.html | 488 + .../amazon/smithy/diff/ModelDiff.html | 364 + .../evaluators/AbstractDiffEvaluator.html | 467 + .../diff/evaluators/AddedEntityBinding.html | 338 + .../smithy/diff/evaluators/AddedMetadata.html | 333 + .../diff/evaluators/AddedOperationError.html | 333 + .../diff/evaluators/AddedRequiredMember.html | 334 + .../diff/evaluators/AddedServiceError.html | 333 + .../smithy/diff/evaluators/AddedShape.html | 333 + .../diff/evaluators/AddedTraitDefinition.html | 333 + .../diff/evaluators/ChangedDefault.html | 332 + .../diff/evaluators/ChangedEnumTrait.html | 336 + .../diff/evaluators/ChangedLengthTrait.html | 376 + .../diff/evaluators/ChangedMemberOrder.html | 335 + .../diff/evaluators/ChangedMemberTarget.html | 341 + .../diff/evaluators/ChangedMetadata.html | 333 + .../diff/evaluators/ChangedNullability.html | 336 + .../evaluators/ChangedOperationInput.html | 334 + .../evaluators/ChangedOperationOutput.html | 334 + .../diff/evaluators/ChangedRangeTrait.html | 376 + .../ChangedResourceIdentifiers.html | 333 + .../diff/evaluators/ChangedShapeType.html | 333 + .../smithy/diff/evaluators/ModifiedTrait.html | 370 + .../RemovedAuthenticationScheme.html | 333 + .../diff/evaluators/RemovedEntityBinding.html | 338 + .../diff/evaluators/RemovedMetadata.html | 333 + .../evaluators/RemovedOperationError.html | 333 + .../diff/evaluators/RemovedServiceError.html | 333 + .../smithy/diff/evaluators/RemovedShape.html | 334 + .../evaluators/RemovedTraitDefinition.html | 333 + .../smithy/diff/evaluators/ServiceRename.html | 335 + .../diff/evaluators/TraitBreakingChange.html | 334 + .../diff/evaluators/package-summary.html | 358 + .../smithy/diff/evaluators/package-tree.html | 193 + .../amazon/smithy/diff/package-summary.html | 216 + .../amazon/smithy/diff/package-tree.html | 172 + .../jmespath/ExpressionProblem.Severity.html | 403 + .../smithy/jmespath/ExpressionProblem.html | 449 + .../smithy/jmespath/ExpressionSerializer.html | 314 + .../smithy/jmespath/ExpressionVisitor.html | 491 + .../smithy/jmespath/JmespathException.html | 312 + .../smithy/jmespath/JmespathExpression.html | 437 + .../amazon/smithy/jmespath/LinterResult.html | 371 + .../amazon/smithy/jmespath/RuntimeType.html | 490 + .../smithy/jmespath/ast/AndExpression.html | 369 + .../smithy/jmespath/ast/BinaryExpression.html | 409 + .../jmespath/ast/ComparatorExpression.html | 448 + .../smithy/jmespath/ast/ComparatorType.html | 447 + .../jmespath/ast/CurrentExpression.html | 402 + .../ast/ExpressionTypeExpression.html | 428 + .../smithy/jmespath/ast/FieldExpression.html | 430 + .../ast/FilterProjectionExpression.html | 449 + .../jmespath/ast/FlattenExpression.html | 427 + .../jmespath/ast/FunctionExpression.html | 508 + .../smithy/jmespath/ast/IndexExpression.html | 431 + .../jmespath/ast/LiteralExpression.html | 971 + .../ast/MultiSelectHashExpression.html | 427 + .../ast/MultiSelectListExpression.html | 427 + .../smithy/jmespath/ast/NotExpression.html | 423 + .../ast/ObjectProjectionExpression.html | 378 + .../smithy/jmespath/ast/OrExpression.html | 368 + .../jmespath/ast/ProjectionExpression.html | 376 + .../smithy/jmespath/ast/SliceExpression.html | 457 + .../smithy/jmespath/ast/Subexpression.html | 428 + .../smithy/jmespath/ast/package-summary.html | 295 + .../smithy/jmespath/ast/package-tree.html | 203 + .../smithy/jmespath/package-summary.html | 239 + .../amazon/smithy/jmespath/package-tree.html | 198 + .../ConflictingShapeNameException.html | 256 + .../JsonSchemaConfig.MapStrategy.html | 411 + .../JsonSchemaConfig.UnionStrategy.html | 423 + .../smithy/jsonschema/JsonSchemaConfig.html | 1100 + .../JsonSchemaConverter.Builder.html | 454 + .../jsonschema/JsonSchemaConverter.html | 512 + .../smithy/jsonschema/JsonSchemaMapper.html | 333 + .../jsonschema/JsonSchemaMapperContext.html | 314 + .../smithy/jsonschema/JsonSchemaVersion.html | 409 + .../jsonschema/PropertyNamingStrategy.html | 313 + .../smithy/jsonschema/Schema.Builder.html | 959 + .../amazon/smithy/jsonschema/Schema.html | 1008 + .../jsonschema/SchemaDocument.Builder.html | 427 + .../smithy/jsonschema/SchemaDocument.html | 553 + .../jsonschema/SmithyJsonSchemaException.html | 315 + .../smithy/jsonschema/package-summary.html | 279 + .../smithy/jsonschema/package-tree.html | 208 + .../AbbreviationNameValidator.Config.html | 330 + .../AbbreviationNameValidator.Provider.html | 303 + .../linters/AbbreviationNameValidator.html | 339 + .../linters/CamelCaseValidator.Config.html | 332 + ...CamelCaseValidator.MemberNameHandling.html | 402 + .../linters/CamelCaseValidator.Provider.html | 303 + .../smithy/linters/CamelCaseValidator.html | 344 + ...utputStructureReuseValidator.Provider.html | 303 + .../InputOutputStructureReuseValidator.html | 372 + .../MissingClientOptionalTrait.Config.html | 371 + .../MissingClientOptionalTrait.Provider.html | 303 + .../linters/MissingClientOptionalTrait.html | 379 + ...MissingPaginatedTraitValidator.Config.html | 434 + ...ssingPaginatedTraitValidator.Provider.html | 303 + .../MissingPaginatedTraitValidator.html | 350 + ...MissingSensitiveTraitValidator.Config.html | 351 + ...ssingSensitiveTraitValidator.Provider.html | 303 + .../MissingSensitiveTraitValidator.html | 339 + .../NoninclusiveTermsValidator.Config.html | 351 + .../NoninclusiveTermsValidator.Provider.html | 303 + .../linters/NoninclusiveTermsValidator.html | 340 + .../RepeatedShapeNameValidator.Config.html | 322 + .../RepeatedShapeNameValidator.Provider.html | 303 + .../linters/RepeatedShapeNameValidator.html | 337 + .../ReservedWordsValidator.Config.html | 330 + .../ReservedWordsValidator.Provider.html | 303 + .../ReservedWordsValidator.ReservedWords.html | 382 + .../linters/ReservedWordsValidator.html | 364 + ...ouldHaveUsedTimestampValidator.Config.html | 331 + ...ldHaveUsedTimestampValidator.Provider.html | 303 + .../ShouldHaveUsedTimestampValidator.html | 357 + ...StandardOperationVerbValidator.Config.html | 400 + ...andardOperationVerbValidator.Provider.html | 303 + .../StandardOperationVerbValidator.html | 345 + .../StutteredShapeNameValidator.Provider.html | 303 + .../linters/StutteredShapeNameValidator.html | 379 + .../smithy/linters/package-summary.html | 359 + .../amazon/smithy/linters/package-tree.html | 217 + .../smithy/model/FromSourceLocation.html | 290 + .../amazon/smithy/model/Model.Builder.html | 493 + .../software/amazon/smithy/model/Model.html | 1956 ++ .../amazon/smithy/model/SourceException.html | 392 + .../amazon/smithy/model/SourceLocation.html | 526 + .../smithy/model/knowledge/BottomUpIndex.html | 397 + .../smithy/model/knowledge/BoxIndex.html | 366 + .../model/knowledge/EventStreamIndex.html | 371 + .../model/knowledge/EventStreamInfo.html | 520 + .../model/knowledge/HttpBinding.Location.html | 472 + .../smithy/model/knowledge/HttpBinding.html | 400 + .../model/knowledge/HttpBindingIndex.html | 738 + .../IdentifierBindingIndex.BindingType.html | 402 + .../knowledge/IdentifierBindingIndex.html | 455 + .../model/knowledge/KnowledgeIndex.html | 230 + .../knowledge/NeighborProviderIndex.html | 394 + .../knowledge/NullableIndex.CheckMode.html | 462 + .../smithy/model/knowledge/NullableIndex.html | 491 + .../model/knowledge/OperationIndex.html | 715 + .../model/knowledge/PaginatedIndex.html | 334 + .../model/knowledge/PaginationInfo.html | 450 + .../model/knowledge/PropertyBindingIndex.html | 395 + .../ServiceIndex.AuthSchemeMode.html | 390 + .../smithy/model/knowledge/ServiceIndex.html | 559 + .../smithy/model/knowledge/TextIndex.html | 324 + .../TextInstance.TextLocationType.html | 394 + .../smithy/model/knowledge/TextInstance.html | 382 + .../smithy/model/knowledge/TopDownIndex.html | 357 + .../model/knowledge/package-summary.html | 321 + .../smithy/model/knowledge/package-tree.html | 204 + .../amazon/smithy/model/loader/IdlToken.html | 705 + .../smithy/model/loader/IdlTokenizer.html | 740 + .../smithy/model/loader/ModelAssembler.html | 979 + .../smithy/model/loader/ModelDiscovery.html | 440 + .../model/loader/ModelImportException.html | 312 + .../model/loader/ModelManifestException.html | 311 + .../model/loader/ModelSyntaxException.html | 392 + .../smithy/model/loader/ParserUtils.html | 584 + .../amazon/smithy/model/loader/Prelude.html | 359 + .../smithy/model/loader/StringTable.html | 346 + .../TopologicalShapeSort.CycleException.html | 366 + .../model/loader/TopologicalShapeSort.html | 387 + .../smithy/model/loader/package-summary.html | 267 + .../smithy/model/loader/package-tree.html | 210 + .../SourceContextLoader.Line.html | 395 + .../sourcecontext/SourceContextLoader.html | 335 + .../loader/sourcecontext/package-summary.html | 183 + .../loader/sourcecontext/package-tree.html | 167 + .../model/neighbor/NeighborProvider.html | 467 + .../smithy/model/neighbor/Relationship.html | 531 + .../model/neighbor/RelationshipDirection.html | 389 + .../model/neighbor/RelationshipType.html | 1027 + .../model/neighbor/UnreferencedShapes.html | 368 + .../UnreferencedTraitDefinitions.html | 324 + .../amazon/smithy/model/neighbor/Walker.html | 476 + .../model/neighbor/package-summary.html | 226 + .../smithy/model/neighbor/package-tree.html | 185 + .../smithy/model/node/ArrayNode.Builder.html | 386 + .../amazon/smithy/model/node/ArrayNode.html | 822 + .../amazon/smithy/model/node/BooleanNode.html | 533 + .../node/ExpectationNotMetException.html | 312 + .../model/node/Node.NonNumericFloat.html | 453 + .../amazon/smithy/model/node/Node.html | 1780 + .../node/NodeDeserializationException.html | 328 + .../model/node/NodeMapper.WhenMissing.html | 433 + .../amazon/smithy/model/node/NodeMapper.html | 841 + .../amazon/smithy/model/node/NodePointer.html | 529 + .../node/NodeSerializationException.html | 312 + .../amazon/smithy/model/node/NodeType.html | 468 + .../model/node/NodeVisitor.Default.html | 501 + .../amazon/smithy/model/node/NodeVisitor.html | 407 + .../amazon/smithy/model/node/NullNode.html | 510 + .../amazon/smithy/model/node/NumberNode.html | 698 + .../smithy/model/node/ObjectNode.Builder.html | 442 + .../amazon/smithy/model/node/ObjectNode.html | 1900 ++ .../amazon/smithy/model/node/StringNode.html | 713 + .../amazon/smithy/model/node/ToNode.html | 264 + .../model/node/internal/NodeHandler.html | 338 + .../model/node/internal/package-summary.html | 215 + .../model/node/internal/package-tree.html | 161 + .../smithy/model/node/package-summary.html | 315 + .../smithy/model/node/package-tree.html | 217 + .../amazon/smithy/model/package-summary.html | 213 + .../amazon/smithy/model/package-tree.html | 182 + .../pattern/InvalidPatternException.html | 306 + .../pattern/InvalidUriPatternException.html | 261 + .../model/pattern/SmithyPattern.Builder.html | 311 + .../pattern/SmithyPattern.Segment.Type.html | 393 + .../model/pattern/SmithyPattern.Segment.html | 490 + .../smithy/model/pattern/SmithyPattern.html | 527 + .../smithy/model/pattern/UriPattern.html | 445 + .../smithy/model/pattern/package-summary.html | 222 + .../smithy/model/pattern/package-tree.html | 202 + .../smithy/model/selector/AttributeValue.html | 571 + .../model/selector/PathFinder.Path.html | 524 + .../smithy/model/selector/PathFinder.html | 472 + .../model/selector/Selector.Runner.html | 315 + .../model/selector/Selector.ShapeMatch.html | 391 + .../selector/Selector.StartingContext.html | 378 + .../smithy/model/selector/Selector.html | 599 + .../model/selector/SelectorException.html | 316 + .../selector/SelectorSyntaxException.html | 256 + .../model/selector/package-summary.html | 237 + .../smithy/model/selector/package-tree.html | 205 + .../model/shapes/AbstractShapeBuilder.html | 782 + .../model/shapes/BigDecimalShape.Builder.html | 359 + .../smithy/model/shapes/BigDecimalShape.html | 422 + .../model/shapes/BigIntegerShape.Builder.html | 359 + .../smithy/model/shapes/BigIntegerShape.html | 422 + .../model/shapes/BlobShape.Builder.html | 359 + .../amazon/smithy/model/shapes/BlobShape.html | 417 + .../model/shapes/BooleanShape.Builder.html | 359 + .../smithy/model/shapes/BooleanShape.html | 417 + .../model/shapes/ByteShape.Builder.html | 359 + .../amazon/smithy/model/shapes/ByteShape.html | 422 + .../model/shapes/CollectionShape.Builder.html | 527 + .../smithy/model/shapes/CollectionShape.html | 376 + .../model/shapes/DocumentShape.Builder.html | 359 + .../smithy/model/shapes/DocumentShape.html | 417 + .../model/shapes/DoubleShape.Builder.html | 359 + .../smithy/model/shapes/DoubleShape.html | 422 + .../model/shapes/EntityShape.Builder.html | 495 + .../smithy/model/shapes/EntityShape.html | 444 + .../model/shapes/EnumShape.Builder.html | 737 + .../amazon/smithy/model/shapes/EnumShape.html | 579 + .../model/shapes/FloatShape.Builder.html | 359 + .../smithy/model/shapes/FloatShape.html | 422 + .../model/shapes/IntEnumShape.Builder.html | 655 + .../smithy/model/shapes/IntEnumShape.html | 478 + .../model/shapes/IntegerShape.Builder.html | 363 + .../smithy/model/shapes/IntegerShape.html | 426 + .../model/shapes/ListShape.Builder.html | 375 + .../amazon/smithy/model/shapes/ListShape.html | 428 + .../model/shapes/LongShape.Builder.html | 359 + .../amazon/smithy/model/shapes/LongShape.html | 422 + .../smithy/model/shapes/MapShape.Builder.html | 613 + .../amazon/smithy/model/shapes/MapShape.html | 506 + .../model/shapes/MemberShape.Builder.html | 425 + .../smithy/model/shapes/MemberShape.html | 639 + .../model/shapes/ModelSerializer.Builder.html | 417 + .../smithy/model/shapes/ModelSerializer.html | 315 + .../smithy/model/shapes/NumberShape.html | 253 + .../model/shapes/OperationShape.Builder.html | 571 + .../smithy/model/shapes/OperationShape.html | 613 + .../model/shapes/ResourceShape.Builder.html | 659 + .../smithy/model/shapes/ResourceShape.html | 691 + .../model/shapes/ServiceShape.Builder.html | 616 + .../smithy/model/shapes/ServiceShape.html | 615 + .../smithy/model/shapes/SetShape.Builder.html | 780 + .../amazon/smithy/model/shapes/SetShape.html | 456 + .../amazon/smithy/model/shapes/Shape.html | 1832 + .../amazon/smithy/model/shapes/ShapeId.html | 794 + .../model/shapes/ShapeIdSyntaxException.html | 302 + .../model/shapes/ShapeType.Category.html | 406 + .../amazon/smithy/model/shapes/ShapeType.html | 817 + .../shapes/ShapeVisitor.DataShapeVisitor.html | 383 + .../model/shapes/ShapeVisitor.Default.html | 730 + .../smithy/model/shapes/ShapeVisitor.html | 621 + .../model/shapes/ShortShape.Builder.html | 359 + .../smithy/model/shapes/ShortShape.html | 422 + .../smithy/model/shapes/SimpleShape.html | 248 + .../model/shapes/SmithyIdlComponentOrder.html | 413 + .../SmithyIdlModelSerializer.Builder.html | 581 + .../shapes/SmithyIdlModelSerializer.html | 349 + .../model/shapes/StringShape.Builder.html | 363 + .../smithy/model/shapes/StringShape.html | 421 + .../model/shapes/StructureShape.Builder.html | 686 + .../smithy/model/shapes/StructureShape.html | 440 + .../model/shapes/TimestampShape.Builder.html | 359 + .../smithy/model/shapes/TimestampShape.html | 417 + .../amazon/smithy/model/shapes/ToShapeId.html | 261 + .../model/shapes/UnionShape.Builder.html | 686 + .../smithy/model/shapes/UnionShape.html | 436 + .../smithy/model/shapes/package-summary.html | 599 + .../smithy/model/shapes/package-tree.html | 305 + .../model/traits/AbstractTrait.Provider.html | 336 + .../smithy/model/traits/AbstractTrait.html | 555 + .../model/traits/AbstractTraitBuilder.html | 356 + .../traits/AddedDefaultTrait.Provider.html | 298 + .../model/traits/AddedDefaultTrait.html | 367 + .../traits/AnnotationTrait.Provider.html | 349 + .../smithy/model/traits/AnnotationTrait.html | 444 + .../traits/AuthDefinitionTrait.Builder.html | 362 + .../traits/AuthDefinitionTrait.Provider.html | 337 + .../model/traits/AuthDefinitionTrait.html | 474 + .../model/traits/AuthTrait.Provider.html | 337 + .../amazon/smithy/model/traits/AuthTrait.html | 496 + .../model/traits/BoxTrait.Provider.html | 298 + .../amazon/smithy/model/traits/BoxTrait.html | 435 + .../traits/ClientOptionalTrait.Provider.html | 298 + .../model/traits/ClientOptionalTrait.html | 386 + .../model/traits/CorsTrait.Builder.html | 350 + .../model/traits/CorsTrait.Provider.html | 348 + .../amazon/smithy/model/traits/CorsTrait.html | 502 + .../model/traits/DefaultTrait.Provider.html | 337 + .../smithy/model/traits/DefaultTrait.html | 405 + .../model/traits/DeprecatedTrait.Builder.html | 323 + .../traits/DeprecatedTrait.Provider.html | 337 + .../smithy/model/traits/DeprecatedTrait.html | 459 + .../traits/DocumentationTrait.Provider.html | 298 + .../model/traits/DocumentationTrait.html | 382 + .../smithy/model/traits/DynamicTrait.html | 360 + .../traits/EffectiveTraitQuery.Builder.html | 399 + .../model/traits/EffectiveTraitQuery.html | 351 + .../model/traits/EndpointTrait.Builder.html | 308 + .../model/traits/EndpointTrait.Provider.html | 337 + .../smithy/model/traits/EndpointTrait.html | 429 + .../model/traits/EnumDefinition.Builder.html | 424 + .../smithy/model/traits/EnumDefinition.html | 482 + .../model/traits/EnumTrait.Builder.html | 395 + .../model/traits/EnumTrait.Provider.html | 348 + .../amazon/smithy/model/traits/EnumTrait.html | 561 + .../model/traits/EnumValueTrait.Builder.html | 362 + .../model/traits/EnumValueTrait.Provider.html | 337 + .../smithy/model/traits/EnumValueTrait.html | 499 + .../model/traits/ErrorTrait.Provider.html | 298 + .../smithy/model/traits/ErrorTrait.html | 463 + .../traits/EventHeaderTrait.Provider.html | 298 + .../smithy/model/traits/EventHeaderTrait.html | 371 + .../traits/EventPayloadTrait.Provider.html | 298 + .../model/traits/EventPayloadTrait.html | 371 + .../model/traits/ExamplesTrait.Builder.html | 363 + .../ExamplesTrait.ErrorExample.Builder.html | 353 + .../traits/ExamplesTrait.ErrorExample.html | 472 + .../traits/ExamplesTrait.Example.Builder.html | 410 + .../model/traits/ExamplesTrait.Example.html | 493 + .../model/traits/ExamplesTrait.Provider.html | 348 + .../smithy/model/traits/ExamplesTrait.html | 487 + .../ExternalDocumentationTrait.Builder.html | 379 + .../ExternalDocumentationTrait.Provider.html | 348 + .../traits/ExternalDocumentationTrait.html | 478 + .../model/traits/HostLabelTrait.Provider.html | 298 + .../smithy/model/traits/HostLabelTrait.html | 369 + .../traits/HttpApiKeyAuthTrait.Builder.html | 336 + .../traits/HttpApiKeyAuthTrait.Location.html | 398 + .../traits/HttpApiKeyAuthTrait.Provider.html | 337 + .../model/traits/HttpApiKeyAuthTrait.html | 459 + .../traits/HttpBasicAuthTrait.Provider.html | 298 + .../model/traits/HttpBasicAuthTrait.html | 368 + .../traits/HttpBearerAuthTrait.Provider.html | 298 + .../model/traits/HttpBearerAuthTrait.html | 368 + .../HttpChecksumRequiredTrait.Provider.html | 298 + .../traits/HttpChecksumRequiredTrait.html | 370 + .../traits/HttpDigestAuthTrait.Provider.html | 298 + .../model/traits/HttpDigestAuthTrait.html | 368 + .../model/traits/HttpErrorTrait.Provider.html | 337 + .../smithy/model/traits/HttpErrorTrait.html | 434 + .../traits/HttpHeaderTrait.Provider.html | 298 + .../smithy/model/traits/HttpHeaderTrait.html | 382 + .../model/traits/HttpLabelTrait.Provider.html | 298 + .../smithy/model/traits/HttpLabelTrait.html | 369 + .../traits/HttpPayloadTrait.Provider.html | 298 + .../smithy/model/traits/HttpPayloadTrait.html | 368 + .../HttpPrefixHeadersTrait.Provider.html | 298 + .../model/traits/HttpPrefixHeadersTrait.html | 382 + .../traits/HttpQueryParamsTrait.Provider.html | 298 + .../model/traits/HttpQueryParamsTrait.html | 368 + .../model/traits/HttpQueryTrait.Provider.html | 298 + .../smithy/model/traits/HttpQueryTrait.html | 382 + .../HttpResponseCodeTrait.Provider.html | 298 + .../model/traits/HttpResponseCodeTrait.html | 370 + .../model/traits/HttpTrait.Builder.html | 377 + .../model/traits/HttpTrait.Provider.html | 337 + .../amazon/smithy/model/traits/HttpTrait.html | 495 + .../model/traits/IdRefTrait.Builder.html | 336 + .../model/traits/IdRefTrait.Provider.html | 348 + .../smithy/model/traits/IdRefTrait.html | 464 + .../IdempotencyTokenTrait.Provider.html | 298 + .../model/traits/IdempotencyTokenTrait.html | 369 + .../traits/IdempotentTrait.Provider.html | 298 + .../smithy/model/traits/IdempotentTrait.html | 368 + .../model/traits/InputTrait.Provider.html | 298 + .../smithy/model/traits/InputTrait.html | 381 + .../model/traits/InternalTrait.Provider.html | 298 + .../smithy/model/traits/InternalTrait.html | 369 + .../model/traits/JsonNameTrait.Provider.html | 298 + .../smithy/model/traits/JsonNameTrait.html | 383 + .../model/traits/LengthTrait.Builder.html | 363 + .../model/traits/LengthTrait.Provider.html | 348 + .../smithy/model/traits/LengthTrait.html | 459 + .../model/traits/MediaTypeTrait.Provider.html | 298 + .../smithy/model/traits/MediaTypeTrait.html | 382 + .../model/traits/MixinTrait.Builder.html | 363 + .../model/traits/MixinTrait.Provider.html | 348 + .../smithy/model/traits/MixinTrait.html | 465 + .../NestedPropertiesTrait.Provider.html | 298 + .../model/traits/NestedPropertiesTrait.html | 356 + .../model/traits/NoReplaceTrait.Provider.html | 298 + .../smithy/model/traits/NoReplaceTrait.html | 370 + .../traits/NotPropertyTrait.Provider.html | 298 + .../smithy/model/traits/NotPropertyTrait.html | 369 + .../traits/OptionalAuthTrait.Provider.html | 298 + .../model/traits/OptionalAuthTrait.html | 368 + .../model/traits/OutputTrait.Provider.html | 298 + .../smithy/model/traits/OutputTrait.html | 381 + .../model/traits/PaginatedTrait.Builder.html | 391 + .../model/traits/PaginatedTrait.Provider.html | 348 + .../smithy/model/traits/PaginatedTrait.html | 596 + .../model/traits/PatternTrait.Provider.html | 298 + .../smithy/model/traits/PatternTrait.html | 427 + .../model/traits/PrivateTrait.Provider.html | 298 + .../smithy/model/traits/PrivateTrait.html | 369 + .../model/traits/PropertyTrait.Builder.html | 348 + .../model/traits/PropertyTrait.Provider.html | 348 + .../smithy/model/traits/PropertyTrait.html | 425 + .../ProtocolDefinitionTrait.Builder.html | 376 + .../ProtocolDefinitionTrait.Provider.html | 337 + .../model/traits/ProtocolDefinitionTrait.html | 495 + .../model/traits/RangeTrait.Builder.html | 363 + .../model/traits/RangeTrait.Provider.html | 348 + .../smithy/model/traits/RangeTrait.html | 459 + .../model/traits/ReadonlyTrait.Provider.html | 298 + .../smithy/model/traits/ReadonlyTrait.html | 368 + .../traits/RecommendedTrait.Builder.html | 349 + .../traits/RecommendedTrait.Provider.html | 348 + .../smithy/model/traits/RecommendedTrait.html | 437 + .../model/traits/ReferencesTrait.Builder.html | 377 + .../traits/ReferencesTrait.Provider.html | 348 + .../ReferencesTrait.Reference.Builder.html | 342 + .../traits/ReferencesTrait.Reference.html | 481 + .../smithy/model/traits/ReferencesTrait.html | 508 + .../RequestCompressionTrait.Builder.html | 336 + .../RequestCompressionTrait.Provider.html | 337 + .../model/traits/RequestCompressionTrait.html | 460 + .../model/traits/RequiredTrait.Provider.html | 298 + .../smithy/model/traits/RequiredTrait.html | 368 + .../traits/RequiresLengthTrait.Provider.html | 298 + .../model/traits/RequiresLengthTrait.html | 368 + .../ResourceIdentifierTrait.Provider.html | 298 + .../model/traits/ResourceIdentifierTrait.html | 383 + .../model/traits/RetryableTrait.Builder.html | 318 + .../model/traits/RetryableTrait.Provider.html | 348 + .../smithy/model/traits/RetryableTrait.html | 474 + .../model/traits/SensitiveTrait.Provider.html | 298 + .../smithy/model/traits/SensitiveTrait.html | 369 + .../model/traits/SinceTrait.Provider.html | 298 + .../smithy/model/traits/SinceTrait.html | 382 + .../model/traits/SparseTrait.Provider.html | 298 + .../smithy/model/traits/SparseTrait.html | 368 + .../model/traits/StreamingTrait.Provider.html | 298 + .../smithy/model/traits/StreamingTrait.html | 443 + .../model/traits/StringListTrait.Builder.html | 433 + .../traits/StringListTrait.Provider.html | 349 + ...gListTrait.StringListTraitConstructor.html | 274 + .../smithy/model/traits/StringListTrait.html | 412 + .../model/traits/StringTrait.Provider.html | 349 + .../smithy/model/traits/StringTrait.html | 397 + .../model/traits/SuppressTrait.Builder.html | 306 + .../model/traits/SuppressTrait.Provider.html | 298 + .../smithy/model/traits/SuppressTrait.html | 403 + .../model/traits/TagsTrait.Builder.html | 306 + .../model/traits/TagsTrait.Provider.html | 298 + .../amazon/smithy/model/traits/TagsTrait.html | 435 + .../traits/TimestampFormatTrait.Format.html | 450 + .../traits/TimestampFormatTrait.Provider.html | 298 + .../model/traits/TimestampFormatTrait.html | 488 + .../model/traits/TitleTrait.Provider.html | 298 + .../smithy/model/traits/TitleTrait.html | 382 + .../amazon/smithy/model/traits/Trait.html | 474 + .../TraitDefinition.BreakingChangeRule.html | 493 + .../model/traits/TraitDefinition.Builder.html | 407 + .../traits/TraitDefinition.ChangeType.html | 502 + .../traits/TraitDefinition.Provider.html | 348 + ...TraitDefinition.StructurallyExclusive.html | 444 + .../smithy/model/traits/TraitDefinition.html | 625 + .../smithy/model/traits/TraitFactory.html | 343 + .../smithy/model/traits/TraitService.html | 288 + .../traits/TraitValidatorsTrait.Builder.html | 324 + .../traits/TraitValidatorsTrait.Provider.html | 348 + .../TraitValidatorsTrait.Validator.html | 434 + .../model/traits/TraitValidatorsTrait.html | 437 + .../traits/UniqueItemsTrait.Provider.html | 298 + .../smithy/model/traits/UniqueItemsTrait.html | 368 + .../model/traits/UnitTypeTrait.Provider.html | 298 + .../smithy/model/traits/UnitTypeTrait.html | 387 + .../model/traits/UnstableTrait.Provider.html | 298 + .../smithy/model/traits/UnstableTrait.html | 368 + .../traits/XmlAttributeTrait.Provider.html | 298 + .../model/traits/XmlAttributeTrait.html | 368 + .../traits/XmlFlattenedTrait.Provider.html | 298 + .../model/traits/XmlFlattenedTrait.html | 367 + .../model/traits/XmlNameTrait.Provider.html | 298 + .../smithy/model/traits/XmlNameTrait.html | 383 + .../traits/XmlNamespaceTrait.Builder.html | 323 + .../traits/XmlNamespaceTrait.Provider.html | 348 + .../model/traits/XmlNamespaceTrait.html | 445 + .../smithy/model/traits/package-summary.html | 1266 + .../smithy/model/traits/package-tree.html | 433 + .../model/traits/synthetic/NoAuthTrait.html | 398 + .../synthetic/OriginalShapeIdTrait.html | 447 + .../synthetic/SyntheticEnumTrait.Builder.html | 350 + .../traits/synthetic/SyntheticEnumTrait.html | 434 + .../traits/synthetic/package-summary.html | 183 + .../model/traits/synthetic/package-tree.html | 184 + .../transform/ChangeShapeTypeOption.html | 369 + .../transform/ModelTransformException.html | 312 + .../model/transform/ModelTransformer.html | 1399 + .../transform/ModelTransformerPlugin.html | 272 + .../model/transform/package-summary.html | 217 + .../smithy/model/transform/package-tree.html | 194 + .../transform/plugins/CleanBindings.html | 330 + .../plugins/CleanOperationStructures.html | 329 + .../plugins/CleanResourceReferences.html | 329 + .../plugins/CleanServiceRenames.html | 328 + .../CleanStructureAndUnionMembers.html | 335 + .../plugins/CleanTraitDefinitions.html | 329 + .../model/transform/plugins/RemoveMixins.html | 328 + .../model/transform/plugins/RemoveTraits.html | 328 + .../transform/plugins/package-summary.html | 213 + .../model/transform/plugins/package-tree.html | 168 + .../model/validation/AbstractValidator.html | 1070 + .../ContextualValidationEventFormatter.html | 331 + .../LineValidationEventFormatter.html | 322 + .../NodeValidationVisitor.Builder.html | 492 + .../NodeValidationVisitor.Feature.html | 437 + .../validation/NodeValidationVisitor.html | 785 + .../smithy/model/validation/Severity.html | 511 + .../model/validation/ValidatedResult.html | 561 + .../validation/ValidatedResultException.html | 336 + .../validation/ValidationEvent.Builder.html | 520 + .../model/validation/ValidationEvent.html | 714 + .../validation/ValidationEventDecorator.html | 351 + .../validation/ValidationEventFormatter.html | 262 + .../model/validation/ValidationUtils.html | 427 + .../smithy/model/validation/Validator.html | 352 + .../model/validation/ValidatorFactory.html | 407 + .../validation/ValidatorService.Provider.html | 406 + .../model/validation/ValidatorService.html | 338 + .../EmitEachSelectorValidator.Config.html | 414 + .../EmitEachSelectorValidator.Provider.html | 303 + .../linters/EmitEachSelectorValidator.html | 382 + .../EmitNoneSelectorValidator.Config.html | 332 + .../EmitNoneSelectorValidator.Provider.html | 303 + .../linters/EmitNoneSelectorValidator.html | 338 + .../UnreferencedShapeValidator.Config.html | 333 + .../UnreferencedShapeValidator.Provider.html | 303 + .../linters/UnreferencedShapeValidator.html | 340 + .../validation/linters/package-summary.html | 206 + .../validation/linters/package-tree.html | 177 + .../node/NodeValidatorPlugin.Context.html | 404 + .../node/NodeValidatorPlugin.Emitter.html | 297 + .../validation/node/NodeValidatorPlugin.html | 361 + .../node/TimestampValidationStrategy.html | 433 + .../validation/node/package-summary.html | 206 + .../model/validation/node/package-tree.html | 182 + .../model/validation/package-summary.html | 307 + .../smithy/model/validation/package-tree.html | 208 + .../ModelBasedEventDecorator.html | 365 + .../suppressions/SeverityOverride.html | 288 + .../validation/suppressions/Suppression.html | 338 + .../suppressions/package-summary.html | 190 + .../validation/suppressions/package-tree.html | 168 + .../testrunner/SmithyTestCase.Error.html | 303 + .../testrunner/SmithyTestCase.Result.html | 371 + .../validation/testrunner/SmithyTestCase.html | 437 + .../testrunner/SmithyTestSuite.Error.html | 303 + .../testrunner/SmithyTestSuite.Result.html | 309 + .../testrunner/SmithyTestSuite.html | 613 + .../testrunner/package-summary.html | 208 + .../validation/testrunner/package-tree.html | 178 + .../validators/AuthTraitValidator.html | 350 + .../validators/DefaultTraitValidator.html | 347 + .../DefaultValueInUpdateValidator.html | 350 + .../validators/DeprecatedTraitValidator.html | 348 + .../validators/EnumShapeValidator.html | 353 + .../validators/EnumTraitValidator.html | 352 + .../EventPayloadTraitValidator.html | 352 + .../validators/ExamplesTraitValidator.html | 348 + ...xclusiveStructureMemberTraitValidator.html | 348 + .../validators/HostLabelTraitValidator.html | 363 + .../HttpApiKeyAuthTraitValidator.html | 350 + .../HttpBindingTraitIgnoredValidator.html | 358 + .../HttpBindingsMissingValidator.html | 349 + .../validators/HttpHeaderTraitValidator.html | 348 + .../validators/HttpLabelTraitValidator.html | 360 + .../HttpMethodSemanticsValidator.html | 349 + .../validators/HttpPayloadValidator.html | 349 + .../HttpPrefixHeadersTraitValidator.html | 349 + .../HttpQueryParamsTraitValidator.html | 349 + .../validators/HttpQueryTraitValidator.html | 348 + .../HttpResponseCodeSemanticsValidator.html | 348 + .../validators/HttpUriConflictValidator.html | 348 + .../validators/HttpUriFormatValidator.html | 347 + .../validators/JsonNameValidator.html | 347 + .../validators/LengthTraitValidator.html | 347 + .../validators/MediaTypeValidator.html | 347 + .../NoInlineDocumentSupportValidator.html | 349 + .../validators/OperationValidator.html | 362 + .../validators/PaginatedTraitValidator.html | 362 + .../validators/PatternTraitValidator.html | 348 + .../validators/PrivateAccessValidator.html | 349 + .../validators/RangeTraitValidator.html | 348 + .../validators/ReferencesTraitValidator.html | 348 + .../RequestCompressionTraitValidator.html | 353 + .../validators/ResourceCycleValidator.html | 348 + .../ResourceIdentifierBindingValidator.html | 352 + .../ResourceIdentifierValidator.html | 349 + .../ResourceLifecycleValidator.html | 348 + ...ResourceOperationInputOutputValidator.html | 348 + .../ServiceAuthDefinitionsValidator.html | 348 + .../validators/ServiceValidator.html | 360 + .../validation/validators/SetValidator.html | 347 + .../validators/ShapeIdConflictValidator.html | 349 + .../validators/ShapeRecursionValidator.html | 356 + .../SingleOperationBindingValidator.html | 349 + .../SingleResourceBindingValidator.html | 349 + .../validators/StreamingTraitValidator.html | 355 + .../validators/TargetValidator.html | 348 + .../TraitBreakingChangesValidator.html | 349 + .../validators/TraitConflictValidator.html | 348 + .../validators/TraitTargetValidator.html | 354 + .../validators/TraitValidatorsValidator.html | 347 + .../validators/TraitValueValidator.html | 375 + .../validation/validators/UnionValidator.html | 347 + .../validators/UnitTypeValidator.html | 349 + .../UnreferencedShapeValidator.html | 359 + .../validators/UnstableTraitValidator.html | 348 + .../XmlNamespaceTraitValidator.html | 352 + .../validators/package-summary.html | 530 + .../validation/validators/package-tree.html | 222 + .../mqtt/traits/MqttJsonTrait.Provider.html | 298 + .../smithy/mqtt/traits/MqttJsonTrait.html | 367 + .../mqtt/traits/PublishTrait.Provider.html | 298 + .../smithy/mqtt/traits/PublishTrait.html | 427 + .../mqtt/traits/ResolvedTopicIndex.html | 446 + .../mqtt/traits/SubscribeTrait.Provider.html | 298 + .../smithy/mqtt/traits/SubscribeTrait.html | 427 + .../smithy/mqtt/traits/Topic.Level.html | 418 + .../amazon/smithy/mqtt/traits/Topic.html | 443 + .../smithy/mqtt/traits/TopicBinding.html | 533 + .../mqtt/traits/TopicLabelTrait.Provider.html | 298 + .../smithy/mqtt/traits/TopicLabelTrait.html | 368 + .../mqtt/traits/TopicSyntaxException.html | 297 + .../smithy/mqtt/traits/package-summary.html | 245 + .../smithy/mqtt/traits/package-tree.html | 209 + .../MqttTopicConflictValidator.html | 351 + .../validators/MqttTopicLabelValidator.html | 355 + .../traits/validators/package-summary.html | 173 + .../mqtt/traits/validators/package-tree.html | 166 + ...g.ErrorStatusConflictHandlingStrategy.html | 389 + ...enApiConfig.HttpPrefixHeadersStrategy.html | 387 + .../amazon/smithy/openapi/OpenApiConfig.html | 1013 + .../smithy/openapi/OpenApiException.html | 324 + .../amazon/smithy/openapi/OpenApiUtils.html | 304 + .../amazon/smithy/openapi/OpenApiVersion.html | 423 + .../smithy/openapi/fromsmithy/Context.html | 647 + .../openapi/fromsmithy/CoreExtension.html | 398 + .../openapi/fromsmithy/OpenApiConverter.html | 425 + .../fromsmithy/OpenApiJsonSchemaMapper.html | 339 + .../openapi/fromsmithy/OpenApiMapper.html | 691 + .../fromsmithy/OpenApiProtocol.Operation.html | 338 + .../openapi/fromsmithy/OpenApiProtocol.html | 510 + .../fromsmithy/SecuritySchemeConverter.html | 475 + .../openapi/fromsmithy/Smithy2OpenApi.html | 356 + .../fromsmithy/Smithy2OpenApiExtension.html | 332 + .../mappers/CheckForGreedyLabels.html | 364 + .../mappers/CheckForPrefixHeaders.html | 364 + .../fromsmithy/mappers/OpenApiJsonAdd.html | 369 + .../mappers/OpenApiJsonSubstitutions.html | 365 + .../mappers/RemoveEmptyComponents.html | 365 + .../mappers/RemoveUnusedComponents.html | 367 + .../SpecificationExtensionsMapper.html | 368 + .../fromsmithy/mappers/UnsupportedTraits.html | 360 + .../fromsmithy/mappers/package-summary.html | 214 + .../fromsmithy/mappers/package-tree.html | 168 + .../openapi/fromsmithy/package-summary.html | 236 + .../openapi/fromsmithy/package-tree.html | 175 + .../protocols/AwsRestJson1Protocol.html | 507 + .../fromsmithy/protocols/package-summary.html | 166 + .../fromsmithy/protocols/package-tree.html | 161 + .../fromsmithy/security/AwsV4Converter.html | 391 + .../security/HttpApiKeyAuthConverter.html | 397 + .../security/HttpBasicConverter.html | 358 + .../security/HttpBearerConverter.html | 358 + .../security/HttpDigestConverter.html | 358 + .../fromsmithy/security/package-summary.html | 190 + .../fromsmithy/security/package-tree.html | 165 + .../openapi/model/CallbackObject.Builder.html | 324 + .../smithy/openapi/model/CallbackObject.html | 362 + .../openapi/model/Component.Builder.html | 430 + .../smithy/openapi/model/Component.html | 434 + .../model/ComponentsObject.Builder.html | 562 + .../openapi/model/ComponentsObject.html | 460 + .../openapi/model/EncodingObject.Builder.html | 380 + .../smithy/openapi/model/EncodingObject.html | 418 + .../openapi/model/ExampleObject.Builder.html | 350 + .../smithy/openapi/model/ExampleObject.html | 418 + .../model/ExternalDocumentation.Builder.html | 322 + .../openapi/model/ExternalDocumentation.html | 394 + .../openapi/model/InfoObject.Builder.html | 378 + .../smithy/openapi/model/InfoObject.html | 432 + .../openapi/model/LinkObject.Builder.html | 378 + .../smithy/openapi/model/LinkObject.html | 432 + .../model/MediaTypeObject.Builder.html | 382 + .../smithy/openapi/model/MediaTypeObject.html | 404 + .../smithy/openapi/model/OpenApi.Builder.html | 492 + .../amazon/smithy/openapi/model/OpenApi.html | 460 + .../model/OperationObject.Builder.html | 550 + .../smithy/openapi/model/OperationObject.html | 516 + .../model/ParameterObject.Builder.html | 508 + .../smithy/openapi/model/ParameterObject.html | 530 + .../openapi/model/PathItem.Builder.html | 504 + .../amazon/smithy/openapi/model/PathItem.html | 544 + .../amazon/smithy/openapi/model/Ref.html | 400 + .../model/RequestBodyObject.Builder.html | 352 + .../openapi/model/RequestBodyObject.html | 390 + .../openapi/model/ResponseObject.Builder.html | 414 + .../smithy/openapi/model/ResponseObject.html | 427 + .../openapi/model/SecurityScheme.Builder.html | 446 + .../smithy/openapi/model/SecurityScheme.html | 460 + .../openapi/model/ServerObject.Builder.html | 376 + .../smithy/openapi/model/ServerObject.html | 404 + .../openapi/model/TagObject.Builder.html | 336 + .../smithy/openapi/model/TagObject.html | 408 + .../openapi/model/XmlObject.Builder.html | 364 + .../smithy/openapi/model/XmlObject.html | 418 + .../smithy/openapi/model/package-summary.html | 318 + .../smithy/openapi/model/package-tree.html | 205 + .../smithy/openapi/package-summary.html | 214 + .../amazon/smithy/openapi/package-tree.html | 195 + .../SpecificationExtensionTrait.Builder.html | 318 + .../SpecificationExtensionTrait.Provider.html | 337 + .../traits/SpecificationExtensionTrait.html | 434 + .../openapi/traits/package-summary.html | 176 + .../smithy/openapi/traits/package-tree.html | 175 + .../traits/Rpcv2CborTrait.Builder.html | 381 + .../traits/Rpcv2CborTrait.Provider.html | 338 + .../protocol/traits/Rpcv2CborTrait.html | 484 + .../traits/Rpcv2CborTraitValidator.html | 351 + .../protocol/traits/package-summary.html | 190 + .../smithy/protocol/traits/package-tree.html | 180 + .../protocoltests/traits/AppliesTo.html | 435 + ...ttpMalformedRequestDefinition.Builder.html | 386 + .../HttpMalformedRequestDefinition.html | 457 + .../HttpMalformedRequestTestCase.Builder.html | 370 + .../traits/HttpMalformedRequestTestCase.html | 422 + ...tpMalformedRequestTestsTrait.Provider.html | 337 + .../HttpMalformedRequestTestsTrait.html | 434 + .../HttpMalformedRequestTestsValidator.html | 348 + ...lformedResponseBodyDefinition.Builder.html | 328 + .../HttpMalformedResponseBodyDefinition.html | 401 + ...tpMalformedResponseDefinition.Builder.html | 344 + .../HttpMalformedResponseDefinition.html | 401 + .../traits/HttpMessageTestCase.html | 532 + .../traits/HttpRequestTestCase.Builder.html | 593 + .../traits/HttpRequestTestCase.html | 478 + .../HttpRequestTestsInputValidator.html | 349 + .../HttpRequestTestsTrait.Provider.html | 337 + .../traits/HttpRequestTestsTrait.html | 462 + .../traits/HttpResponseTestCase.Builder.html | 509 + .../traits/HttpResponseTestCase.html | 380 + .../HttpResponseTestsErrorValidator.html | 353 + .../HttpResponseTestsOutputValidator.html | 352 + .../HttpResponseTestsTrait.Provider.html | 337 + .../traits/HttpResponseTestsTrait.html | 462 + .../UniqueProtocolTestCaseIdValidator.html | 350 + .../protocoltests/traits/package-summary.html | 317 + .../protocoltests/traits/package-tree.html | 216 + .../CoverageChecker.CoverageResult.html | 368 + .../rulesengine/analysis/CoverageChecker.html | 379 + .../rulesengine/analysis/package-summary.html | 172 + .../rulesengine/analysis/package-tree.html | 162 + .../language/functions/AwsArn.Builder.html | 356 + .../aws/language/functions/AwsArn.html | 510 + .../aws/language/functions/AwsBuiltIns.html | 476 + .../functions/AwsPartition.Definition.html | 382 + .../aws/language/functions/AwsPartition.html | 567 + .../functions/AwsRuleSetExtension.html | 368 + .../language/functions/EndpointAuthUtils.html | 309 + .../IsVirtualHostableS3Bucket.Definition.html | 382 + .../functions/IsVirtualHostableS3Bucket.html | 477 + .../functions/ParseArn.Definition.html | 382 + .../aws/language/functions/ParseArn.html | 504 + .../language/functions/package-summary.html | 226 + .../aws/language/functions/package-tree.html | 183 + .../partition/Partition.Builder.html | 407 + .../functions/partition/Partition.html | 519 + .../partition/PartitionOutputs.Builder.html | 419 + .../functions/partition/PartitionOutputs.html | 563 + .../partition/Partitions.Builder.html | 377 + .../functions/partition/Partitions.html | 495 + .../partition/RegionOverride.Builder.html | 334 + .../functions/partition/RegionOverride.html | 433 + .../functions/partition/package-summary.html | 206 + .../functions/partition/package-tree.html | 172 + .../DualStackOnlyEndpointsTrait.Provider.html | 298 + .../traits/DualStackOnlyEndpointsTrait.html | 369 + .../aws/traits/EndpointModifierIndex.html | 335 + .../EndpointModifierTrait.Provider.html | 298 + .../aws/traits/EndpointModifierTrait.html | 371 + .../aws/traits/EndpointPatternType.html | 418 + .../PartitionEndpointSpecialCase.Builder.html | 417 + .../traits/PartitionEndpointSpecialCase.html | 475 + .../traits/PartitionSpecialCase.Builder.html | 394 + .../aws/traits/PartitionSpecialCase.html | 453 + .../aws/traits/RegionSpecialCase.Builder.html | 431 + .../aws/traits/RegionSpecialCase.html | 474 + .../RuleBasedEndpointsTrait.Provider.html | 298 + .../aws/traits/RuleBasedEndpointsTrait.html | 373 + ...dardPartitionalEndpointsTrait.Builder.html | 406 + ...ardPartitionalEndpointsTrait.Provider.html | 337 + .../StandardPartitionalEndpointsTrait.html | 530 + ...tandardRegionalEndpointsTrait.Builder.html | 432 + ...andardRegionalEndpointsTrait.Provider.html | 337 + .../StandardRegionalEndpointsTrait.html | 530 + .../aws/traits/package-summary.html | 275 + .../rulesengine/aws/traits/package-tree.html | 213 + .../AwsSpecialCaseEndpointValidator.html | 348 + .../RuleSetAwsBuiltInValidator.html | 348 + .../aws/validators/package-summary.html | 172 + .../aws/validators/package-tree.html | 166 + .../rulesengine/language/CoreExtension.html | 351 + .../language/Endpoint.Builder.html | 473 + .../smithy/rulesengine/language/Endpoint.html | 542 + .../language/EndpointComponentFactory.html | 353 + .../language/EndpointRuleSet.Builder.html | 461 + .../rulesengine/language/EndpointRuleSet.html | 645 + .../language/EndpointRuleSetExtension.html | 302 + .../language/RulesComponentBuilder.html | 392 + .../language/TraversingVisitor.html | 494 + .../language/error/InnerParseError.html | 297 + .../language/error/InvalidRulesException.html | 356 + .../language/error/RuleError.Evaluator.html | 262 + .../rulesengine/language/error/RuleError.html | 514 + .../language/error/package-summary.html | 193 + .../language/error/package-tree.html | 181 + .../language/evaluation/RuleEvaluator.html | 609 + .../language/evaluation/Scope.html | 568 + .../language/evaluation/TestEvaluator.html | 276 + .../language/evaluation/TypeCheck.html | 267 + .../language/evaluation/package-summary.html | 196 + .../language/evaluation/package-tree.html | 169 + .../language/evaluation/type/AnyType.html | 355 + .../language/evaluation/type/ArrayType.html | 339 + .../language/evaluation/type/BooleanType.html | 330 + .../language/evaluation/type/EmptyType.html | 331 + .../evaluation/type/EndpointType.html | 331 + .../language/evaluation/type/IntegerType.html | 330 + .../evaluation/type/OptionalType.html | 426 + .../language/evaluation/type/RecordType.html | 362 + .../language/evaluation/type/StringType.html | 330 + .../language/evaluation/type/TupleType.html | 344 + .../language/evaluation/type/Type.html | 630 + .../evaluation/type/package-summary.html | 237 + .../evaluation/type/package-tree.html | 176 + .../language/evaluation/value/ArrayValue.html | 431 + .../evaluation/value/BooleanValue.html | 408 + .../language/evaluation/value/EmptyValue.html | 383 + .../value/EndpointValue.Builder.html | 409 + .../evaluation/value/EndpointValue.html | 519 + .../evaluation/value/IntegerValue.html | 354 + .../evaluation/value/RecordValue.html | 454 + .../evaluation/value/StringValue.html | 408 + .../language/evaluation/value/Value.html | 639 + .../evaluation/value/package-summary.html | 214 + .../evaluation/value/package-tree.html | 176 + .../rulesengine/language/package-summary.html | 225 + .../rulesengine/language/package-tree.html | 181 + .../language/syntax/Identifier.html | 425 + .../language/syntax/SyntaxElement.html | 544 + .../language/syntax/ToCondition.html | 305 + .../language/syntax/ToExpression.html | 261 + .../syntax/expressions/Expression.html | 684 + .../ExpressionVisitor.Default.html | 551 + .../syntax/expressions/ExpressionVisitor.html | 459 + .../syntax/expressions/Reference.html | 504 + .../syntax/expressions/Template.Literal.html | 379 + .../syntax/expressions/Template.Part.html | 269 + .../language/syntax/expressions/Template.html | 545 + .../syntax/expressions/TemplateVisitor.html | 380 + .../functions/BooleanEquals.Definition.html | 382 + .../expressions/functions/BooleanEquals.html | 477 + .../functions/FunctionDefinition.html | 346 + .../functions/FunctionNode.Builder.html | 323 + .../expressions/functions/FunctionNode.html | 550 + .../functions/GetAttr.Definition.html | 382 + .../functions/GetAttr.Part.Index.html | 423 + .../functions/GetAttr.Part.Key.html | 437 + .../expressions/functions/GetAttr.Part.html | 303 + .../syntax/expressions/functions/GetAttr.html | 670 + .../functions/IsSet.Definition.html | 382 + .../syntax/expressions/functions/IsSet.html | 466 + .../IsValidHostLabel.Definition.html | 382 + .../functions/IsValidHostLabel.html | 477 + .../functions/LibraryFunction.html | 561 + .../expressions/functions/Not.Definition.html | 382 + .../syntax/expressions/functions/Not.html | 465 + .../functions/ParseUrl.Definition.html | 382 + .../expressions/functions/ParseUrl.html | 518 + .../functions/StringEquals.Definition.html | 382 + .../expressions/functions/StringEquals.html | 477 + .../functions/Substring.Definition.html | 382 + .../expressions/functions/Substring.html | 489 + .../functions/UriEncode.Definition.html | 382 + .../expressions/functions/UriEncode.html | 488 + .../functions/package-summary.html | 313 + .../expressions/functions/package-tree.html | 205 + .../expressions/literal/BooleanLiteral.html | 431 + .../expressions/literal/IntegerLiteral.html | 410 + .../syntax/expressions/literal/Literal.html | 588 + .../expressions/literal/LiteralVisitor.html | 354 + .../expressions/literal/RecordLiteral.html | 431 + .../expressions/literal/StringLiteral.html | 431 + .../expressions/literal/TupleLiteral.html | 431 + .../expressions/literal/package-summary.html | 213 + .../expressions/literal/package-tree.html | 183 + .../syntax/expressions/package-summary.html | 217 + .../syntax/expressions/package-tree.html | 184 + .../language/syntax/package-summary.html | 198 + .../language/syntax/package-tree.html | 169 + .../language/syntax/parameters/BuiltIns.html | 272 + .../syntax/parameters/Deprecated.html | 399 + .../syntax/parameters/Parameter.Builder.html | 475 + .../language/syntax/parameters/Parameter.html | 882 + .../syntax/parameters/ParameterType.html | 503 + .../syntax/parameters/Parameters.Builder.html | 349 + .../syntax/parameters/Parameters.html | 552 + .../syntax/parameters/package-summary.html | 213 + .../syntax/parameters/package-tree.html | 188 + .../syntax/rule/Condition.Builder.html | 368 + .../language/syntax/rule/Condition.html | 647 + .../language/syntax/rule/EndpointRule.html | 422 + .../language/syntax/rule/ErrorRule.html | 428 + .../language/syntax/rule/Rule.Builder.html | 440 + .../language/syntax/rule/Rule.html | 739 + .../syntax/rule/RuleValueVisitor.html | 312 + .../language/syntax/rule/TreeRule.html | 386 + .../language/syntax/rule/package-summary.html | 219 + .../language/syntax/rule/package-tree.html | 180 + .../CleanEndpointTestOperationInput.html | 327 + .../ClientContextParamDefinition.Builder.html | 313 + .../traits/ClientContextParamDefinition.html | 383 + .../ClientContextParamsTrait.Builder.html | 352 + .../ClientContextParamsTrait.Provider.html | 337 + .../traits/ClientContextParamsTrait.html | 466 + .../rulesengine/traits/ContextIndex.html | 383 + .../traits/ContextParamTrait.Builder.html | 308 + .../traits/ContextParamTrait.Provider.html | 337 + .../rulesengine/traits/ContextParamTrait.html | 425 + .../traits/EndpointRuleSetTrait.Builder.html | 308 + .../traits/EndpointRuleSetTrait.Provider.html | 337 + .../traits/EndpointRuleSetTrait.html | 439 + .../traits/EndpointTestCase.Builder.html | 383 + .../rulesengine/traits/EndpointTestCase.html | 435 + .../EndpointTestExpectation.Builder.html | 327 + .../traits/EndpointTestExpectation.html | 407 + .../EndpointTestOperationInput.Builder.html | 395 + .../traits/EndpointTestOperationInput.html | 435 + .../traits/EndpointTestsTrait.Builder.html | 350 + .../traits/EndpointTestsTrait.Provider.html | 337 + .../traits/EndpointTestsTrait.html | 453 + .../traits/EndpointTestsTraitValidator.html | 348 + .../traits/ExpectedEndpoint.Builder.html | 401 + .../rulesengine/traits/ExpectedEndpoint.html | 479 + .../StaticContextParamDefinition.Builder.html | 299 + .../traits/StaticContextParamDefinition.html | 369 + .../StaticContextParamsTrait.Builder.html | 352 + .../StaticContextParamsTrait.Provider.html | 337 + .../traits/StaticContextParamsTrait.html | 425 + .../StaticContextParamsTraitValidator.html | 348 + .../rulesengine/traits/package-summary.html | 313 + .../rulesengine/traits/package-tree.html | 207 + .../validators/AuthSchemeValidator.html | 278 + .../RuleSetAuthSchemesValidator.html | 380 + .../validators/RuleSetBuiltInValidator.html | 348 + .../RuleSetParamMissingDocsValidator.html | 364 + .../validators/RuleSetParameterValidator.html | 348 + .../validators/RuleSetTestCaseValidator.html | 348 + .../validators/RuleSetUriValidator.html | 348 + .../validators/package-summary.html | 213 + .../rulesengine/validators/package-tree.html | 180 + .../smithy/smoketests/traits/Expectation.html | 436 + .../smoketests/traits/FailureExpectation.html | 396 + .../traits/SmokeTestCase.Builder.html | 438 + .../smoketests/traits/SmokeTestCase.html | 563 + .../traits/SmokeTestCaseValidator.html | 354 + .../traits/SmokeTestsTrait.Provider.html | 337 + .../smoketests/traits/SmokeTestsTrait.html | 439 + .../UniqueSmokeTestCaseIdValidator.html | 349 + .../smoketests/traits/package-summary.html | 212 + .../smoketests/traits/package-tree.html | 180 + .../smithy/syntax/CapturedToken.Builder.html | 439 + .../amazon/smithy/syntax/CapturedToken.html | 600 + .../amazon/smithy/syntax/Formatter.html | 307 + .../amazon/smithy/syntax/TokenTree.html | 702 + .../amazon/smithy/syntax/TreeCursor.html | 652 + .../amazon/smithy/syntax/TreeType.html | 1385 + .../amazon/smithy/syntax/package-summary.html | 222 + .../amazon/smithy/syntax/package-tree.html | 188 + .../traitcodegen/GenerateTraitDirective.html | 322 + .../smithy/traitcodegen/SymbolProperties.html | 350 + .../traitcodegen/TraitCodegenContext.html | 385 + .../traitcodegen/TraitCodegenPlugin.html | 351 + .../traitcodegen/TraitCodegenSettings.html | 372 + .../traitcodegen/TraitCodegenUtils.html | 482 + .../generators/ShapeGenerator.html | 324 + .../generators/package-summary.html | 166 + .../traitcodegen/generators/package-tree.html | 161 + .../integrations/TraitCodegenIntegration.html | 227 + .../integrations/core/CoreIntegration.html | 409 + .../integrations/core/package-summary.html | 166 + .../integrations/core/package-tree.html | 161 + .../idref/IdRefDecoratorIntegration.html | 405 + .../integrations/idref/package-summary.html | 167 + .../integrations/idref/package-tree.html | 161 + .../javadoc/JavaDocIntegration.html | 365 + .../integrations/javadoc/package-summary.html | 166 + .../integrations/javadoc/package-tree.html | 161 + .../integrations/package-summary.html | 166 + .../integrations/package-tree.html | 161 + .../UniqueItemDecoratorIntegration.html | 431 + .../uniqueitems/package-summary.html | 166 + .../uniqueitems/package-tree.html | 161 + .../smithy/traitcodegen/package-summary.html | 195 + .../smithy/traitcodegen/package-tree.html | 166 + .../sections/BuilderClassSection.html | 320 + .../traitcodegen/sections/ClassSection.html | 320 + .../sections/EnumVariantSection.html | 320 + .../traitcodegen/sections/GetterSection.html | 320 + .../traitcodegen/sections/JavaDocSection.html | 320 + .../sections/package-summary.html | 190 + .../traitcodegen/sections/package-tree.html | 165 + .../writer/TraitCodegenWriter.html | 496 + .../traitcodegen/writer/package-summary.html | 166 + .../traitcodegen/writer/package-tree.html | 169 + .../smithy/utils/AbstractCodeWriter.html | 2890 ++ .../amazon/smithy/utils/BuilderRef.html | 500 + .../amazon/smithy/utils/CaseUtils.html | 447 + .../utils/CodeInterceptor.Appender.html | 337 + .../utils/CodeInterceptor.Prepender.html | 336 + .../amazon/smithy/utils/CodeInterceptor.html | 438 + .../amazon/smithy/utils/CodeSection.html | 286 + .../amazon/smithy/utils/CodeWriter.html | 1988 ++ .../smithy/utils/CodeWriterDebugInfo.html | 349 + .../amazon/smithy/utils/FunctionalUtils.html | 299 + .../software/amazon/smithy/utils/IoUtils.html | 683 + .../amazon/smithy/utils/ListUtils.html | 414 + .../amazon/smithy/utils/MapUtils.html | 1029 + .../amazon/smithy/utils/MediaType.html | 475 + .../amazon/smithy/utils/OptionalUtils.html | 339 + .../software/amazon/smithy/utils/Pair.html | 587 + .../amazon/smithy/utils/SetUtils.html | 424 + .../amazon/smithy/utils/SimpleCodeWriter.html | 281 + .../amazon/smithy/utils/SimpleParser.html | 943 + .../amazon/smithy/utils/SmithyBuilder.html | 298 + .../amazon/smithy/utils/SmithyGenerated.html | 187 + .../smithy/utils/SmithyInternalApi.html | 190 + .../smithy/utils/SmithyUnstableApi.html | 191 + .../amazon/smithy/utils/StringUtils.html | 1766 + .../software/amazon/smithy/utils/Tagged.html | 283 + .../amazon/smithy/utils/ToSmithyBuilder.html | 269 + .../amazon/smithy/utils/TriConsumer.html | 302 + .../amazon/smithy/utils/package-summary.html | 350 + .../amazon/smithy/utils/package-tree.html | 207 + .../amazon/smithy/waiters/Acceptor.html | 430 + .../amazon/smithy/waiters/AcceptorState.html | 467 + .../waiters/Matcher.ErrorTypeMember.html | 427 + .../waiters/Matcher.InputOutputMember.html | 355 + .../smithy/waiters/Matcher.OutputMember.html | 355 + .../smithy/waiters/Matcher.SuccessMember.html | 427 + .../smithy/waiters/Matcher.UnknownMember.html | 428 + .../smithy/waiters/Matcher.Visitor.html | 313 + .../amazon/smithy/waiters/Matcher.html | 452 + .../amazon/smithy/waiters/PathComparator.html | 483 + .../amazon/smithy/waiters/PathMatcher.html | 457 + .../waiters/UniqueWaiterNamesValidator.html | 349 + .../smithy/waiters/WaitableTrait.Builder.html | 338 + .../waiters/WaitableTrait.Provider.html | 348 + .../amazon/smithy/waiters/WaitableTrait.html | 433 + .../waiters/WaitableTraitValidator.html | 347 + .../amazon/smithy/waiters/Waiter.Builder.html | 425 + .../amazon/smithy/waiters/Waiter.html | 544 + .../smithy/waiters/package-summary.html | 282 + .../amazon/smithy/waiters/package-tree.html | 211 + javadoc/1.47.0/stylesheet.css | 910 + javadoc/1.47.0/type-search-index.js | 1 + javadoc/1.47.0/type-search-index.zip | Bin 0 -> 10526 bytes javadoc/latest/index.html | 2 +- 1718 files changed, 672248 insertions(+), 1099 deletions(-) create mode 100644 2.0/_sources/additional-specs/protocols/index.rst.txt create mode 100644 2.0/_sources/additional-specs/protocols/smithy-rpc-v2.rst.txt create mode 100644 2.0/additional-specs/protocols/index.html create mode 100644 2.0/additional-specs/protocols/smithy-rpc-v2.html create mode 100644 javadoc/1.47.0/allclasses-index.html create mode 100644 javadoc/1.47.0/allclasses.html create mode 100644 javadoc/1.47.0/allpackages-index.html create mode 100644 javadoc/1.47.0/constant-values.html create mode 100644 javadoc/1.47.0/deprecated-list.html create mode 100644 javadoc/1.47.0/element-list create mode 100644 javadoc/1.47.0/help-doc.html create mode 100644 javadoc/1.47.0/index-all.html create mode 100644 javadoc/1.47.0/index.html create mode 100644 javadoc/1.47.0/jquery-ui.overrides.css create mode 100644 javadoc/1.47.0/jquery/external/jquery/jquery.js create mode 100644 javadoc/1.47.0/jquery/jquery-3.6.1.min.js create mode 100644 javadoc/1.47.0/jquery/jquery-ui.min.css create mode 100644 javadoc/1.47.0/jquery/jquery-ui.min.js create mode 100644 javadoc/1.47.0/jquery/jszip-utils/dist/jszip-utils-ie.js create mode 100644 javadoc/1.47.0/jquery/jszip-utils/dist/jszip-utils-ie.min.js create mode 100644 javadoc/1.47.0/jquery/jszip-utils/dist/jszip-utils.js create mode 100644 javadoc/1.47.0/jquery/jszip-utils/dist/jszip-utils.min.js create mode 100644 javadoc/1.47.0/jquery/jszip/dist/jszip.js create mode 100644 javadoc/1.47.0/jquery/jszip/dist/jszip.min.js create mode 100644 javadoc/1.47.0/legal/ADDITIONAL_LICENSE_INFO create mode 100644 javadoc/1.47.0/legal/ASSEMBLY_EXCEPTION create mode 100644 javadoc/1.47.0/legal/LICENSE create mode 100644 javadoc/1.47.0/legal/jquery.md create mode 100644 javadoc/1.47.0/legal/jqueryUI.md create mode 100644 javadoc/1.47.0/legal/jszip.md create mode 100644 javadoc/1.47.0/legal/pako.md create mode 100644 javadoc/1.47.0/member-search-index.js create mode 100644 javadoc/1.47.0/member-search-index.zip create mode 100644 javadoc/1.47.0/overview-summary.html create mode 100644 javadoc/1.47.0/overview-tree.html create mode 100644 javadoc/1.47.0/package-search-index.js create mode 100644 javadoc/1.47.0/package-search-index.zip create mode 100644 javadoc/1.47.0/resources/glass.png create mode 100644 javadoc/1.47.0/resources/x.png create mode 100644 javadoc/1.47.0/script.js create mode 100644 javadoc/1.47.0/search.js create mode 100644 javadoc/1.47.0/serialized-form.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/apigateway/openapi/ApiGatewayConfig.ApiType.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/apigateway/openapi/ApiGatewayConfig.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/apigateway/openapi/ApiGatewayDefaults.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/apigateway/openapi/ApiGatewayExtension.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/apigateway/openapi/ApiGatewayMapper.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/apigateway/openapi/CorsHttpIntegration.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/apigateway/openapi/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/apigateway/openapi/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/ApiKeySourceTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/ApiKeySourceTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/AuthorizerDefinition.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/AuthorizerDefinition.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/AuthorizerIndex.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/AuthorizerTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/AuthorizerTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/AuthorizersTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/AuthorizersTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/AuthorizersTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/AuthorizersTraitValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/IntegrationResponse.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/IntegrationResponse.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/IntegrationTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/IntegrationTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/IntegrationTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/IntegrationTraitIndex.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/MockIntegrationTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/MockIntegrationTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/MockIntegrationTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/RequestValidatorTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/RequestValidatorTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/CfnConfig.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/CfnException.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/CfnConverter.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/CfnMapper.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/Context.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/Smithy2Cfn.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/Smithy2CfnExtension.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/mappers/CoreExtension.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/mappers/HandlerPermissionMapper.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/mappers/RequiredMapper.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/mappers/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/mappers/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/Handler.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/Handler.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/Property.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/Property.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/Remote.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/Remote.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/ResourceSchema.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/ResourceSchema.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/Tagging.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/Tagging.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnAdditionalIdentifierTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnAdditionalIdentifierTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnDefaultValueTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnDefaultValueTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnExcludePropertyTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnExcludePropertyTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnMutabilityTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnMutabilityTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnMutabilityTraitValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnNameTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnNameTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResource.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResource.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResourceIndex.Mutability.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResourceIndex.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResourceProperty.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResourceProperty.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResourcePropertyValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResourceTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResourceTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResourceTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ActionNameTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ActionNameTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ActionPermissionDescriptionTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ActionPermissionDescriptionTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ActionResource.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ActionResource.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ActionResources.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ActionResources.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ConditionKeyDefinition.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ConditionKeyDefinition.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ConditionKeyValueTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ConditionKeyValueTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ConditionKeysIndex.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ConditionKeysTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ConditionKeysTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ConditionKeysTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ConditionKeysValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/DefineConditionKeysTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/DefineConditionKeysTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/DefineConditionKeysTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/DisableConditionKeyInferenceTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/DisableConditionKeyInferenceTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/IamActionTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/IamActionTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/IamActionTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/IamActionValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/IamResourceTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/IamResourceTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/IamResourceTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/IamResourceTraitValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/RequiredActionsTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/RequiredActionsTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/RequiredActionsTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ServiceResolvedConditionKeysTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ServiceResolvedConditionKeysTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/SupportedPrincipalTypesTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/SupportedPrincipalTypesTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/SupportedPrincipalTypesTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/smoketests/model/AwsSmokeTestModel.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/smoketests/model/AwsVendorParams.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/smoketests/model/BaseAwsVendorParams.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/smoketests/model/S3VendorParams.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/smoketests/model/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/smoketests/model/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/ArnIndex.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/ArnReferenceTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/ArnReferenceTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/ArnReferenceTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/ArnTemplateValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/ArnTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/ArnTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/ArnTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/ControlPlaneTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/ControlPlaneTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/DataPlaneTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/DataPlaneTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/DataTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/DataTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/ErrorRenameValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/EventSourceValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/HttpChecksumTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/HttpChecksumTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/HttpChecksumTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/HttpChecksumTraitValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/PlaneIndex.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/SdkServiceIdValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/ServiceTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/ServiceTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/ServiceTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/CognitoUserPoolsTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/CognitoUserPoolsTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/CognitoUserPoolsTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/SigV4ATrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/SigV4ATrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/SigV4ATrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/SigV4Trait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/SigV4Trait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/SigV4Trait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/SigV4TraitsValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/UnsignedPayloadTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/UnsignedPayloadTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/CleanClientDiscoveryTraitTransformer.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientDiscoveredEndpointTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientDiscoveredEndpointTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientDiscoveredEndpointTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientEndpointDiscoveryIdTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientEndpointDiscoveryIdTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientEndpointDiscoveryIndex.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientEndpointDiscoveryInfo.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientEndpointDiscoveryTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientEndpointDiscoveryTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientEndpointDiscoveryTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientEndpointDiscoveryValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/customizations/S3UnwrappedXmlOutputTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/customizations/S3UnwrappedXmlOutputTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/customizations/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/customizations/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsJson1_0Trait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsJson1_0Trait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsJson1_0Trait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsJson1_1Trait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsJson1_1Trait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsJson1_1Trait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsProtocolTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsProtocolTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsQueryCompatibleTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsQueryCompatibleTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsQueryErrorTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsQueryErrorTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsQueryErrorTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsQueryTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsQueryTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/Ec2QueryNameTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/Ec2QueryNameTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/Ec2QueryTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/Ec2QueryTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/ProtocolHttpPayloadValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/ProtocolHttpValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/RestJson1Trait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/RestJson1Trait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/RestJson1Trait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/RestXmlTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/RestXmlTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/RestXmlTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/AwsTagIndex.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/ServiceTaggingValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TagEnabledServiceValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TagEnabledTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TagEnabledTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TagEnabledTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TagResourcePropertyNameValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TagResourcePropertyTypeValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TaggableApiConfig.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TaggableApiConfig.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TaggableResourceValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TaggableTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TaggableTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TaggableTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/FileManifest.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/JsonSubstitutions.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/MockManifest.StoreMode.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/MockManifest.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/PluginContext.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/PluginContext.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/ProjectionResult.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/ProjectionResult.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/ProjectionTransformer.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/SmithyBuild.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/SmithyBuildException.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/SmithyBuildPlugin.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/SmithyBuildResult.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/SmithyBuildResult.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/SourcesConflictException.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/TransformContext.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/TransformContext.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/UnknownProjectionException.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/UnknownTransformException.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/model/MavenConfig.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/model/MavenConfig.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/model/MavenRepository.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/model/MavenRepository.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/model/ProjectionConfig.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/model/ProjectionConfig.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/model/SmithyBuildConfig.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/model/SmithyBuildConfig.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/model/TransformConfig.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/model/TransformConfig.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/model/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/model/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/plugins/BuildInfo.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/plugins/BuildInfoPlugin.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/plugins/ConfigurableSmithyBuildPlugin.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/plugins/ModelPlugin.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/plugins/NullabilityReportPlugin.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/plugins/RunPlugin.Settings.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/plugins/RunPlugin.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/plugins/SourcesPlugin.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/plugins/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/plugins/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/processor/SmithyAnnotationProcessor.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/processor/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/processor/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/Apply.Config.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/Apply.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/ChangeStringEnumsToEnumShapes.Config.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/ChangeStringEnumsToEnumShapes.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/ChangeTypes.Config.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/ChangeTypes.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/ConfigurableProjectionTransformer.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeMetadata.Config.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeMetadata.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeShapesBySelector.Config.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeShapesBySelector.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeShapesByTag.Config.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeShapesByTag.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeShapesByTrait.Config.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeShapesByTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeTags.Config.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeTags.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeTraits.Config.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeTraits.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeTraitsByTag.Config.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeTraitsByTag.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/FilterSuppressions.Config.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/FilterSuppressions.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/FlattenNamespaces.Config.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/FlattenNamespaces.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeMetadata.Config.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeMetadata.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeNamespaces.Config.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeNamespaces.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeServices.Config.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeServices.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeShapesBySelector.Config.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeShapesBySelector.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeShapesByTag.Config.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeShapesByTag.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeTags.Config.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeTags.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeTraits.Config.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeTraits.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeTraitsByTag.Config.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeTraitsByTag.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/RemoveTraitDefinitions.Config.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/RemoveTraitDefinitions.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/RemoveUnusedShapes.Config.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/RemoveUnusedShapes.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/RenameShapes.Config.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/RenameShapes.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/build/transforms/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/cli/AnsiColorFormatter.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/cli/ArgumentReceiver.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/cli/Arguments.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/cli/BuildParameterBuilder.ClassPathTagMatcher.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/cli/BuildParameterBuilder.JarFileClassPathTagMatcher.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/cli/BuildParameterBuilder.Result.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/cli/BuildParameterBuilder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/cli/Cli.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/cli/CliError.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/cli/CliPrinter.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/cli/ColorBuffer.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/cli/ColorFormatter.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/cli/ColorTheme.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/cli/Command.Env.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/cli/Command.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/cli/EnvironmentVariable.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/cli/HelpPrinter.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/cli/SmithyCli.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/cli/StandardOptions.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/cli/Style.Constant.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/cli/Style.Multi.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/cli/Style.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/cli/commands/SmithyCommand.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/cli/commands/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/cli/commands/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/cli/dependencies/DependencyResolver.Factory.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/cli/dependencies/DependencyResolver.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/cli/dependencies/DependencyResolverException.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/cli/dependencies/FileCacheResolver.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/cli/dependencies/FilterCliVersionResolver.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/cli/dependencies/MavenDependencyResolver.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/cli/dependencies/ResolvedArtifact.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/cli/dependencies/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/cli/dependencies/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/cli/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/cli/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/CodegenContext.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/CodegenException.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/DependencyTracker.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/ImportContainer.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/MappedReservedWords.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/MappedReservedWords.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/ReservedWordSymbolProvider.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/ReservedWordSymbolProvider.Escaper.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/ReservedWordSymbolProvider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/ReservedWords.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/ReservedWordsBuilder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/ShapeGenerationOrder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/SmithyIntegration.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/Symbol.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/Symbol.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolContainer.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolDependency.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolDependency.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolDependencyContainer.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolProvider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolReference.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolReference.ContextOption.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolReference.Option.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolReference.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolWriter.Factory.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolWriter.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/TopologicalIndex.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/WriterDelegator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/CodegenDirector.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/ContextualDirective.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/CreateContextDirective.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/CreateSymbolProviderDirective.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/CustomizeDirective.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/DirectedCodegen.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/Directive.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/GenerateEnumDirective.EnumType.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/GenerateEnumDirective.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/GenerateErrorDirective.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/GenerateIntEnumDirective.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/GenerateOperationDirective.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/GenerateResourceDirective.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/GenerateServiceDirective.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/GenerateStructureDirective.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/GenerateUnionDirective.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/ShapeDirective.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/ArtifactDefinitions.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/ArtifactDefinitions.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/ShapeLink.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/ShapeLink.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/TraceFile.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/TraceFile.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/TraceMetadata.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/TraceMetadata.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/TracingSymbolProvider.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/TracingSymbolProvider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/CodegenWriter.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/CodegenWriterDelegator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/CodegenWriterFactory.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/DocWriter.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/DocumentationWriter.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/ImportContainer.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/JavaStyleDocumentationWriterBuilder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/SymbolWriter.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/ChangedMetadata.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/ChangedShape.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/DiffEvaluator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/Differences.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/ModelDiff.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/ModelDiff.Result.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/ModelDiff.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/evaluators/AbstractDiffEvaluator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/evaluators/AddedEntityBinding.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/evaluators/AddedMetadata.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/evaluators/AddedOperationError.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/evaluators/AddedRequiredMember.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/evaluators/AddedServiceError.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/evaluators/AddedShape.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/evaluators/AddedTraitDefinition.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedDefault.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedEnumTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedLengthTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedMemberOrder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedMemberTarget.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedMetadata.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedNullability.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedOperationInput.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedOperationOutput.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedRangeTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedResourceIdentifiers.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedShapeType.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ModifiedTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/evaluators/RemovedAuthenticationScheme.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/evaluators/RemovedEntityBinding.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/evaluators/RemovedMetadata.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/evaluators/RemovedOperationError.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/evaluators/RemovedServiceError.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/evaluators/RemovedShape.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/evaluators/RemovedTraitDefinition.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ServiceRename.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/evaluators/TraitBreakingChange.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/evaluators/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/evaluators/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/diff/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jmespath/ExpressionProblem.Severity.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jmespath/ExpressionProblem.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jmespath/ExpressionSerializer.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jmespath/ExpressionVisitor.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jmespath/JmespathException.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jmespath/JmespathExpression.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jmespath/LinterResult.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jmespath/RuntimeType.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jmespath/ast/AndExpression.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jmespath/ast/BinaryExpression.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jmespath/ast/ComparatorExpression.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jmespath/ast/ComparatorType.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jmespath/ast/CurrentExpression.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jmespath/ast/ExpressionTypeExpression.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jmespath/ast/FieldExpression.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jmespath/ast/FilterProjectionExpression.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jmespath/ast/FlattenExpression.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jmespath/ast/FunctionExpression.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jmespath/ast/IndexExpression.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jmespath/ast/LiteralExpression.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jmespath/ast/MultiSelectHashExpression.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jmespath/ast/MultiSelectListExpression.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jmespath/ast/NotExpression.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jmespath/ast/ObjectProjectionExpression.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jmespath/ast/OrExpression.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jmespath/ast/ProjectionExpression.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jmespath/ast/SliceExpression.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jmespath/ast/Subexpression.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jmespath/ast/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jmespath/ast/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jmespath/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jmespath/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jsonschema/ConflictingShapeNameException.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jsonschema/JsonSchemaConfig.MapStrategy.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jsonschema/JsonSchemaConfig.UnionStrategy.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jsonschema/JsonSchemaConfig.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jsonschema/JsonSchemaConverter.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jsonschema/JsonSchemaConverter.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jsonschema/JsonSchemaMapper.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jsonschema/JsonSchemaMapperContext.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jsonschema/JsonSchemaVersion.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jsonschema/PropertyNamingStrategy.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jsonschema/Schema.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jsonschema/Schema.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jsonschema/SchemaDocument.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jsonschema/SchemaDocument.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jsonschema/SmithyJsonSchemaException.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jsonschema/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/jsonschema/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/AbbreviationNameValidator.Config.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/AbbreviationNameValidator.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/AbbreviationNameValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/CamelCaseValidator.Config.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/CamelCaseValidator.MemberNameHandling.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/CamelCaseValidator.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/CamelCaseValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/InputOutputStructureReuseValidator.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/InputOutputStructureReuseValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/MissingClientOptionalTrait.Config.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/MissingClientOptionalTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/MissingClientOptionalTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/MissingPaginatedTraitValidator.Config.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/MissingPaginatedTraitValidator.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/MissingPaginatedTraitValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/MissingSensitiveTraitValidator.Config.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/MissingSensitiveTraitValidator.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/MissingSensitiveTraitValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/NoninclusiveTermsValidator.Config.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/NoninclusiveTermsValidator.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/NoninclusiveTermsValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/RepeatedShapeNameValidator.Config.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/RepeatedShapeNameValidator.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/RepeatedShapeNameValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/ReservedWordsValidator.Config.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/ReservedWordsValidator.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/ReservedWordsValidator.ReservedWords.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/ReservedWordsValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/ShouldHaveUsedTimestampValidator.Config.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/ShouldHaveUsedTimestampValidator.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/ShouldHaveUsedTimestampValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/StandardOperationVerbValidator.Config.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/StandardOperationVerbValidator.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/StandardOperationVerbValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/StutteredShapeNameValidator.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/StutteredShapeNameValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/linters/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/FromSourceLocation.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/Model.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/Model.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/SourceException.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/SourceLocation.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/knowledge/BottomUpIndex.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/knowledge/BoxIndex.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/knowledge/EventStreamIndex.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/knowledge/EventStreamInfo.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/knowledge/HttpBinding.Location.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/knowledge/HttpBinding.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/knowledge/HttpBindingIndex.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/knowledge/IdentifierBindingIndex.BindingType.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/knowledge/IdentifierBindingIndex.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/knowledge/KnowledgeIndex.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/knowledge/NeighborProviderIndex.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/knowledge/NullableIndex.CheckMode.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/knowledge/NullableIndex.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/knowledge/OperationIndex.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/knowledge/PaginatedIndex.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/knowledge/PaginationInfo.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/knowledge/PropertyBindingIndex.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/knowledge/ServiceIndex.AuthSchemeMode.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/knowledge/ServiceIndex.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/knowledge/TextIndex.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/knowledge/TextInstance.TextLocationType.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/knowledge/TextInstance.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/knowledge/TopDownIndex.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/knowledge/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/knowledge/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/loader/IdlToken.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/loader/IdlTokenizer.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/loader/ModelAssembler.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/loader/ModelDiscovery.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/loader/ModelImportException.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/loader/ModelManifestException.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/loader/ModelSyntaxException.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/loader/ParserUtils.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/loader/Prelude.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/loader/StringTable.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/loader/TopologicalShapeSort.CycleException.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/loader/TopologicalShapeSort.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/loader/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/loader/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/loader/sourcecontext/SourceContextLoader.Line.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/loader/sourcecontext/SourceContextLoader.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/loader/sourcecontext/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/loader/sourcecontext/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/neighbor/NeighborProvider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/neighbor/Relationship.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/neighbor/RelationshipDirection.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/neighbor/RelationshipType.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/neighbor/UnreferencedShapes.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/neighbor/UnreferencedTraitDefinitions.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/neighbor/Walker.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/neighbor/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/neighbor/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/node/ArrayNode.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/node/ArrayNode.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/node/BooleanNode.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/node/ExpectationNotMetException.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/node/Node.NonNumericFloat.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/node/Node.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/node/NodeDeserializationException.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/node/NodeMapper.WhenMissing.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/node/NodeMapper.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/node/NodePointer.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/node/NodeSerializationException.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/node/NodeType.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/node/NodeVisitor.Default.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/node/NodeVisitor.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/node/NullNode.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/node/NumberNode.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/node/ObjectNode.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/node/ObjectNode.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/node/StringNode.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/node/ToNode.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/node/internal/NodeHandler.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/node/internal/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/node/internal/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/node/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/node/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/pattern/InvalidPatternException.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/pattern/InvalidUriPatternException.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/pattern/SmithyPattern.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/pattern/SmithyPattern.Segment.Type.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/pattern/SmithyPattern.Segment.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/pattern/SmithyPattern.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/pattern/UriPattern.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/pattern/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/pattern/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/selector/AttributeValue.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/selector/PathFinder.Path.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/selector/PathFinder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/selector/Selector.Runner.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/selector/Selector.ShapeMatch.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/selector/Selector.StartingContext.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/selector/Selector.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/selector/SelectorException.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/selector/SelectorSyntaxException.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/selector/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/selector/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/AbstractShapeBuilder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/BigDecimalShape.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/BigDecimalShape.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/BigIntegerShape.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/BigIntegerShape.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/BlobShape.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/BlobShape.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/BooleanShape.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/BooleanShape.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/ByteShape.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/ByteShape.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/CollectionShape.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/CollectionShape.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/DocumentShape.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/DocumentShape.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/DoubleShape.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/DoubleShape.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/EntityShape.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/EntityShape.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/EnumShape.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/EnumShape.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/FloatShape.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/FloatShape.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/IntEnumShape.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/IntEnumShape.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/IntegerShape.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/IntegerShape.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/ListShape.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/ListShape.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/LongShape.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/LongShape.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/MapShape.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/MapShape.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/MemberShape.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/MemberShape.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/ModelSerializer.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/ModelSerializer.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/NumberShape.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/OperationShape.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/OperationShape.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/ResourceShape.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/ResourceShape.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/ServiceShape.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/ServiceShape.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/SetShape.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/SetShape.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/Shape.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/ShapeId.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/ShapeIdSyntaxException.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/ShapeType.Category.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/ShapeType.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/ShapeVisitor.DataShapeVisitor.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/ShapeVisitor.Default.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/ShapeVisitor.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/ShortShape.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/ShortShape.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/SimpleShape.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/SmithyIdlComponentOrder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/SmithyIdlModelSerializer.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/SmithyIdlModelSerializer.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/StringShape.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/StringShape.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/StructureShape.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/StructureShape.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/TimestampShape.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/TimestampShape.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/ToShapeId.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/UnionShape.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/UnionShape.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/shapes/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/AbstractTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/AbstractTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/AbstractTraitBuilder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/AddedDefaultTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/AddedDefaultTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/AnnotationTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/AnnotationTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/AuthDefinitionTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/AuthDefinitionTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/AuthDefinitionTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/AuthTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/AuthTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/BoxTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/BoxTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/ClientOptionalTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/ClientOptionalTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/CorsTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/CorsTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/CorsTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/DefaultTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/DefaultTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/DeprecatedTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/DeprecatedTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/DeprecatedTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/DocumentationTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/DocumentationTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/DynamicTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/EffectiveTraitQuery.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/EffectiveTraitQuery.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/EndpointTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/EndpointTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/EndpointTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/EnumDefinition.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/EnumDefinition.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/EnumTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/EnumTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/EnumTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/EnumValueTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/EnumValueTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/EnumValueTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/ErrorTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/ErrorTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/EventHeaderTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/EventHeaderTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/EventPayloadTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/EventPayloadTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/ExamplesTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/ExamplesTrait.ErrorExample.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/ExamplesTrait.ErrorExample.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/ExamplesTrait.Example.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/ExamplesTrait.Example.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/ExamplesTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/ExamplesTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/ExternalDocumentationTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/ExternalDocumentationTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/ExternalDocumentationTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/HostLabelTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/HostLabelTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/HttpApiKeyAuthTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/HttpApiKeyAuthTrait.Location.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/HttpApiKeyAuthTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/HttpApiKeyAuthTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/HttpBasicAuthTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/HttpBasicAuthTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/HttpBearerAuthTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/HttpBearerAuthTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/HttpChecksumRequiredTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/HttpChecksumRequiredTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/HttpDigestAuthTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/HttpDigestAuthTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/HttpErrorTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/HttpErrorTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/HttpHeaderTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/HttpHeaderTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/HttpLabelTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/HttpLabelTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/HttpPayloadTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/HttpPayloadTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/HttpPrefixHeadersTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/HttpPrefixHeadersTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/HttpQueryParamsTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/HttpQueryParamsTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/HttpQueryTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/HttpQueryTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/HttpResponseCodeTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/HttpResponseCodeTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/HttpTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/HttpTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/HttpTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/IdRefTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/IdRefTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/IdRefTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/IdempotencyTokenTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/IdempotencyTokenTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/IdempotentTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/IdempotentTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/InputTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/InputTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/InternalTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/InternalTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/JsonNameTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/JsonNameTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/LengthTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/LengthTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/LengthTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/MediaTypeTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/MediaTypeTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/MixinTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/MixinTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/MixinTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/NestedPropertiesTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/NestedPropertiesTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/NoReplaceTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/NoReplaceTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/NotPropertyTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/NotPropertyTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/OptionalAuthTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/OptionalAuthTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/OutputTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/OutputTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/PaginatedTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/PaginatedTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/PaginatedTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/PatternTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/PatternTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/PrivateTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/PrivateTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/PropertyTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/PropertyTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/PropertyTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/ProtocolDefinitionTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/ProtocolDefinitionTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/ProtocolDefinitionTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/RangeTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/RangeTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/RangeTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/ReadonlyTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/ReadonlyTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/RecommendedTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/RecommendedTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/RecommendedTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/ReferencesTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/ReferencesTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/ReferencesTrait.Reference.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/ReferencesTrait.Reference.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/ReferencesTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/RequestCompressionTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/RequestCompressionTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/RequestCompressionTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/RequiredTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/RequiredTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/RequiresLengthTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/RequiresLengthTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/ResourceIdentifierTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/ResourceIdentifierTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/RetryableTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/RetryableTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/RetryableTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/SensitiveTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/SensitiveTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/SinceTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/SinceTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/SparseTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/SparseTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/StreamingTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/StreamingTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/StringListTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/StringListTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/StringListTrait.StringListTraitConstructor.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/StringListTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/StringTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/StringTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/SuppressTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/SuppressTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/SuppressTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/TagsTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/TagsTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/TagsTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/TimestampFormatTrait.Format.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/TimestampFormatTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/TimestampFormatTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/TitleTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/TitleTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/Trait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/TraitDefinition.BreakingChangeRule.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/TraitDefinition.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/TraitDefinition.ChangeType.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/TraitDefinition.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/TraitDefinition.StructurallyExclusive.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/TraitDefinition.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/TraitFactory.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/TraitService.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/TraitValidatorsTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/TraitValidatorsTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/TraitValidatorsTrait.Validator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/TraitValidatorsTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/UniqueItemsTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/UniqueItemsTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/UnitTypeTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/UnitTypeTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/UnstableTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/UnstableTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/XmlAttributeTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/XmlAttributeTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/XmlFlattenedTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/XmlFlattenedTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/XmlNameTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/XmlNameTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/XmlNamespaceTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/XmlNamespaceTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/XmlNamespaceTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/synthetic/NoAuthTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/synthetic/OriginalShapeIdTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/synthetic/SyntheticEnumTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/synthetic/SyntheticEnumTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/synthetic/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/traits/synthetic/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/transform/ChangeShapeTypeOption.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/transform/ModelTransformException.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/transform/ModelTransformer.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/transform/ModelTransformerPlugin.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/transform/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/transform/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/CleanBindings.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/CleanOperationStructures.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/CleanResourceReferences.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/CleanServiceRenames.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/CleanStructureAndUnionMembers.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/CleanTraitDefinitions.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/RemoveMixins.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/RemoveTraits.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/AbstractValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/ContextualValidationEventFormatter.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/LineValidationEventFormatter.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/NodeValidationVisitor.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/NodeValidationVisitor.Feature.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/NodeValidationVisitor.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/Severity.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/ValidatedResult.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/ValidatedResultException.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/ValidationEvent.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/ValidationEvent.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/ValidationEventDecorator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/ValidationEventFormatter.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/ValidationUtils.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/Validator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/ValidatorFactory.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/ValidatorService.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/ValidatorService.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/linters/EmitEachSelectorValidator.Config.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/linters/EmitEachSelectorValidator.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/linters/EmitEachSelectorValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/linters/EmitNoneSelectorValidator.Config.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/linters/EmitNoneSelectorValidator.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/linters/EmitNoneSelectorValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/linters/UnreferencedShapeValidator.Config.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/linters/UnreferencedShapeValidator.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/linters/UnreferencedShapeValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/linters/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/linters/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/node/NodeValidatorPlugin.Context.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/node/NodeValidatorPlugin.Emitter.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/node/NodeValidatorPlugin.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/node/TimestampValidationStrategy.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/node/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/node/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/suppressions/ModelBasedEventDecorator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/suppressions/SeverityOverride.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/suppressions/Suppression.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/suppressions/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/suppressions/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/testrunner/SmithyTestCase.Error.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/testrunner/SmithyTestCase.Result.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/testrunner/SmithyTestCase.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/testrunner/SmithyTestSuite.Error.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/testrunner/SmithyTestSuite.Result.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/testrunner/SmithyTestSuite.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/testrunner/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/testrunner/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/AuthTraitValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/DefaultTraitValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/DefaultValueInUpdateValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/DeprecatedTraitValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/EnumShapeValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/EnumTraitValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/EventPayloadTraitValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ExamplesTraitValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ExclusiveStructureMemberTraitValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HostLabelTraitValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpApiKeyAuthTraitValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpBindingTraitIgnoredValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpBindingsMissingValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpHeaderTraitValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpLabelTraitValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpMethodSemanticsValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpPayloadValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpPrefixHeadersTraitValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpQueryParamsTraitValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpQueryTraitValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpResponseCodeSemanticsValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpUriConflictValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpUriFormatValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/JsonNameValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/LengthTraitValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/MediaTypeValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/NoInlineDocumentSupportValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/OperationValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/PaginatedTraitValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/PatternTraitValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/PrivateAccessValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/RangeTraitValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ReferencesTraitValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/RequestCompressionTraitValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ResourceCycleValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ResourceIdentifierBindingValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ResourceIdentifierValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ResourceLifecycleValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ResourceOperationInputOutputValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ServiceAuthDefinitionsValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ServiceValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/SetValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ShapeIdConflictValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ShapeRecursionValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/SingleOperationBindingValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/SingleResourceBindingValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/StreamingTraitValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/TargetValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/TraitBreakingChangesValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/TraitConflictValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/TraitTargetValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/TraitValidatorsValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/TraitValueValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/UnionValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/UnitTypeValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/UnreferencedShapeValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/UnstableTraitValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/XmlNamespaceTraitValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/model/validation/validators/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/mqtt/traits/MqttJsonTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/mqtt/traits/MqttJsonTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/mqtt/traits/PublishTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/mqtt/traits/PublishTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/mqtt/traits/ResolvedTopicIndex.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/mqtt/traits/SubscribeTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/mqtt/traits/SubscribeTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/mqtt/traits/Topic.Level.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/mqtt/traits/Topic.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/mqtt/traits/TopicBinding.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/mqtt/traits/TopicLabelTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/mqtt/traits/TopicLabelTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/mqtt/traits/TopicSyntaxException.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/mqtt/traits/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/mqtt/traits/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/mqtt/traits/validators/MqttTopicConflictValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/mqtt/traits/validators/MqttTopicLabelValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/mqtt/traits/validators/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/mqtt/traits/validators/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/OpenApiConfig.ErrorStatusConflictHandlingStrategy.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/OpenApiConfig.HttpPrefixHeadersStrategy.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/OpenApiConfig.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/OpenApiException.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/OpenApiUtils.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/OpenApiVersion.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/Context.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/CoreExtension.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/OpenApiConverter.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/OpenApiJsonSchemaMapper.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/OpenApiMapper.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/OpenApiProtocol.Operation.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/OpenApiProtocol.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/SecuritySchemeConverter.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/Smithy2OpenApi.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/Smithy2OpenApiExtension.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/CheckForGreedyLabels.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/CheckForPrefixHeaders.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/OpenApiJsonAdd.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/OpenApiJsonSubstitutions.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/RemoveEmptyComponents.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/RemoveUnusedComponents.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/SpecificationExtensionsMapper.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/UnsupportedTraits.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/protocols/AwsRestJson1Protocol.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/protocols/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/protocols/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/security/AwsV4Converter.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/security/HttpApiKeyAuthConverter.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/security/HttpBasicConverter.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/security/HttpBearerConverter.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/security/HttpDigestConverter.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/security/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/security/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/CallbackObject.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/CallbackObject.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/Component.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/Component.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/ComponentsObject.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/ComponentsObject.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/EncodingObject.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/EncodingObject.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/ExampleObject.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/ExampleObject.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/ExternalDocumentation.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/ExternalDocumentation.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/InfoObject.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/InfoObject.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/LinkObject.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/LinkObject.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/MediaTypeObject.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/MediaTypeObject.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/OpenApi.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/OpenApi.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/OperationObject.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/OperationObject.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/ParameterObject.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/ParameterObject.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/PathItem.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/PathItem.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/Ref.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/RequestBodyObject.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/RequestBodyObject.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/ResponseObject.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/ResponseObject.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/SecurityScheme.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/SecurityScheme.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/ServerObject.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/ServerObject.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/TagObject.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/TagObject.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/XmlObject.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/XmlObject.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/model/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/traits/SpecificationExtensionTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/traits/SpecificationExtensionTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/traits/SpecificationExtensionTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/traits/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/openapi/traits/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/protocol/traits/Rpcv2CborTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/protocol/traits/Rpcv2CborTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/protocol/traits/Rpcv2CborTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/protocol/traits/Rpcv2CborTraitValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/protocol/traits/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/protocol/traits/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/AppliesTo.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedRequestDefinition.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedRequestDefinition.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedRequestTestCase.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedRequestTestCase.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedRequestTestsTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedRequestTestsTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedRequestTestsValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedResponseBodyDefinition.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedResponseBodyDefinition.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedResponseDefinition.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedResponseDefinition.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMessageTestCase.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpRequestTestCase.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpRequestTestCase.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpRequestTestsInputValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpRequestTestsTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpRequestTestsTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpResponseTestCase.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpResponseTestCase.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpResponseTestsErrorValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpResponseTestsOutputValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpResponseTestsTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpResponseTestsTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/UniqueProtocolTestCaseIdValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/analysis/CoverageChecker.CoverageResult.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/analysis/CoverageChecker.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/analysis/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/analysis/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/AwsArn.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/AwsArn.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/AwsBuiltIns.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/AwsPartition.Definition.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/AwsPartition.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/AwsRuleSetExtension.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/EndpointAuthUtils.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/IsVirtualHostableS3Bucket.Definition.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/IsVirtualHostableS3Bucket.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/ParseArn.Definition.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/ParseArn.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/Partition.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/Partition.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/PartitionOutputs.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/PartitionOutputs.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/Partitions.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/Partitions.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/RegionOverride.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/RegionOverride.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/DualStackOnlyEndpointsTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/DualStackOnlyEndpointsTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/EndpointModifierIndex.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/EndpointModifierTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/EndpointModifierTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/EndpointPatternType.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/PartitionEndpointSpecialCase.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/PartitionEndpointSpecialCase.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/PartitionSpecialCase.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/PartitionSpecialCase.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/RegionSpecialCase.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/RegionSpecialCase.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/RuleBasedEndpointsTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/RuleBasedEndpointsTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/StandardPartitionalEndpointsTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/StandardPartitionalEndpointsTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/StandardPartitionalEndpointsTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/StandardRegionalEndpointsTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/StandardRegionalEndpointsTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/StandardRegionalEndpointsTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/validators/AwsSpecialCaseEndpointValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/validators/RuleSetAwsBuiltInValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/validators/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/validators/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/CoreExtension.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/Endpoint.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/Endpoint.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/EndpointComponentFactory.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/EndpointRuleSet.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/EndpointRuleSet.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/EndpointRuleSetExtension.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/RulesComponentBuilder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/TraversingVisitor.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/error/InnerParseError.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/error/InvalidRulesException.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/error/RuleError.Evaluator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/error/RuleError.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/error/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/error/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/RuleEvaluator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/Scope.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/TestEvaluator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/TypeCheck.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/AnyType.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/ArrayType.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/BooleanType.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/EmptyType.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/EndpointType.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/IntegerType.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/OptionalType.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/RecordType.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/StringType.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/TupleType.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/Type.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/ArrayValue.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/BooleanValue.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/EmptyValue.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/EndpointValue.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/EndpointValue.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/IntegerValue.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/RecordValue.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/StringValue.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/Value.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/Identifier.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/SyntaxElement.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/ToCondition.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/ToExpression.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/Expression.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/ExpressionVisitor.Default.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/ExpressionVisitor.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/Reference.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/Template.Literal.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/Template.Part.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/Template.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/TemplateVisitor.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/BooleanEquals.Definition.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/BooleanEquals.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/FunctionDefinition.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/FunctionNode.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/FunctionNode.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/GetAttr.Definition.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/GetAttr.Part.Index.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/GetAttr.Part.Key.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/GetAttr.Part.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/GetAttr.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/IsSet.Definition.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/IsSet.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/IsValidHostLabel.Definition.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/IsValidHostLabel.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/LibraryFunction.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/Not.Definition.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/Not.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/ParseUrl.Definition.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/ParseUrl.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/StringEquals.Definition.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/StringEquals.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/Substring.Definition.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/Substring.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/UriEncode.Definition.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/UriEncode.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/literal/BooleanLiteral.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/literal/IntegerLiteral.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/literal/Literal.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/literal/LiteralVisitor.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/literal/RecordLiteral.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/literal/StringLiteral.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/literal/TupleLiteral.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/literal/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/literal/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/parameters/BuiltIns.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/parameters/Deprecated.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/parameters/Parameter.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/parameters/Parameter.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/parameters/ParameterType.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/parameters/Parameters.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/parameters/Parameters.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/parameters/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/parameters/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/Condition.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/Condition.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/EndpointRule.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/ErrorRule.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/Rule.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/Rule.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/RuleValueVisitor.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/TreeRule.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/CleanEndpointTestOperationInput.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ClientContextParamDefinition.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ClientContextParamDefinition.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ClientContextParamsTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ClientContextParamsTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ClientContextParamsTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ContextIndex.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ContextParamTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ContextParamTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ContextParamTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointRuleSetTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointRuleSetTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointRuleSetTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestCase.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestCase.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestExpectation.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestExpectation.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestOperationInput.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestOperationInput.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestsTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestsTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestsTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestsTraitValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ExpectedEndpoint.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ExpectedEndpoint.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/StaticContextParamDefinition.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/StaticContextParamDefinition.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/StaticContextParamsTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/StaticContextParamsTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/StaticContextParamsTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/StaticContextParamsTraitValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/validators/AuthSchemeValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/validators/RuleSetAuthSchemesValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/validators/RuleSetBuiltInValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/validators/RuleSetParamMissingDocsValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/validators/RuleSetParameterValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/validators/RuleSetTestCaseValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/validators/RuleSetUriValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/validators/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/rulesengine/validators/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/smoketests/traits/Expectation.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/smoketests/traits/FailureExpectation.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/smoketests/traits/SmokeTestCase.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/smoketests/traits/SmokeTestCase.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/smoketests/traits/SmokeTestCaseValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/smoketests/traits/SmokeTestsTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/smoketests/traits/SmokeTestsTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/smoketests/traits/UniqueSmokeTestCaseIdValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/smoketests/traits/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/smoketests/traits/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/syntax/CapturedToken.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/syntax/CapturedToken.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/syntax/Formatter.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/syntax/TokenTree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/syntax/TreeCursor.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/syntax/TreeType.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/syntax/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/syntax/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/traitcodegen/GenerateTraitDirective.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/traitcodegen/SymbolProperties.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/traitcodegen/TraitCodegenContext.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/traitcodegen/TraitCodegenPlugin.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/traitcodegen/TraitCodegenSettings.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/traitcodegen/TraitCodegenUtils.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/traitcodegen/generators/ShapeGenerator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/traitcodegen/generators/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/traitcodegen/generators/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/TraitCodegenIntegration.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/core/CoreIntegration.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/core/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/core/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/idref/IdRefDecoratorIntegration.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/idref/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/idref/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/javadoc/JavaDocIntegration.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/javadoc/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/javadoc/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/uniqueitems/UniqueItemDecoratorIntegration.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/uniqueitems/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/uniqueitems/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/traitcodegen/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/traitcodegen/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/traitcodegen/sections/BuilderClassSection.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/traitcodegen/sections/ClassSection.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/traitcodegen/sections/EnumVariantSection.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/traitcodegen/sections/GetterSection.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/traitcodegen/sections/JavaDocSection.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/traitcodegen/sections/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/traitcodegen/sections/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/traitcodegen/writer/TraitCodegenWriter.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/traitcodegen/writer/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/traitcodegen/writer/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/utils/AbstractCodeWriter.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/utils/BuilderRef.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/utils/CaseUtils.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/utils/CodeInterceptor.Appender.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/utils/CodeInterceptor.Prepender.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/utils/CodeInterceptor.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/utils/CodeSection.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/utils/CodeWriter.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/utils/CodeWriterDebugInfo.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/utils/FunctionalUtils.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/utils/IoUtils.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/utils/ListUtils.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/utils/MapUtils.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/utils/MediaType.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/utils/OptionalUtils.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/utils/Pair.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/utils/SetUtils.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/utils/SimpleCodeWriter.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/utils/SimpleParser.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/utils/SmithyBuilder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/utils/SmithyGenerated.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/utils/SmithyInternalApi.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/utils/SmithyUnstableApi.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/utils/StringUtils.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/utils/Tagged.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/utils/ToSmithyBuilder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/utils/TriConsumer.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/utils/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/utils/package-tree.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/waiters/Acceptor.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/waiters/AcceptorState.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/waiters/Matcher.ErrorTypeMember.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/waiters/Matcher.InputOutputMember.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/waiters/Matcher.OutputMember.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/waiters/Matcher.SuccessMember.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/waiters/Matcher.UnknownMember.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/waiters/Matcher.Visitor.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/waiters/Matcher.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/waiters/PathComparator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/waiters/PathMatcher.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/waiters/UniqueWaiterNamesValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/waiters/WaitableTrait.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/waiters/WaitableTrait.Provider.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/waiters/WaitableTrait.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/waiters/WaitableTraitValidator.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/waiters/Waiter.Builder.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/waiters/Waiter.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/waiters/package-summary.html create mode 100644 javadoc/1.47.0/software/amazon/smithy/waiters/package-tree.html create mode 100644 javadoc/1.47.0/stylesheet.css create mode 100644 javadoc/1.47.0/type-search-index.js create mode 100644 javadoc/1.47.0/type-search-index.zip diff --git a/1.0/_sources/spec/http-protocol-compliance-tests.rst.txt b/1.0/_sources/spec/http-protocol-compliance-tests.rst.txt index 796d26dc4ce..a2654d0ab91 100644 --- a/1.0/_sources/spec/http-protocol-compliance-tests.rst.txt +++ b/1.0/_sources/spec/http-protocol-compliance-tests.rst.txt @@ -207,8 +207,10 @@ that support the following members: to parse and validate the expected data against generated data. * - params - ``document`` - - Defines the input parameters used to generate the HTTP request. These - parameters MUST be compatible with the input of the operation. + - For clients, defines the input parameters used to generate the HTTP + request. For servers, defines the input parameters extracted from the + HTTP request. These parameters MUST be compatible with the input of the + operation. Parameter values that contain binary data MUST be defined using values that can be represented in plain text (for example, use "foo" @@ -391,9 +393,10 @@ structures that support the following members: base64 encoded. * - params - ``document`` - - Defines the output or error parameters used to generate the HTTP - response. These parameters MUST be compatible with the targeted - operation's output or the targeted error structure. + - For clients, defines the output or error parameters extracted from the + HTTP response. For servers, defines the output or error parameters used + to generate the HTTP response. These parameters MUST be compatible with + the targeted operation's output or the targeted error structure. Parameter values that contain binary data MUST be defined using values that can be represented in plain text (for example, use "foo" diff --git a/1.0/_static/basic.css b/1.0/_static/basic.css index eeb0519a69b..4e9a9f1faca 100644 --- a/1.0/_static/basic.css +++ b/1.0/_static/basic.css @@ -236,16 +236,6 @@ div.body p, div.body dd, div.body li, div.body blockquote { a.headerlink { visibility: hidden; } -a.brackets:before, -span.brackets > a:before{ - content: "["; -} - -a.brackets:after, -span.brackets > a:after { - content: "]"; -} - h1:hover > a.headerlink, h2:hover > a.headerlink, @@ -334,11 +324,15 @@ aside.sidebar { p.sidebar-title { font-weight: bold; } +nav.contents, +aside.topic, div.admonition, div.topic, blockquote { clear: left; } /* -- topics ---------------------------------------------------------------- */ +nav.contents, +aside.topic, div.topic { border: 1px solid #ccc; padding: 7px; @@ -377,6 +371,8 @@ div.body p.centered { div.sidebar > :last-child, aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, div.topic > :last-child, div.admonition > :last-child { margin-bottom: 0; @@ -384,6 +380,8 @@ div.admonition > :last-child { div.sidebar::after, aside.sidebar::after, +nav.contents::after, +aside.topic::after, div.topic::after, div.admonition::after, blockquote::after { @@ -608,19 +606,26 @@ ol.simple p, ul.simple p { margin-bottom: 0; } -dl.footnote > dt, -dl.citation > dt { +aside.footnote > span, +div.citation > span { float: left; - margin-right: 0.5em; } - -dl.footnote > dd, -dl.citation > dd { +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { margin-bottom: 0em; } - -dl.footnote > dd:after, -dl.citation > dd:after { +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { content: ""; clear: both; } @@ -636,10 +641,6 @@ dl.field-list > dt { padding-left: 0.5em; padding-right: 5px; } -dl.field-list > dt:after { - content: ":"; -} - dl.field-list > dd { padding-left: 0.5em; diff --git a/1.0/guides/building-models/build-config.html b/1.0/guides/building-models/build-config.html index e82bcaeb545..79000f0ba8e 100644 --- a/1.0/guides/building-models/build-config.html +++ b/1.0/guides/building-models/build-config.html @@ -311,7 +311,7 @@

smithy-build - +
@@ -419,7 +419,7 @@

smithy-build^[A-Za-z0-9\-_.]+$.

A projection accepts the following configuration:

-

 +
@@ -488,7 +488,7 @@

smithy-build -

+
@@ -516,7 +516,7 @@

smithy-build

apply#

Applies the transforms defined in the given projection names.

-

+
@@ -572,7 +572,7 @@

smithy-build

changeStringEnumsToEnumShapes#

Changes string shapes with enum traits into enum shapes.

-

+
@@ -624,7 +624,7 @@

smithy-build

changeTypes#

Changes the types of shapes.

-

+
@@ -689,7 +689,7 @@

smithy-buildtags via the tags trait.

-

+
@@ -737,7 +737,7 @@

smithy-build

excludeShapesByTrait#

Removes shapes if they are marked with one or more specific traits.

-

+
@@ -785,7 +785,7 @@

smithy-buildtags via the tags trait.

-

+
@@ -834,7 +834,7 @@

smithy-buildnamespaces. Note that this does not filter out traits based on namespaces.

-

+
@@ -883,7 +883,7 @@

smithy-buildservices list of shape IDs.

-

+
@@ -929,7 +929,7 @@

smithy-buildtags.

-

+
@@ -978,7 +978,7 @@

smithy-buildremoveUnusedShapes to remove orphaned shapes.

-

+
@@ -1052,7 +1052,7 @@

smithy-buildremoveUnusedShapes to remove orphaned shapes.

-

+
@@ -1101,7 +1101,7 @@

smithy-buildmetadata and the suppress trait.

-

+
@@ -1304,7 +1304,7 @@

smithy-buildtags list.

-

+
@@ -1353,7 +1353,7 @@

smithy-buildremoveUnusedShapes to remove orphaned shapes.

-

+
@@ -1427,7 +1427,7 @@

smithy-buildremoveUnusedShapes to remove orphaned shapes.

-

+
@@ -1477,7 +1477,7 @@

smithy-buildmetadata key-value pairs from a model if the key is in the provided keys list.

-

+
@@ -1522,7 +1522,7 @@

smithy-buildmetadata key-value pairs from a model if the key is not in the provided keys list.

-

+
@@ -1567,7 +1567,7 @@

smithy-build -

+
@@ -1638,7 +1638,7 @@

smithy-buildexportTagged argument.

-

+
@@ -1692,7 +1692,7 @@

smithy-buildexportTagged argument.

-

+
@@ -1744,7 +1744,7 @@

smithy-build -

+
diff --git a/1.0/guides/building-models/gradle-plugin.html b/1.0/guides/building-models/gradle-plugin.html index 713dec9aa76..432aa1f055b 100644 --- a/1.0/guides/building-models/gradle-plugin.html +++ b/1.0/guides/building-models/gradle-plugin.html @@ -357,7 +357,7 @@

Smithy Gradle Plugin

This extension supports the following properties:

-

+
@@ -436,12 +436,12 @@

Smithy Gradle Plugin} dependencies { - implementation("software.amazon.smithy:smithy-model:1.46.0") + implementation("software.amazon.smithy:smithy-model:1.47.0") // These are just examples of dependencies. This model has a dependency on // a "common" model package and uses the external AWS traits. implementation("com.foo.baz:foo-model-internal-common:1.0.0") - implementation("software.amazon.smithy:smithy-aws-traits:1.46.0") + implementation("software.amazon.smithy:smithy-aws-traits:1.47.0") } @@ -471,7 +471,7 @@

Smithy Gradle Plugin mavenCentral() } dependencies { - classpath("software.amazon.smithy:smithy-aws-traits:1.46.0") + classpath("software.amazon.smithy:smithy-aws-traits:1.47.0") // Take a dependency on the internal model package. This // dependency *must* be a buildscript only dependency to ensure @@ -495,12 +495,12 @@

Smithy Gradle Plugin} dependencies { - implementation("software.amazon.smithy:smithy-model:1.46.0") + implementation("software.amazon.smithy:smithy-model:1.47.0") // Any dependencies that the projected model needs must be (re)declared // here. For example, let's assume that the smithy-aws-traits package is // needed in the projected model too. - implementation("software.amazon.smithy:smithy-aws-traits:1.46.0") + implementation("software.amazon.smithy:smithy-aws-traits:1.47.0") } @@ -600,7 +600,7 @@

Smithy Gradle Plugin // This dependency is required in order to apply the "openapi" // plugin in smithy-build.json - classpath("software.amazon.smithy:smithy-openapi:1.46.0") + classpath("software.amazon.smithy:smithy-openapi:1.47.0") } } diff --git a/1.0/guides/converting-to-openapi.html b/1.0/guides/converting-to-openapi.html index e676975e054..ad3bd09f630 100644 --- a/1.0/guides/converting-to-openapi.html +++ b/1.0/guides/converting-to-openapi.html @@ -410,17 +410,17 @@

Converting to OpenAPI with smithy-buildbuildscript { dependencies { - classpath("software.amazon.smithy:smithy-openapi:1.46.0") + classpath("software.amazon.smithy:smithy-openapi:1.47.0") // The openapi plugin configured in the smithy-build.json example below // uses the restJson1 protocol defined in the aws-traits package. This // additional dependency must added to use that protocol. - classpath("software.amazon.smithy:smithy-aws-traits:1.46.0") + classpath("software.amazon.smithy:smithy-aws-traits:1.47.0") } } dependencies { // The dependency for restJson1 is required here too. - implementation("software.amazon.smithy:smithy-aws-traits:1.46.0") + implementation("software.amazon.smithy:smithy-aws-traits:1.47.0") } @@ -446,7 +446,7 @@

Converting to OpenAPI with smithy-build

Important

-

A buildscript dependency on "software.amazon.smithy:smithy-openapi:1.46.0" is +

A buildscript dependency on "software.amazon.smithy:smithy-openapi:1.47.0" is required in order for smithy-build to map the "openapi" plugin name to the correct Java library implementation.

@@ -1119,7 +1119,7 @@

Amazon API Gateway extensionsbuild.gradle.kts# 
buildscript {
     dependencies {
-        classpath("software.amazon.smithy:smithy-aws-apigateway-openapi:1.46.0")
+        classpath("software.amazon.smithy:smithy-aws-apigateway-openapi:1.47.0")
     }
 }
@@ -1558,7 +1558,7 @@

Converting to OpenAPI with codebuild.gradle.kts#

buildscript {
     dependencies {
-        classpath("software.amazon.smithy:smithy-openapi:1.46.0")
+        classpath("software.amazon.smithy:smithy-openapi:1.47.0")
     }
 }
diff --git a/1.0/guides/generating-cloudformation-resources.html b/1.0/guides/generating-cloudformation-resources.html index 1d4e5f820f6..081551a0dcc 100644 --- a/1.0/guides/generating-cloudformation-resources.html +++ b/1.0/guides/generating-cloudformation-resources.html @@ -346,7 +346,7 @@

Generating Schemas with smithy-buildbuildscript { dependencies { - classpath("software.amazon.smithy:smithy-aws-cloudformation:1.46.0") + classpath("software.amazon.smithy:smithy-aws-cloudformation:1.47.0") } }

@@ -404,7 +404,7 @@

Generating Schemas with smithy-build

Important

-

A buildscript dependency on "software.amazon.smithy:smithy-aws-cloudformation:1.46.0" is +

A buildscript dependency on "software.amazon.smithy:smithy-aws-cloudformation:1.47.0" is required in order for smithy-build to map the "cloudformation" plugin name to the correct Java library implementation.

@@ -759,7 +759,7 @@

Generating Schemas with codebuild.gradle.kts# 
buildscript {
     dependencies {
-        classpath("software.amazon.smithy:smithy-aws-cloudformation:1.46.0")
+        classpath("software.amazon.smithy:smithy-aws-cloudformation:1.47.0")
     }
 }
@@ -785,7 +785,7 @@

Generating Schemas with codesoftware.amazon.smithy.aws.cloudformation.schema.fromsmithy.Smithy2CfnExtension -service providers. See the Javadocs for more information.

+service providers. See the Javadocs for more information.

diff --git a/1.0/guides/model-linters.html b/1.0/guides/model-linters.html index ba9eccebad1..a74e7240a66 100644 --- a/1.0/guides/model-linters.html +++ b/1.0/guides/model-linters.html @@ -313,8 +313,8 @@

Linting overviewbuild.gradle.kts file:

dependencies {
-    implementation("software.amazon.smithy:smithy-model:1.46.0")
-    implementation("software.amazon.smithy:smithy-linters:1.46.0")
+    implementation("software.amazon.smithy:smithy-model:1.47.0")
+    implementation("software.amazon.smithy:smithy-linters:1.47.0")
 }
@@ -339,7 +339,7 @@

Linters in smit casing makes it easier to split words apart.
Default severity
DANGER
Configuration
-

+
@@ -383,7 +383,7 @@

Linters in smit models.
Default severity
DANGER
Configuration
-

+
@@ -437,7 +437,7 @@

Linters in smit allowed or denied.
Default severity
WARNING
Configuration
-

+
@@ -500,7 +500,7 @@

Linters in smit
Configuration

A single key, reserved, is Required in the configuration. Its value is a list of objects with the following properties:

-

+
@@ -565,7 +565,7 @@

Linters in smit names match when case-insensitively containing the word. The following table shows matches for a reserved word of *codename*:

-

+
@@ -596,7 +596,7 @@

Linters in smit case-insensitively ending with the word. The following table shows matches for a reserved word of *codename:

-

+
@@ -627,7 +627,7 @@

Linters in smit case-insensitively starting with the word. The following table shows matches for a reserved word of codename*:

-

+
@@ -658,7 +658,7 @@

Linters in smit case-insensitively the same as the word. The following table shows matches for a reserved word of codename:

-

+
@@ -703,7 +703,7 @@

Linters in smit API to more easily understand the semantics of an operation.
Default severity
DANGER
Configuration
-

+
@@ -771,7 +771,7 @@

Linters in smit redundant.
Default severity
WARNING
Configuration
-

+
@@ -826,7 +826,7 @@

Linters in smit issues in the future.
Default severity
DANGER
Configuration
-

+
@@ -913,7 +913,7 @@

Linters in smit that make them easier to work with in client tooling.
Default severity
DANGER
Configuration
-

+
diff --git a/1.0/quickstart.html b/1.0/quickstart.html index dfba5badf98..d1d5f7dedb3 100644 --- a/1.0/quickstart.html +++ b/1.0/quickstart.html @@ -326,7 +326,7 @@

Shapes and traits -

+
@@ -720,7 +720,7 @@

Building the Model} dependencies { - implementation("software.amazon.smithy:smithy-model:1.46.0") + implementation("software.amazon.smithy:smithy-model:1.47.0") } configure<software.amazon.smithy.gradle.SmithyExtension> { @@ -781,7 +781,7 @@

Complete example} dependencies { - implementation("software.amazon.smithy:smithy-model:1.46.0") + implementation("software.amazon.smithy:smithy-model:1.47.0") } configure<software.amazon.smithy.gradle.SmithyExtension> { diff --git a/1.0/searchindex.js b/1.0/searchindex.js index 0fce665758f..649fd4001f6 100644 --- a/1.0/searchindex.js +++ b/1.0/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["guides/building-models/build-config", "guides/building-models/gradle-plugin", "guides/building-models/index", "guides/converting-to-openapi", "guides/evolving-models", "guides/generating-cloudformation-resources", "guides/index", "guides/model-linters", "guides/style-guide", "index", "quickstart", "spec/aws/amazon-apigateway", "spec/aws/aws-auth", "spec/aws/aws-cloudformation", "spec/aws/aws-core", "spec/aws/aws-ec2-query-protocol", "spec/aws/aws-iam", "spec/aws/aws-json-1_0-protocol", "spec/aws/aws-json-1_1-protocol", "spec/aws/aws-query-protocol", "spec/aws/aws-restjson1-protocol", "spec/aws/aws-restxml-protocol", "spec/aws/customizations/apigateway-customizations", "spec/aws/customizations/glacier-customizations", "spec/aws/customizations/index", "spec/aws/customizations/machinelearning-customizations", "spec/aws/customizations/s3-customizations", "spec/aws/index", "spec/core/auth-traits", "spec/core/behavior-traits", "spec/core/constraint-traits", "spec/core/documentation-traits", "spec/core/endpoint-traits", "spec/core/http-traits", "spec/core/idl", "spec/core/index", "spec/core/json-ast", "spec/core/model", "spec/core/model-validation", "spec/core/prelude-model", "spec/core/protocol-traits", "spec/core/resource-traits", "spec/core/selectors", "spec/core/stream-traits", "spec/core/type-refinement-traits", "spec/core/xml-traits", "spec/http-protocol-compliance-tests", "spec/index", "spec/mqtt", "spec/waiters", "ts-ssdk/error-handling", "ts-ssdk/handlers", "ts-ssdk/index", "ts-ssdk/introduction", "ts-ssdk/supported-endpoints", "ts-ssdk/validation"], "filenames": ["guides/building-models/build-config.rst", "guides/building-models/gradle-plugin.rst", "guides/building-models/index.rst", "guides/converting-to-openapi.rst", "guides/evolving-models.rst", "guides/generating-cloudformation-resources.rst", "guides/index.rst", "guides/model-linters.rst", "guides/style-guide.rst", "index.rst", "quickstart.rst", "spec/aws/amazon-apigateway.rst", "spec/aws/aws-auth.rst", "spec/aws/aws-cloudformation.rst", "spec/aws/aws-core.rst", "spec/aws/aws-ec2-query-protocol.rst", "spec/aws/aws-iam.rst", "spec/aws/aws-json-1_0-protocol.rst", "spec/aws/aws-json-1_1-protocol.rst", "spec/aws/aws-query-protocol.rst", "spec/aws/aws-restjson1-protocol.rst", "spec/aws/aws-restxml-protocol.rst", "spec/aws/customizations/apigateway-customizations.rst", "spec/aws/customizations/glacier-customizations.rst", "spec/aws/customizations/index.rst", "spec/aws/customizations/machinelearning-customizations.rst", "spec/aws/customizations/s3-customizations.rst", "spec/aws/index.rst", "spec/core/auth-traits.rst", "spec/core/behavior-traits.rst", "spec/core/constraint-traits.rst", "spec/core/documentation-traits.rst", "spec/core/endpoint-traits.rst", "spec/core/http-traits.rst", "spec/core/idl.rst", "spec/core/index.rst", "spec/core/json-ast.rst", "spec/core/model.rst", "spec/core/model-validation.rst", "spec/core/prelude-model.rst", "spec/core/protocol-traits.rst", "spec/core/resource-traits.rst", "spec/core/selectors.rst", "spec/core/stream-traits.rst", "spec/core/type-refinement-traits.rst", "spec/core/xml-traits.rst", "spec/http-protocol-compliance-tests.rst", "spec/index.rst", "spec/mqtt.rst", "spec/waiters.rst", "ts-ssdk/error-handling.rst", "ts-ssdk/handlers.rst", "ts-ssdk/index.rst", "ts-ssdk/introduction.rst", "ts-ssdk/supported-endpoints.rst", "ts-ssdk/validation.rst"], "titles": ["smithy-build", "Smithy Gradle Plugin", "Building Smithy Models", "Converting Smithy to OpenAPI", "Evolving Models", "Generating CloudFormation Resource Schemas from Smithy", "Smithy Guides", "Model linters", "Style Guide", "Smithy", "Quick start", "Amazon API Gateway traits", "AWS Authentication Traits", "AWS CloudFormation traits", "AWS Core Specification", "AWS EC2 query protocol", "AWS IAM traits", "AWS JSON 1.0 protocol", "AWS JSON 1.1 protocol", "AWS query protocol", "AWS restJson1 protocol", "AWS restXml protocol", "Amazon API Gateway Customizations", "Amazon Glacier Customizations", "AWS Service Customizations", "Amazon Machine Learning Customizations", "Amazon S3 Customizations", "AWS specifications", "7. Authentication traits", "8. Behavior traits", "3. Constraint traits", "4. Documentation traits", "13. Endpoint Traits", "11. HTTP binding traits", "16. Smithy IDL", "Smithy specification", "17. JSON AST", "1. The Smithy model", "15. Model validation", "2. Prelude model", "6. Protocol traits", "9. Resource traits", "14. Selectors", "10. Streaming Traits", "5. Type refinement traits", "12. XML binding traits", "HTTP Protocol Compliance Tests", "Specifications", "MQTT Protocol Bindings", "Waiters", "Smithy Server Generator for TypeScript error handling", "Smithy Server Generator for TypeScript handlers", "Smithy Server Generator for TypeScript", "Introduction to the Smithy Server Generator for TypeScript", "Smithy Server Generator for TypeScript supported endpoints", "Smithy Server Generator for TypeScript validation"], "terms": {"requir": [0, 1, 3, 4, 5, 7, 8, 10, 11, 12, 13, 14, 16, 17, 18, 19, 20, 21, 28, 29, 31, 32, 33, 34, 35, 36, 37, 38, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 51, 55], "construct": [0, 12, 16, 29], "configur": [0, 1, 2, 6, 7, 10, 14, 15, 16, 17, 18, 19, 20, 21, 26, 28, 29, 32, 33, 37, 38, 40, 42, 46, 49], "file": [0, 1, 2, 3, 5, 6, 7, 10, 14, 26, 34, 35, 36, 41, 42, 46], "thi": [0, 1, 2, 3, 4, 5, 7, 8, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 26, 28, 29, 30, 31, 32, 33, 34, 36, 37, 38, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 53, 55], "i": [0, 1, 2, 3, 4, 5, 7, 8, 9, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 26, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 40, 41, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55], "describ": [0, 2, 3, 4, 5, 7, 11, 13, 14, 16, 20, 21, 29, 30, 31, 34, 35, 37, 40, 44, 46, 49, 51], "how": [0, 2, 3, 4, 5, 7, 8, 10, 11, 13, 15, 17, 18, 23, 28, 33, 34, 37, 40, 41, 42, 43, 45, 46, 49], "creat": [0, 1, 2, 3, 5, 7, 8, 10, 11, 13, 29, 30, 36, 38, 41, 42, 49, 53], "what": [0, 3, 5, 14, 16, 23, 30, 37, 46, 48, 55], "The": [0, 1, 2, 3, 4, 5, 7, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 25, 26, 28, 29, 30, 31, 32, 33, 34, 35, 36, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 55], "accept": [0, 7, 10, 13, 14, 17, 18, 20, 24, 28, 30, 33, 34, 37, 43, 49, 50], "follow": [0, 1, 3, 4, 5, 7, 8, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 26, 28, 29, 30, 31, 32, 33, 34, 36, 37, 38, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 51], "properti": [0, 2, 3, 4, 5, 7, 10, 11, 12, 14, 15, 16, 17, 18, 19, 20, 21, 23, 27, 28, 29, 30, 31, 32, 33, 34, 35, 37, 38, 40, 41, 42, 45, 46, 49], "type": [0, 1, 4, 5, 7, 10, 12, 13, 14, 15, 17, 18, 19, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 38, 39, 40, 41, 43, 46, 47, 48, 49, 50, 51, 53, 54, 55], "descript": [0, 1, 3, 5, 7, 8, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 28, 29, 30, 31, 32, 33, 34, 36, 37, 38, 40, 41, 42, 45, 46, 49], "version": [0, 1, 3, 5, 7, 8, 9, 10, 11, 14, 15, 16, 17, 18, 19, 20, 21, 24, 27, 28, 29, 31, 35, 36, 37, 38, 39, 40, 42, 43, 48, 51, 55], "string": [0, 1, 3, 4, 5, 7, 8, 10, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 26, 27, 28, 29, 30, 31, 32, 35, 36, 37, 38, 39, 40, 41, 43, 44, 45, 46, 48, 49, 51, 55], "defin": [0, 1, 3, 4, 5, 7, 8, 9, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 28, 29, 30, 31, 32, 33, 35, 36, 38, 39, 40, 41, 42, 43, 44, 45, 46, 48, 49, 51, 53, 55], "set": [0, 1, 6, 7, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 26, 28, 29, 30, 31, 32, 33, 35, 38, 40, 42, 44, 46, 49, 50, 51, 53, 55], "1": [0, 1, 3, 5, 7, 8, 9, 10, 11, 12, 14, 15, 16, 19, 20, 21, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 48, 49, 55], "0": [0, 1, 3, 5, 7, 8, 9, 10, 11, 12, 14, 15, 16, 18, 19, 20, 21, 27, 28, 29, 30, 31, 32, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 48, 49, 55], "outputdirectori": [0, 1], "locat": [0, 3, 5, 7, 11, 15, 19, 21, 27, 28, 32, 33, 38, 41, 43], "where": [0, 1, 2, 3, 5, 7, 11, 14, 15, 16, 17, 18, 19, 20, 21, 28, 29, 33, 34, 35, 36, 37, 38, 42, 43, 45, 49, 51, 53, 55], "ar": [0, 1, 2, 3, 4, 5, 7, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 40, 41, 42, 43, 44, 45, 46, 48, 49, 50, 51, 53, 54, 55], "written": [0, 1, 7, 35, 36, 42, 46, 53], "each": [0, 1, 3, 5, 7, 8, 10, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 28, 29, 30, 31, 33, 34, 36, 37, 38, 40, 41, 42, 43, 45, 46, 48, 49, 51, 53, 55], "subdirectori": 0, "name": [0, 1, 3, 5, 6, 7, 10, 11, 12, 13, 15, 16, 17, 18, 19, 20, 21, 26, 27, 28, 29, 30, 31, 32, 33, 34, 36, 37, 38, 40, 41, 42, 43, 44, 46, 48, 50], "after": [0, 7, 8, 14, 17, 18, 20, 26, 29, 32, 34, 37, 38, 42, 53, 55], "from": [0, 2, 3, 4, 6, 7, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 25, 26, 29, 30, 31, 33, 34, 37, 38, 39, 40, 42, 43, 45, 46, 48, 49, 50, 51, 53, 54, 55], "includ": [0, 2, 3, 4, 5, 7, 8, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 29, 31, 32, 33, 34, 35, 37, 38, 39, 40, 42, 43, 44, 46, 49, 50, 51, 53], "place": [0, 1, 3, 4, 14, 19, 26, 33, 34, 37, 38], "directori": [0, 1, 7, 10, 14, 41, 42], "import": [0, 3, 5, 7, 14, 34, 38, 40], "provid": [0, 1, 3, 5, 7, 10, 11, 13, 14, 15, 17, 18, 19, 20, 21, 25, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 40, 41, 42, 43, 44, 45, 46, 48, 49], "list": [0, 1, 3, 5, 6, 7, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 26, 28, 29, 30, 31, 33, 35, 38, 40, 41, 42, 44, 46, 47, 49], "rel": [0, 27, 30, 36, 37, 39, 41, 42, 49], "combin": [0, 1, 3, 14, 26, 28, 33, 34, 42, 43, 54], "singl": [0, 1, 3, 7, 8, 10, 15, 17, 18, 19, 20, 21, 29, 33, 34, 36, 37, 38, 39, 42, 43, 44, 48, 49, 54], "when": [0, 1, 3, 4, 5, 7, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 26, 28, 29, 30, 31, 32, 33, 34, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 48, 49, 50, 51, 55], "encount": [0, 1, 3, 4, 19, 21, 33, 34, 36, 37, 38, 40, 49, 50, 55], "all": [0, 3, 5, 7, 8, 10, 11, 13, 14, 15, 17, 18, 19, 20, 21, 22, 23, 28, 29, 30, 31, 33, 34, 36, 37, 38, 39, 41, 42, 43, 44, 45, 46, 47, 48, 50, 51, 53], "within": [0, 3, 5, 10, 11, 13, 14, 15, 16, 19, 21, 29, 30, 31, 32, 33, 34, 36, 37, 39, 42, 45, 49], "note": [0, 3, 14, 30, 35, 37, 38, 44, 49], "system": [0, 6, 14, 29, 37, 38, 40], "mai": [0, 3, 4, 5, 7, 10, 14, 15, 17, 18, 19, 20, 21, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 40, 41, 42, 43, 44, 45, 46, 48, 49], "choos": [0, 11, 29, 30, 37, 45, 51, 53, 55], "reli": [0, 1, 3, 4, 5, 15, 18, 19, 20, 21, 33], "other": [0, 1, 4, 6, 7, 10, 11, 14, 15, 16, 18, 19, 20, 21, 25, 26, 30, 31, 33, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 46, 48, 49], "mechan": [0, 14, 29, 37], "form": [0, 7, 8, 11, 14, 27, 33, 34, 35, 36, 37, 38, 41, 42, 43, 48], "composit": 0, "These": [0, 1, 2, 3, 5, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 31, 32, 37, 43, 44, 46, 49, 50, 53, 55], "everi": [0, 3, 4, 7, 11, 14, 17, 18, 28, 32, 33, 34, 36, 37, 39, 42, 46, 48, 49, 51, 55], "map": [0, 3, 5, 6, 7, 10, 11, 14, 15, 16, 17, 18, 20, 21, 29, 30, 31, 33, 35, 38, 41, 42, 43, 44, 46, 49], "object": [0, 3, 5, 7, 8, 11, 12, 14, 15, 17, 18, 19, 20, 21, 28, 33, 34, 36, 37, 38, 40, 41, 42, 43, 45, 49, 53], "A": [0, 1, 3, 4, 5, 7, 8, 10, 11, 12, 13, 15, 16, 17, 18, 19, 20, 21, 22, 23, 26, 27, 28, 29, 30, 31, 32, 33, 34, 36, 37, 38, 40, 41, 42, 43, 44, 45, 46, 48, 49, 51, 53], "an": [0, 1, 3, 4, 5, 7, 8, 10, 11, 12, 13, 15, 16, 17, 18, 19, 20, 21, 23, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 40, 41, 42, 43, 44, 45, 46, 48, 49, 50, 51, 53, 54, 55], "arbitrari": [0, 10, 11, 14, 31, 37, 51], "ignoremissingplugin": 0, "bool": [0, 16], "If": [0, 1, 3, 4, 7, 10, 11, 14, 17, 18, 20, 21, 28, 29, 30, 31, 32, 33, 34, 37, 38, 40, 42, 43, 44, 46, 49, 50, 53, 55], "can": [0, 1, 3, 4, 5, 7, 8, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 28, 29, 30, 31, 32, 33, 34, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 48, 49, 50, 51, 53, 54, 55], "t": [0, 1, 3, 7, 10, 14, 15, 18, 19, 20, 21, 33, 34, 37], "found": [0, 1, 3, 5, 7, 14, 30, 33, 34, 37, 38, 42], "default": [0, 1, 3, 5, 7, 10, 11, 13, 14, 15, 17, 18, 19, 20, 21, 24, 26, 28, 29, 30, 33, 38, 40, 41, 42, 43, 44, 45, 49, 51, 52], "fail": [0, 1, 3, 4, 14, 29, 32, 40, 42, 43, 49, 51, 55], "true": [0, 3, 5, 7, 11, 14, 15, 17, 18, 19, 21, 29, 30, 33, 34, 37, 40, 42, 43, 45, 46, 48, 49, 54, 55], "allow": [0, 1, 2, 3, 5, 7, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 29, 30, 31, 33, 34, 36, 37, 38, 40, 41, 42, 43, 44, 46, 48, 49, 51, 53, 55], "progress": [0, 49], "even": [0, 3, 8, 37, 38, 46, 49, 51], "classpath": [0, 1, 3, 5, 7], "exampl": [0, 2, 4, 5, 6, 7, 8, 11, 12, 16, 17, 18, 20, 21, 27, 28, 29, 30, 32, 33, 34, 35, 36, 37, 38, 40, 41, 42, 43, 44, 45, 47, 48, 53, 55], "output": [0, 3, 4, 7, 10, 12, 13, 14, 15, 17, 18, 19, 20, 21, 26, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 41, 42, 43, 46, 47, 48, 49, 51, 53, 55], "foo": [0, 1, 3, 5, 7, 8, 10, 11, 13, 14, 15, 16, 19, 21, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 40, 41, 42, 45, 46, 48, 49], "some": [0, 3, 5, 7, 12, 13, 14, 19, 29, 30, 37, 40, 41, 42, 46, 49, 54], "my": [0, 3, 5, 14, 16, 33, 34, 36, 37, 38], "abstract": [0, 3, 29, 34, 36, 37, 40, 43, 46, 48, 49, 51, 53], "specif": [0, 2, 3, 4, 9, 10, 11, 15, 17, 18, 19, 20, 21, 28, 29, 30, 32, 33, 34, 36, 37, 38, 39, 41, 42, 43, 46, 48, 49, 53], "arg": [0, 1], "tag": [0, 3, 10, 11, 13, 14, 15, 30, 33, 34, 35, 36, 37, 38, 42, 46, 47, 48, 49], "intern": [0, 1, 2, 7, 11, 17, 18, 20, 29, 35, 42, 47, 50], "beta": [0, 34, 37], "trait": [0, 1, 6, 7, 24, 27, 35, 36, 39, 46, 50, 55], "config": [0, 3, 5, 7, 14], "valu": [0, 1, 3, 5, 7, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 24, 26, 28, 29, 31, 32, 33, 35, 36, 38, 39, 40, 41, 43, 44, 45, 46, 48, 49, 50, 51, 54, 55], "filter": [0, 1, 7, 10, 29, 31, 42, 46, 48], "modifi": [0, 51], "intend": [0, 7, 29, 31, 37, 40, 53], "audienc": 0, "custom": [0, 1, 3, 4, 5, 6, 8, 10, 11, 13, 14, 15, 17, 18, 19, 20, 21, 30, 31, 32, 33, 37, 38, 40, 42, 43, 47, 48, 49, 50, 52, 53], "compani": [0, 31], "maintain": [0, 1, 5, 7, 13, 37, 42, 49], "extern": [0, 1, 14, 31, 41, 42], "api": [0, 5, 6, 7, 10, 12, 13, 15, 16, 19, 24, 27, 28, 29, 30, 31, 32, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 49, 51, 52, 53], "paramet": [0, 3, 14, 15, 17, 18, 19, 20, 21, 25, 27, 28, 29, 31, 33, 49, 51, 55], "oper": [0, 1, 3, 5, 6, 7, 11, 12, 13, 14, 16, 21, 23, 25, 26, 27, 28, 29, 30, 31, 32, 33, 35, 38, 41, 42, 43, 44, 46, 48, 49, 50, 51, 53, 54, 55], "avail": [0, 1, 3, 7, 9, 10, 14, 16, 29, 31, 37, 38, 42, 46, 49, 54], "onli": [0, 1, 2, 3, 4, 5, 7, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 28, 29, 30, 31, 33, 34, 36, 37, 38, 40, 41, 42, 43, 44, 46, 48, 51, 53, 55], "subset": [0, 29, 42], "must": [0, 1, 3, 5, 7, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 26, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 40, 41, 42, 43, 44, 45, 46, 48, 49, 53], "match": [0, 1, 3, 7, 11, 12, 14, 29, 30, 32, 33, 35, 37, 38, 41, 46, 48, 49, 50, 51, 54], "pattern": [0, 3, 7, 10, 11, 14, 32, 34, 35, 38, 47, 48], "za": [0, 10, 14, 16, 30], "z0": [0, 10, 14, 16], "9": [0, 10, 14, 16, 30, 34, 49], "_": [0, 30, 33, 37, 42, 45], "boolean": [0, 1, 3, 5, 6, 7, 10, 13, 14, 15, 16, 17, 18, 19, 20, 21, 29, 30, 31, 33, 34, 36, 37, 39, 40, 42, 43, 44, 45, 46, 48, 49], "placehold": [0, 3, 14, 32, 33, 48], "remov": [0, 3, 4, 5, 14, 19, 26, 29, 37, 42, 49], "shape": [0, 3, 5, 6, 7, 11, 12, 13, 14, 16, 23, 27, 28, 29, 30, 31, 32, 33, 35, 38, 40, 41, 43, 44, 46, 48, 49, 53, 55], "content": [0, 3, 5, 7, 10, 11, 12, 14, 15, 16, 17, 18, 19, 23, 27, 29, 31, 32, 33, 34, 37, 38, 40, 42, 43, 46, 47, 50], "ani": [0, 1, 2, 3, 5, 7, 10, 11, 13, 14, 15, 17, 18, 19, 20, 21, 28, 29, 30, 31, 32, 33, 34, 36, 37, 38, 39, 40, 41, 42, 43, 44, 46, 49, 50, 51, 53, 54, 55], "kind": [0, 3, 7, 19, 28, 29, 33, 34, 35, 36, 37, 38, 40, 42, 46], "necessari": [0, 3, 5, 14, 29, 37, 42, 43, 45, 49, 51], "order": [0, 1, 3, 5, 7, 8, 10, 11, 14, 16, 17, 18, 20, 21, 26, 28, 29, 30, 33, 34, 37, 40, 42, 46, 49, 50, 51, 55], "attempt": [0, 14, 29, 38, 41, 42, 49], "resolv": [0, 3, 11, 13, 15, 17, 18, 19, 20, 21, 26, 27, 30, 31, 32, 33, 34, 36, 37, 40, 41, 42, 46, 48], "java": [0, 1, 3, 4, 5, 7, 37, 44, 46], "spi": [0, 7], "instanc": [0, 10, 13, 14, 30, 36, 37, 38, 49, 50, 51, 53], "softwar": [0, 1, 3, 5, 7, 10, 14, 33], "amazon": [0, 1, 2, 5, 6, 7, 10, 12, 14, 15, 16, 17, 18, 20, 24, 27, 41, 47, 49, 51, 52, 53], "smithybuildplugin": 0, "return": [0, 7, 10, 11, 13, 14, 29, 30, 33, 34, 36, 37, 38, 40, 41, 42, 43, 49, 50, 51, 53, 54, 55], "call": [0, 3, 10, 11, 13, 14, 29, 30, 37, 41, 42, 49, 51, 53, 54], "getnam": 0, "emit": [0, 3, 7, 14, 34, 38, 43, 49], "warn": [0, 3, 7, 31, 37, 38], "cannot": [0, 13, 14, 15, 19, 21, 30, 31, 33, 34, 37, 38, 41, 44, 49, 50], "write": [0, 6, 13, 38, 49, 52, 53, 54], "insid": [0, 10, 15, 34, 36, 37, 40, 42, 48], "projectionnam": 0, "inform": [0, 1, 3, 5, 8, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 30, 34, 37, 38, 42, 50], "about": [0, 7, 8, 10, 11, 14, 16, 30, 31, 34, 36, 37, 38, 42, 43, 46, 49, 50], "result": [0, 3, 4, 5, 7, 10, 11, 14, 15, 18, 19, 20, 21, 29, 32, 33, 34, 37, 42, 43, 46, 49, 50, 53], "valid": [0, 1, 5, 6, 8, 10, 11, 13, 14, 16, 17, 18, 20, 21, 29, 30, 31, 32, 34, 35, 37, 40, 41, 42, 43, 45, 46, 47, 49, 50, 52, 53], "event": [0, 7, 14, 17, 18, 19, 20, 21, 34, 35, 48, 49, 51, 54], "pluginnam": 0, "artifactnam": 0, "contribut": [0, 35], "path": [0, 3, 11, 14, 26, 29, 33, 37, 38, 46, 49], "against": [0, 11, 14, 30, 33, 34, 38, 42, 46, 49, 51, 53, 55], "For": [0, 1, 2, 3, 4, 5, 7, 8, 10, 11, 14, 15, 16, 17, 18, 19, 30, 31, 32, 33, 35, 37, 38, 41, 42, 43, 44, 45, 46, 48, 49, 50, 51, 53, 55], "given": [0, 1, 3, 5, 11, 13, 14, 15, 16, 19, 30, 31, 32, 33, 34, 35, 37, 38, 40, 42, 43, 45, 46, 48, 49, 55], "baz": [0, 1, 3, 5, 11, 15, 19, 31, 33, 34, 37, 38, 41, 42, 45, 46, 48], "would": [0, 3, 5, 7, 14, 15, 16, 19, 26, 29, 30, 33, 37, 38, 40, 44, 49, 51, 53, 55], "becom": [0, 29, 37, 49], "structur": [0, 1, 3, 6, 7, 10, 13, 14, 16, 17, 18, 20, 21, 26, 27, 28, 29, 30, 32, 33, 35, 38, 39, 40, 41, 42, 43, 44, 46, 48, 50, 53, 54, 55], "contain": [0, 1, 3, 5, 7, 10, 11, 14, 15, 16, 17, 18, 19, 20, 21, 28, 29, 30, 31, 32, 33, 34, 36, 37, 38, 40, 41, 42, 43, 44, 45, 46, 48, 49, 55], "kei": [0, 1, 5, 7, 10, 11, 14, 20, 21, 27, 28, 30, 31, 33, 34, 35, 36, 37, 41, 42, 44, 45, 46, 54], "pair": [0, 3, 5, 7, 15, 19, 20, 21, 30, 33, 34, 37, 46], "referenc": [0, 4, 7, 11, 14, 16, 29, 30, 33, 34, 36, 37, 38, 39, 41, 42, 43, 44, 48], "No": [0, 7, 33, 34, 37, 38, 40, 46, 48], "cycl": 0, "bar": [0, 1, 3, 7, 11, 13, 15, 16, 19, 31, 32, 33, 34, 35, 37, 38, 40, 45, 46, 48], "chang": [0, 3, 4, 5, 7, 14, 15, 19, 20, 21, 28, 29, 31, 33, 42, 43, 44, 45, 48, 49, 55], "enum": [0, 3, 4, 14, 26, 28, 35, 38, 42, 47], "synthesizenam": 0, "whether": [0, 1, 3, 4, 5, 7, 14, 30], "without": [0, 2, 4, 7, 11, 13, 14, 15, 16, 18, 19, 20, 21, 26, 28, 29, 33, 34, 37, 38, 41, 42, 49, 53, 55], "should": [0, 1, 3, 4, 5, 7, 8, 10, 11, 12, 13, 14, 16, 17, 18, 19, 20, 21, 23, 25, 26, 28, 29, 30, 31, 32, 33, 34, 35, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 48, 49, 53, 54], "have": [0, 3, 5, 7, 10, 13, 14, 15, 16, 19, 20, 21, 23, 26, 28, 29, 30, 32, 33, 34, 36, 37, 38, 40, 41, 42, 43, 44, 46, 48, 49, 50, 53, 55], "synthes": 0, "possibl": [0, 3, 4, 10, 14, 31, 33, 37, 39, 42, 46, 49], "convert": [0, 5, 6, 7, 11, 13, 14, 17, 18, 37, 42, 46, 49, 51, 53, 54], "To": [0, 1, 11, 14, 29, 30, 33, 37, 42, 49], "successfulli": [0, 14, 16, 28, 40, 49], "definit": [0, 1, 3, 4, 10, 11, 13, 15, 19, 20, 21, 28, 30, 34, 35, 36, 38, 40, 42, 46, 51], "option": [0, 3, 4, 5, 7, 11, 14, 26, 29, 30, 33, 34, 35, 36, 37, 38, 40, 42, 43, 44, 46, 49, 51], "enabl": [0, 3, 5, 10, 11, 14, 26, 29, 33, 51, 53, 55], "By": [0, 1, 3, 5, 7, 8, 10, 14, 15, 17, 18, 19, 20, 21, 29, 33, 37, 40, 41, 45, 49], "disabl": [0, 3, 5, 10, 11, 14, 16, 21, 26, 29, 32, 33, 55], "mark": [0, 3, 4, 7, 10, 13, 14, 16, 20, 21, 28, 29, 30, 31, 32, 33, 36, 37, 40, 41, 42, 43, 44, 46, 48, 49], "deprec": [0, 4, 5, 19, 29, 30, 34, 35, 37, 42, 47, 49], "member": [0, 3, 4, 5, 7, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 29, 30, 31, 32, 33, 34, 35, 38, 40, 41, 42, 43, 44, 45, 46, 48, 49, 50, 55], "addition": [0, 14, 46, 51], "exampleproject": 0, "shapetyp": 0, "shapeid": [0, 3, 5, 13, 14, 31, 34, 37], "id": [0, 1, 3, 5, 7, 10, 11, 13, 15, 16, 17, 18, 19, 20, 21, 27, 28, 30, 31, 33, 35, 36, 38, 39, 40, 46, 48, 49], "assign": [0, 14, 34, 36, 37, 38, 40, 42], "synthesizeenumnam": 0, "support": [0, 1, 3, 5, 7, 10, 11, 12, 13, 14, 16, 26, 27, 28, 29, 30, 31, 33, 34, 36, 37, 38, 40, 41, 42, 43, 46, 48, 49, 52, 53, 55], "simpl": [0, 10, 11, 13, 14, 15, 16, 19, 31, 33, 35, 38, 39, 42, 44, 51], "union": [0, 3, 6, 7, 10, 14, 17, 18, 20, 21, 30, 33, 35, 40, 42, 43, 46, 48], "qux": [0, 31, 34, 37, 38], "thei": [0, 1, 3, 7, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 28, 29, 30, 31, 32, 33, 34, 37, 38, 40, 42, 43, 44, 46, 49, 50, 53, 55], "one": [0, 3, 5, 7, 8, 10, 11, 13, 14, 16, 17, 18, 19, 20, 21, 29, 30, 33, 34, 36, 37, 40, 41, 42, 44, 46, 48, 49, 51, 53], "more": [0, 1, 2, 3, 5, 7, 8, 10, 11, 13, 14, 15, 16, 19, 21, 26, 29, 30, 33, 34, 36, 37, 38, 40, 41, 42, 44, 48, 49, 53, 55], "via": [0, 3, 4, 7, 13, 15, 16, 17, 18, 19, 20, 21, 28, 33, 48, 51, 53, 54], "caus": [0, 3, 30, 37, 38, 40, 42, 49, 55], "doe": [0, 1, 3, 4, 7, 11, 14, 15, 17, 18, 19, 21, 28, 29, 30, 31, 33, 34, 36, 37, 38, 40, 41, 42, 43, 45, 48, 49, 50, 53], "prelud": [0, 10, 34, 35, 37, 42, 44, 47], "assum": [0, 1, 3, 5, 7, 11, 17, 18, 20, 21, 34, 37, 41, 46, 49, 51], "namespac": [0, 3, 5, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 28, 29, 30, 31, 32, 33, 35, 36, 37, 38, 39, 40, 41, 42, 43, 45, 46, 48, 49], "least": [0, 7, 14, 30, 36, 37, 40, 42, 49], "retain": 0, "out": [0, 1, 3, 10, 29, 31, 37, 42, 46, 49, 53], "part": [0, 3, 4, 12, 13, 14, 23, 29, 30, 33, 37, 40, 41, 42, 43, 49], "base": [0, 3, 5, 7, 11, 14, 16, 20, 21, 29, 30, 33, 37, 42, 43, 44, 45, 46, 49, 50], "com": [0, 1, 7, 14, 15, 16, 17, 18, 19, 20, 21, 26, 31, 33, 34, 35, 37, 41, 45, 46, 49], "servic": [0, 1, 3, 5, 6, 7, 9, 11, 12, 13, 15, 16, 17, 18, 19, 20, 21, 23, 25, 28, 29, 30, 31, 33, 35, 38, 40, 41, 43, 45, 46, 47, 48, 49, 50, 51, 52, 53, 55], "entri": [0, 3, 10, 14, 15, 17, 18, 19, 20, 21, 28, 30, 33, 34, 36, 37, 42, 45, 51, 55], "myservic": [0, 1, 14, 15, 16, 17, 18, 19, 20, 21, 31, 36, 37, 42], "taga": 0, "tagb": 0, "present": [0, 3, 5, 8, 10, 11, 14, 15, 16, 17, 18, 19, 20, 21, 29, 30, 31, 33, 37, 40, 41, 42, 43, 46, 48], "also": [0, 1, 3, 5, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 28, 29, 30, 33, 34, 36, 37, 38, 40, 42, 43, 48, 53, 55], "make": [0, 1, 3, 7, 8, 10, 14, 23, 25, 29, 34, 35, 37, 38, 41, 42, 46, 49], "up": [0, 1, 3, 10, 14, 31, 34, 37, 41, 42, 43], "automat": [0, 1, 3, 5, 7, 10, 13, 14, 16, 25, 29, 31, 33, 34, 37, 39, 46, 48, 54, 55], "orphan": 0, "argument": [0, 42, 51], "end": [0, 3, 7, 8, 14, 32, 33, 34, 37, 38, 40, 42, 43, 50, 53], "exclud": [0, 13, 38, 42], "entir": [0, 10, 14, 29, 30, 33, 34, 36, 37, 38, 48], "sinc": [0, 7, 10, 23, 26, 29, 33, 35, 40, 42, 47, 50, 51, 53], "customtrait": 0, "you": [0, 1, 3, 5, 7, 9, 10, 14, 32, 37, 38, 55], "ha": [0, 1, 3, 5, 7, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 28, 29, 30, 33, 34, 36, 37, 38, 41, 42, 44, 45, 46, 48, 49, 50, 51, 53, 55], "suppress": [0, 1, 8, 34, 35, 37, 49, 55], "metadata": [0, 3, 7, 8, 14, 35, 36, 42, 43, 48, 51, 53], "removeunus": 0, "effect": [0, 3, 10, 11, 14, 28, 29, 31, 34, 37, 38, 44, 45], "often": [0, 3, 4, 7, 14, 37, 43], "could": [0, 3, 10, 31, 34, 37, 38, 42, 43, 46, 49, 51, 53, 55], "left": [0, 29, 34, 37, 42, 43], "longer": [0, 4, 14, 29, 31, 42, 49], "inadvert": [0, 3, 32], "disclos": 0, "privat": [0, 7, 11, 28, 34, 35, 37, 47], "unreleas": 0, "featur": [0, 1, 20, 31, 34, 37, 38, 49], "never": [0, 11, 33, 36, 42, 44, 49, 50, 54, 55], "updat": [0, 3, 5, 6, 7, 10, 13, 34, 36, 41, 42, 51], "refer": [0, 3, 5, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 28, 30, 31, 32, 33, 35, 37, 38, 42, 47, 48, 49, 53, 54], "removereason": 0, "reason": [0, 7, 10, 13, 14, 29, 31, 33, 38], "reveal": 0, "sensit": [0, 7, 14, 33, 34, 35, 37, 40, 42, 47, 48], "extra": 0, "step": [0, 14, 17, 18, 20, 29, 33, 34, 37, 40, 49, 53], "team": [0, 5, 31, 37, 38, 49], "take": [0, 1, 3, 10, 14, 17, 18, 20, 30, 33, 34, 37, 38, 49, 51], "ensur": [0, 1, 7, 28, 29, 30, 33, 34, 37, 38, 40, 42, 46, 48, 51], "do": [0, 3, 5, 7, 8, 14, 29, 30, 32, 33, 34, 36, 37, 38, 41, 42, 43, 45, 46, 48, 51, 55], "leak": 0, "publish": [0, 1, 7, 47, 53], "outsid": [0, 13, 29, 30, 34, 36, 37, 51], "organ": [0, 5, 7, 14, 37, 38], "eventidallowlist": 0, "them": [0, 3, 5, 7, 10, 13, 23, 37, 40, 48], "tandem": 0, "eventiddenylist": 0, "namespaceallowlist": 0, "namespacedenylist": 0, "deni": [0, 7], "myinternalvalid": 0, "b": [0, 3, 15, 19, 33, 34, 35, 36, 37, 38, 42, 43, 45, 48], "c": [0, 3, 15, 34, 37, 42, 43, 48], "public": [0, 7, 11, 31], "author": [0, 8, 16, 27, 28, 29, 31, 33, 37, 42, 47, 51, 53], "flatten": [0, 1, 42], "connect": [0, 11, 14, 17, 18, 20, 21, 33, 37, 42, 43, 48], "target": [0, 3, 4, 5, 7, 10, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 40, 41, 42, 43, 44, 45, 46, 48, 53], "closur": [0, 10, 14, 15, 16, 17, 18, 19, 20, 21, 28, 29, 36, 40, 42, 49], "replac": [0, 3, 5, 7, 14, 26, 37, 41, 48, 49], "equival": [0, 13, 14, 30, 33, 34, 37, 42], "forc": 0, "its": [0, 3, 4, 5, 10, 13, 14, 16, 29, 32, 33, 34, 36, 37, 40, 41, 42, 43, 49, 53], "addit": [0, 1, 3, 4, 5, 7, 10, 13, 14, 15, 16, 17, 18, 19, 20, 21, 29, 32, 33, 37, 38, 41, 42, 46, 48, 49, 51], "along": [0, 1, 5, 7, 15, 19, 29, 38, 42, 55], "which": [0, 1, 2, 3, 5, 11, 14, 15, 17, 18, 19, 20, 21, 28, 29, 30, 31, 33, 34, 36, 37, 40, 41, 42, 43, 46, 48, 49, 50, 51, 53], "exist": [0, 3, 5, 14, 28, 29, 33, 34, 35, 37, 38, 40, 41, 43, 49], "separ": [0, 1, 2, 7, 8, 11, 14, 15, 17, 18, 19, 29, 33, 34, 37, 38, 42, 48, 53], "n": [0, 11, 17, 18, 34, 49], "been": [0, 15, 19, 21, 29, 34, 37, 48, 49], "renam": [0, 3, 4, 27, 36, 37], "disambigu": [0, 15, 17, 18, 19, 20, 21, 33, 36, 37], "through": [0, 1, 3, 5, 7, 11, 14, 19, 28, 29, 34, 35, 37, 42, 43, 46, 49, 51, 53], "": [0, 1, 2, 3, 4, 5, 7, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 26, 29, 30, 32, 33, 34, 37, 38, 41, 42, 44, 46, 48, 49, 50, 51, 52, 53, 54, 55], "so": [0, 1, 5, 10, 13, 14, 16, 33, 34, 35, 37, 42, 46, 48, 49, 55], "long": [0, 3, 7, 10, 14, 15, 17, 18, 19, 20, 21, 29, 30, 33, 34, 36, 37, 39, 42, 43, 44, 45, 46, 48, 49], "don": [0, 10, 14, 15, 18, 19, 20, 21, 37], "conflict": [0, 4, 13, 14, 15, 17, 18, 19, 20, 21, 29, 30, 31, 34, 35, 36, 43, 44, 45], "leav": [0, 43, 53], "intact": 0, "export": [0, 3, 11, 14, 51, 55], "ad": [0, 1, 3, 4, 5, 7, 10, 11, 13, 29, 31, 33, 34, 37, 38, 42, 43, 48, 49], "exporttag": 0, "keep": [0, 5], "tag1": 0, "anoth": [0, 1, 3, 5, 10, 21, 31, 33, 34, 37, 42, 48, 49, 51], "regardless": [0, 28, 29, 32, 33, 37, 42, 48, 49, 53], "wa": [0, 1, 4, 14, 19, 31, 34, 37, 38, 42, 43, 49], "being": [0, 1, 3, 14, 16, 26, 29, 33, 34, 37, 42, 46, 50, 51, 55], "absolut": [0, 14, 30, 33, 34, 36, 37, 38, 41, 42, 49], "holder": 0, "expand": [0, 14, 32, 33, 34, 38], "load": [0, 3, 7, 11, 14, 34, 37, 41, 46], "time": [0, 3, 5, 7, 10, 12, 15, 19, 21, 29, 30, 33, 34, 37, 40, 41, 42, 45, 48, 49, 53, 55], "syntax": [0, 3, 34, 35, 36, 37, 40], "escap": [0, 30, 35, 38], "backslash": [0, 34], "befor": [0, 3, 7, 8, 11, 14, 17, 18, 20, 26, 29, 34, 37, 38, 41, 42, 43, 45, 48, 49, 50, 53], "liter": [0, 12, 14, 19, 22, 26, 34, 38, 42, 48], "non": [0, 3, 7, 11, 13, 14, 26, 27, 29, 33, 34, 36, 37, 49, 50, 54], "preced": [0, 26, 29, 34, 35, 37, 42, 53], "over": [0, 3, 5, 17, 18, 20, 21, 29, 30, 33, 34, 36, 37, 40, 42, 43, 46, 48, 49, 55], "consid": [0, 4, 11, 14, 15, 17, 18, 19, 20, 21, 26, 29, 30, 33, 34, 37, 38, 42, 43, 44, 48, 49, 51, 55], "name_kei": 0, "hi": [0, 3, 5, 15, 19, 21, 33, 34, 36, 37, 42, 45, 46], "either": [0, 3, 7, 10, 14, 15, 16, 17, 18, 19, 20, 21, 29, 33, 34, 37, 41, 42, 43, 50, 53], "top": [0, 3, 5, 7, 13, 14, 15, 17, 18, 19, 20, 21, 29, 31, 32, 33, 35, 37, 42, 43, 48, 49], "level": [0, 3, 5, 7, 13, 14, 15, 17, 18, 19, 20, 21, 26, 29, 30, 31, 32, 33, 35, 37, 38, 42, 43, 48, 49, 50, 51, 53, 54], "same": [0, 3, 7, 10, 11, 12, 13, 14, 15, 17, 18, 19, 20, 21, 29, 30, 31, 33, 34, 36, 37, 38, 40, 42, 45, 46, 48, 49, 51, 53, 54], "complet": [0, 2, 3, 5, 13, 16, 29, 49], "overwrit": 0, "merg": [0, 14, 34, 35, 36], "wai": [0, 10, 16, 31, 32, 34, 37, 40, 44, 49, 51, 52, 54], "matchespluginnam": 0, "log": [0, 3, 14, 31, 49, 55], "NOT": [0, 4, 5, 10, 12, 13, 14, 19, 20, 26, 29, 30, 31, 32, 33, 35, 36, 37, 40, 41, 42, 43, 48, 49], "download": 0, "instal": [0, 2, 3, 5, 10], "class": [0, 7, 14, 37, 51], "modul": [0, 53], "discov": [0, 1, 14], "alwai": [0, 1, 7, 10, 14, 33, 34, 36, 37, 42, 44, 53, 55], "run": [0, 1, 4, 10, 14, 29, 46, 49, 51], "serial": [0, 3, 10, 27, 28, 32, 35, 37, 40, 42, 46, 50, 51, 53], "self": 0, "depend": [0, 1, 3, 5, 7, 10, 14, 16, 29, 34, 37, 41, 53], "produc": [0, 14, 33, 34, 37, 43], "document": [0, 3, 5, 7, 8, 10, 11, 12, 14, 15, 16, 17, 18, 19, 20, 21, 30, 33, 36, 37, 38, 39, 40, 42, 43, 45, 46, 47, 48, 49], "copi": [0, 1, 3, 5, 10], "manifest": [0, 1], "were": [0, 10, 29, 33, 37, 38, 41, 42], "jar": [0, 1, 2, 7, 10], "while": [0, 3, 14, 29, 33, 34, 37, 40, 42, 43, 46, 48, 49, 54, 55], "itself": [0, 14, 29, 30, 37, 38, 49], "empti": [0, 3, 7, 11, 12, 15, 19, 27, 29, 30, 32, 33, 34, 35, 37, 38, 46], "than": [0, 1, 3, 11, 13, 15, 19, 21, 29, 33, 34, 36, 37, 40, 41, 42, 44, 45, 48, 49], "new": [0, 3, 4, 5, 7, 10, 14, 17, 18, 19, 20, 34, 37, 38, 42, 43, 49, 51, 55], "newli": [0, 29], "newlin": [0, 19, 34, 38], "line": [0, 5, 13, 33], "start": [0, 1, 7, 9, 14, 29, 30, 33, 34, 37, 38, 42, 43, 44, 45, 46, 49], "number": [0, 3, 7, 8, 10, 14, 15, 17, 18, 19, 20, 21, 29, 30, 32, 33, 34, 36, 37, 38, 40, 42, 43, 45, 48, 49], "sign": [0, 10, 12, 14, 29, 37], "comment": [0, 10, 35], "ignor": [0, 1, 13, 14, 15, 17, 18, 19, 32, 33, 34, 37, 38, 46, 49], "store": [0, 31, 33, 37, 40, 42, 43], "meta": [0, 1, 3, 7, 28, 33, 37, 40], "inf": [0, 1, 7], "integr": [1, 2, 14, 16, 27, 36, 37, 47, 54], "appli": [1, 3, 4, 5, 7, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 28, 29, 30, 31, 32, 33, 35, 38, 40, 41, 42, 43, 45, 46, 49, 55], "us": [1, 2, 3, 5, 6, 7, 8, 10, 11, 12, 13, 15, 16, 17, 18, 19, 20, 21, 23, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 53, 54, 55], "kotlin": [1, 7], "6": [1, 3, 5, 10, 40, 49], "src": [1, 7], "main": [1, 7, 15, 17, 18, 19, 20, 21, 36], "resourc": [1, 3, 4, 6, 7, 11, 16, 27, 31, 33, 35, 42, 47], "detect": [1, 3, 37, 38, 49, 55], "abl": [1, 15, 18, 19, 20, 21, 29, 37, 40, 54], "find": [1, 3, 7, 33, 38, 42], "discoveri": [1, 27], "two": [1, 4, 7, 8, 11, 14, 16, 17, 18, 28, 30, 33, 34, 37, 38, 40, 42, 46, 48, 49, 50, 51], "differ": [1, 4, 6, 10, 13, 15, 20, 27, 29, 30, 33, 34, 37, 38, 40, 42, 46, 48, 49, 51], "mode": [1, 14, 29, 55], "specifi": [1, 3, 5, 7, 11, 13, 14, 15, 17, 18, 19, 20, 21, 23, 25, 28, 29, 30, 33, 34, 38, 42, 46, 48, 49, 51], "smithyextens": [1, 10], "There": [1, 10, 17, 18, 34, 37, 42, 48], "correspond": [1, 3, 11, 14, 29, 30, 31, 32, 33, 37, 41, 48, 49, 50, 51, 53, 55], "json": [1, 2, 6, 10, 11, 12, 14, 15, 16, 19, 21, 22, 27, 28, 29, 30, 31, 32, 33, 34, 35, 37, 38, 40, 41, 43, 44, 45, 46, 47, 55], "projectionsourcetag": 1, "get": [1, 3, 5, 7, 10, 13, 19, 26, 29, 32, 33, 38, 42, 43, 49], "search": [1, 7], "determin": [1, 5, 7, 10, 19, 30, 34, 37, 40, 42, 43, 48, 49, 53], "look": [1, 3, 4, 7, 10, 11, 14, 30, 51], "buildscript": [1, 3, 5], "see": [1, 3, 5, 7, 10, 11, 13, 14, 15, 16, 17, 18, 19, 21, 23, 29, 30, 33], "mf": 1, "attribut": [1, 5, 15, 19, 21, 35, 38], "aggreg": [1, 10, 15, 19, 35, 42, 44], "comma": [1, 11, 33, 34, 38, 42], "queri": [1, 3, 11, 20, 21, 27, 28, 46, 49], "smithybuildconfig": 1, "filecollect": 1, "collect": [1, 3, 5, 7, 10, 30, 36, 37, 42, 45, 49], "allowunknowntrait": 1, "unknown": [1, 3, 4, 12, 30, 34, 37, 41, 42, 43, 50], "becaus": [1, 3, 4, 7, 10, 13, 19, 28, 29, 30, 32, 33, 34, 37, 38, 40, 41, 42, 43, 46, 49, 50, 55], "execut": [1, 11, 16, 30, 46, 49, 51, 53, 55], "compileclasspath": 1, "plu": [1, 14, 34], "prevent": [1, 3, 7, 10, 30, 33, 49, 50], "accident": [1, 51], "script": [1, 33], "runtimeclasspath": 1, "kt": [1, 3, 5, 7, 10], "doesn": [1, 3, 7, 10, 14], "omit": [1, 3, 11, 13, 14, 17, 18, 20, 33, 34, 36, 37, 41, 42], "repositori": [1, 10, 35, 42], "mavenloc": [1, 10], "mavencentr": [1, 10], "implement": [1, 2, 3, 5, 7, 10, 14, 15, 17, 18, 19, 20, 21, 28, 33, 34, 35, 37, 38, 40, 42, 46, 48, 49, 50, 51, 53, 55], "46": [1, 3, 5, 7, 10, 34], "just": [1, 3, 7, 10, 28, 30, 40, 53], "common": [1, 3, 7, 8, 34, 36, 37, 38, 49, 50, 51, 55], "packag": [1, 3, 5, 7, 37, 41, 54, 55], "aw": [1, 5, 8, 25, 42, 51, 52, 55], "might": [1, 7, 10, 12, 13, 14, 29, 37, 38, 42, 44, 46, 49], "want": [1, 10, 23, 55], "need": [1, 2, 3, 5, 7, 8, 10, 13, 14, 15, 19, 21, 29, 30, 33, 36, 37, 38, 41, 42, 43, 45, 46, 49, 55], "your": [1, 4, 10, 11, 51], "origin": [1, 3, 29, 33, 37, 38], "appear": [1, 3, 5, 7, 8, 14, 16, 17, 18, 20, 21, 29, 33, 34, 42, 46, 48], "weren": 1, "setof": 1, "re": [1, 34], "declar": [1, 3, 16, 30, 33, 34, 35, 37, 48, 51], "here": [1, 3, 34, 38], "let": [1, 10, 44, 49], "too": [1, 3, 5, 33, 34, 40, 45, 55], "transform": [1, 2, 10, 11, 14, 35, 37, 44], "excludeshapesbytag": [1, 10], "excludeshapesbytrait": 1, "excludemetadata": 1, "removeunusedshap": 1, "meant": [1, 30, 31, 33, 34, 37, 42], "logic": [1, 2, 3, 14, 23, 32, 35, 37, 43, 46, 49, 51, 53], "group": [1, 3, 7, 11, 14, 30, 31, 37, 46, 49], "easier": [1, 3, 7, 8, 10, 37, 49], "add": [1, 3, 4, 5, 7, 10, 12, 15, 17, 18, 19, 20, 21, 26, 30, 31, 32, 37, 42, 43, 44, 45, 48, 49, 51, 53, 55], "x": [1, 3, 5, 11, 12, 14, 17, 18, 20, 24, 27, 28, 32, 33, 42, 43, 46, 48], "foobaz": [1, 12, 14, 37], "made": [1, 3, 7, 14, 31, 34, 37, 42, 46, 55], "10": [1, 14, 30, 34, 37, 42, 49, 51, 55], "correctli": [1, 37, 42, 46], "built": [1, 2, 3, 7, 29, 31, 35, 37, 40, 50, 51, 53, 55], "root": [1, 3, 5, 11, 15, 16, 17, 18, 19, 21, 37], "openapi": [1, 2, 6, 11], "abov": [1, 3, 7, 10, 13, 15, 19, 21, 30, 34, 37, 38, 41, 42, 47, 48, 49], "sever": [1, 7, 10, 33, 34, 35, 37, 41, 45, 47, 49], "check": [1, 4, 7, 14, 42, 49, 51, 55], "quick": [1, 9], "guid": [1, 3, 4, 5, 7, 9, 10], "tutori": [1, 10], "artifact": [2, 7, 10, 35, 37], "gener": [2, 3, 4, 6, 7, 8, 9, 10, 11, 13, 14, 15, 16, 19, 21, 24, 28, 29, 30, 31, 37, 40, 44, 46, 49], "code": [2, 4, 6, 7, 8, 9, 10, 11, 13, 15, 17, 18, 20, 21, 27, 28, 29, 30, 31, 33, 34, 37, 38, 40, 42, 44, 46, 49, 50, 51, 55], "etc": [2, 3, 7, 15, 17, 18, 20, 21, 33, 36, 37, 38, 40, 42, 46], "gradl": [2, 3, 5, 7, 10], "plugin": [2, 3, 5, 10, 55], "wrapper": [2, 29], "around": [2, 19, 30], "most": [2, 7, 12, 14, 26, 33, 42, 49], "develop": [2, 3, 5, 10, 37, 38, 46, 50, 51, 53, 55], "easili": [2, 7, 36, 37, 49, 55], "deep": 2, "knowledg": 2, "work": [2, 7, 10, 14, 34, 49, 51, 53], "tool": [2, 3, 4, 7, 10, 14, 29, 30, 31, 34, 35, 36, 37, 38, 40, 41, 44], "lightweight": [2, 53], "sourc": [2, 3, 5, 9, 11, 14, 35, 51, 53], "extens": [2, 5, 6, 15, 37], "project": [2, 3, 5, 7, 10, 35, 38], "environ": [2, 14, 26, 46, 51], "variabl": [2, 3, 35, 46, 48], "model": [3, 5, 6, 15, 16, 17, 18, 19, 20, 21, 26, 27, 30, 31, 32, 33, 34, 35, 36, 40, 41, 42, 44, 46, 47, 50, 51, 53, 55], "standard": [3, 5, 7, 13, 14, 17, 18, 20, 29, 38, 41], "rest": [3, 11, 34, 40, 52], "own": [3, 10, 14, 33, 34, 37, 38], "interfac": [3, 5, 7, 10, 13, 34, 35, 38, 40, 51, 53, 55], "languag": [3, 4, 7, 8, 9, 10, 29, 30, 34, 35, 36, 37, 38, 39, 42, 44, 46, 53], "independ": [3, 37, 53], "case": [3, 5, 7, 8, 12, 14, 15, 17, 18, 19, 20, 21, 29, 30, 31, 33, 34, 35, 36, 37, 38, 40, 44, 46, 48, 49, 50, 51, 53, 55], "both": [3, 7, 13, 14, 15, 17, 18, 19, 20, 21, 28, 29, 30, 31, 33, 34, 37, 40, 41, 42, 43, 46, 48, 49, 53], "hoc": 3, "autom": [3, 10, 14, 38], "workflow": [3, 14], "access": [3, 11, 14, 28, 30, 33, 38, 42, 43, 44], "like": [3, 7, 10, 14, 20, 29, 30, 31, 33, 34, 37, 38, 42, 44, 48, 49, 51], "swaggerui": 3, "client": [3, 4, 7, 10, 11, 15, 17, 18, 19, 20, 21, 22, 23, 25, 26, 27, 28, 30, 31, 33, 34, 35, 36, 37, 40, 41, 42, 44, 46, 48, 49, 50, 53, 55], "server": [3, 9, 10, 14, 15, 17, 18, 19, 20, 21, 29, 31, 33, 35, 37, 40, 44, 46, 48], "current": [3, 10, 15, 34, 37, 42, 49], "3": [3, 15, 17, 18, 19, 31, 32, 33, 34, 37, 42, 43, 49], "2": [3, 9, 10, 11, 14, 15, 17, 18, 19, 26, 28, 29, 32, 33, 34, 36, 37, 42, 43, 49], "veri": [3, 37, 38, 42, 43], "approach": [3, 5], "protocol": [3, 10, 11, 12, 26, 32, 33, 35, 37, 42, 43, 44, 45, 47, 51, 52, 53, 54], "agnost": [3, 37, 40, 46, 48, 51], "mean": [3, 7, 10, 13, 15, 16, 19, 30, 33, 34, 37, 38, 40, 42, 43, 44, 46, 49, 51], "focus": [3, 40], "rather": [3, 15, 19, 21, 34, 37, 40, 45, 49], "data": [3, 7, 10, 12, 16, 19, 27, 29, 30, 31, 32, 33, 34, 37, 40, 43, 46, 47, 51, 52], "sent": [3, 11, 12, 14, 15, 17, 18, 19, 25, 28, 29, 30, 33, 40, 42, 43, 46, 48, 49], "wire": [3, 4, 30, 31, 40, 46, 49, 53], "rpc": [3, 37], "pub": 3, "sub": [3, 37, 42], "strength": 3, "weak": 3, "much": [3, 7, 33, 37], "broader": 3, "behavior": [3, 4, 13, 15, 19, 20, 21, 27, 33, 35, 38, 41, 42, 45, 46, 47, 48, 49, 55], "underli": 3, "complex": [3, 5, 13, 34, 42, 44, 48, 49], "permiss": [3, 5, 11, 14, 16], "adapt": 3, "web": [3, 52], "poor": 3, "experi": [3, 37], "strongli": [3, 30, 49], "lossi": 3, "variou": [3, 4, 10, 14, 32, 33, 34, 37, 39, 49], "endpoint": [3, 11, 15, 17, 18, 19, 20, 21, 25, 27, 33, 35, 46, 47, 50, 51, 52, 53], "hostlabel": [3, 15, 17, 18, 19, 20, 21, 35, 46, 47], "dynam": [3, 33, 46], "alter": [3, 29], "input": [3, 4, 7, 10, 11, 12, 13, 14, 15, 17, 18, 19, 20, 21, 26, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 41, 42, 43, 46, 47, 48, 49, 51, 53, 55], "http": [3, 5, 9, 10, 11, 12, 13, 15, 16, 17, 18, 26, 27, 28, 29, 31, 32, 35, 37, 40, 42, 43, 44, 45, 47, 48, 50, 51, 53, 54], "prefix": [3, 7, 11, 14, 20, 21, 32, 33, 34, 45, 46], "header": [3, 11, 12, 14, 15, 17, 18, 19, 20, 21, 24, 28, 29, 32, 35, 42, 43, 46, 48, 50, 54], "bind": [3, 10, 15, 17, 18, 19, 26, 27, 28, 32, 34, 35, 36, 40, 42, 43, 46, 47, 50, 54], "under": [3, 4, 7, 46], "thing": [3, 10, 29, 31, 33, 36, 37, 49], "s3": [3, 14, 24, 27, 49], "amz": [3, 12, 14, 17, 18, 24, 33], "greedi": 3, "label": [3, 14, 15, 17, 18, 19, 20, 21, 35, 42], "uri": [3, 11, 13, 14, 15, 19, 20, 21, 23, 26, 32, 35, 41, 43, 45, 46], "act": [3, 48], "multipl": [3, 7, 10, 15, 19, 21, 26, 29, 33, 34, 35, 37, 38, 43, 46, 48], "segment": [3, 14, 15, 19, 33, 37], "vendor": [3, 11, 46], "pass": [3, 11, 14, 29, 42, 51, 53], "forbidden": [3, 7], "forbidgreedylabel": 3, "flag": [3, 4, 7, 32, 37, 42], "rout": [3, 14, 33, 51, 53], "aren": 3, "method": [3, 5, 10, 11, 13, 14, 17, 18, 20, 26, 32, 35, 37, 43, 46, 51, 53], "uniqu": [3, 13, 14, 15, 17, 18, 19, 20, 21, 28, 29, 30, 33, 36, 37, 49], "send": [3, 12, 14, 15, 17, 18, 19, 20, 21, 29, 32, 33, 40, 42, 43, 48, 49], "mqtt": [3, 43, 47], "arn": [3, 11, 12, 13, 16, 27, 47, 51], "nativ": [3, 11, 49], "nor": [3, 55], "compat": [3, 4, 7, 14, 30, 31, 33, 34, 35, 37, 42, 43, 46, 50, 55], "stream": [3, 7, 12, 14, 17, 18, 19, 20, 21, 29, 35, 42, 47, 48, 49], "blob": [3, 10, 11, 14, 15, 17, 18, 19, 20, 21, 29, 30, 33, 34, 35, 36, 37, 39, 40, 42, 45, 49], "memori": [3, 37, 43], "isn": [3, 10, 33], "technic": [3, 35], "larg": [3, 10, 12, 29, 37, 43], "payload": [3, 11, 14, 17, 18, 20, 21, 27, 29, 33, 40, 43, 46, 48, 50], "carri": 3, "fromsmithi": [3, 5], "openapiextens": 3, "show": [3, 5, 7, 11, 16, 17, 18, 26], "below": [3, 13, 14, 26, 29, 30, 42], "restjson1": [3, 11, 12, 27, 42, 47, 51, 55], "actual": [3, 4, 5, 7, 11, 14, 15, 31, 34, 36, 38, 42, 48], "process": [3, 5, 10, 14, 15, 19, 29, 31, 34, 37, 43, 46, 49, 50, 53, 55], "weather": [3, 11, 37, 55], "correct": [3, 5, 15, 18, 19, 20, 21, 30, 46, 49], "librari": [3, 4, 5, 29, 53, 54], "highli": [3, 5, 33], "typic": [3, 5, 7, 10, 14, 29, 37, 54], "affect": [3, 4, 5, 15, 17, 18, 19, 20, 21, 31, 32, 37, 49], "openapiprotocol": 3, "regist": [3, 5, 7, 13], "coreextens": 3, "supportedtag": 3, "limit": [3, 5, 7, 8, 14, 19, 29, 33, 37, 46, 48, 49], "defaultblobformat": 3, "format": [3, 6, 11, 12, 15, 17, 18, 19, 20, 21, 27, 29, 30, 31, 33, 34, 36, 37, 40, 43, 48, 55], "byte": [3, 10, 15, 17, 18, 19, 20, 21, 29, 30, 33, 34, 36, 37, 39, 40, 42, 43, 44, 45, 48, 49, 53], "base64": [3, 11, 15, 17, 18, 19, 20, 21, 33, 37, 45, 46, 49, 54], "encod": [3, 10, 11, 14, 15, 16, 17, 18, 19, 20, 21, 29, 33, 34, 37, 45, 46, 49, 54], "externaldoc": [3, 5], "field": [3, 5, 11, 14, 15, 17, 18, 19, 20, 21, 29, 33, 43, 46, 48, 49], "prioriti": [3, 5, 14, 17, 18, 20, 21, 28, 29], "externaldocument": [3, 5, 16, 35, 42, 47], "insensit": [3, 5, 7, 14, 29, 33, 35, 36, 37, 38, 49], "homepag": [3, 31, 42], "keepunusedcompon": 3, "unus": 3, "compon": [3, 5, 13, 14, 15, 17, 18, 19, 20, 33, 37, 48, 54], "jsoncontenttyp": 3, "media": [3, 11, 40, 46], "associ": [3, 7, 15, 19, 21, 37, 43, 46, 48, 49, 50, 53, 55], "applic": [3, 11, 13, 14, 15, 17, 18, 19, 20, 21, 22, 31, 34, 37, 40, 43, 46, 53], "forbid": [3, 7], "removegreedyparametersuffix": 3, "suffix": [3, 14, 15, 19, 33], "instead": [3, 5, 7, 8, 19, 20, 21, 33, 37, 46, 49, 50, 51, 53, 55], "onhttpprefixhead": 3, "httpprefixhead": [3, 14, 20, 21, 35, 47], "ignoreunsupportedtrait": 3, "entireti": 3, "arrai": [3, 17, 18, 20, 34, 37, 38, 42, 49], "replace_m": 3, "another_replac": 3, "hello": [3, 5, 15, 19, 30, 34, 37, 38, 45, 46], "prefer": [3, 17, 18, 19, 20, 21, 40, 42], "jsonadd": [3, 5], "perform": [3, 5, 11, 14, 16, 26, 30, 32, 33, 34, 37, 42, 46, 49, 51, 53], "explicit": [3, 5, 13, 14, 16, 28, 41, 43, 46, 49], "resili": 3, "node": [3, 5, 7, 15, 19, 21, 26, 35, 38, 46, 51, 53], "pointer": [3, 5, 37, 55], "rfc": [3, 5, 15, 16, 17, 18, 19, 28, 29, 32, 33, 34, 35, 37, 40, 41, 45, 48], "6901": [3, 5, 37], "similar": [3, 5, 14, 37, 39, 42, 44, 51], "semant": [3, 5, 7, 10, 31, 34, 35, 40, 41, 42, 45, 48], "patch": [3, 5, 33], "6902": [3, 5], "except": [3, 5, 11, 14, 31, 33, 34, 37, 42, 44, 49, 50, 55], "undefin": [3, 5, 15, 19, 21, 33, 55], "nest": [3, 5, 10, 15, 19, 21, 30, 34, 37, 38, 42, 45], "info": [3, 5], "titl": [3, 5, 14, 35, 47], "intermedi": [3, 5, 42, 49], "useintegertyp": 3, "integ": [3, 7, 8, 10, 11, 13, 15, 16, 17, 18, 19, 20, 21, 29, 30, 33, 34, 36, 37, 38, 39, 42, 43, 44, 45, 46, 48, 49], "short": [3, 7, 10, 15, 17, 18, 19, 20, 21, 29, 30, 31, 33, 34, 36, 37, 39, 42, 43, 44, 45, 48, 49, 50, 55], "recommend": [3, 7, 14, 30, 35, 37, 44, 45, 47, 54], "alphanumericonlyref": 3, "strip": [3, 14], "alphanumer": [3, 14, 33, 49], "charact": [3, 7, 8, 14, 17, 18, 20, 31, 32, 35, 38, 42, 46, 48, 49], "apigatewai": [3, 14, 27, 47, 51, 54], "apigatewaytyp": 3, "usejsonnam": 3, "jsonnam": [3, 20, 35, 47, 49], "defaulttimestampformat": [3, 5], "timestampformat": [3, 5, 15, 17, 18, 19, 20, 21, 33, 35, 47], "timestamp": [3, 5, 7, 10, 13, 15, 17, 18, 19, 20, 21, 30, 33, 34, 36, 37, 39, 40, 42, 43, 45, 46, 48, 49], "expect": [3, 5, 15, 17, 18, 19, 20, 21, 25, 26, 28, 29, 33, 42, 43, 46, 48, 49, 50, 51], "date": [3, 5, 7, 15, 16, 19, 21, 29, 31, 33, 37, 40, 45, 48], "epoch": [3, 5, 17, 18, 20, 37, 40, 49], "second": [3, 5, 11, 17, 18, 20, 33, 37, 40, 42, 48, 49], "unionstrategi": 3, "oneof": 3, "mapstrategi": 3, "propertynam": [3, 5], "additionalproperti": 3, "patternproperti": 3, "indic": [3, 7, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 26, 28, 29, 30, 31, 37, 38, 40, 41, 43, 44, 46, 48, 49, 50], "schemadocumentextens": [3, 5], "overwritten": [3, 5], "disablefeatur": [3, 5], "supportnonnumericfloat": 3, "nan": [3, 15, 17, 18, 19, 20, 21, 37], "infin": [3, 15, 17, 18, 19, 20, 21, 37], "float": [3, 7, 10, 16, 27, 30, 33, 34, 36, 37, 39, 42, 43, 44, 45, 49], "doubl": [3, 7, 10, 27, 30, 33, 34, 36, 37, 39, 42, 44, 45, 49], "numer": [3, 16, 27, 30, 34, 35, 46, 48, 49], "floatmemb": 3, "With": [3, 37, 42], "authent": [3, 11, 27, 33, 35, 46, 47, 53], "attach": [3, 10, 11, 29, 30, 36, 37, 42, 46, 49], "smithy2openapiextens": 3, "securityschemeconvert": 3, "auth": [3, 11, 14, 27, 35, 42, 47, 51], "sigv4": [3, 11, 27, 47], "httpapikeyauth": [3, 35, 42, 47], "httpbasicauth": [3, 35, 42, 47], "httpbearerauth": [3, 35, 42, 47], "httpdigestauth": [3, 35, 42, 47], "2006": [3, 10, 26, 31], "03": [3, 10, 11, 12, 14, 26, 31], "01": [3, 10, 26, 28, 31, 45], "exampleoper": [3, 48, 55], "operationid": 3, "respons": [3, 4, 17, 18, 20, 26, 27, 29, 30, 33, 37, 48, 49, 50, 51, 53, 54], "200": [3, 11, 13, 19, 33, 46], "securityschem": 3, "apikei": [3, 28], "In": [3, 5, 10, 11, 14, 15, 17, 18, 19, 21, 29, 30, 33, 34, 37, 40, 42, 43, 44, 46, 48, 50, 53, 55], "error": [3, 4, 5, 7, 10, 11, 13, 14, 27, 29, 30, 31, 33, 34, 35, 36, 37, 38, 41, 42, 47, 48, 49, 51, 52, 53, 55], "togeth": [3, 7, 10, 26, 34, 36, 37, 42, 48], "unit": [3, 4, 35, 39, 42, 46, 48, 53], "foooper": [3, 16], "doc": [3, 26, 34, 42], "1234": [3, 34], "5678": 3, "howev": [3, 4, 12, 14, 15, 17, 18, 19, 20, 21, 31, 33, 37, 40, 41, 42, 43, 45, 55], "scatter": 3, "throughout": [3, 11], "requestbodi": 3, "foooperation_example1": 3, "summari": [3, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 26, 28, 29, 30, 31, 32, 33, 38, 40, 41, 43, 44, 45, 46, 48, 49], "pick": [3, 14, 17, 18, 20, 21], "modif": [3, 4, 11], "disablecloudformationsubstitut": 3, "templat": [3, 27, 32], "intrins": 3, "additionalallowedcorshead": 3, "preflight": [3, 33], "sdk": [3, 9, 27, 50, 51, 53, 54, 55], "invoc": [3, 11, 29, 53], "those": [3, 7, 14, 15, 16, 17, 18, 19, 20, 21, 30, 33, 37, 42, 46], "mediatyp": [3, 20, 21, 33, 35, 37, 46, 47, 50], "httppayload": [3, 14, 20, 21, 29, 35, 43, 47], "forward": [3, 4, 33, 34, 35, 36, 37], "opt": [3, 11, 14], "requestvalid": [3, 27, 47], "popul": [3, 5, 20, 23, 33], "It": [3, 4, 7, 10, 11, 14, 29, 34, 36, 37, 42, 43, 44, 46, 50, 53], "full": [3, 11, 13, 14, 15, 17, 18, 19, 20, 21, 49], "validaterequestbodi": 3, "validaterequestparamet": 3, "param": [3, 11, 46], "fals": [3, 7, 10, 14, 15, 19, 21, 29, 30, 33, 34, 37, 42, 45, 48, 49], "bodi": [3, 11, 14, 15, 19, 20, 21, 26, 27, 29, 33, 46, 54], "gather": 3, "util": [3, 5, 7, 8, 13, 20, 29, 37, 46, 48], "backend": [3, 11], "mockintegr": [3, 27, 47], "mock": [3, 11], "inherit": [3, 11, 14, 16, 28, 29, 34, 42], "child": [3, 10, 15, 21, 36, 37, 42], "overrid": [3, 5, 7, 13, 28, 29, 40, 42], "dure": [3, 13, 19, 29, 37, 46, 50], "control": [3, 5, 8, 14, 29, 30, 32, 33, 35, 46, 48, 53], "expos": [3, 11, 20, 26, 29, 31, 33, 37, 43, 49], "credenti": [3, 11, 12, 33], "appropri": [3, 11, 14, 20, 21, 29, 35, 38, 41, 44, 49, 53], "static": [3, 7, 11, 14, 17, 18, 23, 48], "lambda": [3, 11, 14, 51, 52], "first": [3, 5, 7, 10, 14, 15, 17, 18, 20, 21, 29, 33, 34, 37, 41, 42, 43, 48, 49, 53], "2019": [3, 14, 29, 42], "06": [3, 29], "17": [3, 11, 12, 14, 49], "operationa": [3, 16, 28, 42], "operationb": [3, 16, 28, 42], "resourcea": [3, 37], "resourceb": [3, 37], "operationc": [3, 28, 42], "operationd": [3, 28, 42], "operation": 3, "operationf": 3, "d": [3, 11, 34, 48], "e": [3, 7, 8, 14, 29, 31, 33, 34, 36, 37, 41, 44, 48], "f": [3, 34], "signatur": [3, 27, 29], "4": [3, 27, 29, 34, 37, 41, 48, 49], "authorizeruri": 3, "authtyp": [3, 11], "awssigv4": [3, 11], "commonli": [3, 7, 51], "deploi": [3, 5, 13, 33, 51], "region": [3, 11, 12, 14, 16, 26], "until": [3, 14, 37, 42, 49], "deploy": 3, "offer": 3, "abil": [3, 13, 30, 48, 50], "treat": [3, 11, 15, 17, 18, 19, 20, 21, 30, 33, 34, 37, 42], "well": [3, 7, 10, 11, 13, 16, 30, 33, 37, 46, 51, 53, 54, 55], "known": [3, 11, 17, 18, 20, 40, 42, 43, 50, 53], "fn": 3, "stack": 3, "wrap": [3, 15, 19, 21, 26, 34, 38, 44], "providerarn": [3, 12], "authorizercredenti": 3, "connectionid": [3, 11], "cognitouserpool": [3, 27, 47], "cognito_user_pool": [3, 11], "idp": [3, 12], "u": [3, 8, 11, 12, 14, 26, 34], "east": [3, 11, 12, 14], "123": [3, 12, 34, 40], "userpool": [3, 12], "api_kei": 3, "apikeysourc": [3, 27, 47], "caller": [3, 11, 49, 50], "identifi": [3, 5, 7, 10, 11, 13, 15, 16, 19, 21, 27, 29, 34, 35, 36, 38, 41, 42, 43, 46], "throttl": [3, 11, 29, 43, 44, 49], "advanc": [3, 5, 7, 42, 55], "ll": [3, 5, 10], "next": [3, 5, 29, 42, 53], "openapiconvert": 3, "openapiconfig": 3, "setservic": [3, 5], "mymodel": [3, 5], "javadoc": [3, 5], "break": [4, 34, 55], "page": [4, 14, 29], "backward": [4, 7, 14, 19, 31, 33, 35, 37, 42, 43, 50, 55], "best": [4, 10, 14, 37, 38, 51], "alreadi": [4, 41, 49], "condit": [4, 27, 30, 41, 48, 55], "previous": [4, 14, 29, 42], "releas": [4, 14, 34, 38], "later": [4, 29, 37, 42], "represent": [4, 10, 29, 36, 37, 38, 40, 42, 48], "upon": 4, "state": [4, 10, 19, 37, 42, 48], "binari": [4, 10, 11, 16, 33, 37, 43, 45, 46], "futur": [4, 7, 10, 29, 31, 33, 37, 49], "better": [4, 7, 8, 10, 37], "open": [4, 32, 33, 34, 35, 37, 40, 48, 53], "anticip": 4, "account": [4, 14, 23], "receiv": [4, 11, 14, 19, 21, 29, 37, 43, 46, 48, 50, 53], "runtim": [4, 11, 14, 30, 33, 41, 46, 48, 51], "incompat": [4, 29, 33, 37, 54], "influenc": [4, 6, 8, 15, 19, 21, 29, 30, 33, 34, 37, 40, 43, 44, 45, 46], "program": [4, 7, 10, 29, 30, 37, 38, 46, 53], "relax": 4, "selector": [4, 7, 8, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 26, 28, 29, 30, 31, 32, 33, 35, 37, 38, 40, 41, 43, 44, 45, 46, 47, 48, 49], "structurallyexclus": [4, 37], "compar": [4, 7, 35, 37, 46, 49], "issu": [4, 7, 10, 15, 18, 19, 20, 21, 29, 37, 49], "cli": [4, 14], "duplic": [5, 29, 37, 39, 49], "effort": [5, 13, 14], "lower": [5, 7, 13, 14, 30, 33, 37, 49], "sync": [5, 14], "reduc": [5, 13, 14], "potenti": [5, 7, 13, 30, 34, 37, 49], "translat": [5, 11, 13], "depict": [5, 13], "command": [5, 13, 14], "entiti": [5, 10, 15, 19, 21, 37], "ident": [5, 7, 10, 11, 14, 15, 17, 18, 19, 20, 21, 29, 32, 33, 37, 46, 51], "restrict": [5, 16, 30, 35, 37, 55], "mutabl": [5, 27], "bound": [5, 10, 13, 14, 16, 20, 21, 23, 28, 29, 30, 31, 33, 36, 37, 38, 41, 42, 43], "queue": [5, 11, 14], "organizationnam": 5, "cloudformationnam": [5, 27], "typenam": 5, "queueservic": 5, "sdkid": [5, 12, 16, 27], "2020": [5, 15, 16, 17, 18, 19, 20, 21, 28, 34, 42, 45], "07": [5, 15, 16, 19, 34], "02": [5, 15, 16, 17, 18, 19, 20, 21, 28, 36, 37, 40], "otherwis": [5, 11, 15, 17, 18, 19, 20, 21, 29, 32, 33, 35, 44], "servicenam": 5, "documentationurl": 5, "url": [5, 11, 15, 16, 17, 18, 19, 31, 33], "user": [5, 11, 12, 13, 14, 16, 29, 31, 32, 33, 38, 40, 43, 49, 51, 55], "sourcedoc": 5, "sourceurl": 5, "disablehandlerpermissiongener": 5, "handler": [5, 50, 52, 53, 54, 55], "lifecycl": [5, 13, 35, 36, 38, 41, 42], "iam": [5, 11, 14, 27, 47, 51], "requiredact": [5, 27, 47], "section": [5, 8, 14, 17, 18, 29, 32, 33, 35, 37, 40, 41, 48, 49], "provis": 5, "action": [5, 15, 16, 19, 26, 37, 49], "align": [5, 8, 37], "invok": [5, 10, 11, 16, 28, 31, 36, 49, 53, 55], "relat": [5, 11, 14, 16, 37, 41], "themselv": [5, 42], "getdependencycompon": 5, "createqueu": 5, "read": [5, 8, 10, 13, 29, 34, 36, 38, 41, 42, 53, 54], "getqueu": 5, "updatequeu": 5, "delet": [5, 10, 29, 33, 36, 38, 41, 42, 49], "deletequeu": 5, "listqueu": 5, "disabledeprecatedpropertygener": 5, "deprecatedproperti": 5, "disablerequiredpropertygener": 5, "disablecapitalizedproperti": 5, "capit": [5, 7, 15, 37], "cfnname": [5, 27, 47], "accord": [5, 15, 19, 30, 33, 48, 50], "creation": [5, 13, 14, 37], "smithy2cfnextens": 5, "cloudformationconvert": 5, "cfnconfig": 5, "cfnconvert": 5, "resourceschema": 5, "setorganizationnam": 5, "convers": [5, 6, 7, 11, 49, 53], "build": [6, 7, 13, 14, 29, 35, 37, 41, 42, 51, 55], "overview": [6, 27, 35], "linter": 6, "lint": 6, "evolv": [6, 29, 37, 48, 55], "evolut": 6, "box": [6, 17, 18, 20, 35, 37, 39, 47], "spars": [6, 30, 33, 35, 37, 47], "diff": [6, 8, 37, 48], "style": [6, 7, 14, 26, 29, 34, 37], "introduct": [6, 35, 52], "between": [6, 11, 14, 27, 29, 32, 33, 34, 37, 41, 42, 43, 46, 48, 49, 50, 51, 54], "schema": [6, 13, 37, 40], "secur": [6, 14, 28], "scheme": [6, 11, 12, 28, 32, 33, 34, 46], "gatewai": [6, 14, 24, 27, 47, 51, 52, 53], "cloudform": [6, 14, 27, 47], "special": [7, 10, 15, 17, 18, 19, 20, 21, 28, 30, 31, 34, 36, 37, 38, 40, 44], "maven": 7, "central": 7, "repres": [7, 8, 10, 14, 17, 18, 20, 29, 30, 31, 33, 34, 37, 39, 43, 44, 46, 48, 49, 50], "abbrevi": [7, 14, 37], "uppercas": [7, 8], "letter": [7, 8, 14, 15, 30, 37], "xmlrequest": [7, 8], "instanceid": [7, 49], "rational": [7, 38], "strict": [7, 8, 37], "word": [7, 8, 14, 35, 42], "predict": [7, 25, 37], "python": [7, 37], "wish": [7, 14, 31, 42, 50], "snake_cas": 7, "camel": [7, 8], "split": [7, 34, 37, 47], "apart": 7, "danger": [7, 34, 37, 38, 49], "allowedabbrevi": 7, "adher": [7, 8, 16, 29, 33, 34, 36, 37, 38, 42, 44, 45, 48, 49], "consist": [7, 8, 10, 30, 32, 33, 34, 37, 38, 48, 49], "uppercamelcas": [7, 8, 49], "lowercamelcas": [7, 8], "understand": [7, 10, 17, 18, 20, 21, 26, 28, 37, 40, 41, 49, 53], "lead": [7, 14, 30, 33, 34, 49], "membernam": [7, 37], "upper": [7, 30, 49], "text": [7, 11, 14, 15, 19, 20, 21, 29, 31, 35, 37, 46, 48], "perpetu": 7, "cultur": 7, "bias": 7, "bia": 7, "term": 7, "suggest": 7, "altern": 7, "noninclus": 7, "substr": [7, 11], "trail": [7, 14, 30, 33], "whitespac": [7, 14, 34, 42], "append": [7, 14, 15, 19, 29, 42, 46], "occur": [7, 8, 29, 37, 38, 42, 50], "messag": [7, 10, 15, 19, 21, 30, 31, 35, 37, 40, 44, 46, 48, 50, 55], "intent": [7, 37, 42, 49], "impact": [7, 19, 37, 38], "whitelist": 7, "blacklist": 7, "past": 7, "denial": [7, 30], "skin": 7, "color": [7, 33], "inclus": [7, 10, 29, 30, 37, 49], "clearli": [7, 42], "commun": [7, 38, 40], "allowlist": 7, "denylist": 7, "someth": [7, 33, 37, 38, 44, 49], "keyword": [7, 10, 34], "unless": [7, 14, 15, 16, 17, 18, 19, 20, 21, 28, 33, 35, 37, 40, 49, 55], "excludedefault": 7, "mankind": 7, "humankind": 7, "mailman": 7, "mail": 7, "carrier": 7, "postal": 7, "worker": 7, "reserv": [7, 33, 38, 48], "manner": 7, "evalu": [7, 16, 29, 30, 32, 33, 42, 46, 55], "detail": [7, 11, 14, 17, 18, 23, 29, 33, 37, 48, 50, 51, 53], "symbol": [7, 30, 34, 37], "safe": [7, 15, 19, 21, 29, 30, 37, 43, 45, 51], "Its": 7, "displai": 7, "why": [7, 31, 37], "fooreservedword": 7, "codenam": 7, "tabl": [7, 14, 16, 17, 18, 20, 21, 26, 30, 37, 41, 42, 45, 47, 48, 49], "createcodenameinput": 7, "codenameresourc": 7, "referencedcodenam": 7, "verb": 7, "properli": [7, 26, 46, 51], "function": [7, 11, 14, 29, 33, 35, 37, 40, 43, 49, 51, 54, 55], "help": [7, 10, 29, 30, 34, 38, 46, 49], "consum": [7, 29, 30, 31, 37, 43], "come": [7, 34, 37, 48], "famili": 7, "g": [7, 8, 14, 29, 33, 36, 37, 41, 44, 48], "batch": [7, 14], "honor": [7, 45], "suggestaltern": 7, "At": [7, 30, 33, 55], "deregist": 7, "transit": [7, 10, 30, 37, 49], "repeat": [7, 37, 45, 46], "As": [7, 15, 18, 19, 20, 21, 29, 31, 33, 41, 43, 46, 51], "tablenam": [7, 41], "redund": 7, "exactmatch": 7, "dedic": [7, 37], "problem": [7, 42, 49, 50], "diverg": 7, "exclus": [7, 33, 37, 43], "ever": [7, 37], "unnecessarili": 7, "ty": 7, "pagin": [7, 10, 35, 37, 47], "unbound": [7, 29], "sla": 7, "verbsrequirepagin": 7, "verbssuggestpagin": 7, "inputmembersrequirepagin": 7, "maxresult": [7, 29, 34, 37], "pages": [7, 10, 29], "nexttoken": [7, 10, 29, 37], "pagetoken": 7, "token": [7, 11, 14, 34, 35, 42], "outputmembersrequirepagin": 7, "marker": 7, "nextpag": 7, "begin": [7, 14, 33, 34], "exact": [7, 10, 33, 37, 40, 41, 48], "purpos": [7, 14, 37, 49, 50, 53, 55], "underscor": [7, 30], "mix": 7, "foobar": 7, "foo_bar": 7, "idiomat": [7, 29, 37, 44], "additionalpattern": 7, "regular": [7, 11, 16, 30], "express": [7, 11, 13, 16, 30, 40, 42, 46, 53], "involv": [7, 14], "extend": [7, 29, 37, 55], "abstractvalid": 7, "validationev": 7, "mypackag": 7, "collector": 7, "documentationtrait": 7, "documentationvalid": 7, "hastrait": 7, "tolist": 7, "validatorservic": 7, "nodemapp": 7, "forbiddendocumentationvalid": 7, "forbiddendocument": 7, "final": [7, 10, 14, 49, 53], "getforbid": 7, "void": [7, 37, 39], "setforbid": 7, "super": [7, 16, 38], "deseri": [7, 17, 18, 19, 33, 35, 37, 40, 46, 50, 51, 53], "pojo": 7, "mapper": 7, "constructor": [7, 51], "violat": [7, 33, 38, 42, 49, 55], "flatmap": [7, 45], "validateshap": 7, "orelseget": 7, "grab": 7, "expecttrait": 7, "docstr": 7, "getvalu": 7, "point": [7, 10, 29, 33, 34, 37, 38, 42, 51, 55], "meow": 7, "emiteachselector": [7, 35, 42], "pretti": [7, 38], "far": 7, "smithi": [8, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 28, 29, 30, 31, 32, 33, 36, 38, 39, 40, 41, 42, 43, 44, 45, 46], "idl": [8, 10, 35, 36, 37, 39, 43, 46, 47], "resembl": 8, "length": [8, 15, 17, 18, 19, 29, 33, 34, 35, 37, 38, 42, 43, 46, 47, 48, 49, 51, 55], "min": [8, 30, 34, 37, 42], "max": [8, 30, 33, 34, 37, 42], "1000": [8, 14, 34], "myshap": [8, 30, 36, 37, 42], "anothershap": 8, "mystructur": [8, 14, 15, 19, 30, 31, 34, 35, 36, 37, 40, 45], "mytrait": [8, 34], "utf": [8, 10, 11, 15, 19, 21, 34, 37, 45, 48], "8": [8, 10, 11, 15, 19, 21, 29, 34, 37, 45, 48, 49], "feed": [8, 34], "000a": [8, 34], "licens": 8, "copyright": 8, "exactli": [8, 30, 34, 37, 42, 46, 48, 49], "blank": [8, 34], "four": [8, 34], "space": [8, 14, 29, 38], "colon": [8, 14, 42], "horizont": [8, 34], "nois": 8, "fooid": [8, 13], "convent": [8, 14, 37, 46, 47, 48], "normal": [8, 14, 17, 18, 20, 34, 37, 40], "xmlhttprequest": 8, "camelcas": 8, "lowercas": [8, 14, 30, 37], "dot": [8, 29, 33], "dynamodb": [8, 11, 14, 41], "view": 9, "io": 9, "typescript": 9, "introduc": [10, 37, 49], "learn": [10, 14, 24, 27], "test": [10, 11, 13, 14, 16, 27, 29, 30, 32, 33, 34, 35, 37, 38, 40, 41, 43, 44, 45, 47, 48, 49], "uninterpret": [10, 37], "bit": [10, 37], "rang": [10, 29, 34, 35, 37, 38, 42, 47], "128": [10, 37], "127": [10, 37], "16": [10, 37], "32": [10, 37], "768": [10, 37], "767": [10, 37], "31": [10, 11, 37], "64": [10, 16, 37], "63": [10, 14, 37], "precis": [10, 37, 40, 49], "ieee": [10, 15, 17, 18, 19, 20, 21, 37], "754": [10, 15, 17, 18, 19, 20, 21, 37], "biginteg": [10, 15, 17, 18, 19, 20, 21, 30, 33, 34, 36, 37, 39, 42, 45, 49], "arbitrarili": [10, 37], "bigdecim": [10, 15, 17, 18, 19, 20, 21, 30, 33, 34, 36, 37, 39, 42, 45, 49], "decim": [10, 37, 49], "instant": [10, 30, 37], "utc": [10, 37, 40], "offset": [10, 37, 40], "timezon": [10, 37], "untyp": [10, 34], "homogen": [10, 37], "fix": [10, 29, 30, 37, 40], "heterogen": [10, 34, 37], "demonstr": [10, 46], "we": 10, "citi": 10, "forecast": [10, 37, 41], "mani": [10, 14, 15, 17, 18, 19, 20, 21, 23, 29, 33, 34, 37, 46], "singleton": 10, "listciti": 10, "getciti": 10, "getforecast": [10, 37, 55], "getcurrenttim": 10, "tripl": 10, "slash": [10, 14, 33, 34], "ast": [10, 34, 35, 37, 47], "cityid": 10, "parent": [10, 11, 14, 37], "per": [10, 14, 29, 33, 34, 37], "put": [10, 13, 14, 33, 36, 41, 42], "canon": [10, 12, 37], "readonli": [10, 13, 31, 32, 33, 35, 37, 41, 47], "getcityinput": 10, "getcityoutput": 10, "nosuchresourc": [10, 41], "coordin": [10, 40], "citycoordin": 10, "latitud": 10, "longitud": 10, "resourcetyp": 10, "And": [10, 33, 35], "getforecastinput": [10, 37], "getforecastoutput": [10, 37], "chanceofrain": [10, 37], "side": [10, 15, 17, 18, 19, 20, 21, 29, 42, 49, 50, 53], "inputtoken": [10, 29], "outputtoken": [10, 29], "truncat": [10, 15, 17, 18, 19, 20, 21, 29, 37, 40], "item": [10, 19, 29, 30, 37, 42, 45], "listcitiesinput": 10, "listcitiesoutput": 10, "citysummari": 10, "subsequ": [10, 29, 38, 42], "retriev": [10, 14, 17, 18, 20, 29, 36, 37, 38, 42], "usual": [10, 11, 23], "good": [10, 49, 55], "idea": [10, 49, 55], "grow": 10, "unpredict": [10, 29], "size": [10, 12, 15, 17, 18, 19, 20, 21, 29, 30, 33, 43], "give": [10, 14, 37, 46, 49], "relationship": [10, 33, 35, 36, 37, 41], "link": [10, 14, 31, 41], "dry": 10, "fit": [10, 37, 40], "design": [10, 14, 29, 33, 38, 40, 41], "getcurrenttimeinput": 10, "getcurrenttimeoutput": 10, "now": 10, "Then": [10, 11, 37], "uncom": 10, "task": [10, 49], "sure": 10, "That": [10, 30, 33, 49], "try": 10, "plenti": 10, "explor": 10, "teach": 10, "everyth": 10, "know": [10, 29, 43, 44, 49], "sampl": [10, 15, 19], "three": [10, 34, 37, 42, 46, 51], "laid": 10, "request": [11, 12, 13, 17, 18, 20, 21, 22, 23, 25, 26, 27, 32, 33, 35, 37, 42, 48, 49, 50, 51, 53, 54], "usageidentifierkei": 11, "formerli": 11, "usag": [11, 14], "plan": 11, "2018": [11, 12, 14, 42, 51, 55], "beyond": [11, 37], "customauthtyp": 11, "embed": 11, "uniform": 11, "west": [11, 14, 26], "2015": 11, "account_id": [11, 12], "lambda_function_nam": 11, "service_api": 11, "host": [11, 14, 19, 24, 32, 33, 46], "remain": [11, 34, 49], "initi": [11, 12, 14, 19, 29, 35, 37, 48], "functionarn": 11, "role": [11, 14], "identitysourc": 11, "hold": [11, 15], "submit": 11, "cach": [11, 33, 42], "querystr": 11, "deriv": [11, 13, 14, 27, 32], "verifi": [11, 42], "null": [11, 15, 17, 18, 19, 20, 21, 30, 32, 34, 37, 44, 46, 49], "401": 11, "unauthor": 11, "identityvalidationexpress": 11, "incom": [11, 51, 53, 54], "aud": 11, "resultttlinsecond": 11, "ttl": 11, "equal": [11, 29, 34, 35, 37, 42, 49], "greater": [11, 29, 34, 42, 49], "300": [11, 49], "maximum": [11, 19, 29, 30, 33, 49], "3600": 11, "hour": [11, 29, 49], "z": [11, 14, 30, 42, 48, 49], "100": [11, 33, 34, 37], "hierarch": [11, 14, 48], "depth": 11, "http_proxi": 11, "aws_proxi": 11, "notif": [11, 14], "httpmethod": 11, "post": [11, 13, 15, 17, 18, 19, 33, 43, 46], "unspecifi": 11, "manual": [11, 29], "grant": [11, 16], "polici": [11, 14, 16], "passthroughbehavior": 11, "unmap": 11, "when_no_templ": 11, "when_no_match": 11, "handl": [11, 14, 17, 18, 20, 21, 26, 31, 37, 48, 51, 52, 53, 54], "timeoutinmilli": 11, "timeout": 11, "50": [11, 33, 37, 40], "m": 11, "29": [11, 28, 40], "000": 11, "vpclink": 11, "connectiontyp": 11, "network": [11, 29, 54], "internet": [11, 50], "routabl": 11, "vpc_link": 11, "balanc": [11, 14, 29, 49], "vpc": 11, "cachenamespac": 11, "payloadformatvers": 11, "proxi": [11, 19, 33], "cachekeyparamet": 11, "whose": [11, 14, 32, 48], "desir": [11, 34, 42, 49], "012345678901": 11, "helloworld": 11, "exec": 11, "stage": 11, "xml": [11, 26, 27, 35, 40, 47], "statuscod": 11, "responseparamet": 11, "requestid": [11, 15, 19, 21], "cid": 11, "responsetempl": 11, "302": 11, "redirect": 11, "400": [11, 19, 20, 21, 33, 40, 46, 55], "myoper": [11, 16, 31, 33, 36, 37, 46], "convert_to_text": 11, "convert_to_binari": 11, "decod": [11, 29, 33, 46, 54], "predefin": [11, 44], "userid": [11, 37], "op": 11, "respect": [11, 16, 19, 49], "statu": [11, 20, 21, 27, 31, 32, 33, 40, 44, 46, 49, 50], "select": [11, 14, 42, 49], "regex": [11, 14, 30, 46], "errormessag": [11, 30, 42, 46], "failur": [11, 30, 46, 50, 55], "throw": [11, 29, 50, 51, 53], "integrationrespons": 11, "2xx": 11, "suppli": [11, 14, 37, 38, 51, 53, 55], "scope": [12, 14, 35, 37, 45], "arnnamespac": [12, 16, 27], "comput": [12, 13, 14, 16, 23, 34, 42, 49], "annot": [12, 13, 14, 15, 16, 19, 26, 28, 29, 30, 31, 32, 33, 41, 43, 44, 45, 48], "amount": [12, 19, 34, 49], "calcul": [12, 23], "putth": [12, 14, 33], "putthingsinput": [12, 14], "putthingsoutput": [12, 14], "sha256": [12, 14, 23], "cognito": [12, 14], "pool": 12, "element": [12, 15, 19, 21, 29, 30, 37, 46], "user_pool_id": 12, "additionalschema": 13, "interact": 13, "additionalfooproperti": 13, "fooresourc": 13, "barproperti": 13, "responsecod": 13, "getfoo": [13, 29], "getfoorequest": 13, "getfoorespons": 13, "httplabel": [13, 20, 21, 35, 43, 46, 47], "httpresponsecod": [13, 19, 35, 47], "createfoo": 13, "updatefoo": 13, "createfoorequest": 13, "createfoorespons": 13, "createproperti": 13, "complexproperti": 13, "mutableproperti": 13, "writeproperti": 13, "createwriteproperti": 13, "readproperti": 13, "idempot": [13, 33, 35, 36, 37, 41, 47], "updatefoorequest": 13, "anotherproperti": 13, "fulli": [13, 14, 34, 37, 48], "fooproperti": 13, "taglist": [13, 14], "immutableset": 13, "updatedat": 13, "createdat": 13, "secret": 13, "password": 13, "alias": 13, "alia": [13, 42], "fooalia": 13, "culmin": 13, "httpqueri": [13, 20, 21, 35, 42, 46, 47], "addedproperti": 13, "immut": 13, "primari": [13, 40, 51], "none": [13, 14, 29, 37, 39, 49], "product": [14, 33, 34, 37, 38, 40, 42, 45], "cloudformationservic": 14, "across": [14, 29, 30, 33, 34, 36, 37, 46, 47, 49], "summar": 14, "onc": [14, 29, 36, 37, 43, 48], "publicli": 14, "brand": 14, "serviceid": 14, "inappropri": [14, 29], "taken": [14, 33, 40], "offici": [14, 29, 52], "storag": 14, "off": [14, 29, 54], "digit": [14, 30, 34, 37, 45, 49], "explicitli": [14, 16, 19, 26, 29, 33, 37, 40, 41, 42, 43, 48, 53], "overridden": 14, "though": [14, 30, 49, 51], "php": 14, "apigatewaycli": 14, "major": [14, 31, 34], "resourcenam": 14, "face": [14, 50], "eventsourc": 14, "cloudtrail": 14, "record": 14, "amazonaw": [14, 26, 49], "ec2": [14, 27, 49], "swf": 14, "cloudwatch": 14, "monitor": 14, "Such": [14, 37], "dash": 14, "partit": [14, 29], "subject": [14, 29, 48], "therefor": [14, 42], "substitut": [14, 46, 48], "percent": [14, 33, 46], "myresourceid": 14, "noregion": 14, "noaccount": 14, "partitionnam": 14, "china": 14, "beij": 14, "cn": 14, "rd": 14, "resid": 14, "hyphen": 14, "123456789012": 14, "vari": 14, "databas": 14, "elast": 14, "beanstalk": 14, "elasticbeanstalk": 14, "app": 14, "myenviron": 14, "david": 14, "eu": 14, "db": 14, "mysql": 14, "bucket": [14, 24, 41, 49], "my_corporate_bucket": 14, "exampleobject": 14, "png": 14, "myresourc": [14, 16, 33, 37], "myid": 14, "accountid": [14, 24], "insert": [14, 33, 37, 38, 45], "someresourc": [14, 36], "someservic": 14, "someresourceid": 14, "context": [14, 29, 31, 35, 37, 38, 52, 53, 55], "previou": [14, 29, 34, 37, 38, 42], "simpletyp": [14, 38, 42, 45], "conjunct": 14, "machin": [14, 24, 27, 37], "imag": [14, 31], "audio": 14, "video": [14, 40], "transfer": [14, 15, 19, 33, 40], "forego": 14, "administr": 14, "statist": 14, "analyt": 14, "rule": [14, 15, 19, 30, 33, 35, 36, 38, 40, 42, 49, 50], "plane": 14, "cellular": 14, "infrastructur": 14, "expir": [14, 29], "address": [14, 24, 37, 49], "cacheperiodinminut": 14, "denot": [14, 34], "illustr": [14, 30, 37, 42], "describeendpoint": 14, "getobject": 14, "invalidendpointerror": 14, "fooservic": 14, "09": [14, 42], "describeendpointsinput": 14, "describeendpointsoutput": 14, "httperror": [14, 20, 21, 29, 35, 42, 44, 46, 47, 50, 55], "421": 14, "getobjectinput": 14, "getobjectoutput": 14, "synchron": 14, "asynchron": [14, 43, 48, 49], "priorit": 14, "evict": 14, "minut": [14, 49], "refresh": 14, "period": [14, 17, 18, 29, 32, 49], "highest": [14, 29], "continu": [14, 35, 37, 42, 49, 55], "lru": 14, "global": [14, 16], "requestalgorithmmemb": 14, "algorithm": [14, 28, 29, 34, 49], "crc32c": 14, "crc32": 14, "sha1": 14, "requestchecksumrequir": 14, "md5": [14, 29], "requestvalidationmodememb": 14, "responsealgorithm": 14, "validationmod": 14, "putsometh": [14, 29], "checksumalgorithm": 14, "putsomethinginput": [14, 29], "putsomethingoutput": [14, 29], "httpheader": [14, 20, 21, 29, 32, 35, 43, 46, 47], "trailer": [14, 33], "chunk": [14, 15, 19], "skip": [14, 42, 46], "rais": 14, "conform": [14, 16, 38, 53], "directli": [14, 37, 41, 51, 53, 54, 55], "scenario": [14, 29], "unsign": [14, 27], "thu": [14, 42, 43], "supersed": [14, 37], "exhaust": [14, 15, 19, 26], "acm": [14, 31], "certif": 14, "manag": [14, 29, 33, 37], "auto": 14, "scale": 14, "appstream": 14, "athena": 14, "budget": 14, "clouddirectori": 14, "cloudfront": 14, "cloudhsm": 14, "v2": 14, "cloudsearch": 14, "domain": [14, 32, 37, 42], "codebuild": 14, "codecommit": 14, "codedeploi": 14, "codepipelin": 14, "codestar": 14, "cost": [14, 49], "report": [14, 35], "pipelin": 14, "dax": 14, "acceler": 14, "devic": 14, "farm": 14, "direct": [14, 29, 30, 34, 35, 37], "migrat": [14, 19], "cloud": 14, "ecr": 14, "registri": 14, "ec": 14, "ef": 14, "elasticach": 14, "transcod": 14, "emr": 14, "mapreduc": 14, "elasticsearch": 14, "firehos": 14, "kinesi": 14, "gamelift": 14, "glacier": [14, 24, 27], "glue": 14, "greengrass": 14, "health": 14, "importexport": 14, "inspector": 14, "iot": 14, "km": 14, "lex": 14, "lightsail": 14, "marketplac": 14, "entitl": 14, "commerc": 14, "meter": 14, "hub": 14, "mobil": 14, "mturk": 14, "turk": 14, "opswork": 14, "opsworkscm": 14, "chef": 14, "pinpoint": 14, "polli": 14, "redshift": 14, "rekognit": 14, "53": [14, 19], "simpledb": 14, "catalog": 14, "se": 14, "email": 14, "shield": 14, "sm": 14, "snowbal": 14, "sn": 14, "sq": 14, "ssm": 14, "sfn": 14, "st": 14, "waf": 14, "workdoc": 14, "workspac": 14, "xrai": 14, "rai": 14, "awsqueri": [15, 27, 47], "xmlnamespac": [15, 19, 21, 35, 47], "05": [15, 17, 18, 19, 51, 55], "mystruct": 15, "xmlname": [15, 19, 21, 26, 35, 47], "cor": [15, 17, 18, 19, 20, 21, 35, 47], "hostprefix": [15, 17, 18, 19, 20, 21, 32, 33, 46], "xmlattribut": [15, 19, 21, 35, 40, 47], "xmlflatten": [15, 19, 21, 35, 47], "unwrap": [15, 19, 21, 26, 45], "xmln": [15, 19, 21, 26, 45], "requestcompress": [15, 17, 18, 19, 20, 21, 35, 47], "compress": [15, 17, 18, 19, 20, 21, 35, 53], "index": [15, 19, 46], "increment": [15, 19], "counter": [15, 19, 49], "shall": [15, 17, 18, 19, 20, 21, 29, 35], "3986": [15, 19, 32, 33], "concaten": [15, 19, 33, 34, 37, 38], "scientif": [15, 19, 21, 45], "notat": [15, 19, 21, 35, 45], "expon": [15, 19, 21, 45], "unfortun": [15, 17, 18, 19, 20, 21], "parser": [15, 17, 18, 19, 20, 21, 34, 36, 46], "unabl": [15, 17, 18, 19, 20, 21], "pars": [15, 17, 18, 19, 20, 21, 34, 37, 40, 42, 46, 53], "exce": [15, 17, 18, 19, 20, 21, 49], "suit": [15, 17, 18, 19, 20, 21, 46], "ec2querystructuresinput": 15, "hasquerynam": 15, "ignorem": 15, "hasqueryandxmlnam": 15, "usesxmlnam": 15, "temp": [15, 19], "ec2querystructur": 15, "example0": 15, "example1": [15, 19, 45], "example2": [15, 19, 45], "example3": [15, 19, 45], "ec2querylistsinput": 15, "listarg": [15, 19], "stringlist": [15, 19, 29, 34], "complexlistarg": [15, 19], "greetinglist": [15, 19], "renamedlistarg": 15, "greetingstruct": [15, 19], "ec2querylist": 15, "hola": [15, 19], "success": [15, 19, 33, 34, 49], "xmltest": [15, 19], "xmltestrespons": [15, 19], "testvalu": [15, 19], "comprehens": [15, 19, 21], "distinguish": [15, 17, 18, 19, 20, 21], "invalidgreet": [15, 19, 21, 46], "anotherset": [15, 19, 21], "hypothet": [15, 19, 21, 28, 37, 40], "posit": [15, 17, 18, 19, 20, 21, 48], "neg": [15, 17, 18, 19, 20, 21, 29], "Not": [15, 17, 18, 19, 20, 21, 37, 43], "norm": [15, 17, 18, 19, 20, 21, 37, 49], "github": [15, 17, 18, 19, 20, 21, 35, 42], "lang": [15, 17, 18, 19, 20, 21, 35], "tree": [15, 17, 18, 19, 20, 21, 23, 34, 36], "todo": [15, 17, 18, 20, 21, 26, 42], "permit": [15, 17, 18, 19, 20, 21, 33, 34, 37], "__type": [15, 17, 18, 19, 20, 21], "serviceerror": [15, 18, 19, 20, 21], "henc": [15, 18, 19, 20, 21], "infer": 16, "augment": [16, 35, 41], "brief": 16, "entail": 16, "myresourcefoo": 16, "otherservic": 16, "definedcontextkei": 16, "2017": [16, 28, 36, 37, 40], "11": [16, 28, 36, 37, 40, 49], "62": [16, 49], "ipaddress": 16, "arrayofarn": 16, "arrayofbinari": 16, "arrayofbool": 16, "arrayofd": 16, "arrayofipaddress": 16, "arrayofnumer": 16, "arrayofstr": 16, "datetim": 16, "profil": 16, "iso": 16, "8601": 16, "4632": 16, "unord": [16, 37, 42], "ancestor": 16, "had": 16, "otheroper": 16, "princip": 16, "iamus": 16, "iamrol": 16, "federatedus": 16, "deviat": [16, 45], "superresourc": 16, "superid": 16, "myinnerresourc": 16, "innerresourc": 16, "yum": 16, "innerresourceyum": 16, "eventstreamhttp": [17, 18, 20, 21], "layer": [17, 18, 20, 21, 40, 53], "negoti": [17, 18, 20, 21], "alpn": [17, 18, 20, 21], "h2": [17, 18, 20, 21], "7230": [17, 18, 33], "join": [17, 18, 54], "myop": [17, 18], "unix": [17, 18, 20, 34, 37, 40, 46], "observ": [17, 18, 20], "still": [17, 18, 29, 37, 48, 49, 50, 51, 55], "amzn": [17, 18, 19, 20], "errortyp": [17, 18, 20, 46, 49], "legaci": [17, 18, 20], "sometim": [17, 18, 20, 42, 54], "sanit": [17, 18, 20], "fooerror": [17, 18, 20], "coral": [17, 18, 20], "protocoltest": [17, 18, 20], "restjson": [17, 18, 20, 42], "readabl": [19, 37, 44], "querystructuresinput": 19, "querystructur": 19, "querylistsinput": 19, "flattenedlistarg": 19, "listargwithxmlnamememb": 19, "listwithxmlnam": 19, "notic": [19, 41], "flattenedlistargwithxmlnam": 19, "querylist": 19, "querymapsinput": 19, "maparg": 19, "stringmap": [19, 33], "renamedmaparg": 19, "complexmaparg": 19, "complexmap": 19, "mapwithxmlmembernam": 19, "mapwithxmlnam": 19, "k": 19, "v": 19, "querymap": 19, "responsemetadata": 19, "ok": [19, 37], "mon": 19, "27": [19, 29], "jul": 19, "2009": 19, "12": [19, 30, 49], "28": [19, 42], "gmt": [19, 40], "xmltestresult": 19, "c6104cbe": 19, "af31": 19, "11e0": 19, "8154": 19, "cbc7ccf896c7": 19, "errorrespons": [19, 21], "bad": [19, 49, 55], "sender": [19, 21, 29], "One": [19, 21, 36, 37, 42, 46, 48, 51], "whomev": [19, 21], "fault": [19, 21, 44], "perspect": [19, 21], "500": [19, 20, 21, 33, 42], "invalidth": 19, "invalidthingexcept": 19, "compatibli": [19, 31], "awsjson1_0": [19, 27, 47], "04": [20, 21, 33, 37, 40, 42], "awsjson1_1": [20, 27, 47], "httpqueryparam": [20, 21, 35, 47], "plain": [20, 21, 29, 31, 37, 46], "octet": [20, 21], "anyth": [20, 38], "noerrorwrap": 21, "upload": 23, "archiv": 23, "uploadarch": 23, "uploadmultipartpart": 23, "hash": 23, "checksum": [24, 27, 29], "predictendpoint": 24, "closest": 26, "compos": [26, 37, 42], "unset": 26, "prepend": [26, 32, 33], "bucketnam": [26, 33, 41], "dualstack": 26, "endpointprefix": [26, 27], "restxml": [26, 27, 47], "abridg": 26, "getbucketloc": 26, "getbucketlocationinput": 26, "getbucketlocationoutput": 26, "locationconstraint": 26, "bucketlocationconstraint": 26, "us_west_2": 26, "shown": 26, "core": [27, 35, 37, 39, 47], "cloudtraileventsourc": 27, "docid": 27, "arnrefer": [27, 47], "classif": 27, "controlplan": [27, 42, 47], "dataplan": [27, 42, 47], "clientendpointdiscoveri": [27, 47], "clientdiscoveredendpoint": [27, 47], "clientendpointdiscoveryid": [27, 47], "httpchecksum": [27, 47], "httpchecksumrequir": [27, 35, 47], "appendix": [27, 33, 35], "unsignedpayload": [27, 47], "actionpermissiondescript": [27, 47], "conditionkei": [27, 47], "defineconditionkei": [27, 47], "disableconditionkeyinfer": [27, 47], "supportedprincipaltyp": [27, 47], "iamresourc": [27, 47], "share": [27, 33, 37, 46], "contenthandl": 27, "requestparamet": 27, "requesttempl": 27, "cfnresourc": [27, 47], "cfnexcludeproperti": [27, 47], "cfnmutabl": [27, 47], "cfnadditionalidentifi": [27, 47], "cfndefaultvalu": [27, 47], "complianc": [27, 35, 47], "www": [27, 31, 33], "urlencod": 27, "resolut": [27, 35, 41], "awsqueryerror": [27, 47], "awsquerycompat": [27, 47], "ec2queri": [27, 47], "ec2querynam": [27, 47], "fooexampl": 28, "weatherservic": [28, 40, 55], "algorithmauth": 28, "algorithmauthalgorithm": 28, "sha": 28, "basic": [28, 33, 53], "2617": 28, "digest": 28, "bearer": 28, "6750": 28, "unauthent": 28, "pingserv": 28, "someunauthenticatedoper": 28, "servicewithnoauthtrait": 28, "servicewithauthtrait": 28, "invalid": [28, 30, 31, 32, 33, 34, 37, 38, 42, 43, 46, 48, 49], "invalidexampl": 28, "discard": [29, 37, 48], "replai": 29, "uuid": 29, "retri": 29, "due": [29, 37, 49, 54], "allocatewidget": 29, "allocatewidgetinput": 29, "clienttoken": 29, "deletesometh": 29, "deletesomethinginput": 29, "deletesomethingoutput": 29, "inher": [29, 37], "getsometh": [29, 37], "getsomethinginput": [29, 37], "getsomethingoutput": [29, 37], "503": 29, "serviceunavailableerror": 29, "429": [29, 44], "throttlingerror": [29, 43, 44], "intention": 29, "divid": 29, "discret": 29, "cursor": 29, "fill": 29, "meet": 29, "latenc": 29, "getfoosinput": 29, "getfoosoutput": 29, "seri": 29, "abnf": [29, 35, 36, 37, 42, 45, 46, 49], "resultwrapp": 29, "natur": [29, 49], "ten": 29, "sort": 29, "rank": 29, "reach": [29, 49], "relev": 29, "yet": [29, 37], "seen": 29, "iter": [29, 33, 34], "last": [29, 33, 34, 49], "free": 29, "back": [29, 30, 37, 53, 55], "stop": [29, 42, 49], "impli": [29, 38], "tail": 29, "infinit": 29, "loop": 29, "opaqu": [29, 37], "extrem": 29, "hard": [29, 37], "proof": 29, "recogn": [29, 50], "24": [29, 49], "quickli": [29, 49], "phase": [29, 53], "ephemer": 29, "reject": [29, 31, 37, 46, 51], "certain": [29, 33, 55], "smaller": 29, "sum": 29, "presenc": [29, 37], "absenc": 29, "1864": 29, "requireslength": [29, 35, 47], "avoid": [29, 30, 37, 38, 49], "gzip": 29, "streamingmemb": 29, "streamingfoo": 29, "disable_request_compress": 29, "older": 29, "9110": 29, "putwithcontentencod": 29, "customencod": 29, "brotli": 29, "putwithcontentencodinginput": 29, "prior": [29, 32, 43], "mismatch": [29, 50], "small": 29, "minimum": [29, 30, 34, 49], "threshold": 29, "request_min_compression_size_byt": 29, "lowest": 29, "disablerequestcompress": 29, "trigger": [29, 49], "10485760": 29, "10240": 29, "requestmincompressionsizebyt": 29, "qualiti": [29, 48], "tradeoff": 29, "speed": 29, "els": [29, 49], "constrain": [30, 38, 42, 51], "constant": [30, 46], "encourag": [30, 53], "reliabl": 30, "ascii": 30, "latin": 30, "zero": [30, 34, 37, 42, 43, 48], "z_": 30, "z_0": 30, "stricter": 30, "commonmark": [30, 31, 34, 46, 49], "categor": [30, 46, 49], "mystr": [30, 31, 34, 35, 36, 37, 38], "t2": 30, "nano": 30, "t2_nano": 30, "burstabl": 30, "baselin": 30, "cpu": 30, "burst": 30, "ebsonli": 30, "micro": 30, "t2_micro": 30, "m256": 30, "mega": 30, "m256_mega": 30, "primarili": [30, 44], "failwhenmiss": [30, 42], "integerref": 30, "notfound": [30, 37, 49], "invalidshape1": 30, "invalidshape2": 30, "invalidshape3": 30, "validshap": 30, "validshape2": 30, "syntact": 30, "unicod": [30, 34], "scalar": [30, 42], "ecma": 30, "262": 30, "dialect": 30, "recurs": [30, 35], "lookahead": 30, "behind": [30, 51], "chosen": 30, "care": [30, 31, 33, 38], "expens": 30, "malform": 30, "owasp": 30, "implicitli": [30, 37, 40, 41, 53], "w": [30, 34], "wherea": [30, 31, 49], "real": 30, "fall": [30, 37, 50], "myint": 30, "foostr": 30, "mylist": [30, 34, 36, 37, 45], "codepoint": 30, "matter": 30, "mathemat": 30, "partial": 30, "numberofitem": 30, "positiveinteg": 30, "7": [30, 33, 40, 48, 49], "shoppingcart": 30, "materi": 31, "somestr": 31, "otherstr": 31, "constraint": [31, 33, 34, 35, 37, 38, 42, 44, 46, 47, 48, 55], "myoperationinput": [31, 33, 36, 37], "myoperationoutput": [31, 36, 37], "myoperationerror": 31, "pend": 31, "ref": 31, "benefit": [31, 37, 51], "putcontentsinput": 31, "validatecont": 31, "transmit": [31, 43], "visibl": 31, "particular": [31, 33, 37, 48, 49, 53], "experiment": 31, "somestructur": 31, "proper": [31, 42], "friendli": 31, "mysimpleimageservic": 31, "userinfo": 32, "port": 32, "risk": 32, "getstatu": [32, 33], "getstatusinput": [32, 33], "getstatusoutput": [32, 33], "surround": [32, 33], "close": [32, 33, 34, 42, 48], "brace": [32, 33, 34, 48], "label_nam": [32, 33], "abc": [32, 40], "immedi": [32, 33, 34, 37], "adjac": [32, 33], "def": [32, 40], "decor": [32, 48], "inject": [32, 38], "expans": [32, 38], "AND": 32, "spam": 32, "egg": 32, "poorli": 33, "interoper": 33, "204": 33, "205": 33, "299": 33, "999": [33, 37], "putobject": 33, "putobjectinput": 33, "objectkei": [33, 41], "paramnam": 33, "somevalu": [33, 48], "myblob": 33, "safeti": [33, 51], "characterist": 33, "5": [33, 34, 40, 42, 46, 49], "v1": 33, "fragment": 33, "getservic": 33, "getserviceoutput": 33, "yourhost": 33, "ye": [33, 48], "miss": [33, 34, 35, 37, 42, 46], "captur": [33, 37, 42], "span": [33, 34, 38, 48], "label1": 33, "label2": 33, "portion": 33, "requiredkei": 33, "otherkei": 33, "requiredvalu": 33, "disregard": 33, "othervalu": 33, "qualifi": [33, 34, 37, 42], "whole": [33, 51], "middl": 33, "greedili": 33, "longest": 33, "ambigu": [33, 35, 37], "delimit": [33, 34, 38, 42], "legal": 33, "illeg": 33, "occupi": 33, "bam": [33, 34], "coexist": 33, "404": 33, "myerror": 33, "rfc7230": 33, "imf": [33, 40], "fixdat": [33, 40], "7231": [33, 40], "enforc": [33, 37, 38], "practic": [33, 37, 38], "carefulli": 33, "discourag": 33, "te": 33, "upgrad": 33, "agent": 33, "3339": [33, 37, 40, 45, 48], "1985": [33, 37, 40], "12t23": [33, 37, 40], "20": [33, 37, 40, 42], "52z": [33, 37], "3a20": 33, "3a50": 33, "unreserv": 33, "random": [33, 49], "getrandombinarydata": 33, "getrandombinarydatainput": 33, "getrandombinarydataoutput": 33, "contenttyp": 33, "raw": [33, 51], "differenti": [33, 34, 37], "listth": [33, 36], "listthingsinput": 33, "listthingsoutput": 33, "breviti": 33, "concern": [33, 43], "myparam": 33, "mapofstr": 33, "meaning": [33, 37, 39, 50], "putthinginput": 33, "thingid": 33, "realid": 33, "fakeid": 33, "othertag": 33, "postth": 33, "postthinginput": 33, "anothertag": 33, "lasttag": 33, "201": 33, "cross": 33, "browser": 33, "maxag": 33, "600": 33, "ag": [33, 34], "additionalallowedhead": 33, "additionalexposedhead": 33, "publishmessag": [33, 43], "publishmessagesinput": [33, 43], "messagestream": [33, 43], "invalidoper": 33, "invalidoperationinput": 33, "grammar": [34, 35, 36], "usestat": 34, "shorter": 34, "5234": [34, 35], "controlsect": 34, "metadatasect": 34, "shapesect": 34, "sp": 34, "nl": 34, "x20": [34, 42], "x09": 34, "tab": 34, "x0a": 34, "x0d": 34, "0a": 34, "r": 34, "10ffff": [34, 42], "documentationcom": 34, "linecom": 34, "notnl": 34, "controlstat": 34, "nodeobjectkei": 34, "nodevalu": [34, 37], "br": 34, "metadatastat": 34, "nodearrai": 34, "nodeobject": 34, "nodekeyword": 34, "nodestringvalu": 34, "trailingcomma": 34, "nodeobjectkvp": 34, "quotedtext": 34, "minu": [34, 49], "int": 34, "frac": 34, "exp": 34, "x2e": 34, "x31": 34, "39": [34, 49], "x65": 34, "x45": 34, "decimalpoint": 34, "digitonetonin": 34, "x2d": 34, "x2b": 34, "x30": 34, "textblock": 34, "dquot": [34, 42], "quotedchar": 34, "21": [34, 42], "x23": [34, 42], "5b": [34, 42], "x5d": [34, 42], "escapedchar": 34, "preserveddoubl": 34, "unicodeescap": 34, "hex": 34, "x41": [34, 49], "x61": 34, "66": 34, "x5c": 34, "threedquot": 34, "namespacestat": 34, "usesect": 34, "shapestat": 34, "absoluterootshapeid": [34, 37], "applystat": 34, "traitstat": [34, 37], "shapebodi": 34, "simpleshapestat": 34, "liststat": 34, "setstat": 34, "mapstat": 34, "structurestat": 34, "unionstat": 34, "servicestat": 34, "operationstat": 34, "resourcestat": 34, "simpletypenam": 34, "listmemb": 34, "explicitlistmemb": 34, "setmemb": 34, "explicitsetmemb": 34, "mapmemb": 34, "mapkei": 34, "mapvalu": 34, "explicitmapkei": 34, "explicitmapvalu": 34, "structurememb": 34, "explicitstructurememb": 34, "unionmemb": 34, "explicitunionmemb": 34, "traitbodi": 34, "traitbodyvalu": 34, "traitstructur": 34, "traitstructurekvp": 34, "termin": [34, 43], "minor": 34, "unexpect": [34, 43, 50], "less": [34, 37, 42, 49], "greet": [34, 46], "unquot": 34, "examplesyntacticshapeid": 34, "mymap": [34, 45], "anothertrait": 34, "satisfi": [34, 38, 42], "myboolean": 34, "invalidshap": 34, "quot": [34, 38, 42], "incorrect": 34, "sugar": 34, "inconsequenti": 34, "syntacticshapeidtarget": 34, "bring": [34, 37], "attent": 34, "broken": 34, "unintention": 34, "rare": [34, 37], "stringset": [34, 37], "integermap": [34, 36, 37], "myunion": [34, 36, 37], "i32": [34, 37], "modelrepositori": 34, "pingservic": 34, "13": [34, 45, 49], "unavail": 34, "badrequest": [34, 37], "pingserviceinput": 34, "pingserviceoutput": 34, "unavailableerror": 34, "badrequesterror": [34, 36, 37], "sprocketresourc": 34, "sprocketid": 34, "getsprocket": [34, 44], "sprocket": 34, "placement": 34, "enclos": [34, 42], "parenthesi": 34, "anim": 34, "kingdom": 34, "structuredtrait": [34, 37], "mystring1": 34, "mystring2": 34, "bracket": [34, 42], "myset": [34, 36, 45], "analog": 34, "advantag": 34, "456": 34, "an_arrai": 34, "1e": 34, "0e": 34, "cr": 34, "u000d": 34, "crlf": 34, "u000du000a": 34, "lf": 34, "u000a": 34, "platform": [34, 46], "concert": 34, "sequenc": 34, "0022": 34, "005c": 34, "002f": 34, "0008": 34, "backspac": 34, "000c": 34, "ff": 34, "000d": 34, "carriag": 34, "0009": 34, "ht": 34, "hhhh": 34, "uhhhh": 34, "hexadecim": 34, "noth": [34, 42], "heavili": 34, "inspir": 34, "jep": 34, "355": 34, "indent": [34, 38], "div": 34, "p": 34, "insignific": [34, 42], "rewritten": 34, "ill": 34, "count": 34, "wholli": 34, "third": 34, "fourth": 34, "margin": 34, "move": [34, 37, 49], "right": [34, 42, 43], "bear": 34, "visual": [34, 37], "trim": 34, "nbar": 34, "unescap": 34, "interpret": [34, 35, 40, 43, 46], "nbaz": 34, "intermix": 34, "2119": 35, "backu": 35, "naur": 35, "reader": 35, "invit": 35, "welcom": 35, "complementari": 35, "alongsid": [35, 37, 53], "idref": [35, 42, 47], "uniqueitem": [35, 37, 47], "errorexampl": 35, "unstabl": [35, 38, 47], "refin": [35, 37, 47], "protocoldefinit": [35, 42, 46, 47, 48], "authdefinit": [35, 42, 46, 47], "optionalauth": [35, 47], "idempotencytoken": [35, 46, 47], "retryabl": [35, 43, 44, 47], "noreplac": [35, 37, 47], "implicit": 35, "resourceidentifi": [35, 37, 47], "comparison": [35, 37, 38, 40], "neighbor": 35, "undirect": 35, "revers": [35, 53], "topdown": 35, "var": [35, 38], "emitnoneselector": 35, "lexic": 35, "statement": [35, 37, 42], "block": [35, 37], "isomorph": 36, "driver": 36, "simplic": 36, "stringmemb": 36, "numbermemb": 36, "getservertim": [36, 37], "someerror": [36, 37], "widget": [36, 37], "smithywidget": 36, "foowidget": [36, 37], "collectionoper": [36, 37, 42], "cyclic": [36, 37], "hierarchi": [36, 37, 42], "forecastid": [36, 37, 41], "createth": 36, "getth": [36, 49], "updateth": 36, "deleteth": 36, "someinstanceoper": 36, "somecollectionoper": 36, "notfounderror": [36, 37], "struct": [36, 45], "framework": [37, 49, 50, 53, 55], "facilit": 37, "figur": [37, 49], "concept": [37, 38], "improv": [37, 49], "modular": 37, "assembl": 37, "human": [37, 44], "aim": 37, "streamlin": 37, "ecosystem": 37, "graph": [37, 42], "shape_nam": 37, "member_nam": 37, "basi": 37, "atom": 37, "primit": 37, "unlik": [37, 45], "diagram": 37, "shapenam": [37, 41], "_________": 37, "_______": 37, "________": 37, "reusabl": 37, "formal": 37, "rootshapeid": [37, 42], "shapeidmemb": 37, "identifierstart": 37, "identifierchar": 37, "alpha": [37, 45, 49, 55], "pascalcas": 37, "inflect": 37, "facet": 37, "acronym": 37, "resourcearn": 37, "iochannel": 37, "htmlentiti": 37, "html_entiti": 37, "ideal": 37, "snake": 37, "prolept": 37, "gregorian": 37, "calendar": 37, "local": 37, "midnight": 37, "januari": [37, 40], "0001": 37, "ce": 37, "23": 37, "59": 37, "decemb": 37, "9999": 37, "tempor": 37, "millisecond": [37, 40], "broad": 37, "guarante": [37, 49], "unstructur": 37, "rigid": 37, "purview": 37, "simple_shape_stat": 37, "pre": 37, "list_stat": 37, "nullabl": 37, "dens": 37, "sparselist": [37, 44], "set_stat": 37, "agre": 37, "challeng": 37, "map_stat": 37, "sparsemap": [37, 44], "structure_stat": 37, "layout": 37, "similarli": 37, "variant": [37, 46], "union_stat": 37, "player": 37, "game": 37, "playeract": 37, "quit": 37, "directedact": 37, "jump": 37, "singular": 37, "unittyp": [37, 39], "imposs": [37, 43, 46], "validlist": 37, "intermediatestructur": 37, "recursivelist": 37, "mutual": 37, "recursiveshape1": 37, "recursivememb": 37, "recursiveshape2": 37, "service_stat": 37, "incident": 37, "fundament": 37, "getservertimeoutput": 37, "ubiquit": 37, "discern": 37, "badrequestexcept": 37, "thrown": [37, 50], "essenti": [37, 42, 55], "despit": 37, "sparingli": 37, "widget1": 37, "undeclar": 37, "operation_stat": 37, "mysideeffectoper": 37, "flexibl": [37, 49], "resource_stat": 37, "verbatim": 37, "resourcec": 37, "invalid1": 37, "invalid2": 37, "someotherstr": 37, "weatherdata": 37, "batchputforecast": 37, "batchputforecastsinput": 37, "batchputforecastsoutput": 37, "batchputforecastlist": 37, "historicalforecast": [37, 41], "historicalid": [37, 41], "historicalforecastid": [37, 41], "gethistoricalforecast": 37, "listhistoricalforecast": 37, "gethistoricalforecastinput": 37, "gethistoricalforecastoutput": 37, "customforecastidnam": 37, "customhistoricalidnam": 37, "putforecast": 37, "createforecast": 37, "updateforecast": 37, "deleteforecast": 37, "listforecast": 37, "putforecastinput": 37, "putforecastoutput": 37, "rfc7231": 37, "createforecastinput": 37, "createforecastoutput": 37, "resourcenotfound": 37, "updateforecastinput": 37, "updateforecastoutput": 37, "deleteforecastinput": 37, "deleteforecastoutput": 37, "listforecastsinput": 37, "listforecastsoutput": 37, "forecastlist": 37, "done": [37, 46, 48], "collis": 37, "prohibit": 37, "round": 37, "fraction": [37, 40], "mytraitnam": 37, "breakingchang": 37, "breakingchangerul": 37, "lorem": 37, "stringshap": 37, "ipsum": 37, "dolor": 37, "stand": 37, "mystring4": 37, "analysi": 37, "riski": 37, "review": 37, "problemat": 37, "cannotadd": 37, "cannottoaddorremov": 37, "namelist": 37, "han": 37, "luke": 37, "chewi": 37, "job": 37, "smuggler": 37, "jedi": 37, "ghost": 37, "wide": 37, "validconflict": 37, "lack": [37, 44], "et": 37, "al": 37, "higher": 37, "simpli": [37, 43, 50, 51, 53], "happen": [37, 49, 50, 53], "reconcil": 37, "guidanc": 37, "defer": 37, "customiz": 38, "great": 38, "deal": 38, "disciplin": 38, "coher": 38, "particularli": 38, "checkstyl": 38, "findbug": 38, "bug": [38, 49, 50], "pitfal": 38, "power": 38, "rigor": 38, "processor": 38, "somevalid": 38, "customeventid": 38, "someproperti": 38, "unknownvalidator_": 38, "unknownvalidator_foo": 38, "wrong": [38, 51], "unsuppress": 38, "unreferencedshap": 38, "overlybroadvalid": 38, "bindtotrait": 38, "messagetempl": 38, "missingdocument": 38, "operationinputnam": 38, "operationoutputnam": 38, "lifecyclegetnam": 38, "lifecycledeletenam": 38, "contextu": 38, "documentedstr": 38, "granular": [38, 40], "selector_context_valu": 38, "pipe": [38, 42], "goodby": 38, "unstabletrait": 38, "donotusem": 38, "nothing": 38, "descend": [38, 42], "print": 38, "omiss": 38, "rememb": 38, "missingconstrainttrait": 38, "did": 38, "forget": 38, "minim": [39, 49], "primitiveboolean": 39, "primitivebyt": 39, "primitiveshort": 39, "primitiveinteg": 39, "primitivelong": 39, "primitivefloat": 39, "primitivedoubl": 39, "noinlinedocumentsupport": 40, "jsonexampl": 40, "xmlexampl": 40, "configurableexampl": 40, "6838": 40, "quicktim": 40, "videodata": 40, "isol": 40, "aid": 40, "helper": 40, "contract": [40, 53], "contrast": 40, "520z": 40, "gracefulli": [40, 46], "tue": 40, "apr": 40, "2014": 40, "18": 40, "30": 40, "38": 40, "elaps": 40, "00": 40, "univers": [40, 53], "thursdai": 40, "1970": 40, "1515531081": 40, "liber": 40, "improperli": 40, "createt": 41, "updatet": 41, "derefer": 41, "5988": 41, "circumst": 41, "historicalrefer": 41, "customforecastid": 41, "customhistoricalid": 41, "anotherhistoricalrefer": 41, "meteorologist": 41, "forecastinform": 41, "someid": 41, "someshapeidentifi": 41, "meteorologistid": 41, "otherdata": 41, "someothershap": 41, "simpleresourc": 41, "simpleresourcerefer": 41, "serv": [41, 53], "said": 41, "filenam": 41, "getfil": 41, "getfileinput": 41, "getfileoutput": 41, "dsl": 42, "travers": 42, "thought": 42, "multidigraph": 42, "vertex": 42, "edg": [42, 46], "individu": [42, 51], "yield": [42, 53], "clear": 42, "hand": 42, "cast": 42, "80": 42, "fixm": 42, "assert": [42, 46, 51], "allowedtag": 42, "operationainput": 42, "badvalu": 42, "badenum": 42, "goodvalu": 42, "goodenum": 42, "tri": [42, 46], "negat": 42, "solv": 42, "neither": [42, 55], "criteria": 42, "chain": 42, "further": 42, "selectorforwarddirectedneighbor": 42, "y": [42, 48], "atyp": 42, "intenum": 42, "toler": 42, "variad": 42, "predic": 42, "soon": 42, "old": 42, "disqualifi": 42, "again": 42, "08": 42, "eagerli": 42, "selectorvariableset": 42, "reassign": 42, "selectorvariableget": 42, "authtrait": 42, "hasdigestauth": 42, "hasbasicauth": 42, "noauth": 42, "pseudo": 42, "matched_shap": 42, "current_shap": 42, "auth_trait": 42, "get_recursive_neighbor": 42, "__trait_auth_values_project": 42, "__auth_traits_id_project": 42, "issubset": 42, "selectorexpress": 42, "selectorshapetyp": 42, "selectorattr": 42, "selectorscopedattr": 42, "selectorfunct": 42, "selectorforwardundirectedneighbor": 42, "selectorreverseundirectedneighbor": 42, "selectorforwardrecursiveneighbor": 42, "selectorreversedirectedneighbor": 42, "selectordirectedrelationship": 42, "selectorkei": 42, "selectorattrcomparison": 42, "selectorcompar": 42, "selectorattrvalu": 42, "selectorpath": 42, "selectorpathseg": 42, "selectorvalu": 42, "selectorfunctionproperti": 42, "selectortext": 42, "selectorstringcompar": 42, "selectornumericcompar": 42, "selectorprojectioncompar": 42, "selectorscopedassert": 42, "selectorscopedvalu": 42, "selectorcontextvalu": 42, "selectorfunctionarg": 42, "selectorsinglequotedtext": 42, "selectordoublequotedtext": 42, "selectorsinglequotedchar": 42, "selectordoublequotedchar": 42, "26": 42, "x28": 42, "selectortest": 42, "skippreludeshap": 42, "atleastten": 42, "atleaston": 42, "atmostf": 42, "streamingoper": 43, "streamingoperationinput": 43, "streamingoperationoutput": 43, "streamingblob": 43, "finit": 43, "finitestreamingblob": 43, "duplex": 43, "simplex": 43, "frame": 43, "capabl": 43, "room": 43, "publishev": 43, "leaveev": 43, "subscribetomov": 43, "subscribetomovementsinput": 43, "subscribetomovementsoutput": 43, "movement": 43, "movementev": 43, "down": 43, "veloc": 43, "compris": 43, "opportun": [43, 53, 55], "subscribetomessag": 43, "subscribetomessagesinput": 43, "subscribetomessagesoutput": 43, "lifetim": 43, "connectionlifetim": 43, "dispatch": 43, "subscribetoev": 43, "subscribetoeventsinput": 43, "subscribetoeventsoutput": 43, "event1": 43, "event2": 43, "event3": 43, "exampleev": 43, "significantli": 44, "rust": 44, "boxedinteg": 44, "unbox": 44, "getsprocketinput": 44, "getsprocketrequest": 44, "getsprocketoutput": 44, "outermost": 45, "astruct": 45, "bstruct": 45, "dmfsdwu": 45, "1578255206": 45, "05t20": 45, "26z": 45, "flat": 45, "choic": [45, 53], "key1": 45, "key2": 45, "key3": 45, "notfoo": 45, "notflat": 45, "xmlidentifi": 45, "anotherstructur": 45, "junit": 46, "00000000": 46, "0000": 46, "4000": 46, "8000": 46, "000000000000": 46, "httprequesttestcas": 46, "unsupport": 46, "resolvedhost": 46, "discrep": 46, "authschem": 46, "queryparam": 46, "forbidqueryparam": 46, "requirequeryparam": 46, "forbidhead": 46, "requirehead": 46, "zm9vcg": 46, "bodymediatyp": 46, "runner": 46, "vendorparam": 46, "disk": 46, "vendorparamsshap": 46, "appliesto": 46, "undesir": 46, "say_hello": 46, "exampleprotocol": 46, "teddi": 46, "20there": 46, "sayhello": 46, "sayhelloinput": 46, "httpresponsetestcas": 46, "say_goodby": 46, "farewel": 46, "bye": 46, "saygoodby": 46, "saygoodbyeinput": 46, "saygoodbyeoutput": 46, "invalid_greet": 46, "httpmalformedrequesttestcas": 46, "exercis": 46, "testparamet": 46, "permut": 46, "total": [46, 49], "codewrit": 46, "l": 46, "formatt": 46, "messageregex": 46, "varianc": 46, "invertnumb": 46, "numbervalu": 46, "malformedlongsinpathsreject": 46, "badnumer": 46, "001": 46, "2abc": 46, "boolean_coercion": 46, "float_trunc": 46, "trailing_char": 46, "invertnumberinput": 46, "waiter": 47, "eventhead": [47, 48], "eventpayload": [47, 48], "subscrib": 47, "topiclabel": 47, "httpmalformedrequesttest": 47, "httprequesttest": 47, "httpresponsetest": 47, "waitabl": 47, "transport": [48, 50, 53], "transmiss": 48, "establish": 48, "live": 48, "session": 48, "broker": 48, "qo": 48, "degre": 48, "deliv": 48, "repli": [48, 53], "alert": 48, "peer": 48, "packet": 48, "disconnect": 48, "exampleoperationinput": 48, "wildcard": 48, "extran": 48, "postfoo": 48, "postfooinput": 48, "anothervalu": 48, "destroi": 48, "unsubscrib": 48, "subscribeforev": 48, "subscribeforeventsinput": 48, "subscribeforeventsoutput": 48, "eventstream": 48, "2f": 48, "met": 48, "notc": 48, "mqttjson": 48, "const": [48, 51, 55], "poll": 49, "enter": 49, "eventu": 49, "cumbersom": 49, "prone": 49, "goal": 49, "onto": [49, 51], "who": 49, "turn": 49, "wait": 49, "pseudocod": 49, "instanceterminatedwait": 49, "builder": 49, "myclient": 49, "singletonlist": 49, "totalallowedwaittim": 49, "durat": 49, "bucketexist": 49, "headbucket": 49, "headbucketinput": 49, "headbucketoutput": 49, "delai": 49, "exceed": 49, "5a": 49, "willing": 49, "deadlin": 49, "surpris": 49, "caught": 49, "inspect": 49, "cancel": 49, "attemptceil": 49, "maxdelai": 49, "overflow": 49, "larger": 49, "mindelai": 49, "120": 49, "logarithm": 49, "maxwaittim": 49, "remainingtim": 49, "subtract": 49, "needlessli": 49, "cumul": 49, "298": 49, "295": 49, "289": 49, "283": 49, "22": 49, "261": 49, "101": 49, "199": 49, "43": 49, "144": 49, "156": 49, "168": 49, "132": 49, "71": 49, "239": 49, "61": 49, "42": 49, "281": 49, "19": 49, "290": 49, "296": 49, "oppos": 49, "strategi": 49, "linear": 49, "spent": 49, "stabil": 49, "respond": 49, "overhead": 49, "agreement": 49, "few": 49, "fewer": 49, "increas": 49, "overload": 49, "unnecessari": 49, "protect": 49, "intuit": 49, "slightli": 49, "aggress": 49, "finish": 49, "inputoutput": 49, "succe": [49, 53], "footnot": 49, "truli": 49, "analyz": 49, "waitabletraitjmespathproblem": 49, "extract": [49, 51], "stringequ": 49, "booleanequ": 49, "allstringequ": 49, "anystringequ": 49, "thingexist": 49, "fast": 49, "getthinginput": 49, "getthingoutput": 49, "groupexist": 49, "listgroup": 49, "listgroupsinput": 49, "listgroupsoutput": 49, "outlin": 49, "overli": 49, "confid": 49, "difficult": 49, "simplifi": 49, "statenam": 49, "snapshot": 49, "snapshotdelet": 49, "snapshotremov": 49, "objectexist": 49, "conversiontaskdelet": 49, "runinstancecomplet": 49, "terminateinstancecomplet": 49, "instancerun": 49, "instancetermin": 49, "notexist": 49, "incomplet": 49, "validationerror": 49, "suppos": 49, "startresourc": 49, "stopresourc": 49, "resourcerun": 49, "getresourc": 49, "getresourceinput": 49, "getresourceoutput": 49, "subclass": 50, "internalfailur": 50, "render": [50, 55], "categori": 50, "low": [50, 53, 54], "catch": 50, "unintend": 50, "disclosur": 50, "javascript": 50, "typeerror": 50, "unpars": [50, 53], "circuit": [50, 55], "robot": 50, "traffic": 50, "latter": 50, "misconfigur": 50, "incorrectli": 50, "415": 50, "406": 50, "requesttyp": 51, "httprequest": [51, 54, 55], "responsetyp": 51, "httprespons": [51, 54, 55], "promis": 51, "situat": 51, "j": [51, 53], "stringwizard": 51, "echo": 51, "ssdk": [51, 53, 55], "stringwizardservicehandl": 51, "echohandl": 51, "lengthhandl": 51, "conveni": [51, 53], "getlengthhandl": 51, "lengthserverinput": 51, "lengthserveroutput": 51, "getlengthparamet": 51, "distribut": 51, "busi": 51, "o": [51, 55], "async": [51, 55], "lambdahandl": 51, "apigatewayproxyhandl": 51, "apigatewayproxyresult": [51, 54], "shim": [51, 53, 54], "convertev": [51, 54], "await": 51, "convertversion1respons": [51, 54], "although": 51, "stringwizardservic": 51, "getstringwizardservicehandl": 51, "__servicehandl": 51, "__httprequest": 51, "__httprespons": 51, "echoserverinput": 51, "echoserveroutput": 51, "convei": 51, "unmodel": [51, 53], "handlercontext": 51, "userarn": 51, "requestcontext": 51, "unmodifi": 51, "flow": 52, "servicehandl": [52, 55], "factori": [52, 55], "synthet": 52, "unavoid": 52, "focu": 53, "entrypoint": 53, "ones": 53, "prebuilt": 53, "easi": 53, "encapsul": 53, "band": 53, "pertin": 53, "unknownoperationexcept": 53, "serializationexcept": 53, "refactor": 53, "incorpor": 53, "favorit": 53, "middlewar": 53, "preprocess": 53, "postprocess": 53, "plug": 53, "fight": 53, "heavyweight": 53, "shelf": 54, "front": 54, "npm": 54, "apigatewayproxyev": 54, "isbase64encod": 54, "late": 55, "internalfailureexcept": 55, "roll": 55, "validationexcept": 55, "accomplish": 55, "refus": 55, "disabledefaultvalid": 55, "codegen": 55, "packagevers": 55, "decid": 55, "validationcustom": 55, "getexampleoperationhandl": 55, "exampleoperationserverinput": 55, "exampleoperationserveroutput": 55, "validationfailur": 55, "enumvalidationfailur": 55, "lengthvalidationfailur": 55, "patternvalidationfailur": 55, "rangevalidationfailur": 55, "requiredvalidationfailur": 55, "uniqueitemsvalidationfailur": 55, "validationcontext": 55, "serviceexcept": 55, "question": 55, "badinput": 55, "getgetforecasthandl": 55, "ctx": 55, "badinputerror": 55}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"smithi": [0, 1, 2, 3, 4, 5, 6, 7, 9, 10, 34, 35, 37, 47, 48, 49, 50, 51, 52, 53, 54, 55], "build": [0, 1, 2, 3, 5, 10], "us": [0, 4, 14, 35], "json": [0, 3, 5, 17, 18, 20, 36], "project": [0, 1, 9, 42], "artifact": [0, 1], "transform": 0, "appli": [0, 34, 36, 37], "changestringenumstoenumshap": 0, "changetyp": 0, "excludeshapesbytag": 0, "excludeshapesbytrait": 0, "includeshapesbytag": 0, "includenamespac": 0, "includeservic": 0, "excludetag": 0, "excludetrait": 0, "excludetraitsbytag": 0, "filtersuppress": 0, "includetag": 0, "includetrait": 0, "includetraitsbytag": 0, "excludemetadata": 0, "includemetadata": 0, "flattennamespac": 0, "removetraitdefinit": 0, "removeunusedshap": 0, "renameshap": 0, "environ": 0, "variabl": [0, 38, 42], "plugin": [0, 1], "model": [0, 1, 2, 4, 7, 8, 10, 13, 14, 37, 38, 39, 43, 48, 49], "info": 0, "sourc": [0, 1], "gradl": 1, "instal": 1, "extens": [1, 3], "properti": [1, 13, 36], "gener": [1, 5, 23, 50, 51, 52, 53, 54, 55], "tag": [1, 31], "from": [1, 5], "complet": [1, 10], "exampl": [1, 3, 10, 13, 14, 15, 19, 31, 46, 49], "system": 2, "overview": [2, 7, 19, 34, 37, 46, 48], "guid": [2, 6, 8], "convert": 3, "openapi": 3, "introduct": [3, 5, 38, 42, 48, 53], "differ": [3, 5, 17, 18], "between": [3, 5, 17, 18], "unsupport": 3, "featur": 3, "configur": [3, 5], "set": [3, 5, 25, 34, 36, 37, 45], "schema": [3, 5], "secur": 3, "scheme": 3, "trait": [3, 4, 5, 8, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 26, 28, 29, 30, 31, 32, 33, 34, 37, 38, 40, 41, 42, 43, 44, 45, 47, 48, 49], "convers": 3, "amazon": [3, 11, 22, 23, 25, 26, 54], "api": [3, 4, 11, 14, 22, 54], "gatewai": [3, 11, 22, 54], "binari": 3, "type": [3, 11, 16, 20, 21, 36, 37, 42, 44, 45], "request": [3, 14, 15, 19, 29, 43, 46], "valid": [3, 7, 33, 38, 48, 55], "integr": [3, 11], "cor": [3, 33], "function": [3, 42], "author": [3, 11], "aw": [3, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 24, 26, 27, 47, 54], "cloudform": [3, 5, 13], "substitut": 3, "cognito": 3, "user": 3, "pool": 3, "kei": [3, 15, 16, 19], "usag": 3, "plan": 3, "other": [3, 5, 34], "influenc": [3, 5], "code": [3, 5, 19], "evolv": 4, "updat": [4, 37], "servic": [4, 10, 14, 24, 27, 34, 36, 37, 42], "oper": [4, 10, 15, 17, 18, 19, 20, 34, 36, 37], "structur": [4, 8, 11, 15, 19, 31, 34, 36, 37, 45, 49], "boolean": 4, "evolut": 4, "union": [4, 15, 19, 34, 36, 37, 45, 49], "box": [4, 44], "shape": [4, 8, 10, 15, 17, 18, 19, 20, 21, 34, 36, 37, 39, 42, 45], "spars": [4, 44], "list": [4, 10, 34, 36, 37, 45], "map": [4, 19, 34, 36, 37, 45], "diff": 4, "resourc": [5, 10, 13, 14, 34, 36, 37, 41, 49], "linter": 7, "lint": 7, "abbreviationnam": 7, "camelcas": 7, "noninclusiveterm": 7, "reservedword": 7, "wildcard": 7, "standardoperationverb": 7, "repeatedshapenam": 7, "inputoutputstructurereus": 7, "missingpaginatedtrait": 7, "shouldhaveusedtimestamp": 7, "write": 7, "custom": [7, 22, 23, 24, 25, 26, 27, 45, 55], "style": 8, "file": [8, 37], "encod": 8, "new": 8, "line": [8, 34], "format": [8, 14, 38, 46], "indent": 8, "whitespac": 8, "trail": [8, 34], "comma": 8, "name": [8, 14, 45, 49], "member": [8, 36, 37], "abbrevi": 8, "namespac": [8, 34], "read": [9, 37], "more": 9, "document": [9, 31, 34, 35], "implement": [9, 29], "link": 9, "quick": 10, "start": 10, "what": 10, "i": [10, 42], "weather": 10, "": 10, "syntax": 10, "defin": [10, 34, 37], "review": 10, "non": [10, 15, 17, 18, 19, 20, 21, 42], "lifecycl": [10, 37], "next": 10, "step": 10, "apigatewai": 11, "apikeysourc": 11, "requestvalid": 11, "mockintegr": 11, "share": 11, "data": [11, 14, 49, 53], "contenthandl": 11, "string": [11, 33, 34, 42], "requestparamet": 11, "requesttempl": 11, "respons": [11, 14, 15, 19, 21, 43, 46], "templat": [11, 14, 38, 48], "paramet": [11, 46], "authent": [12, 28], "auth": [12, 28], "sigv4": 12, "unsignedpayload": 12, "unsign": 12, "payload": 12, "signatur": 12, "version": [12, 23, 34], "4": 12, "cognitouserpool": 12, "cfnresourc": 13, "cfnexcludeproperti": 13, "mutabl": 13, "cfnmutabl": 13, "cfnname": 13, "cfnadditionalidentifi": 13, "cfndefaultvalu": 13, "core": 14, "specif": [14, 27, 35, 47], "sdkid": 14, "choos": 14, "an": 14, "sdk": 14, "id": [14, 34, 37, 41, 42], "client": [14, 29, 32, 43], "cloudformationnam": 14, "arnnamespac": 14, "cloudtraileventsourc": 14, "docid": 14, "endpointprefix": 14, "arn": 14, "rel": [14, 34], "identifi": [14, 37], "arnrefer": 14, "classif": 14, "controlplan": 14, "dataplan": 14, "endpoint": [14, 26, 32, 54], "discoveri": 14, "clientendpointdiscoveri": 14, "clientdiscoveredendpoint": 14, "clientendpointdiscoveryid": 14, "behavior": [14, 17, 18, 29, 32, 43], "cach": 14, "protocol": [14, 15, 17, 18, 19, 20, 21, 27, 40, 46, 48, 50], "httpchecksum": 14, "http": [14, 19, 20, 21, 33, 46], "checksum": [14, 23], "resolv": 14, "locat": 14, "httpchecksumrequir": [14, 29], "appendix": 14, "A": 14, "ec2": 15, "queri": [15, 19, 33], "ec2queri": 15, "ec2querynam": 15, "resolut": [15, 19, 34, 37], "support": [15, 17, 18, 19, 20, 21, 54], "serial": [15, 17, 18, 19, 20, 21, 33, 43, 45, 48], "x": [15, 19, 23], "www": [15, 19], "form": [15, 19], "urlencod": [15, 19], "collect": [15, 19], "xml": [15, 19, 21, 45], "error": [15, 17, 18, 19, 20, 21, 43, 44, 46, 50], "numer": [15, 17, 18, 19, 20, 21, 42], "float": [15, 17, 18, 19, 20, 21], "doubl": [15, 17, 18, 19, 20, 21], "complianc": [15, 17, 18, 19, 20, 21, 42, 46], "test": [15, 17, 18, 19, 20, 21, 42, 46], "renam": [15, 17, 18, 19, 20, 21], "iam": 16, "actionpermissiondescript": 16, "conditionkei": 16, "defineconditionkei": 16, "condit": 16, "disableconditionkeyinfer": 16, "requiredact": 16, "supportedprincipaltyp": 16, "iamresourc": 16, "deriv": 16, "1": [17, 18], "0": 17, "awsjson1_0": [17, 18], "empti": [17, 18, 42], "bodi": [17, 18], "awsjson1_1": [17, 18], "statu": 19, "awsqueri": 19, "awsqueryerror": 19, "awsquerycompat": 19, "restjson1": 20, "content": [20, 21, 35], "bind": [20, 21, 33, 37, 38, 45, 48], "restxml": 21, "accept": 22, "header": [22, 23, 33], "glacier": 23, "amz": 23, "default": [23, 37, 55], "valu": [23, 25, 30, 34, 37, 42], "accountid": 23, "machin": 25, "learn": 25, "host": [25, 26], "predictendpoint": 25, "s3": 26, "bucket": 26, "address": 26, "virtual": 26, "dual": 26, "stack": 26, "transfer": 26, "acceler": 26, "s3unwrappedxmloutput": 26, "authdefinit": 28, "httpbasicauth": 28, "httpdigestauth": 28, "httpbearerauth": 28, "httpapikeyauth": 28, "optionalauth": 28, "idempotencytoken": 29, "idempot": 29, "readonli": 29, "retryabl": 29, "pagin": 29, "continu": 29, "token": 29, "backward": 29, "compat": 29, "requestcompress": 29, "compress": 29, "constraint": 30, "enum": [30, 49], "idref": 30, "length": 30, "pattern": [30, 33], "privat": 30, "rang": 30, "requir": 30, "uniqueitem": 30, "equal": 30, "preced": 30, "deprec": 31, "errorexampl": 31, "externaldocument": 31, "intern": 31, "recommend": 31, "sensit": 31, "sinc": 31, "titl": 31, "unstabl": 31, "label": [32, 33, 48], "hostlabel": 32, "method": 33, "uri": 33, "liter": 33, "charact": [33, 34], "sequenc": 33, "greedi": 33, "conflict": [33, 37, 48], "avoid": 33, "httperror": 33, "httpheader": 33, "restrict": 33, "httplabel": 33, "httppayload": 33, "httpprefixhead": 33, "httpqueri": 33, "httpqueryparam": 33, "httpresponsecod": 33, "messag": [33, 38, 43], "event": [33, 38, 43], "stream": [33, 43], "idl": 34, "lexic": [34, 42], "note": [34, 42], "abnf": 34, "comment": 34, "control": 34, "section": 34, "statement": 34, "metadata": [34, 37, 38], "refer": [34, 36, 41], "syntact": 34, "simpl": [34, 36, 37, 45, 49], "node": [34, 37, 42], "escap": 34, "text": 34, "block": 34, "incident": 34, "white": 34, "space": 34, "remov": 34, "signific": 34, "convent": 35, "thi": 35, "tabl": 35, "ast": 36, "top": 36, "level": 36, "The": 37, "semant": 37, "aggreg": 37, "unit": 37, "recurs": [37, 42], "definit": [37, 48], "closur": 37, "implicit": [37, 41, 49], "explicit": 37, "put": 37, "creat": 37, "delet": 37, "extern": 37, "annot": 37, "break": 37, "chang": 37, "rule": 37, "merg": 37, "miss": 38, "sever": 38, "suppress": 38, "built": 38, "emiteachselector": 38, "emitnoneselector": 38, "prelud": 39, "protocoldefinit": 40, "jsonnam": 40, "mediatyp": 40, "timestampformat": 40, "noreplac": 41, "resourceidentifi": 41, "selector": 42, "match": 42, "attribut": [42, 45], "exist": 42, "comparison": 42, "compar": 42, "scope": 42, "context": [42, 51], "And": 42, "logic": 42, "multipl": 42, "case": 42, "insensit": 42, "neighbor": 42, "forward": 42, "undirect": 42, "direct": 42, "revers": 42, "relationship": 42, "topdown": 42, "var": 42, "grammar": 42, "deseri": 43, "blob": 43, "requireslength": 43, "initi": 43, "server": [43, 50, 51, 52, 53, 54, 55], "eventhead": 43, "eventpayload": 43, "refin": 44, "input": 44, "output": 44, "element": 45, "xmlname": 45, "wrap": 45, "flatten": 45, "xmlattribut": 45, "xmlflatten": 45, "xmlnamespac": 45, "httprequesttest": 46, "httpresponsetest": 46, "httpmalformedrequesttest": 46, "httpmalformedrequestdefinit": 46, "httpmalformedresponsedefinit": 46, "httpmalformedresponsebodydefinit": 46, "httpmalformedresponsebodyassert": 46, "malform": 46, "addit": 47, "index": 47, "mqtt": 48, "topic": 48, "publish": 48, "subscrib": 48, "topiclabel": 48, "waiter": 49, "waitabl": 49, "workflow": 49, "retri": 49, "why": 49, "exponenti": 49, "backoff": 49, "jitter": 49, "acceptor": 49, "acceptorst": 49, "matcher": 49, "pathmatch": 49, "jmespath": 49, "static": 49, "analysi": 49, "pathcompar": 49, "best": 49, "practic": 49, "keep": 49, "express": 49, "after": 49, "state": 49, "do": 49, "onli": 49, "termin": 49, "failur": 49, "typescript": [50, 51, 52, 53, 54, 55], "handl": 50, "synthet": 50, "unavoid": 50, "internalfailureexcept": 50, "serializationexcept": 50, "unknownoperationexcept": 50, "unsupportedmediatypeexcept": 50, "notacceptableexcept": 50, "handler": 51, "servicehandl": 51, "factori": 51, "flow": 53, "rest": 54, "lambda": 54}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 57}, "alltitles": {"smithy-build": [[0, "smithy-build"]], "Using smithy-build.json": [[0, "using-smithy-build-json"]], "Projections": [[0, "projections"]], "Projection artifacts": [[0, "projection-artifacts"]], "Transforms": [[0, "transforms"]], "apply": [[0, "apply"]], "changeStringEnumsToEnumShapes": [[0, "changestringenumstoenumshapes"]], "changeTypes": [[0, "changetypes"]], "excludeShapesByTag": [[0, "excludeshapesbytag"]], "excludeShapesByTrait": [[0, "excludeshapesbytrait"]], "includeShapesByTag": [[0, "includeshapesbytag"]], "includeNamespaces": [[0, "includenamespaces"]], "includeServices": [[0, "includeservices"]], "excludeTags": [[0, "excludetags"]], "excludeTraits": [[0, "excludetraits"]], "excludeTraitsByTag": [[0, "excludetraitsbytag"]], "filterSuppressions": [[0, "filtersuppressions"]], "includeTags": [[0, "includetags"]], "includeTraits": [[0, "includetraits"]], "includeTraitsByTag": [[0, "includetraitsbytag"]], "excludeMetadata": [[0, "excludemetadata"]], "includeMetadata": [[0, "includemetadata"]], "flattenNamespaces": [[0, "flattennamespaces"]], "removeTraitDefinitions": [[0, "removetraitdefinitions"]], "removeUnusedShapes": [[0, "removeunusedshapes"]], "renameShapes": [[0, "renameshapes"]], "Environment variables": [[0, "environment-variables"]], "Plugins": [[0, "plugins"]], "model plugin": [[0, "model-plugin"]], "build-info plugin": [[0, "build-info-plugin"]], "sources plugin": [[0, "sources-plugin"]], "Smithy Gradle Plugin": [[1, "smithy-gradle-plugin"]], "Installation": [[1, "installation"]], "Smithy model sources": [[1, "smithy-model-sources"]], "Building Smithy models": [[1, "building-smithy-models"]], "Smithy extension properties": [[1, "smithy-extension-properties"]], "Building a source model": [[1, "building-a-source-model"]], "Generating a projection": [[1, "generating-a-projection"]], "Projection tags": [[1, "projection-tags"]], "Building artifacts from Smithy models": [[1, "building-artifacts-from-smithy-models"]], "Complete Examples": [[1, "complete-examples"]], "Building Smithy Models": [[2, "building-smithy-models"]], "Build system overview": [[2, "build-system-overview"]], "Build system guides": [[2, "build-system-guides"]], "Converting Smithy to OpenAPI": [[3, "converting-smithy-to-openapi"]], "Introduction": [[3, "introduction"], [5, "introduction"], [38, "introduction"], [42, "introduction"], [48, "introduction"]], "Differences between Smithy and OpenAPI": [[3, "differences-between-smithy-and-openapi"]], "Unsupported features": [[3, "unsupported-features"]], "Converting to OpenAPI with smithy-build": [[3, "converting-to-openapi-with-smithy-build"]], "OpenAPI configuration settings": [[3, "openapi-configuration-settings"]], "JSON schema configuration settings": [[3, "json-schema-configuration-settings"], [5, "json-schema-configuration-settings"]], "Security schemes": [[3, "security-schemes"]], "@examples trait conversion": [[3, "examples-trait-conversion"]], "Amazon API Gateway extensions": [[3, "amazon-api-gateway-extensions"]], "Amazon API Gateway configuration settings": [[3, "amazon-api-gateway-configuration-settings"]], "Binary types": [[3, "binary-types"]], "Request validators": [[3, "request-validators"]], "Integrations": [[3, "integrations"]], "CORS functionality": [[3, "cors-functionality"]], "Authorizers": [[3, "authorizers"]], "AWS CloudFormation substitutions": [[3, "aws-cloudformation-substitutions"]], "Amazon Cognito User Pools": [[3, "amazon-cognito-user-pools"]], "Amazon API Gateway API key usage plans": [[3, "amazon-api-gateway-api-key-usage-plans"]], "Other traits that influence API Gateway": [[3, "other-traits-that-influence-api-gateway"]], "Converting to OpenAPI with code": [[3, "converting-to-openapi-with-code"]], "Evolving Models": [[4, "evolving-models"]], "Updating services": [[4, "updating-services"]], "Updating operations": [[4, "updating-operations"]], "Updating structures": [[4, "updating-structures"]], "Booleans and API evolution": [[4, "booleans-and-api-evolution"]], "Updating unions": [[4, "updating-unions"]], "Boxed shapes": [[4, "boxed-shapes"]], "Sparse lists and maps": [[4, "sparse-lists-and-maps"]], "Updating traits": [[4, "updating-traits"]], "Using Smithy Diff": [[4, "using-smithy-diff"]], "Generating CloudFormation Resource Schemas from Smithy": [[5, "generating-cloudformation-resource-schemas-from-smithy"]], "Differences between Smithy resources and CloudFormation Resource Schemas": [[5, "differences-between-smithy-resources-and-cloudformation-resource-schemas"]], "Generating Schemas with smithy-build": [[5, "generating-schemas-with-smithy-build"]], "CloudFormation configuration settings": [[5, "cloudformation-configuration-settings"]], "Other traits that influence generation": [[5, "other-traits-that-influence-generation"]], "Generating Schemas with code": [[5, "generating-schemas-with-code"]], "Smithy Guides": [[6, "smithy-guides"]], "Model linters": [[7, "model-linters"]], "Linting overview": [[7, "linting-overview"]], "Linters in smithy-linters": [[7, "linters-in-smithy-linters"]], "AbbreviationName": [[7, "abbreviationname"]], "CamelCase": [[7, "camelcase"]], "NoninclusiveTerms": [[7, "noninclusiveterms"]], "ReservedWords": [[7, "reservedwords"]], "Wildcards in ReservedWords": [[7, "wildcards-in-reservedwords"]], "StandardOperationVerb": [[7, "standardoperationverb"]], "RepeatedShapeName": [[7, "repeatedshapename"]], "InputOutputStructureReuse": [[7, "inputoutputstructurereuse"]], "MissingPaginatedTrait": [[7, "missingpaginatedtrait"]], "ShouldHaveUsedTimestamp": [[7, "shouldhaveusedtimestamp"]], "Writing custom validators": [[7, "writing-custom-validators"]], "Writing custom Linters": [[7, "writing-custom-linters"]], "Style Guide": [[8, "style-guide"]], "Model files": [[8, "model-files"]], "File encoding": [[8, "file-encoding"]], "New lines": [[8, "new-lines"]], "Model file structure": [[8, "model-file-structure"]], "Formatting": [[8, "formatting"]], "Indentation": [[8, "indentation"]], "Whitespace": [[8, "whitespace"]], "Trailing commas": [[8, "trailing-commas"]], "Naming": [[8, "naming"]], "Shape names": [[8, "shape-names"]], "Member names": [[8, "member-names"]], "Trait names": [[8, "trait-names"]], "Abbreviations": [[8, "abbreviations"]], "Namespace names": [[8, "namespace-names"]], "Smithy": [[9, "smithy"]], "Read more": [[9, "read-more"]], "Documentation": [[9, null]], "Implementations": [[9, null]], "Project links": [[9, null]], "Quick start": [[10, "quick-start"]], "What is Smithy?": [[10, "what-is-smithy"]], "Shapes and traits": [[10, "shapes-and-traits"]], "Weather Service": [[10, "weather-service"]], "What's that syntax?": [[10, null]], "Defining resources": [[10, "defining-resources"]], "Review": [[10, null], [10, null], [10, null]], "Defining operations": [[10, "defining-operations"]], "Listing resources": [[10, "listing-resources"]], "Non-Lifecycle Operations": [[10, "non-lifecycle-operations"]], "Building the Model": [[10, "building-the-model"]], "Next steps": [[10, "next-steps"]], "Complete example": [[10, "complete-example"]], "Amazon API Gateway traits": [[11, "amazon-api-gateway-traits"]], "aws.apigateway#apiKeySource trait": [[11, "aws-apigateway-apikeysource-trait"]], "aws.apigateway#authorizers trait": [[11, "aws-apigateway-authorizers-trait"]], "aws.apigateway#authorizer trait": [[11, "aws-apigateway-authorizer-trait"]], "aws.apigateway#requestValidator trait": [[11, "aws-apigateway-requestvalidator-trait"]], "aws.apigateway#integration trait": [[11, "aws-apigateway-integration-trait"]], "aws.apigateway#mockIntegration trait": [[11, "aws-apigateway-mockintegration-trait"]], "Shared trait data types": [[11, "shared-trait-data-types"]], "ContentHandling string": [[11, "contenthandling-string"]], "requestParameters structure": [[11, "requestparameters-structure"]], "requestTemplates structure": [[11, "requesttemplates-structure"]], "responses structure": [[11, "responses-structure"]], "response structure": [[11, "response-structure"]], "Response templates structure": [[11, "response-templates-structure"]], "Response parameters structure": [[11, "response-parameters-structure"]], "AWS Authentication Traits": [[12, "aws-authentication-traits"]], "aws.auth#sigv4 trait": [[12, "aws-auth-sigv4-trait"]], "aws.auth#unsignedPayload trait": [[12, "aws-auth-unsignedpayload-trait"]], "Unsigned Payloads and signature version 4": [[12, "unsigned-payloads-and-signature-version-4"]], "aws.auth#cognitoUserPools trait": [[12, "aws-auth-cognitouserpools-trait"]], "AWS CloudFormation traits": [[13, "aws-cloudformation-traits"]], "aws.cloudformation#cfnResource trait": [[13, "aws-cloudformation-cfnresource-trait"]], "Resource properties": [[13, "resource-properties"]], "aws.cloudformation#cfnExcludeProperty trait": [[13, "aws-cloudformation-cfnexcludeproperty-trait"]], "Property mutability": [[13, "property-mutability"]], "aws.cloudformation#cfnMutability trait": [[13, "aws-cloudformation-cfnmutability-trait"]], "aws.cloudformation#cfnName trait": [[13, "aws-cloudformation-cfnname-trait"]], "aws.cloudformation#cfnAdditionalIdentifier trait": [[13, "aws-cloudformation-cfnadditionalidentifier-trait"]], "aws.cloudformation#cfnDefaultValue trait": [[13, "aws-cloudformation-cfndefaultvalue-trait"]], "Example model": [[13, "example-model"]], "AWS Core Specification": [[14, "aws-core-specification"]], "aws.api#service trait": [[14, "aws-api-service-trait"]], "sdkId": [[14, "sdkid"]], "Choosing an SDK service ID": [[14, "choosing-an-sdk-service-id"]], "Using SDK service ID for client naming": [[14, "using-sdk-service-id-for-client-naming"]], "cloudFormationName": [[14, "cloudformationname"]], "arnNamespace": [[14, "arnnamespace"]], "cloudTrailEventSource": [[14, "cloudtraileventsource"]], "docId": [[14, "docid"]], "endpointPrefix": [[14, "endpointprefix"]], "aws.api#arn trait": [[14, "aws-api-arn-trait"]], "Format of an ARN": [[14, "format-of-an-arn"]], "Relative ARN templates": [[14, "relative-arn-templates"]], "Using an ARN as a resource identifier": [[14, "using-an-arn-as-a-resource-identifier"]], "aws.api#arnReference trait": [[14, "aws-api-arnreference-trait"]], "aws.api#data trait": [[14, "aws-api-data-trait"]], "Data Classifications": [[14, "data-classifications"]], "aws.api#controlPlane trait": [[14, "aws-api-controlplane-trait"]], "aws.api#dataPlane trait": [[14, "aws-api-dataplane-trait"]], "Client Endpoint Discovery": [[14, "client-endpoint-discovery"]], "aws.api#clientEndpointDiscovery trait": [[14, "aws-api-clientendpointdiscovery-trait"]], "aws.api#clientDiscoveredEndpoint trait": [[14, "aws-api-clientdiscoveredendpoint-trait"]], "aws.api#clientEndpointDiscoveryId trait": [[14, "aws-api-clientendpointdiscoveryid-trait"]], "Example Model": [[14, "example-model"]], "Client Behavior": [[14, "client-behavior"], [32, "client-behavior"]], "Caching": [[14, "caching"]], "aws.protocols#httpChecksum trait": [[14, "aws-protocols-httpchecksum-trait"]], "Client behavior": [[14, "aws-protocols-httpchecksum-trait-behavior"], [29, "client-behavior"], [43, "client-behavior"]], "HTTP request checksums": [[14, "http-request-checksums"], [14, "id10"]], "HTTP response checksums": [[14, "http-response-checksums"], [14, "id11"]], "Service behavior": [[14, "service-behavior"]], "Resolving checksum name": [[14, "resolving-checksum-name"]], "Resolving checksum location": [[14, "resolving-checksum-location"]], "Behavior with httpChecksumRequired": [[14, "behavior-with-httpchecksumrequired"]], "Appendix": [[14, "appendix"]], "Appendix A: Example SDK service IDs": [[14, "appendix-a-example-sdk-service-ids"]], "AWS EC2 query protocol": [[15, "aws-ec2-query-protocol"]], "aws.protocols#ec2Query trait": [[15, "aws-protocols-ec2query-trait"]], "aws.protocols#ec2QueryName trait": [[15, "aws-protocols-ec2queryname-trait"]], "Query key resolution": [[15, "query-key-resolution"], [19, "query-key-resolution"]], "Supported traits": [[15, "supported-traits"], [17, "supported-traits"], [18, "supported-traits"], [19, "supported-traits"], [20, "supported-traits"], [21, "supported-traits"]], "Request serialization": [[15, "request-serialization"], [19, "request-serialization"]], "x-www-form-urlencoded shape serialization": [[15, "x-www-form-urlencoded-shape-serialization"], [19, "x-www-form-urlencoded-shape-serialization"]], "Examples": [[15, "examples"]], "Structures and Unions": [[15, "structures-and-unions"]], "Collections": [[15, "collections"], [19, "collections"]], "Response serialization": [[15, "response-serialization"], [19, "response-serialization"]], "XML shape serialization": [[15, "xml-shape-serialization"], [19, "xml-shape-serialization"], [21, "xml-shape-serialization"]], "Operation error serialization": [[15, "operation-error-serialization"], [17, "operation-error-serialization"], [18, "operation-error-serialization"], [19, "operation-error-serialization"], [20, "operation-error-serialization"]], "Non-numeric float and double serialization": [[15, "non-numeric-float-and-double-serialization"], [17, "non-numeric-float-and-double-serialization"], [18, "non-numeric-float-and-double-serialization"], [19, "non-numeric-float-and-double-serialization"], [20, "non-numeric-float-and-double-serialization"], [21, "non-numeric-float-and-double-serialization"]], "Protocol compliance tests": [[15, "protocol-compliance-tests"], [17, "protocol-compliance-tests"], [18, "protocol-compliance-tests"], [19, "protocol-compliance-tests"], [20, "protocol-compliance-tests"], [21, "protocol-compliance-tests"]], "Error shape renaming": [[15, "error-shape-renaming"], [17, "error-shape-renaming"], [18, "error-shape-renaming"], [19, "error-shape-renaming"], [20, "error-shape-renaming"], [21, "error-shape-renaming"]], "AWS IAM traits": [[16, "aws-iam-traits"]], "aws.iam#actionPermissionDescription trait": [[16, "aws-iam-actionpermissiondescription-trait"]], "aws.iam#conditionKeys trait": [[16, "aws-iam-conditionkeys-trait"]], "aws.iam#defineConditionKeys trait": [[16, "aws-iam-defineconditionkeys-trait"]], "Condition Key Types": [[16, "condition-key-types"]], "aws.iam#disableConditionKeyInference trait": [[16, "aws-iam-disableconditionkeyinference-trait"]], "aws.iam#requiredActions trait": [[16, "aws-iam-requiredactions-trait"]], "aws.iam#supportedPrincipalTypes trait": [[16, "aws-iam-supportedprincipaltypes-trait"]], "aws.iam#iamResource trait": [[16, "aws-iam-iamresource-trait"]], "Deriving Condition Keys": [[16, "deriving-condition-keys"]], "AWS JSON 1.0 protocol": [[17, "aws-json-1-0-protocol"]], "aws.protocols#awsJson1_0 trait": [[17, "aws-protocols-awsjson1-0-trait"]], "Protocol Behaviors": [[17, "protocol-behaviors"], [18, "protocol-behaviors"]], "Shape serialization": [[17, "shape-serialization"], [18, "shape-serialization"]], "Empty body serialization": [[17, "empty-body-serialization"], [18, "empty-body-serialization"]], "Differences between awsJson1_0 and awsJson1_1": [[17, "differences-between-awsjson1-0-and-awsjson1-1"], [18, "differences-between-awsjson1-0-and-awsjson1-1"]], "AWS JSON 1.1 protocol": [[18, "aws-json-1-1-protocol"]], "aws.protocols#awsJson1_1 trait": [[18, "aws-protocols-awsjson1-1-trait"]], "AWS query protocol": [[19, "aws-query-protocol"]], "Overview": [[19, "overview"], [46, "overview"]], "Example requests": [[19, "example-requests"]], "Structures and unions": [[19, "structures-and-unions"]], "Maps": [[19, "maps"]], "Error HTTP response status code resolution": [[19, "error-http-response-status-code-resolution"]], "Error \"Code\" resolution": [[19, "error-code-resolution"]], "aws.protocols#awsQuery trait": [[19, "aws-protocols-awsquery-trait"]], "aws.protocols#awsQueryError trait": [[19, "aws-protocols-awsqueryerror-trait"]], "aws.protocols#awsQueryCompatible trait": [[19, "aws-protocols-awsquerycompatible-trait"]], "AWS restJson1 protocol": [[20, "aws-restjson1-protocol"]], "aws.protocols#restJson1 trait": [[20, "aws-protocols-restjson1-trait"]], "Content-Type": [[20, "content-type"], [21, "content-type"]], "JSON shape serialization": [[20, "json-shape-serialization"]], "HTTP binding serialization": [[20, "http-binding-serialization"], [21, "http-binding-serialization"]], "AWS restXml protocol": [[21, "aws-restxml-protocol"]], "aws.protocols#restXml trait": [[21, "aws-protocols-restxml-trait"]], "Error response serialization": [[21, "error-response-serialization"]], "Amazon API Gateway Customizations": [[22, "amazon-api-gateway-customizations"]], "Accept header": [[22, "accept-header"]], "Amazon Glacier Customizations": [[23, "amazon-glacier-customizations"]], "X-Amz-Glacier-Version header": [[23, "x-amz-glacier-version-header"]], "Default value for accountId": [[23, "default-value-for-accountid"]], "Default checksum generation": [[23, "default-checksum-generation"]], "AWS Service Customizations": [[24, "aws-service-customizations"], [27, "aws-service-customizations"]], "Amazon Machine Learning Customizations": [[25, "amazon-machine-learning-customizations"]], "Set host to value of PredictEndpoint": [[25, "set-host-to-value-of-predictendpoint"]], "Amazon S3 Customizations": [[26, "amazon-s3-customizations"]], "S3 Bucket Addressing": [[26, "s3-bucket-addressing"]], "S3 Bucket Virtual Hosting": [[26, "s3-bucket-virtual-hosting"]], "S3 Dual-Stack Endpoints": [[26, "s3-dual-stack-endpoints"]], "S3 Transfer Acceleration Endpoints": [[26, "s3-transfer-acceleration-endpoints"]], "S3 Traits": [[26, "s3-traits"]], "aws.customizations#s3UnwrappedXmlOutput trait": [[26, "aws-customizations-s3unwrappedxmloutput-trait"]], "AWS specifications": [[27, "aws-specifications"], [47, "aws-specifications"]], "AWS Protocols": [[27, "aws-protocols"]], "Authentication traits": [[28, "authentication-traits"]], "authDefinition trait": [[28, "authdefinition-trait"]], "httpBasicAuth trait": [[28, "httpbasicauth-trait"]], "httpDigestAuth trait": [[28, "httpdigestauth-trait"]], "httpBearerAuth trait": [[28, "httpbearerauth-trait"]], "httpApiKeyAuth trait": [[28, "httpapikeyauth-trait"]], "optionalAuth trait": [[28, "optionalauth-trait"]], "auth trait": [[28, "auth-trait"]], "Behavior traits": [[29, "behavior-traits"]], "idempotencyToken trait": [[29, "idempotencytoken-trait"]], "idempotent trait": [[29, "idempotent-trait"]], "readonly trait": [[29, "readonly-trait"]], "retryable trait": [[29, "retryable-trait"]], "paginated trait": [[29, "paginated-trait"]], "Pagination Behavior": [[29, "pagination-behavior"]], "Continuation tokens": [[29, "continuation-tokens"]], "Backward compatibility": [[29, "backward-compatibility"], [29, "id8"]], "httpChecksumRequired trait": [[29, "httpchecksumrequired-trait"]], "requestCompression trait": [[29, "requestcompression-trait"]], "Request compression behavior": [[29, "request-compression-behavior"]], "Client Implementation": [[29, "client-implementation"]], "Constraint traits": [[30, "constraint-traits"]], "enum trait": [[30, "enum-trait"]], "idRef trait": [[30, "idref-trait"]], "length trait": [[30, "length-trait"]], "pattern trait": [[30, "pattern-trait"]], "private trait": [[30, "private-trait"]], "range trait": [[30, "range-trait"]], "required trait": [[30, "required-trait"]], "uniqueItems trait": [[30, "uniqueitems-trait"]], "Value equality": [[30, "value-equality"]], "Trait precedence": [[30, "trait-precedence"]], "Documentation traits": [[31, "documentation-traits"]], "deprecated trait": [[31, "deprecated-trait"]], "documentation trait": [[31, "documentation-trait"]], "examples trait": [[31, "examples-trait"]], "ErrorExample structure": [[31, "errorexample-structure"]], "externalDocumentation trait": [[31, "externaldocumentation-trait"]], "internal trait": [[31, "internal-trait"]], "recommended trait": [[31, "recommended-trait"]], "sensitive trait": [[31, "sensitive-trait"]], "since trait": [[31, "since-trait"]], "tags trait": [[31, "tags-trait"]], "title trait": [[31, "title-trait"]], "unstable trait": [[31, "unstable-trait"]], "Endpoint Traits": [[32, "endpoint-traits"]], "endpoint trait": [[32, "endpoint-trait"]], "Labels": [[32, "labels"], [33, "labels"]], "hostLabel trait": [[32, "hostlabel-trait"]], "HTTP binding traits": [[33, "http-binding-traits"]], "http trait": [[33, "http-trait"]], "method": [[33, "method"]], "uri": [[33, "uri"]], "Literal character sequences": [[33, "literal-character-sequences"]], "Query string literals": [[33, "query-string-literals"]], "Greedy labels": [[33, "greedy-labels"]], "Pattern Validation and Conflict Avoidance": [[33, "pattern-validation-and-conflict-avoidance"]], "httpError trait": [[33, "httperror-trait"]], "httpHeader trait": [[33, "httpheader-trait"]], "Restricted HTTP headers": [[33, "restricted-http-headers"]], "httpLabel trait": [[33, "httplabel-trait"]], "httpPayload trait": [[33, "httppayload-trait"]], "httpPrefixHeaders trait": [[33, "httpprefixheaders-trait"]], "httpQuery trait": [[33, "httpquery-trait"]], "httpQueryParams trait": [[33, "httpqueryparams-trait"]], "httpResponseCode trait": [[33, "httpresponsecode-trait"]], "cors trait": [[33, "cors-trait"]], "Serializing HTTP messages": [[33, "serializing-http-messages"]], "Event streams": [[33, "event-streams"], [43, "event-streams"]], "Smithy IDL": [[34, "smithy-idl"]], "Smithy IDL overview": [[34, "smithy-idl-overview"]], "Lexical notes": [[34, "lexical-notes"]], "Smithy IDL ABNF": [[34, "smithy-idl-abnf"]], "Comments": [[34, "comments"]], "Control section": [[34, "control-section"]], "Version statement": [[34, "version-statement"]], "Metadata section": [[34, "metadata-section"]], "Shape section": [[34, "shape-section"]], "Namespaces": [[34, "namespaces"]], "Referring to shapes": [[34, "referring-to-shapes"]], "Relative shape ID resolution": [[34, "relative-shape-id-resolution"]], "Syntactic shape IDs": [[34, "syntactic-shape-ids"]], "Defining shapes": [[34, "defining-shapes"]], "Simple shapes": [[34, "simple-shapes"], [36, "simple-shapes"], [37, "simple-shapes"]], "List shapes": [[34, "list-shapes"]], "Set shapes": [[34, "set-shapes"]], "Map shapes": [[34, "map-shapes"]], "Structure shapes": [[34, "structure-shapes"]], "Union shapes": [[34, "union-shapes"]], "Service shape": [[34, "service-shape"], [36, "service-shape"]], "Operation shape": [[34, "operation-shape"], [36, "operation-shape"]], "Resource shape": [[34, "resource-shape"], [36, "resource-shape"]], "Documentation comment": [[34, "documentation-comment"]], "Applying traits": [[34, "applying-traits"]], "Trait values": [[34, "trait-values"]], "Structure, map, and union trait values": [[34, "structure-map-and-union-trait-values"]], "List and set trait values": [[34, "list-and-set-trait-values"]], "Other trait values": [[34, "other-trait-values"]], "Apply statement": [[34, "apply-statement"]], "Node values": [[34, "node-values"], [37, "node-values"]], "String values": [[34, "string-values"]], "String escape characters": [[34, "string-escape-characters"]], "Text blocks": [[34, "text-blocks"]], "Incidental white space removal": [[34, "incidental-white-space-removal"]], "Significant trailing line": [[34, "significant-trailing-line"]], "Escapes in text blocks": [[34, "escapes-in-text-blocks"]], "Smithy specification": [[35, "smithy-specification"], [47, "smithy-specification"]], "Conventions used in this document": [[35, "conventions-used-in-this-document"]], "Table of contents": [[35, "table-of-contents"]], "JSON AST": [[36, "json-ast"]], "Top level properties": [[36, "top-level-properties"]], "AST shapes": [[36, "ast-shapes"]], "List and set shapes": [[36, "list-and-set-shapes"]], "AST member": [[36, "ast-member"]], "AST shape reference": [[36, "ast-shape-reference"]], "Map shape": [[36, "map-shape"]], "Structure and union shapes": [[36, "structure-and-union-shapes"]], "AST apply type": [[36, "ast-apply-type"]], "The Smithy model": [[37, "the-smithy-model"]], "Smithy overview": [[37, "smithy-overview"]], "The semantic model": [[37, "the-semantic-model"]], "Shapes": [[37, "shapes"]], "Shape ID": [[37, "shape-id"]], "Shape ID conflicts": [[37, "shape-id-conflicts"]], "Aggregate shapes": [[37, "aggregate-shapes"]], "Member": [[37, "member"]], "List": [[37, "list"]], "Set": [[37, "set"]], "Map": [[37, "map"]], "Structure": [[37, "structure"]], "Default structure member values": [[37, "default-structure-member-values"]], "Union": [[37, "union"]], "Unit type": [[37, "unit-type"]], "Recursive shape definitions": [[37, "recursive-shape-definitions"]], "Service shapes": [[37, "service-shapes"]], "Service": [[37, "service"]], "Service operations": [[37, "service-operations"]], "Service resources": [[37, "service-resources"]], "Service closure": [[37, "service-closure"]], "Operation": [[37, "operation"]], "Resource": [[37, "resource"]], "Resource Identifiers": [[37, "resource-identifiers"]], "Binding identifiers to operations": [[37, "binding-identifiers-to-operations"]], "Implicit identifier bindings": [[37, "implicit-identifier-bindings"]], "Explicit identifier bindings": [[37, "explicit-identifier-bindings"]], "Resource lifecycle operations": [[37, "resource-lifecycle-operations"]], "Put lifecycle": [[37, "put-lifecycle"]], "Create lifecycle": [[37, "create-lifecycle"]], "Read lifecycle": [[37, "read-lifecycle"]], "Update lifecycle": [[37, "update-lifecycle"]], "Delete lifecycle": [[37, "delete-lifecycle"]], "List lifecycle": [[37, "list-lifecycle"]], "Traits": [[37, "traits"]], "Applying traits to shapes": [[37, "applying-traits-to-shapes"]], "Applying traits externally": [[37, "applying-traits-externally"]], "Trait conflict resolution": [[37, "trait-conflict-resolution"]], "Trait node values": [[37, "trait-node-values"]], "Defining traits": [[37, "defining-traits"]], "Annotation traits": [[37, "annotation-traits"]], "Trait breaking change rules": [[37, "trait-breaking-change-rules"]], "Model metadata": [[37, "model-metadata"]], "Merging metadata": [[37, "merging-metadata"]], "Node value types": [[37, "node-value-types"]], "Merging model files": [[37, "merging-model-files"]], "Model validation": [[38, "model-validation"]], "Validators": [[38, "validators"]], "Missing validators": [[38, "missing-validators"]], "Severity": [[38, "severity"]], "Suppressions": [[38, "suppressions"]], "suppress trait": [[38, "suppress-trait"]], "Suppression metadata": [[38, "suppression-metadata"]], "Built-in validators": [[38, "built-in-validators"]], "EmitEachSelector": [[38, "emiteachselector"]], "Binding events to traits": [[38, "binding-events-to-traits"]], "Message templates": [[38, "message-templates"]], "Variable message formatting": [[38, "variable-message-formatting"]], "EmitNoneSelector": [[38, "emitnoneselector"]], "Prelude model": [[39, "prelude-model"]], "Prelude shapes": [[39, "prelude-shapes"]], "Protocol traits": [[40, "protocol-traits"]], "protocolDefinition trait": [[40, "protocoldefinition-trait"]], "jsonName trait": [[40, "jsonname-trait"]], "mediaType trait": [[40, "mediatype-trait"]], "timestampFormat trait": [[40, "timestampformat-trait"]], "Resource traits": [[41, "resource-traits"]], "noReplace trait": [[41, "noreplace-trait"]], "references trait": [[41, "references-trait"]], "Implicit ids": [[41, "implicit-ids"]], "resourceIdentifier trait": [[41, "resourceidentifier-trait"]], "Selectors": [[42, "selectors"]], "Matching shapes with selectors": [[42, "matching-shapes-with-selectors"]], "Matching shapes by type": [[42, "matching-shapes-by-type"]], "Attribute selectors": [[42, "attribute-selectors"]], "Attribute existence": [[42, "attribute-existence"]], "Attribute comparison": [[42, "attribute-comparison"]], "String comparators": [[42, "string-comparators"]], "Numeric comparators": [[42, "numeric-comparators"]], "Attributes": [[42, "attributes"]], "id attribute": [[42, "id-attribute"]], "service attribute": [[42, "service-attribute"]], "trait attribute": [[42, "trait-attribute"]], "Node attribute": [[42, "node-attribute"]], "Empty attribute": [[42, "empty-attribute"]], "Projection attribute": [[42, "projection-attribute"]], "Comparisons to non-projections": [[42, "comparisons-to-non-projections"]], "Comparisons to projections": [[42, "comparisons-to-projections"]], "Projection comparators": [[42, "projection-comparators"]], "Scoped attribute selectors": [[42, "scoped-attribute-selectors"]], "Context values": [[42, "context-values"]], "And-logic": [[42, "and-logic"]], "Matching multiple values": [[42, "matching-multiple-values"]], "Case insensitive comparisons": [[42, "case-insensitive-comparisons"]], "Neighbors": [[42, "neighbors"]], "Forward undirected neighbor": [[42, "forward-undirected-neighbor"]], "Forward directed neighbors": [[42, "forward-directed-neighbors"]], "Forward recursive neighbors": [[42, "forward-recursive-neighbors"]], "Reverse undirected neighbor": [[42, "reverse-undirected-neighbor"]], "Reverse directed neighbor": [[42, "reverse-directed-neighbor"]], "Relationships": [[42, "relationships"]], "Functions": [[42, "functions"]], ":test": [[42, "test"]], ":is": [[42, "is"]], ":not": [[42, "not"]], ":topdown": [[42, "topdown"]], "Variables": [[42, "variables"]], "var attribute": [[42, "var-attribute"]], "Grammar": [[42, "grammar"]], "Lexical note": [[42, null]], "Compliance Tests": [[42, "compliance-tests"]], "Streaming Traits": [[43, "streaming-traits"]], "streaming trait": [[43, "streaming-trait"]], "Deserializing streaming blobs": [[43, "deserializing-streaming-blobs"]], "requiresLength trait": [[43, "requireslength-trait"]], "Modeled errors in event streams": [[43, "modeled-errors-in-event-streams"]], "Initial messages": [[43, "initial-messages"]], "Initial-request": [[43, "initial-request"]], "Initial-response": [[43, "initial-response"]], "Initial message client and server behavior": [[43, "initial-message-client-and-server-behavior"]], "Event message serialization": [[43, "event-message-serialization"]], "Event stream traits": [[43, "event-stream-traits"]], "eventHeader trait": [[43, "eventheader-trait"]], "eventPayload trait": [[43, "eventpayload-trait"]], "Type refinement traits": [[44, "type-refinement-traits"]], "box trait": [[44, "box-trait"]], "error trait": [[44, "error-trait"]], "input trait": [[44, "input-trait"]], "output trait": [[44, "output-trait"]], "sparse trait": [[44, "sparse-trait"]], "XML binding traits": [[45, "xml-binding-traits"]], "Serializing XML shapes": [[45, "serializing-xml-shapes"]], "Structure and union serialization": [[45, "structure-and-union-serialization"]], "Custom XML element names": [[45, "custom-xml-element-names"]], "XML attributes": [[45, "xml-attributes"]], "xmlName on structures and unions": [[45, "xmlname-on-structures-and-unions"]], "Simple type serialization": [[45, "simple-type-serialization"]], "List and set serialization": [[45, "list-and-set-serialization"]], "Wrapped list serialization": [[45, "wrapped-list-serialization"]], "Flattened list serialization": [[45, "flattened-list-serialization"]], "Map serialization": [[45, "map-serialization"]], "Wrapped map serialization": [[45, "wrapped-map-serialization"]], "Flattened map serialization": [[45, "flattened-map-serialization"]], "xmlAttribute trait": [[45, "xmlattribute-trait"]], "xmlFlattened trait": [[45, "xmlflattened-trait"]], "xmlName trait": [[45, "xmlname-trait"]], "xmlNamespace trait": [[45, "xmlnamespace-trait"]], "HTTP Protocol Compliance Tests": [[46, "http-protocol-compliance-tests"]], "Parameter format": [[46, "parameter-format"]], "httpRequestTests": [[46, "httprequesttests"]], "HTTP request example": [[46, "http-request-example"]], "httpResponseTests": [[46, "httpresponsetests"]], "HTTP response example": [[46, "http-response-example"]], "HTTP error response example": [[46, "http-error-response-example"]], "httpMalformedRequestTests": [[46, "httpmalformedrequesttests"]], "HttpMalformedRequestDefinition": [[46, "httpmalformedrequestdefinition"]], "HttpMalformedResponseDefinition": [[46, "httpmalformedresponsedefinition"]], "HttpMalformedResponseBodyDefinition": [[46, "httpmalformedresponsebodydefinition"]], "HttpMalformedResponseBodyAssertion": [[46, "httpmalformedresponsebodyassertion"]], "HTTP malformed request example": [[46, "http-malformed-request-example"]], "Specifications": [[47, "specifications"]], "Additional specifications": [[47, "additional-specifications"]], "Trait Index": [[47, "trait-index"]], "MQTT Protocol Bindings": [[48, "mqtt-protocol-bindings"]], "MQTT overview": [[48, "mqtt-overview"]], "MQTT topic templates": [[48, "mqtt-topic-templates"]], "smithy.mqtt#publish trait": [[48, "smithy-mqtt-publish-trait"]], "Publish validation": [[48, "publish-validation"]], "smithy.mqtt#subscribe trait": [[48, "smithy-mqtt-subscribe-trait"]], "Subscribe validation": [[48, "subscribe-validation"]], "smithy.mqtt#topicLabel trait": [[48, "smithy-mqtt-topiclabel-trait"]], "Label serialization": [[48, "label-serialization"]], "Topic conflicts": [[48, "topic-conflicts"]], "Model definition": [[48, "model-definition"]], "Waiters": [[49, "waiters"]], "smithy.waiters#waitable trait": [[49, "smithy-waiters-waitable-trait"]], "Waiter names": [[49, "waiter-names"]], "Waiter workflow": [[49, "waiter-workflow"]], "Waiter retries": [[49, "waiter-retries"]], "Why exponential backoff with jitter?": [[49, "why-exponential-backoff-with-jitter"]], "Waiter structure": [[49, "waiter-structure"]], "Acceptor structure": [[49, "acceptor-structure"]], "AcceptorState enum": [[49, "acceptorstate-enum"]], "Matcher union": [[49, "matcher-union"]], "PathMatcher structure": [[49, "pathmatcher-structure"]], "JMESPath data model": [[49, "jmespath-data-model"]], "JMESPath static analysis": [[49, "jmespath-static-analysis"]], "PathComparator enum": [[49, "pathcomparator-enum"]], "Waiter examples": [[49, "waiter-examples"]], "Waiter best-practices": [[49, "waiter-best-practices"]], "Keep JMESPath expressions simple": [[49, "keep-jmespath-expressions-simple"]], "Name waiters after the resource and state": [[49, "name-waiters-after-the-resource-and-state"]], "Do not model implicit acceptors": [[49, "do-not-model-implicit-acceptors"]], "Only model terminal failure states": [[49, "only-model-terminal-failure-states"]], "Smithy Server Generator for TypeScript error handling": [[50, "smithy-server-generator-for-typescript-error-handling"]], "Synthetic errors": [[50, "synthetic-errors"]], "Unavoidable errors": [[50, "unavoidable-errors"]], "InternalFailureException": [[50, "internalfailureexception"]], "SerializationException": [[50, "serializationexception"]], "UnknownOperationException": [[50, "unknownoperationexception"]], "Protocol errors": [[50, "protocol-errors"]], "UnsupportedMediaTypeException": [[50, "unsupportedmediatypeexception"]], "NotAcceptableException": [[50, "notacceptableexception"]], "Smithy Server Generator for TypeScript handlers": [[51, "smithy-server-generator-for-typescript-handlers"]], "ServiceHandler factories": [[51, "servicehandler-factories"]], "Contexts": [[51, "contexts"]], "Smithy Server Generator for TypeScript": [[52, "smithy-server-generator-for-typescript"]], "Introduction to the Smithy Server Generator for TypeScript": [[53, "introduction-to-the-smithy-server-generator-for-typescript"]], "Data flow": [[53, "data-flow"]], "Smithy Server Generator for TypeScript supported endpoints": [[54, "smithy-server-generator-for-typescript-supported-endpoints"]], "Amazon API Gateway REST APIs and AWS Lambda": [[54, "amazon-api-gateway-rest-apis-and-aws-lambda"]], "Smithy Server Generator for TypeScript validation": [[55, "smithy-server-generator-for-typescript-validation"]], "Default validation": [[55, "default-validation"]], "Custom validation": [[55, "custom-validation"]]}, "indexentries": {"rfc": [[3, "index-0"], [3, "index-1"], [5, "index-0"], [5, "index-1"], [15, "index-0"], [16, "index-0"], [19, "index-0"], [28, "index-0"], [28, "index-1"], [28, "index-2"], [29, "index-0"], [29, "index-1"], [32, "index-0"], [33, "index-0"], [33, "index-1"], [33, "index-2"], [33, "index-3"], [33, "index-4"], [33, "index-5"], [33, "index-6"], [33, "index-7"], [33, "index-8"], [33, "index-9"], [35, "index-0"], [35, "index-1"], [37, "index-0"], [37, "index-1"], [37, "index-2"], [37, "index-3"], [40, "index-0"], [40, "index-1"], [40, "index-2"], [41, "index-0"], [48, "index-0"]], "rfc 6901": [[3, "index-0"], [5, "index-0"], [37, "index-3"]], "rfc 6902": [[3, "index-1"], [5, "index-1"]], "rfc 3986": [[15, "index-0"], [19, "index-0"]], "rfc 4632": [[16, "index-0"]], "rfc 2617": [[28, "index-0"], [28, "index-1"]], "rfc 6750": [[28, "index-2"]], "rfc 1864": [[29, "index-0"]], "rfc 9110#section-8.4": [[29, "index-1"]], "rfc 3986#section-3.2.2": [[32, "index-0"]], "rfc 3339": [[33, "index-4"], [33, "index-9"], [37, "index-0"], [37, "index-2"], [48, "index-0"]], "rfc 3986#section-2.1": [[33, "index-6"], [33, "index-8"]], "rfc 3986#section-2.3": [[33, "index-5"], [33, "index-7"]], "rfc 7230#appendix-b": [[33, "index-0"]], "rfc 7230#section-3.2": [[33, "index-2"]], "rfc 7230#section-5.3.1": [[33, "index-1"]], "rfc 7231#section-7.1.1.1": [[33, "index-3"], [40, "index-2"]], "rfc 2119": [[35, "index-0"]], "rfc 5234": [[35, "index-1"]], "rfc 7231#section-4.3.4": [[37, "index-1"]], "rfc 3339#section-5.6": [[40, "index-1"]], "rfc 6838": [[40, "index-0"]], "rfc 5988#section-4": [[41, "index-0"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["guides/building-models/build-config", "guides/building-models/gradle-plugin", "guides/building-models/index", "guides/converting-to-openapi", "guides/evolving-models", "guides/generating-cloudformation-resources", "guides/index", "guides/model-linters", "guides/style-guide", "index", "quickstart", "spec/aws/amazon-apigateway", "spec/aws/aws-auth", "spec/aws/aws-cloudformation", "spec/aws/aws-core", "spec/aws/aws-ec2-query-protocol", "spec/aws/aws-iam", "spec/aws/aws-json-1_0-protocol", "spec/aws/aws-json-1_1-protocol", "spec/aws/aws-query-protocol", "spec/aws/aws-restjson1-protocol", "spec/aws/aws-restxml-protocol", "spec/aws/customizations/apigateway-customizations", "spec/aws/customizations/glacier-customizations", "spec/aws/customizations/index", "spec/aws/customizations/machinelearning-customizations", "spec/aws/customizations/s3-customizations", "spec/aws/index", "spec/core/auth-traits", "spec/core/behavior-traits", "spec/core/constraint-traits", "spec/core/documentation-traits", "spec/core/endpoint-traits", "spec/core/http-traits", "spec/core/idl", "spec/core/index", "spec/core/json-ast", "spec/core/model", "spec/core/model-validation", "spec/core/prelude-model", "spec/core/protocol-traits", "spec/core/resource-traits", "spec/core/selectors", "spec/core/stream-traits", "spec/core/type-refinement-traits", "spec/core/xml-traits", "spec/http-protocol-compliance-tests", "spec/index", "spec/mqtt", "spec/waiters", "ts-ssdk/error-handling", "ts-ssdk/handlers", "ts-ssdk/index", "ts-ssdk/introduction", "ts-ssdk/supported-endpoints", "ts-ssdk/validation"], "filenames": ["guides/building-models/build-config.rst", "guides/building-models/gradle-plugin.rst", "guides/building-models/index.rst", "guides/converting-to-openapi.rst", "guides/evolving-models.rst", "guides/generating-cloudformation-resources.rst", "guides/index.rst", "guides/model-linters.rst", "guides/style-guide.rst", "index.rst", "quickstart.rst", "spec/aws/amazon-apigateway.rst", "spec/aws/aws-auth.rst", "spec/aws/aws-cloudformation.rst", "spec/aws/aws-core.rst", "spec/aws/aws-ec2-query-protocol.rst", "spec/aws/aws-iam.rst", "spec/aws/aws-json-1_0-protocol.rst", "spec/aws/aws-json-1_1-protocol.rst", "spec/aws/aws-query-protocol.rst", "spec/aws/aws-restjson1-protocol.rst", "spec/aws/aws-restxml-protocol.rst", "spec/aws/customizations/apigateway-customizations.rst", "spec/aws/customizations/glacier-customizations.rst", "spec/aws/customizations/index.rst", "spec/aws/customizations/machinelearning-customizations.rst", "spec/aws/customizations/s3-customizations.rst", "spec/aws/index.rst", "spec/core/auth-traits.rst", "spec/core/behavior-traits.rst", "spec/core/constraint-traits.rst", "spec/core/documentation-traits.rst", "spec/core/endpoint-traits.rst", "spec/core/http-traits.rst", "spec/core/idl.rst", "spec/core/index.rst", "spec/core/json-ast.rst", "spec/core/model.rst", "spec/core/model-validation.rst", "spec/core/prelude-model.rst", "spec/core/protocol-traits.rst", "spec/core/resource-traits.rst", "spec/core/selectors.rst", "spec/core/stream-traits.rst", "spec/core/type-refinement-traits.rst", "spec/core/xml-traits.rst", "spec/http-protocol-compliance-tests.rst", "spec/index.rst", "spec/mqtt.rst", "spec/waiters.rst", "ts-ssdk/error-handling.rst", "ts-ssdk/handlers.rst", "ts-ssdk/index.rst", "ts-ssdk/introduction.rst", "ts-ssdk/supported-endpoints.rst", "ts-ssdk/validation.rst"], "titles": ["smithy-build", "Smithy Gradle Plugin", "Building Smithy Models", "Converting Smithy to OpenAPI", "Evolving Models", "Generating CloudFormation Resource Schemas from Smithy", "Smithy Guides", "Model linters", "Style Guide", "Smithy", "Quick start", "Amazon API Gateway traits", "AWS Authentication Traits", "AWS CloudFormation traits", "AWS Core Specification", "AWS EC2 query protocol", "AWS IAM traits", "AWS JSON 1.0 protocol", "AWS JSON 1.1 protocol", "AWS query protocol", "AWS restJson1 protocol", "AWS restXml protocol", "Amazon API Gateway Customizations", "Amazon Glacier Customizations", "AWS Service Customizations", "Amazon Machine Learning Customizations", "Amazon S3 Customizations", "AWS specifications", "7. Authentication traits", "8. Behavior traits", "3. Constraint traits", "4. Documentation traits", "13. Endpoint Traits", "11. HTTP binding traits", "16. Smithy IDL", "Smithy specification", "17. JSON AST", "1. The Smithy model", "15. Model validation", "2. Prelude model", "6. Protocol traits", "9. Resource traits", "14. Selectors", "10. Streaming Traits", "5. Type refinement traits", "12. XML binding traits", "HTTP Protocol Compliance Tests", "Specifications", "MQTT Protocol Bindings", "Waiters", "Smithy Server Generator for TypeScript error handling", "Smithy Server Generator for TypeScript handlers", "Smithy Server Generator for TypeScript", "Introduction to the Smithy Server Generator for TypeScript", "Smithy Server Generator for TypeScript supported endpoints", "Smithy Server Generator for TypeScript validation"], "terms": {"requir": [0, 1, 3, 4, 5, 7, 8, 10, 11, 12, 13, 14, 16, 17, 18, 19, 20, 21, 28, 29, 31, 32, 33, 34, 35, 36, 37, 38, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 51, 55], "construct": [0, 12, 16, 29], "configur": [0, 1, 2, 6, 7, 10, 14, 15, 16, 17, 18, 19, 20, 21, 26, 28, 29, 32, 33, 37, 38, 40, 42, 46, 49], "file": [0, 1, 2, 3, 5, 6, 7, 10, 14, 26, 34, 35, 36, 41, 42, 46], "thi": [0, 1, 2, 3, 4, 5, 7, 8, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 26, 28, 29, 30, 31, 32, 33, 34, 36, 37, 38, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 53, 55], "i": [0, 1, 2, 3, 4, 5, 7, 8, 9, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 26, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 40, 41, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55], "describ": [0, 2, 3, 4, 5, 7, 11, 13, 14, 16, 20, 21, 29, 30, 31, 34, 35, 37, 40, 44, 46, 49, 51], "how": [0, 2, 3, 4, 5, 7, 8, 10, 11, 13, 15, 17, 18, 23, 28, 33, 34, 37, 40, 41, 42, 43, 45, 46, 49], "creat": [0, 1, 2, 3, 5, 7, 8, 10, 11, 13, 29, 30, 36, 38, 41, 42, 49, 53], "what": [0, 3, 5, 14, 16, 23, 30, 37, 46, 48, 55], "The": [0, 1, 2, 3, 4, 5, 7, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 25, 26, 28, 29, 30, 31, 32, 33, 34, 35, 36, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 55], "accept": [0, 7, 10, 13, 14, 17, 18, 20, 24, 28, 30, 33, 34, 37, 43, 49, 50], "follow": [0, 1, 3, 4, 5, 7, 8, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 26, 28, 29, 30, 31, 32, 33, 34, 36, 37, 38, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 51], "properti": [0, 2, 3, 4, 5, 7, 10, 11, 12, 14, 15, 16, 17, 18, 19, 20, 21, 23, 27, 28, 29, 30, 31, 32, 33, 34, 35, 37, 38, 40, 41, 42, 45, 46, 49], "type": [0, 1, 4, 5, 7, 10, 12, 13, 14, 15, 17, 18, 19, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 38, 39, 40, 41, 43, 46, 47, 48, 49, 50, 51, 53, 54, 55], "descript": [0, 1, 3, 5, 7, 8, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 28, 29, 30, 31, 32, 33, 34, 36, 37, 38, 40, 41, 42, 45, 46, 49], "version": [0, 1, 3, 5, 7, 8, 9, 10, 11, 14, 15, 16, 17, 18, 19, 20, 21, 24, 27, 28, 29, 31, 35, 36, 37, 38, 39, 40, 42, 43, 48, 51, 55], "string": [0, 1, 3, 4, 5, 7, 8, 10, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 26, 27, 28, 29, 30, 31, 32, 35, 36, 37, 38, 39, 40, 41, 43, 44, 45, 46, 48, 49, 51, 55], "defin": [0, 1, 3, 4, 5, 7, 8, 9, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 28, 29, 30, 31, 32, 33, 35, 36, 38, 39, 40, 41, 42, 43, 44, 45, 46, 48, 49, 51, 53, 55], "set": [0, 1, 6, 7, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 26, 28, 29, 30, 31, 32, 33, 35, 38, 40, 42, 44, 46, 49, 50, 51, 53, 55], "1": [0, 1, 3, 5, 7, 8, 9, 10, 11, 12, 14, 15, 16, 19, 20, 21, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 48, 49, 55], "0": [0, 1, 3, 5, 7, 8, 9, 10, 11, 12, 14, 15, 16, 18, 19, 20, 21, 27, 28, 29, 30, 31, 32, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 48, 49, 55], "outputdirectori": [0, 1], "locat": [0, 3, 5, 7, 11, 15, 19, 21, 27, 28, 32, 33, 38, 41, 43], "where": [0, 1, 2, 3, 5, 7, 11, 14, 15, 16, 17, 18, 19, 20, 21, 28, 29, 33, 34, 35, 36, 37, 38, 42, 43, 45, 49, 51, 53, 55], "ar": [0, 1, 2, 3, 4, 5, 7, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 40, 41, 42, 43, 44, 45, 46, 48, 49, 50, 51, 53, 54, 55], "written": [0, 1, 7, 35, 36, 42, 46, 53], "each": [0, 1, 3, 5, 7, 8, 10, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 28, 29, 30, 31, 33, 34, 36, 37, 38, 40, 41, 42, 43, 45, 46, 48, 49, 51, 53, 55], "subdirectori": 0, "name": [0, 1, 3, 5, 6, 7, 10, 11, 12, 13, 15, 16, 17, 18, 19, 20, 21, 26, 27, 28, 29, 30, 31, 32, 33, 34, 36, 37, 38, 40, 41, 42, 43, 44, 46, 48, 50], "after": [0, 7, 8, 14, 17, 18, 20, 26, 29, 32, 34, 37, 38, 42, 53, 55], "from": [0, 2, 3, 4, 6, 7, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 25, 26, 29, 30, 31, 33, 34, 37, 38, 39, 40, 42, 43, 45, 46, 48, 49, 50, 51, 53, 54, 55], "includ": [0, 2, 3, 4, 5, 7, 8, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 29, 31, 32, 33, 34, 35, 37, 38, 39, 40, 42, 43, 44, 46, 49, 50, 51, 53], "place": [0, 1, 3, 4, 14, 19, 26, 33, 34, 37, 38], "directori": [0, 1, 7, 10, 14, 41, 42], "import": [0, 3, 5, 7, 14, 34, 38, 40], "provid": [0, 1, 3, 5, 7, 10, 11, 13, 14, 15, 17, 18, 19, 20, 21, 25, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 40, 41, 42, 43, 44, 45, 46, 48, 49], "list": [0, 1, 3, 5, 6, 7, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 26, 28, 29, 30, 31, 33, 35, 38, 40, 41, 42, 44, 46, 47, 49], "rel": [0, 27, 30, 36, 37, 39, 41, 42, 49], "combin": [0, 1, 3, 14, 26, 28, 33, 34, 42, 43, 54], "singl": [0, 1, 3, 7, 8, 10, 15, 17, 18, 19, 20, 21, 29, 33, 34, 36, 37, 38, 39, 42, 43, 44, 48, 49, 54], "when": [0, 1, 3, 4, 5, 7, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 26, 28, 29, 30, 31, 32, 33, 34, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 48, 49, 50, 51, 55], "encount": [0, 1, 3, 4, 19, 21, 33, 34, 36, 37, 38, 40, 49, 50, 55], "all": [0, 3, 5, 7, 8, 10, 11, 13, 14, 15, 17, 18, 19, 20, 21, 22, 23, 28, 29, 30, 31, 33, 34, 36, 37, 38, 39, 41, 42, 43, 44, 45, 46, 47, 48, 50, 51, 53], "within": [0, 3, 5, 10, 11, 13, 14, 15, 16, 19, 21, 29, 30, 31, 32, 33, 34, 36, 37, 39, 42, 45, 49], "note": [0, 3, 14, 30, 35, 37, 38, 44, 49], "system": [0, 6, 14, 29, 37, 38, 40], "mai": [0, 3, 4, 5, 7, 10, 14, 15, 17, 18, 19, 20, 21, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 40, 41, 42, 43, 44, 45, 46, 48, 49], "choos": [0, 11, 29, 30, 37, 45, 51, 53, 55], "reli": [0, 1, 3, 4, 5, 15, 18, 19, 20, 21, 33], "other": [0, 1, 4, 6, 7, 10, 11, 14, 15, 16, 18, 19, 20, 21, 25, 26, 30, 31, 33, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 46, 48, 49], "mechan": [0, 14, 29, 37], "form": [0, 7, 8, 11, 14, 27, 33, 34, 35, 36, 37, 38, 41, 42, 43, 48], "composit": 0, "These": [0, 1, 2, 3, 5, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 31, 32, 37, 43, 44, 46, 49, 50, 53, 55], "everi": [0, 3, 4, 7, 11, 14, 17, 18, 28, 32, 33, 34, 36, 37, 39, 42, 46, 48, 49, 51, 55], "map": [0, 3, 5, 6, 7, 10, 11, 14, 15, 16, 17, 18, 20, 21, 29, 30, 31, 33, 35, 38, 41, 42, 43, 44, 46, 49], "object": [0, 3, 5, 7, 8, 11, 12, 14, 15, 17, 18, 19, 20, 21, 28, 33, 34, 36, 37, 38, 40, 41, 42, 43, 45, 49, 53], "A": [0, 1, 3, 4, 5, 7, 8, 10, 11, 12, 13, 15, 16, 17, 18, 19, 20, 21, 22, 23, 26, 27, 28, 29, 30, 31, 32, 33, 34, 36, 37, 38, 40, 41, 42, 43, 44, 45, 46, 48, 49, 51, 53], "an": [0, 1, 3, 4, 5, 7, 8, 10, 11, 12, 13, 15, 16, 17, 18, 19, 20, 21, 23, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 40, 41, 42, 43, 44, 45, 46, 48, 49, 50, 51, 53, 54, 55], "arbitrari": [0, 10, 11, 14, 31, 37, 51], "ignoremissingplugin": 0, "bool": [0, 16], "If": [0, 1, 3, 4, 7, 10, 11, 14, 17, 18, 20, 21, 28, 29, 30, 31, 32, 33, 34, 37, 38, 40, 42, 43, 44, 46, 49, 50, 53, 55], "can": [0, 1, 3, 4, 5, 7, 8, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 28, 29, 30, 31, 32, 33, 34, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 48, 49, 50, 51, 53, 54, 55], "t": [0, 1, 3, 7, 10, 14, 15, 18, 19, 20, 21, 33, 34, 37], "found": [0, 1, 3, 5, 7, 14, 30, 33, 34, 37, 38, 42], "default": [0, 1, 3, 5, 7, 10, 11, 13, 14, 15, 17, 18, 19, 20, 21, 24, 26, 28, 29, 30, 33, 38, 40, 41, 42, 43, 44, 45, 49, 51, 52], "fail": [0, 1, 3, 4, 14, 29, 32, 40, 42, 43, 49, 51, 55], "true": [0, 3, 5, 7, 11, 14, 15, 17, 18, 19, 21, 29, 30, 33, 34, 37, 40, 42, 43, 45, 46, 48, 49, 54, 55], "allow": [0, 1, 2, 3, 5, 7, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 29, 30, 31, 33, 34, 36, 37, 38, 40, 41, 42, 43, 44, 46, 48, 49, 51, 53, 55], "progress": [0, 49], "even": [0, 3, 8, 37, 38, 46, 49, 51], "classpath": [0, 1, 3, 5, 7], "exampl": [0, 2, 4, 5, 6, 7, 8, 11, 12, 16, 17, 18, 20, 21, 27, 28, 29, 30, 32, 33, 34, 35, 36, 37, 38, 40, 41, 42, 43, 44, 45, 47, 48, 53, 55], "output": [0, 3, 4, 7, 10, 12, 13, 14, 15, 17, 18, 19, 20, 21, 26, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 41, 42, 43, 46, 47, 48, 49, 51, 53, 55], "foo": [0, 1, 3, 5, 7, 8, 10, 11, 13, 14, 15, 16, 19, 21, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 40, 41, 42, 45, 46, 48, 49], "some": [0, 3, 5, 7, 12, 13, 14, 19, 29, 30, 37, 40, 41, 42, 46, 49, 54], "my": [0, 3, 5, 14, 16, 33, 34, 36, 37, 38], "abstract": [0, 3, 29, 34, 36, 37, 40, 43, 46, 48, 49, 51, 53], "specif": [0, 2, 3, 4, 9, 10, 11, 15, 17, 18, 19, 20, 21, 28, 29, 30, 32, 33, 34, 36, 37, 38, 39, 41, 42, 43, 46, 48, 49, 53], "arg": [0, 1], "tag": [0, 3, 10, 11, 13, 14, 15, 30, 33, 34, 35, 36, 37, 38, 42, 46, 47, 48, 49], "intern": [0, 1, 2, 7, 11, 17, 18, 20, 29, 35, 42, 47, 50], "beta": [0, 34, 37], "trait": [0, 1, 6, 7, 24, 27, 35, 36, 39, 46, 50, 55], "config": [0, 3, 5, 7, 14], "valu": [0, 1, 3, 5, 7, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 24, 26, 28, 29, 31, 32, 33, 35, 36, 38, 39, 40, 41, 43, 44, 45, 46, 48, 49, 50, 51, 54, 55], "filter": [0, 1, 7, 10, 29, 31, 42, 46, 48], "modifi": [0, 51], "intend": [0, 7, 29, 31, 37, 40, 53], "audienc": 0, "custom": [0, 1, 3, 4, 5, 6, 8, 10, 11, 13, 14, 15, 17, 18, 19, 20, 21, 30, 31, 32, 33, 37, 38, 40, 42, 43, 47, 48, 49, 50, 52, 53], "compani": [0, 31], "maintain": [0, 1, 5, 7, 13, 37, 42, 49], "extern": [0, 1, 14, 31, 41, 42], "api": [0, 5, 6, 7, 10, 12, 13, 15, 16, 19, 24, 27, 28, 29, 30, 31, 32, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 49, 51, 52, 53], "paramet": [0, 3, 14, 15, 17, 18, 19, 20, 21, 25, 27, 28, 29, 31, 33, 49, 51, 55], "oper": [0, 1, 3, 5, 6, 7, 11, 12, 13, 14, 16, 21, 23, 25, 26, 27, 28, 29, 30, 31, 32, 33, 35, 38, 41, 42, 43, 44, 46, 48, 49, 50, 51, 53, 54, 55], "avail": [0, 1, 3, 7, 9, 10, 14, 16, 29, 31, 37, 38, 42, 46, 49, 54], "onli": [0, 1, 2, 3, 4, 5, 7, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 28, 29, 30, 31, 33, 34, 36, 37, 38, 40, 41, 42, 43, 44, 46, 48, 51, 53, 55], "subset": [0, 29, 42], "must": [0, 1, 3, 5, 7, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 26, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 40, 41, 42, 43, 44, 45, 46, 48, 49, 53], "match": [0, 1, 3, 7, 11, 12, 14, 29, 30, 32, 33, 35, 37, 38, 41, 46, 48, 49, 50, 51, 54], "pattern": [0, 3, 7, 10, 11, 14, 32, 34, 35, 38, 47, 48], "za": [0, 10, 14, 16, 30], "z0": [0, 10, 14, 16], "9": [0, 10, 14, 16, 30, 34, 49], "_": [0, 30, 33, 37, 42, 45], "boolean": [0, 1, 3, 5, 6, 7, 10, 13, 14, 15, 16, 17, 18, 19, 20, 21, 29, 30, 31, 33, 34, 36, 37, 39, 40, 42, 43, 44, 45, 46, 48, 49], "placehold": [0, 3, 14, 32, 33, 48], "remov": [0, 3, 4, 5, 14, 19, 26, 29, 37, 42, 49], "shape": [0, 3, 5, 6, 7, 11, 12, 13, 14, 16, 23, 27, 28, 29, 30, 31, 32, 33, 35, 38, 40, 41, 43, 44, 46, 48, 49, 53, 55], "content": [0, 3, 5, 7, 10, 11, 12, 14, 15, 16, 17, 18, 19, 23, 27, 29, 31, 32, 33, 34, 37, 38, 40, 42, 43, 46, 47, 50], "ani": [0, 1, 2, 3, 5, 7, 10, 11, 13, 14, 15, 17, 18, 19, 20, 21, 28, 29, 30, 31, 32, 33, 34, 36, 37, 38, 39, 40, 41, 42, 43, 44, 46, 49, 50, 51, 53, 54, 55], "kind": [0, 3, 7, 19, 28, 29, 33, 34, 35, 36, 37, 38, 40, 42, 46], "necessari": [0, 3, 5, 14, 29, 37, 42, 43, 45, 49, 51], "order": [0, 1, 3, 5, 7, 8, 10, 11, 14, 16, 17, 18, 20, 21, 26, 28, 29, 30, 33, 34, 37, 40, 42, 46, 49, 50, 51, 55], "attempt": [0, 14, 29, 38, 41, 42, 49], "resolv": [0, 3, 11, 13, 15, 17, 18, 19, 20, 21, 26, 27, 30, 31, 32, 33, 34, 36, 37, 40, 41, 42, 46, 48], "java": [0, 1, 3, 4, 5, 7, 37, 44, 46], "spi": [0, 7], "instanc": [0, 10, 13, 14, 30, 36, 37, 38, 49, 50, 51, 53], "softwar": [0, 1, 3, 5, 7, 10, 14, 33], "amazon": [0, 1, 2, 5, 6, 7, 10, 12, 14, 15, 16, 17, 18, 20, 24, 27, 41, 47, 49, 51, 52, 53], "smithybuildplugin": 0, "return": [0, 7, 10, 11, 13, 14, 29, 30, 33, 34, 36, 37, 38, 40, 41, 42, 43, 49, 50, 51, 53, 54, 55], "call": [0, 3, 10, 11, 13, 14, 29, 30, 37, 41, 42, 49, 51, 53, 54], "getnam": 0, "emit": [0, 3, 7, 14, 34, 38, 43, 49], "warn": [0, 3, 7, 31, 37, 38], "cannot": [0, 13, 14, 15, 19, 21, 30, 31, 33, 34, 37, 38, 41, 44, 49, 50], "write": [0, 6, 13, 38, 49, 52, 53, 54], "insid": [0, 10, 15, 34, 36, 37, 40, 42, 48], "projectionnam": 0, "inform": [0, 1, 3, 5, 8, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 30, 34, 37, 38, 42, 50], "about": [0, 7, 8, 10, 11, 14, 16, 30, 31, 34, 36, 37, 38, 42, 43, 46, 49, 50], "result": [0, 3, 4, 5, 7, 10, 11, 14, 15, 18, 19, 20, 21, 29, 32, 33, 34, 37, 42, 43, 46, 49, 50, 53], "valid": [0, 1, 5, 6, 8, 10, 11, 13, 14, 16, 17, 18, 20, 21, 29, 30, 31, 32, 34, 35, 37, 40, 41, 42, 43, 45, 46, 47, 49, 50, 52, 53], "event": [0, 7, 14, 17, 18, 19, 20, 21, 34, 35, 48, 49, 51, 54], "pluginnam": 0, "artifactnam": 0, "contribut": [0, 35], "path": [0, 3, 11, 14, 26, 29, 33, 37, 38, 46, 49], "against": [0, 11, 14, 30, 33, 34, 38, 42, 46, 49, 51, 53, 55], "For": [0, 1, 2, 3, 4, 5, 7, 8, 10, 11, 14, 15, 16, 17, 18, 19, 30, 31, 32, 33, 35, 37, 38, 41, 42, 43, 44, 45, 46, 48, 49, 50, 51, 53, 55], "given": [0, 1, 3, 5, 11, 13, 14, 15, 16, 19, 30, 31, 32, 33, 34, 35, 37, 38, 40, 42, 43, 45, 46, 48, 49, 55], "baz": [0, 1, 3, 5, 11, 15, 19, 31, 33, 34, 37, 38, 41, 42, 45, 46, 48], "would": [0, 3, 5, 7, 14, 15, 16, 19, 26, 29, 30, 33, 37, 38, 40, 44, 49, 51, 53, 55], "becom": [0, 29, 37, 49], "structur": [0, 1, 3, 6, 7, 10, 13, 14, 16, 17, 18, 20, 21, 26, 27, 28, 29, 30, 32, 33, 35, 38, 39, 40, 41, 42, 43, 44, 46, 48, 50, 53, 54, 55], "contain": [0, 1, 3, 5, 7, 10, 11, 14, 15, 16, 17, 18, 19, 20, 21, 28, 29, 30, 31, 32, 33, 34, 36, 37, 38, 40, 41, 42, 43, 44, 45, 46, 48, 49, 55], "kei": [0, 1, 5, 7, 10, 11, 14, 20, 21, 27, 28, 30, 31, 33, 34, 35, 36, 37, 41, 42, 44, 45, 46, 54], "pair": [0, 3, 5, 7, 15, 19, 20, 21, 30, 33, 34, 37, 46], "referenc": [0, 4, 7, 11, 14, 16, 29, 30, 33, 34, 36, 37, 38, 39, 41, 42, 43, 44, 48], "No": [0, 7, 33, 34, 37, 38, 40, 46, 48], "cycl": 0, "bar": [0, 1, 3, 7, 11, 13, 15, 16, 19, 31, 32, 33, 34, 35, 37, 38, 40, 45, 46, 48], "chang": [0, 3, 4, 5, 7, 14, 15, 19, 20, 21, 28, 29, 31, 33, 42, 43, 44, 45, 48, 49, 55], "enum": [0, 3, 4, 14, 26, 28, 35, 38, 42, 47], "synthesizenam": 0, "whether": [0, 1, 3, 4, 5, 7, 14, 30], "without": [0, 2, 4, 7, 11, 13, 14, 15, 16, 18, 19, 20, 21, 26, 28, 29, 33, 34, 37, 38, 41, 42, 49, 53, 55], "should": [0, 1, 3, 4, 5, 7, 8, 10, 11, 12, 13, 14, 16, 17, 18, 19, 20, 21, 23, 25, 26, 28, 29, 30, 31, 32, 33, 34, 35, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 48, 49, 53, 54], "have": [0, 3, 5, 7, 10, 13, 14, 15, 16, 19, 20, 21, 23, 26, 28, 29, 30, 32, 33, 34, 36, 37, 38, 40, 41, 42, 43, 44, 46, 48, 49, 50, 53, 55], "synthes": 0, "possibl": [0, 3, 4, 10, 14, 31, 33, 37, 39, 42, 46, 49], "convert": [0, 5, 6, 7, 11, 13, 14, 17, 18, 37, 42, 46, 49, 51, 53, 54], "To": [0, 1, 11, 14, 29, 30, 33, 37, 42, 49], "successfulli": [0, 14, 16, 28, 40, 49], "definit": [0, 1, 3, 4, 10, 11, 13, 15, 19, 20, 21, 28, 30, 34, 35, 36, 38, 40, 42, 46, 51], "option": [0, 3, 4, 5, 7, 11, 14, 26, 29, 30, 33, 34, 35, 36, 37, 38, 40, 42, 43, 44, 46, 49, 51], "enabl": [0, 3, 5, 10, 11, 14, 26, 29, 33, 51, 53, 55], "By": [0, 1, 3, 5, 7, 8, 10, 14, 15, 17, 18, 19, 20, 21, 29, 33, 37, 40, 41, 45, 49], "disabl": [0, 3, 5, 10, 11, 14, 16, 21, 26, 29, 32, 33, 55], "mark": [0, 3, 4, 7, 10, 13, 14, 16, 20, 21, 28, 29, 30, 31, 32, 33, 36, 37, 40, 41, 42, 43, 44, 46, 48, 49], "deprec": [0, 4, 5, 19, 29, 30, 34, 35, 37, 42, 47, 49], "member": [0, 3, 4, 5, 7, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 29, 30, 31, 32, 33, 34, 35, 38, 40, 41, 42, 43, 44, 45, 46, 48, 49, 50, 55], "addition": [0, 14, 46, 51], "exampleproject": 0, "shapetyp": 0, "shapeid": [0, 3, 5, 13, 14, 31, 34, 37], "id": [0, 1, 3, 5, 7, 10, 11, 13, 15, 16, 17, 18, 19, 20, 21, 27, 28, 30, 31, 33, 35, 36, 38, 39, 40, 46, 48, 49], "assign": [0, 14, 34, 36, 37, 38, 40, 42], "synthesizeenumnam": 0, "support": [0, 1, 3, 5, 7, 10, 11, 12, 13, 14, 16, 26, 27, 28, 29, 30, 31, 33, 34, 36, 37, 38, 40, 41, 42, 43, 46, 48, 49, 52, 53, 55], "simpl": [0, 10, 11, 13, 14, 15, 16, 19, 31, 33, 35, 38, 39, 42, 44, 51], "union": [0, 3, 6, 7, 10, 14, 17, 18, 20, 21, 30, 33, 35, 40, 42, 43, 46, 48], "qux": [0, 31, 34, 37, 38], "thei": [0, 1, 3, 7, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 28, 29, 30, 31, 32, 33, 34, 37, 38, 40, 42, 43, 44, 46, 49, 50, 53, 55], "one": [0, 3, 5, 7, 8, 10, 11, 13, 14, 16, 17, 18, 19, 20, 21, 29, 30, 33, 34, 36, 37, 40, 41, 42, 44, 46, 48, 49, 51, 53], "more": [0, 1, 2, 3, 5, 7, 8, 10, 11, 13, 14, 15, 16, 19, 21, 26, 29, 30, 33, 34, 36, 37, 38, 40, 41, 42, 44, 48, 49, 53, 55], "via": [0, 3, 4, 7, 13, 15, 16, 17, 18, 19, 20, 21, 28, 33, 48, 51, 53, 54], "caus": [0, 3, 30, 37, 38, 40, 42, 49, 55], "doe": [0, 1, 3, 4, 7, 11, 14, 15, 17, 18, 19, 21, 28, 29, 30, 31, 33, 34, 36, 37, 38, 40, 41, 42, 43, 45, 48, 49, 50, 53], "prelud": [0, 10, 34, 35, 37, 42, 44, 47], "assum": [0, 1, 3, 5, 7, 11, 17, 18, 20, 21, 34, 37, 41, 46, 49, 51], "namespac": [0, 3, 5, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 28, 29, 30, 31, 32, 33, 35, 36, 37, 38, 39, 40, 41, 42, 43, 45, 46, 48, 49], "least": [0, 7, 14, 30, 36, 37, 40, 42, 49], "retain": 0, "out": [0, 1, 3, 10, 29, 31, 37, 42, 46, 49, 53], "part": [0, 3, 4, 12, 13, 14, 23, 29, 30, 33, 37, 40, 41, 42, 43, 49], "base": [0, 3, 5, 7, 11, 14, 16, 20, 21, 29, 30, 33, 37, 42, 43, 44, 45, 46, 49, 50], "com": [0, 1, 7, 14, 15, 16, 17, 18, 19, 20, 21, 26, 31, 33, 34, 35, 37, 41, 45, 46, 49], "servic": [0, 1, 3, 5, 6, 7, 9, 11, 12, 13, 15, 16, 17, 18, 19, 20, 21, 23, 25, 28, 29, 30, 31, 33, 35, 38, 40, 41, 43, 45, 46, 47, 48, 49, 50, 51, 52, 53, 55], "entri": [0, 3, 10, 14, 15, 17, 18, 19, 20, 21, 28, 30, 33, 34, 36, 37, 42, 45, 51, 55], "myservic": [0, 1, 14, 15, 16, 17, 18, 19, 20, 21, 31, 36, 37, 42], "taga": 0, "tagb": 0, "present": [0, 3, 5, 8, 10, 11, 14, 15, 16, 17, 18, 19, 20, 21, 29, 30, 31, 33, 37, 40, 41, 42, 43, 46, 48], "also": [0, 1, 3, 5, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 28, 29, 30, 33, 34, 36, 37, 38, 40, 42, 43, 48, 53, 55], "make": [0, 1, 3, 7, 8, 10, 14, 23, 25, 29, 34, 35, 37, 38, 41, 42, 46, 49], "up": [0, 1, 3, 10, 14, 31, 34, 37, 41, 42, 43], "automat": [0, 1, 3, 5, 7, 10, 13, 14, 16, 25, 29, 31, 33, 34, 37, 39, 46, 48, 54, 55], "orphan": 0, "argument": [0, 42, 51], "end": [0, 3, 7, 8, 14, 32, 33, 34, 37, 38, 40, 42, 43, 50, 53], "exclud": [0, 13, 38, 42], "entir": [0, 10, 14, 29, 30, 33, 34, 36, 37, 38, 48], "sinc": [0, 7, 10, 23, 26, 29, 33, 35, 40, 42, 47, 50, 51, 53], "customtrait": 0, "you": [0, 1, 3, 5, 7, 9, 10, 14, 32, 37, 38, 55], "ha": [0, 1, 3, 5, 7, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 28, 29, 30, 33, 34, 36, 37, 38, 41, 42, 44, 45, 46, 48, 49, 50, 51, 53, 55], "suppress": [0, 1, 8, 34, 35, 37, 49, 55], "metadata": [0, 3, 7, 8, 14, 35, 36, 42, 43, 48, 51, 53], "removeunus": 0, "effect": [0, 3, 10, 11, 14, 28, 29, 31, 34, 37, 38, 44, 45], "often": [0, 3, 4, 7, 14, 37, 43], "could": [0, 3, 10, 31, 34, 37, 38, 42, 43, 46, 49, 51, 53, 55], "left": [0, 29, 34, 37, 42, 43], "longer": [0, 4, 14, 29, 31, 42, 49], "inadvert": [0, 3, 32], "disclos": 0, "privat": [0, 7, 11, 28, 34, 35, 37, 47], "unreleas": 0, "featur": [0, 1, 20, 31, 34, 37, 38, 49], "never": [0, 11, 33, 36, 42, 44, 49, 50, 54, 55], "updat": [0, 3, 5, 6, 7, 10, 13, 34, 36, 41, 42, 51], "refer": [0, 3, 5, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 28, 30, 31, 32, 33, 35, 37, 38, 42, 47, 48, 49, 53, 54], "removereason": 0, "reason": [0, 7, 10, 13, 14, 29, 31, 33, 38], "reveal": 0, "sensit": [0, 7, 14, 33, 34, 35, 37, 40, 42, 47, 48], "extra": 0, "step": [0, 14, 17, 18, 20, 29, 33, 34, 37, 40, 49, 53], "team": [0, 5, 31, 37, 38, 49], "take": [0, 1, 3, 10, 14, 17, 18, 20, 30, 33, 34, 37, 38, 49, 51], "ensur": [0, 1, 7, 28, 29, 30, 33, 34, 37, 38, 40, 42, 46, 48, 51], "do": [0, 3, 5, 7, 8, 14, 29, 30, 32, 33, 34, 36, 37, 38, 41, 42, 43, 45, 46, 48, 51, 55], "leak": 0, "publish": [0, 1, 7, 47, 53], "outsid": [0, 13, 29, 30, 34, 36, 37, 51], "organ": [0, 5, 7, 14, 37, 38], "eventidallowlist": 0, "them": [0, 3, 5, 7, 10, 13, 23, 37, 40, 48], "tandem": 0, "eventiddenylist": 0, "namespaceallowlist": 0, "namespacedenylist": 0, "deni": [0, 7], "myinternalvalid": 0, "b": [0, 3, 15, 19, 33, 34, 35, 36, 37, 38, 42, 43, 45, 48], "c": [0, 3, 15, 34, 37, 42, 43, 48], "public": [0, 7, 11, 31], "author": [0, 8, 16, 27, 28, 29, 31, 33, 37, 42, 47, 51, 53], "flatten": [0, 1, 42], "connect": [0, 11, 14, 17, 18, 20, 21, 33, 37, 42, 43, 48], "target": [0, 3, 4, 5, 7, 10, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 40, 41, 42, 43, 44, 45, 46, 48, 53], "closur": [0, 10, 14, 15, 16, 17, 18, 19, 20, 21, 28, 29, 36, 40, 42, 49], "replac": [0, 3, 5, 7, 14, 26, 37, 41, 48, 49], "equival": [0, 13, 14, 30, 33, 34, 37, 42], "forc": 0, "its": [0, 3, 4, 5, 10, 13, 14, 16, 29, 32, 33, 34, 36, 37, 40, 41, 42, 43, 49, 53], "addit": [0, 1, 3, 4, 5, 7, 10, 13, 14, 15, 16, 17, 18, 19, 20, 21, 29, 32, 33, 37, 38, 41, 42, 46, 48, 49, 51], "along": [0, 1, 5, 7, 15, 19, 29, 38, 42, 55], "which": [0, 1, 2, 3, 5, 11, 14, 15, 17, 18, 19, 20, 21, 28, 29, 30, 31, 33, 34, 36, 37, 40, 41, 42, 43, 46, 48, 49, 50, 51, 53], "exist": [0, 3, 5, 14, 28, 29, 33, 34, 35, 37, 38, 40, 41, 43, 49], "separ": [0, 1, 2, 7, 8, 11, 14, 15, 17, 18, 19, 29, 33, 34, 37, 38, 42, 48, 53], "n": [0, 11, 17, 18, 34, 49], "been": [0, 15, 19, 21, 29, 34, 37, 48, 49], "renam": [0, 3, 4, 27, 36, 37], "disambigu": [0, 15, 17, 18, 19, 20, 21, 33, 36, 37], "through": [0, 1, 3, 5, 7, 11, 14, 19, 28, 29, 34, 35, 37, 42, 43, 46, 49, 51, 53], "": [0, 1, 2, 3, 4, 5, 7, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 26, 29, 30, 32, 33, 34, 37, 38, 41, 42, 44, 46, 48, 49, 50, 51, 52, 53, 54, 55], "so": [0, 1, 5, 10, 13, 14, 16, 33, 34, 35, 37, 42, 46, 48, 49, 55], "long": [0, 3, 7, 10, 14, 15, 17, 18, 19, 20, 21, 29, 30, 33, 34, 36, 37, 39, 42, 43, 44, 45, 46, 48, 49], "don": [0, 10, 14, 15, 18, 19, 20, 21, 37], "conflict": [0, 4, 13, 14, 15, 17, 18, 19, 20, 21, 29, 30, 31, 34, 35, 36, 43, 44, 45], "leav": [0, 43, 53], "intact": 0, "export": [0, 3, 11, 14, 51, 55], "ad": [0, 1, 3, 4, 5, 7, 10, 11, 13, 29, 31, 33, 34, 37, 38, 42, 43, 48, 49], "exporttag": 0, "keep": [0, 5], "tag1": 0, "anoth": [0, 1, 3, 5, 10, 21, 31, 33, 34, 37, 42, 48, 49, 51], "regardless": [0, 28, 29, 32, 33, 37, 42, 48, 49, 53], "wa": [0, 1, 4, 14, 19, 31, 34, 37, 38, 42, 43, 49], "being": [0, 1, 3, 14, 16, 26, 29, 33, 34, 37, 42, 46, 50, 51, 55], "absolut": [0, 14, 30, 33, 34, 36, 37, 38, 41, 42, 49], "holder": 0, "expand": [0, 14, 32, 33, 34, 38], "load": [0, 3, 7, 11, 14, 34, 37, 41, 46], "time": [0, 3, 5, 7, 10, 12, 15, 19, 21, 29, 30, 33, 34, 37, 40, 41, 42, 45, 48, 49, 53, 55], "syntax": [0, 3, 34, 35, 36, 37, 40], "escap": [0, 30, 35, 38], "backslash": [0, 34], "befor": [0, 3, 7, 8, 11, 14, 17, 18, 20, 26, 29, 34, 37, 38, 41, 42, 43, 45, 48, 49, 50, 53], "liter": [0, 12, 14, 19, 22, 26, 34, 38, 42, 48], "non": [0, 3, 7, 11, 13, 14, 26, 27, 29, 33, 34, 36, 37, 49, 50, 54], "preced": [0, 26, 29, 34, 35, 37, 42, 53], "over": [0, 3, 5, 17, 18, 20, 21, 29, 30, 33, 34, 36, 37, 40, 42, 43, 46, 48, 49, 55], "consid": [0, 4, 11, 14, 15, 17, 18, 19, 20, 21, 26, 29, 30, 33, 34, 37, 38, 42, 43, 44, 48, 49, 51, 55], "name_kei": 0, "hi": [0, 3, 5, 15, 19, 21, 33, 34, 36, 37, 42, 45, 46], "either": [0, 3, 7, 10, 14, 15, 16, 17, 18, 19, 20, 21, 29, 33, 34, 37, 41, 42, 43, 50, 53], "top": [0, 3, 5, 7, 13, 14, 15, 17, 18, 19, 20, 21, 29, 31, 32, 33, 35, 37, 42, 43, 48, 49], "level": [0, 3, 5, 7, 13, 14, 15, 17, 18, 19, 20, 21, 26, 29, 30, 31, 32, 33, 35, 37, 38, 42, 43, 48, 49, 50, 51, 53, 54], "same": [0, 3, 7, 10, 11, 12, 13, 14, 15, 17, 18, 19, 20, 21, 29, 30, 31, 33, 34, 36, 37, 38, 40, 42, 45, 46, 48, 49, 51, 53, 54], "complet": [0, 2, 3, 5, 13, 16, 29, 49], "overwrit": 0, "merg": [0, 14, 34, 35, 36], "wai": [0, 10, 16, 31, 32, 34, 37, 40, 44, 49, 51, 52, 54], "matchespluginnam": 0, "log": [0, 3, 14, 31, 49, 55], "NOT": [0, 4, 5, 10, 12, 13, 14, 19, 20, 26, 29, 30, 31, 32, 33, 35, 36, 37, 40, 41, 42, 43, 48, 49], "download": 0, "instal": [0, 2, 3, 5, 10], "class": [0, 7, 14, 37, 51], "modul": [0, 53], "discov": [0, 1, 14], "alwai": [0, 1, 7, 10, 14, 33, 34, 36, 37, 42, 44, 53, 55], "run": [0, 1, 4, 10, 14, 29, 46, 49, 51], "serial": [0, 3, 10, 27, 28, 32, 35, 37, 40, 42, 46, 50, 51, 53], "self": 0, "depend": [0, 1, 3, 5, 7, 10, 14, 16, 29, 34, 37, 41, 53], "produc": [0, 14, 33, 34, 37, 43], "document": [0, 3, 5, 7, 8, 10, 11, 12, 14, 15, 16, 17, 18, 19, 20, 21, 30, 33, 36, 37, 38, 39, 40, 42, 43, 45, 46, 47, 48, 49], "copi": [0, 1, 3, 5, 10], "manifest": [0, 1], "were": [0, 10, 29, 33, 37, 38, 41, 42], "jar": [0, 1, 2, 7, 10], "while": [0, 3, 14, 29, 33, 34, 37, 40, 42, 43, 46, 48, 49, 54, 55], "itself": [0, 14, 29, 30, 37, 38, 49], "empti": [0, 3, 7, 11, 12, 15, 19, 27, 29, 30, 32, 33, 34, 35, 37, 38, 46], "than": [0, 1, 3, 11, 13, 15, 19, 21, 29, 33, 34, 36, 37, 40, 41, 42, 44, 45, 48, 49], "new": [0, 3, 4, 5, 7, 10, 14, 17, 18, 19, 20, 34, 37, 38, 42, 43, 49, 51, 55], "newli": [0, 29], "newlin": [0, 19, 34, 38], "line": [0, 5, 13, 33], "start": [0, 1, 7, 9, 14, 29, 30, 33, 34, 37, 38, 42, 43, 44, 45, 46, 49], "number": [0, 3, 7, 8, 10, 14, 15, 17, 18, 19, 20, 21, 29, 30, 32, 33, 34, 36, 37, 38, 40, 42, 43, 45, 48, 49], "sign": [0, 10, 12, 14, 29, 37], "comment": [0, 10, 35], "ignor": [0, 1, 13, 14, 15, 17, 18, 19, 32, 33, 34, 37, 38, 46, 49], "store": [0, 31, 33, 37, 40, 42, 43], "meta": [0, 1, 3, 7, 28, 33, 37, 40], "inf": [0, 1, 7], "integr": [1, 2, 14, 16, 27, 36, 37, 47, 54], "appli": [1, 3, 4, 5, 7, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 28, 29, 30, 31, 32, 33, 35, 38, 40, 41, 42, 43, 45, 46, 49, 55], "us": [1, 2, 3, 5, 6, 7, 8, 10, 11, 12, 13, 15, 16, 17, 18, 19, 20, 21, 23, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 53, 54, 55], "kotlin": [1, 7], "6": [1, 3, 5, 10, 40, 49], "src": [1, 7], "main": [1, 7, 15, 17, 18, 19, 20, 21, 36], "resourc": [1, 3, 4, 6, 7, 11, 16, 27, 31, 33, 35, 42, 47], "detect": [1, 3, 37, 38, 49, 55], "abl": [1, 15, 18, 19, 20, 21, 29, 37, 40, 54], "find": [1, 3, 7, 33, 38, 42], "discoveri": [1, 27], "two": [1, 4, 7, 8, 11, 14, 16, 17, 18, 28, 30, 33, 34, 37, 38, 40, 42, 46, 48, 49, 50, 51], "differ": [1, 4, 6, 10, 13, 15, 20, 27, 29, 30, 33, 34, 37, 38, 40, 42, 46, 48, 49, 51], "mode": [1, 14, 29, 55], "specifi": [1, 3, 5, 7, 11, 13, 14, 15, 17, 18, 19, 20, 21, 23, 25, 28, 29, 30, 33, 34, 38, 42, 46, 48, 49, 51], "smithyextens": [1, 10], "There": [1, 10, 17, 18, 34, 37, 42, 48], "correspond": [1, 3, 11, 14, 29, 30, 31, 32, 33, 37, 41, 48, 49, 50, 51, 53, 55], "json": [1, 2, 6, 10, 11, 12, 14, 15, 16, 19, 21, 22, 27, 28, 29, 30, 31, 32, 33, 34, 35, 37, 38, 40, 41, 43, 44, 45, 46, 47, 55], "projectionsourcetag": 1, "get": [1, 3, 5, 7, 10, 13, 19, 26, 29, 32, 33, 38, 42, 43, 49], "search": [1, 7], "determin": [1, 5, 7, 10, 19, 30, 34, 37, 40, 42, 43, 48, 49, 53], "look": [1, 3, 4, 7, 10, 11, 14, 30, 51], "buildscript": [1, 3, 5], "see": [1, 3, 5, 7, 10, 11, 13, 14, 15, 16, 17, 18, 19, 21, 23, 29, 30, 33], "mf": 1, "attribut": [1, 5, 15, 19, 21, 35, 38], "aggreg": [1, 10, 15, 19, 35, 42, 44], "comma": [1, 11, 33, 34, 38, 42], "queri": [1, 3, 11, 20, 21, 27, 28, 46, 49], "smithybuildconfig": 1, "filecollect": 1, "collect": [1, 3, 5, 7, 10, 30, 36, 37, 42, 45, 49], "allowunknowntrait": 1, "unknown": [1, 3, 4, 12, 30, 34, 37, 41, 42, 43, 50], "becaus": [1, 3, 4, 7, 10, 13, 19, 28, 29, 30, 32, 33, 34, 37, 38, 40, 41, 42, 43, 46, 49, 50, 55], "execut": [1, 11, 16, 30, 46, 49, 51, 53, 55], "compileclasspath": 1, "plu": [1, 14, 34], "prevent": [1, 3, 7, 10, 30, 33, 49, 50], "accident": [1, 51], "script": [1, 33], "runtimeclasspath": 1, "kt": [1, 3, 5, 7, 10], "doesn": [1, 3, 7, 10, 14], "omit": [1, 3, 11, 13, 14, 17, 18, 20, 33, 34, 36, 37, 41, 42], "repositori": [1, 10, 35, 42], "mavenloc": [1, 10], "mavencentr": [1, 10], "implement": [1, 2, 3, 5, 7, 10, 14, 15, 17, 18, 19, 20, 21, 28, 33, 34, 35, 37, 38, 40, 42, 46, 48, 49, 50, 51, 53, 55], "47": [1, 3, 5, 7, 10], "just": [1, 3, 7, 10, 28, 30, 40, 53], "common": [1, 3, 7, 8, 34, 36, 37, 38, 49, 50, 51, 55], "packag": [1, 3, 5, 7, 37, 41, 54, 55], "aw": [1, 5, 8, 25, 42, 51, 52, 55], "might": [1, 7, 10, 12, 13, 14, 29, 37, 38, 42, 44, 46, 49], "want": [1, 10, 23, 55], "need": [1, 2, 3, 5, 7, 8, 10, 13, 14, 15, 19, 21, 29, 30, 33, 36, 37, 38, 41, 42, 43, 45, 46, 49, 55], "your": [1, 4, 10, 11, 51], "origin": [1, 3, 29, 33, 37, 38], "appear": [1, 3, 5, 7, 8, 14, 16, 17, 18, 20, 21, 29, 33, 34, 42, 46, 48], "weren": 1, "setof": 1, "re": [1, 34], "declar": [1, 3, 16, 30, 33, 34, 35, 37, 48, 51], "here": [1, 3, 34, 38], "let": [1, 10, 44, 49], "too": [1, 3, 5, 33, 34, 40, 45, 55], "transform": [1, 2, 10, 11, 14, 35, 37, 44], "excludeshapesbytag": [1, 10], "excludeshapesbytrait": 1, "excludemetadata": 1, "removeunusedshap": 1, "meant": [1, 30, 31, 33, 34, 37, 42], "logic": [1, 2, 3, 14, 23, 32, 35, 37, 43, 46, 49, 51, 53], "group": [1, 3, 7, 11, 14, 30, 31, 37, 46, 49], "easier": [1, 3, 7, 8, 10, 37, 49], "add": [1, 3, 4, 5, 7, 10, 12, 15, 17, 18, 19, 20, 21, 26, 30, 31, 32, 37, 42, 43, 44, 45, 48, 49, 51, 53, 55], "x": [1, 3, 5, 11, 12, 14, 17, 18, 20, 24, 27, 28, 32, 33, 42, 43, 46, 48], "foobaz": [1, 12, 14, 37], "made": [1, 3, 7, 14, 31, 34, 37, 42, 46, 55], "10": [1, 14, 30, 34, 37, 42, 49, 51, 55], "correctli": [1, 37, 42, 46], "built": [1, 2, 3, 7, 29, 31, 35, 37, 40, 50, 51, 53, 55], "root": [1, 3, 5, 11, 15, 16, 17, 18, 19, 21, 37], "openapi": [1, 2, 6, 11], "abov": [1, 3, 7, 10, 13, 15, 19, 21, 30, 34, 37, 38, 41, 42, 47, 48, 49], "sever": [1, 7, 10, 33, 34, 35, 37, 41, 45, 47, 49], "check": [1, 4, 7, 14, 42, 49, 51, 55], "quick": [1, 9], "guid": [1, 3, 4, 5, 7, 9, 10], "tutori": [1, 10], "artifact": [2, 7, 10, 35, 37], "gener": [2, 3, 4, 6, 7, 8, 9, 10, 11, 13, 14, 15, 16, 19, 21, 24, 28, 29, 30, 31, 37, 40, 44, 46, 49], "code": [2, 4, 6, 7, 8, 9, 10, 11, 13, 15, 17, 18, 20, 21, 27, 28, 29, 30, 31, 33, 34, 37, 38, 40, 42, 44, 46, 49, 50, 51, 55], "etc": [2, 3, 7, 15, 17, 18, 20, 21, 33, 36, 37, 38, 40, 42, 46], "gradl": [2, 3, 5, 7, 10], "plugin": [2, 3, 5, 10, 55], "wrapper": [2, 29], "around": [2, 19, 30], "most": [2, 7, 12, 14, 26, 33, 42, 49], "develop": [2, 3, 5, 10, 37, 38, 46, 50, 51, 53, 55], "easili": [2, 7, 36, 37, 49, 55], "deep": 2, "knowledg": 2, "work": [2, 7, 10, 14, 34, 49, 51, 53], "tool": [2, 3, 4, 7, 10, 14, 29, 30, 31, 34, 35, 36, 37, 38, 40, 41, 44], "lightweight": [2, 53], "sourc": [2, 3, 5, 9, 11, 14, 35, 51, 53], "extens": [2, 5, 6, 15, 37], "project": [2, 3, 5, 7, 10, 35, 38], "environ": [2, 14, 26, 46, 51], "variabl": [2, 3, 35, 46, 48], "model": [3, 5, 6, 15, 16, 17, 18, 19, 20, 21, 26, 27, 30, 31, 32, 33, 34, 35, 36, 40, 41, 42, 44, 46, 47, 50, 51, 53, 55], "standard": [3, 5, 7, 13, 14, 17, 18, 20, 29, 38, 41], "rest": [3, 11, 34, 40, 52], "own": [3, 10, 14, 33, 34, 37, 38], "interfac": [3, 5, 7, 10, 13, 34, 35, 38, 40, 51, 53, 55], "languag": [3, 4, 7, 8, 9, 10, 29, 30, 34, 35, 36, 37, 38, 39, 42, 44, 46, 53], "independ": [3, 37, 53], "case": [3, 5, 7, 8, 12, 14, 15, 17, 18, 19, 20, 21, 29, 30, 31, 33, 34, 35, 36, 37, 38, 40, 44, 46, 48, 49, 50, 51, 53, 55], "both": [3, 7, 13, 14, 15, 17, 18, 19, 20, 21, 28, 29, 30, 31, 33, 34, 37, 40, 41, 42, 43, 46, 48, 49, 53], "hoc": 3, "autom": [3, 10, 14, 38], "workflow": [3, 14], "access": [3, 11, 14, 28, 30, 33, 38, 42, 43, 44], "like": [3, 7, 10, 14, 20, 29, 30, 31, 33, 34, 37, 38, 42, 44, 48, 49, 51], "swaggerui": 3, "client": [3, 4, 7, 10, 11, 15, 17, 18, 19, 20, 21, 22, 23, 25, 26, 27, 28, 30, 31, 33, 34, 35, 36, 37, 40, 41, 42, 44, 46, 48, 49, 50, 53, 55], "server": [3, 9, 10, 14, 15, 17, 18, 19, 20, 21, 29, 31, 33, 35, 37, 40, 44, 46, 48], "current": [3, 10, 15, 34, 37, 42, 49], "3": [3, 15, 17, 18, 19, 31, 32, 33, 34, 37, 42, 43, 49], "2": [3, 9, 10, 11, 14, 15, 17, 18, 19, 26, 28, 29, 32, 33, 34, 36, 37, 42, 43, 49], "veri": [3, 37, 38, 42, 43], "approach": [3, 5], "protocol": [3, 10, 11, 12, 26, 32, 33, 35, 37, 42, 43, 44, 45, 47, 51, 52, 53, 54], "agnost": [3, 37, 40, 46, 48, 51], "mean": [3, 7, 10, 13, 15, 16, 19, 30, 33, 34, 37, 38, 40, 42, 43, 44, 46, 49, 51], "focus": [3, 40], "rather": [3, 15, 19, 21, 34, 37, 40, 45, 49], "data": [3, 7, 10, 12, 16, 19, 27, 29, 30, 31, 32, 33, 34, 37, 40, 43, 46, 47, 51, 52], "sent": [3, 11, 12, 14, 15, 17, 18, 19, 25, 28, 29, 30, 33, 40, 42, 43, 46, 48, 49], "wire": [3, 4, 30, 31, 40, 46, 49, 53], "rpc": [3, 37], "pub": 3, "sub": [3, 37, 42], "strength": 3, "weak": 3, "much": [3, 7, 33, 37], "broader": 3, "behavior": [3, 4, 13, 15, 19, 20, 21, 27, 33, 35, 38, 41, 42, 45, 46, 47, 48, 49, 55], "underli": 3, "complex": [3, 5, 13, 34, 42, 44, 48, 49], "permiss": [3, 5, 11, 14, 16], "adapt": 3, "web": [3, 52], "poor": 3, "experi": [3, 37], "strongli": [3, 30, 49], "lossi": 3, "variou": [3, 4, 10, 14, 32, 33, 34, 37, 39, 49], "endpoint": [3, 11, 15, 17, 18, 19, 20, 21, 25, 27, 33, 35, 46, 47, 50, 51, 52, 53], "hostlabel": [3, 15, 17, 18, 19, 20, 21, 35, 46, 47], "dynam": [3, 33, 46], "alter": [3, 29], "input": [3, 4, 7, 10, 11, 12, 13, 14, 15, 17, 18, 19, 20, 21, 26, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 41, 42, 43, 46, 47, 48, 49, 51, 53, 55], "http": [3, 5, 9, 10, 11, 12, 13, 15, 16, 17, 18, 26, 27, 28, 29, 31, 32, 35, 37, 40, 42, 43, 44, 45, 47, 48, 50, 51, 53, 54], "prefix": [3, 7, 11, 14, 20, 21, 32, 33, 34, 45, 46], "header": [3, 11, 12, 14, 15, 17, 18, 19, 20, 21, 24, 28, 29, 32, 35, 42, 43, 46, 48, 50, 54], "bind": [3, 10, 15, 17, 18, 19, 26, 27, 28, 32, 34, 35, 36, 40, 42, 43, 46, 47, 50, 54], "under": [3, 4, 7, 46], "thing": [3, 10, 29, 31, 33, 36, 37, 49], "s3": [3, 14, 24, 27, 49], "amz": [3, 12, 14, 17, 18, 24, 33], "greedi": 3, "label": [3, 14, 15, 17, 18, 19, 20, 21, 35, 42], "uri": [3, 11, 13, 14, 15, 19, 20, 21, 23, 26, 32, 35, 41, 43, 45, 46], "act": [3, 48], "multipl": [3, 7, 10, 15, 19, 21, 26, 29, 33, 34, 35, 37, 38, 43, 46, 48], "segment": [3, 14, 15, 19, 33, 37], "vendor": [3, 11, 46], "pass": [3, 11, 14, 29, 42, 51, 53], "forbidden": [3, 7], "forbidgreedylabel": 3, "flag": [3, 4, 7, 32, 37, 42], "rout": [3, 14, 33, 51, 53], "aren": 3, "method": [3, 5, 10, 11, 13, 14, 17, 18, 20, 26, 32, 35, 37, 43, 46, 51, 53], "uniqu": [3, 13, 14, 15, 17, 18, 19, 20, 21, 28, 29, 30, 33, 36, 37, 49], "send": [3, 12, 14, 15, 17, 18, 19, 20, 21, 29, 32, 33, 40, 42, 43, 48, 49], "mqtt": [3, 43, 47], "arn": [3, 11, 12, 13, 16, 27, 47, 51], "nativ": [3, 11, 49], "nor": [3, 55], "compat": [3, 4, 7, 14, 30, 31, 33, 34, 35, 37, 42, 43, 46, 50, 55], "stream": [3, 7, 12, 14, 17, 18, 19, 20, 21, 29, 35, 42, 47, 48, 49], "blob": [3, 10, 11, 14, 15, 17, 18, 19, 20, 21, 29, 30, 33, 34, 35, 36, 37, 39, 40, 42, 45, 49], "memori": [3, 37, 43], "isn": [3, 10, 33], "technic": [3, 35], "larg": [3, 10, 12, 29, 37, 43], "payload": [3, 11, 14, 17, 18, 20, 21, 27, 29, 33, 40, 43, 46, 48, 50], "carri": 3, "fromsmithi": [3, 5], "openapiextens": 3, "show": [3, 5, 7, 11, 16, 17, 18, 26], "below": [3, 13, 14, 26, 29, 30, 42], "restjson1": [3, 11, 12, 27, 42, 47, 51, 55], "actual": [3, 4, 5, 7, 11, 14, 15, 31, 34, 36, 38, 42, 48], "process": [3, 5, 10, 14, 15, 19, 29, 31, 34, 37, 43, 46, 49, 50, 53, 55], "weather": [3, 11, 37, 55], "correct": [3, 5, 15, 18, 19, 20, 21, 30, 46, 49], "librari": [3, 4, 5, 29, 53, 54], "highli": [3, 5, 33], "typic": [3, 5, 7, 10, 14, 29, 37, 54], "affect": [3, 4, 5, 15, 17, 18, 19, 20, 21, 31, 32, 37, 49], "openapiprotocol": 3, "regist": [3, 5, 7, 13], "coreextens": 3, "supportedtag": 3, "limit": [3, 5, 7, 8, 14, 19, 29, 33, 37, 46, 48, 49], "defaultblobformat": 3, "format": [3, 6, 11, 12, 15, 17, 18, 19, 20, 21, 27, 29, 30, 31, 33, 34, 36, 37, 40, 43, 48, 55], "byte": [3, 10, 15, 17, 18, 19, 20, 21, 29, 30, 33, 34, 36, 37, 39, 40, 42, 43, 44, 45, 48, 49, 53], "base64": [3, 11, 15, 17, 18, 19, 20, 21, 33, 37, 45, 46, 49, 54], "encod": [3, 10, 11, 14, 15, 16, 17, 18, 19, 20, 21, 29, 33, 34, 37, 45, 46, 49, 54], "externaldoc": [3, 5], "field": [3, 5, 11, 14, 15, 17, 18, 19, 20, 21, 29, 33, 43, 46, 48, 49], "prioriti": [3, 5, 14, 17, 18, 20, 21, 28, 29], "externaldocument": [3, 5, 16, 35, 42, 47], "insensit": [3, 5, 7, 14, 29, 33, 35, 36, 37, 38, 49], "homepag": [3, 31, 42], "keepunusedcompon": 3, "unus": 3, "compon": [3, 5, 13, 14, 15, 17, 18, 19, 20, 33, 37, 48, 54], "jsoncontenttyp": 3, "media": [3, 11, 40, 46], "associ": [3, 7, 15, 19, 21, 37, 43, 46, 48, 49, 50, 53, 55], "applic": [3, 11, 13, 14, 15, 17, 18, 19, 20, 21, 22, 31, 34, 37, 40, 43, 46, 53], "forbid": [3, 7], "removegreedyparametersuffix": 3, "suffix": [3, 14, 15, 19, 33], "instead": [3, 5, 7, 8, 19, 20, 21, 33, 37, 46, 49, 50, 51, 53, 55], "onhttpprefixhead": 3, "httpprefixhead": [3, 14, 20, 21, 35, 47], "ignoreunsupportedtrait": 3, "entireti": 3, "arrai": [3, 17, 18, 20, 34, 37, 38, 42, 49], "replace_m": 3, "another_replac": 3, "hello": [3, 5, 15, 19, 30, 34, 37, 38, 45, 46], "prefer": [3, 17, 18, 19, 20, 21, 40, 42], "jsonadd": [3, 5], "perform": [3, 5, 11, 14, 16, 26, 30, 32, 33, 34, 37, 42, 46, 49, 51, 53], "explicit": [3, 5, 13, 14, 16, 28, 41, 43, 46, 49], "resili": 3, "node": [3, 5, 7, 15, 19, 21, 26, 35, 38, 46, 51, 53], "pointer": [3, 5, 37, 55], "rfc": [3, 5, 15, 16, 17, 18, 19, 28, 29, 32, 33, 34, 35, 37, 40, 41, 45, 48], "6901": [3, 5, 37], "similar": [3, 5, 14, 37, 39, 42, 44, 51], "semant": [3, 5, 7, 10, 31, 34, 35, 40, 41, 42, 45, 48], "patch": [3, 5, 33], "6902": [3, 5], "except": [3, 5, 11, 14, 31, 33, 34, 37, 42, 44, 49, 50, 55], "undefin": [3, 5, 15, 19, 21, 33, 55], "nest": [3, 5, 10, 15, 19, 21, 30, 34, 37, 38, 42, 45], "info": [3, 5], "titl": [3, 5, 14, 35, 47], "intermedi": [3, 5, 42, 49], "useintegertyp": 3, "integ": [3, 7, 8, 10, 11, 13, 15, 16, 17, 18, 19, 20, 21, 29, 30, 33, 34, 36, 37, 38, 39, 42, 43, 44, 45, 46, 48, 49], "short": [3, 7, 10, 15, 17, 18, 19, 20, 21, 29, 30, 31, 33, 34, 36, 37, 39, 42, 43, 44, 45, 48, 49, 50, 55], "recommend": [3, 7, 14, 30, 35, 37, 44, 45, 47, 54], "alphanumericonlyref": 3, "strip": [3, 14], "alphanumer": [3, 14, 33, 49], "charact": [3, 7, 8, 14, 17, 18, 20, 31, 32, 35, 38, 42, 46, 48, 49], "apigatewai": [3, 14, 27, 47, 51, 54], "apigatewaytyp": 3, "usejsonnam": 3, "jsonnam": [3, 20, 35, 47, 49], "defaulttimestampformat": [3, 5], "timestampformat": [3, 5, 15, 17, 18, 19, 20, 21, 33, 35, 47], "timestamp": [3, 5, 7, 10, 13, 15, 17, 18, 19, 20, 21, 30, 33, 34, 36, 37, 39, 40, 42, 43, 45, 46, 48, 49], "expect": [3, 5, 15, 17, 18, 19, 20, 21, 25, 26, 28, 29, 33, 42, 43, 46, 48, 49, 50, 51], "date": [3, 5, 7, 15, 16, 19, 21, 29, 31, 33, 37, 40, 45, 48], "epoch": [3, 5, 17, 18, 20, 37, 40, 49], "second": [3, 5, 11, 17, 18, 20, 33, 37, 40, 42, 48, 49], "unionstrategi": 3, "oneof": 3, "mapstrategi": 3, "propertynam": [3, 5], "additionalproperti": 3, "patternproperti": 3, "indic": [3, 7, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 26, 28, 29, 30, 31, 37, 38, 40, 41, 43, 44, 46, 48, 49, 50], "schemadocumentextens": [3, 5], "overwritten": [3, 5], "disablefeatur": [3, 5], "supportnonnumericfloat": 3, "nan": [3, 15, 17, 18, 19, 20, 21, 37], "infin": [3, 15, 17, 18, 19, 20, 21, 37], "float": [3, 7, 10, 16, 27, 30, 33, 34, 36, 37, 39, 42, 43, 44, 45, 49], "doubl": [3, 7, 10, 27, 30, 33, 34, 36, 37, 39, 42, 44, 45, 49], "numer": [3, 16, 27, 30, 34, 35, 46, 48, 49], "floatmemb": 3, "With": [3, 37, 42], "authent": [3, 11, 27, 33, 35, 46, 47, 53], "attach": [3, 10, 11, 29, 30, 36, 37, 42, 46, 49], "smithy2openapiextens": 3, "securityschemeconvert": 3, "auth": [3, 11, 14, 27, 35, 42, 47, 51], "sigv4": [3, 11, 27, 47], "httpapikeyauth": [3, 35, 42, 47], "httpbasicauth": [3, 35, 42, 47], "httpbearerauth": [3, 35, 42, 47], "httpdigestauth": [3, 35, 42, 47], "2006": [3, 10, 26, 31], "03": [3, 10, 11, 12, 14, 26, 31], "01": [3, 10, 26, 28, 31, 45], "exampleoper": [3, 48, 55], "operationid": 3, "respons": [3, 4, 17, 18, 20, 26, 27, 29, 30, 33, 37, 48, 49, 50, 51, 53, 54], "200": [3, 11, 13, 19, 33, 46], "securityschem": 3, "apikei": [3, 28], "In": [3, 5, 10, 11, 14, 15, 17, 18, 19, 21, 29, 30, 33, 34, 37, 40, 42, 43, 44, 46, 48, 50, 53, 55], "error": [3, 4, 5, 7, 10, 11, 13, 14, 27, 29, 30, 31, 33, 34, 35, 36, 37, 38, 41, 42, 47, 48, 49, 51, 52, 53, 55], "togeth": [3, 7, 10, 26, 34, 36, 37, 42, 48], "unit": [3, 4, 35, 39, 42, 46, 48, 53], "foooper": [3, 16], "doc": [3, 26, 34, 42], "1234": [3, 34], "5678": 3, "howev": [3, 4, 12, 14, 15, 17, 18, 19, 20, 21, 31, 33, 37, 40, 41, 42, 43, 45, 55], "scatter": 3, "throughout": [3, 11], "requestbodi": 3, "foooperation_example1": 3, "summari": [3, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 26, 28, 29, 30, 31, 32, 33, 38, 40, 41, 43, 44, 45, 46, 48, 49], "pick": [3, 14, 17, 18, 20, 21], "modif": [3, 4, 11], "disablecloudformationsubstitut": 3, "templat": [3, 27, 32], "intrins": 3, "additionalallowedcorshead": 3, "preflight": [3, 33], "sdk": [3, 9, 27, 50, 51, 53, 54, 55], "invoc": [3, 11, 29, 53], "those": [3, 7, 14, 15, 16, 17, 18, 19, 20, 21, 30, 33, 37, 42, 46], "mediatyp": [3, 20, 21, 33, 35, 37, 46, 47, 50], "httppayload": [3, 14, 20, 21, 29, 35, 43, 47], "forward": [3, 4, 33, 34, 35, 36, 37], "opt": [3, 11, 14], "requestvalid": [3, 27, 47], "popul": [3, 5, 20, 23, 33], "It": [3, 4, 7, 10, 11, 14, 29, 34, 36, 37, 42, 43, 44, 46, 50, 53], "full": [3, 11, 13, 14, 15, 17, 18, 19, 20, 21, 49], "validaterequestbodi": 3, "validaterequestparamet": 3, "param": [3, 11, 46], "fals": [3, 7, 10, 14, 15, 19, 21, 29, 30, 33, 34, 37, 42, 45, 48, 49], "bodi": [3, 11, 14, 15, 19, 20, 21, 26, 27, 29, 33, 46, 54], "gather": 3, "util": [3, 5, 7, 8, 13, 20, 29, 37, 46, 48], "backend": [3, 11], "mockintegr": [3, 27, 47], "mock": [3, 11], "inherit": [3, 11, 14, 16, 28, 29, 34, 42], "child": [3, 10, 15, 21, 36, 37, 42], "overrid": [3, 5, 7, 13, 28, 29, 40, 42], "dure": [3, 13, 19, 29, 37, 46, 50], "control": [3, 5, 8, 14, 29, 30, 32, 33, 35, 46, 48, 53], "expos": [3, 11, 20, 26, 29, 31, 33, 37, 43, 49], "credenti": [3, 11, 12, 33], "appropri": [3, 11, 14, 20, 21, 29, 35, 38, 41, 44, 49, 53], "static": [3, 7, 11, 14, 17, 18, 23, 48], "lambda": [3, 11, 14, 51, 52], "first": [3, 5, 7, 10, 14, 15, 17, 18, 20, 21, 29, 33, 34, 37, 41, 42, 43, 48, 49, 53], "2019": [3, 14, 29, 42], "06": [3, 29], "17": [3, 11, 12, 14, 49], "operationa": [3, 16, 28, 42], "operationb": [3, 16, 28, 42], "resourcea": [3, 37], "resourceb": [3, 37], "operationc": [3, 28, 42], "operationd": [3, 28, 42], "operation": 3, "operationf": 3, "d": [3, 11, 34, 48], "e": [3, 7, 8, 14, 29, 31, 33, 34, 36, 37, 41, 44, 48], "f": [3, 34], "signatur": [3, 27, 29], "4": [3, 27, 29, 34, 37, 41, 48, 49], "authorizeruri": 3, "authtyp": [3, 11], "awssigv4": [3, 11], "commonli": [3, 7, 51], "deploi": [3, 5, 13, 33, 51], "region": [3, 11, 12, 14, 16, 26], "until": [3, 14, 37, 42, 49], "deploy": 3, "offer": 3, "abil": [3, 13, 30, 48, 50], "treat": [3, 11, 15, 17, 18, 19, 20, 21, 30, 33, 34, 37, 42], "well": [3, 7, 10, 11, 13, 16, 30, 33, 37, 46, 51, 53, 54, 55], "known": [3, 11, 17, 18, 20, 40, 42, 43, 50, 53], "fn": 3, "stack": 3, "wrap": [3, 15, 19, 21, 26, 34, 38, 44], "providerarn": [3, 12], "authorizercredenti": 3, "connectionid": [3, 11], "cognitouserpool": [3, 27, 47], "cognito_user_pool": [3, 11], "idp": [3, 12], "u": [3, 8, 11, 12, 14, 26, 34], "east": [3, 11, 12, 14], "123": [3, 12, 34, 40], "userpool": [3, 12], "api_kei": 3, "apikeysourc": [3, 27, 47], "caller": [3, 11, 49, 50], "identifi": [3, 5, 7, 10, 11, 13, 15, 16, 19, 21, 27, 29, 34, 35, 36, 38, 41, 42, 43, 46], "throttl": [3, 11, 29, 43, 44, 49], "advanc": [3, 5, 7, 42, 55], "ll": [3, 5, 10], "next": [3, 5, 29, 42, 53], "openapiconvert": 3, "openapiconfig": 3, "setservic": [3, 5], "mymodel": [3, 5], "javadoc": [3, 5], "break": [4, 34, 55], "page": [4, 14, 29], "backward": [4, 7, 14, 19, 31, 33, 35, 37, 42, 43, 50, 55], "best": [4, 10, 14, 37, 38, 51], "alreadi": [4, 41, 49], "condit": [4, 27, 30, 41, 48, 55], "previous": [4, 14, 29, 42], "releas": [4, 14, 34, 38], "later": [4, 29, 37, 42], "represent": [4, 10, 29, 36, 37, 38, 40, 42, 48], "upon": 4, "state": [4, 10, 19, 37, 42, 48], "binari": [4, 10, 11, 16, 33, 37, 43, 45, 46], "futur": [4, 7, 10, 29, 31, 33, 37, 49], "better": [4, 7, 8, 10, 37], "open": [4, 32, 33, 34, 35, 37, 40, 48, 53], "anticip": 4, "account": [4, 14, 23], "receiv": [4, 11, 14, 19, 21, 29, 37, 43, 46, 48, 50, 53], "runtim": [4, 11, 14, 30, 33, 41, 46, 48, 51], "incompat": [4, 29, 33, 37, 54], "influenc": [4, 6, 8, 15, 19, 21, 29, 30, 33, 34, 37, 40, 43, 44, 45, 46], "program": [4, 7, 10, 29, 30, 37, 38, 46, 53], "relax": 4, "selector": [4, 7, 8, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 26, 28, 29, 30, 31, 32, 33, 35, 37, 38, 40, 41, 43, 44, 45, 46, 47, 48, 49], "structurallyexclus": [4, 37], "compar": [4, 7, 35, 37, 46, 49], "issu": [4, 7, 10, 15, 18, 19, 20, 21, 29, 37, 49], "cli": [4, 14], "duplic": [5, 29, 37, 39, 49], "effort": [5, 13, 14], "lower": [5, 7, 13, 14, 30, 33, 37, 49], "sync": [5, 14], "reduc": [5, 13, 14], "potenti": [5, 7, 13, 30, 34, 37, 49], "translat": [5, 11, 13], "depict": [5, 13], "command": [5, 13, 14], "entiti": [5, 10, 15, 19, 21, 37], "ident": [5, 7, 10, 11, 14, 15, 17, 18, 19, 20, 21, 29, 32, 33, 37, 46, 51], "restrict": [5, 16, 30, 35, 37, 55], "mutabl": [5, 27], "bound": [5, 10, 13, 14, 16, 20, 21, 23, 28, 29, 30, 31, 33, 36, 37, 38, 41, 42, 43], "queue": [5, 11, 14], "organizationnam": 5, "cloudformationnam": [5, 27], "typenam": 5, "queueservic": 5, "sdkid": [5, 12, 16, 27], "2020": [5, 15, 16, 17, 18, 19, 20, 21, 28, 34, 42, 45], "07": [5, 15, 16, 19, 34], "02": [5, 15, 16, 17, 18, 19, 20, 21, 28, 36, 37, 40], "otherwis": [5, 11, 15, 17, 18, 19, 20, 21, 29, 32, 33, 35, 44], "servicenam": 5, "documentationurl": 5, "url": [5, 11, 15, 16, 17, 18, 19, 31, 33], "user": [5, 11, 12, 13, 14, 16, 29, 31, 32, 33, 38, 40, 43, 49, 51, 55], "sourcedoc": 5, "sourceurl": 5, "disablehandlerpermissiongener": 5, "handler": [5, 50, 52, 53, 54, 55], "lifecycl": [5, 13, 35, 36, 38, 41, 42], "iam": [5, 11, 14, 27, 47, 51], "requiredact": [5, 27, 47], "section": [5, 8, 14, 17, 18, 29, 32, 33, 35, 37, 40, 41, 48, 49], "provis": 5, "action": [5, 15, 16, 19, 26, 37, 49], "align": [5, 8, 37], "invok": [5, 10, 11, 16, 28, 31, 36, 49, 53, 55], "relat": [5, 11, 14, 16, 37, 41], "themselv": [5, 42], "getdependencycompon": 5, "createqueu": 5, "read": [5, 8, 10, 13, 29, 34, 36, 38, 41, 42, 53, 54], "getqueu": 5, "updatequeu": 5, "delet": [5, 10, 29, 33, 36, 38, 41, 42, 49], "deletequeu": 5, "listqueu": 5, "disabledeprecatedpropertygener": 5, "deprecatedproperti": 5, "disablerequiredpropertygener": 5, "disablecapitalizedproperti": 5, "capit": [5, 7, 15, 37], "cfnname": [5, 27, 47], "accord": [5, 15, 19, 30, 33, 48, 50], "creation": [5, 13, 14, 37], "smithy2cfnextens": 5, "cloudformationconvert": 5, "cfnconfig": 5, "cfnconvert": 5, "resourceschema": 5, "setorganizationnam": 5, "convers": [5, 6, 7, 11, 49, 53], "build": [6, 7, 13, 14, 29, 35, 37, 41, 42, 51, 55], "overview": [6, 27, 35], "linter": 6, "lint": 6, "evolv": [6, 29, 37, 48, 55], "evolut": 6, "box": [6, 17, 18, 20, 35, 37, 39, 47], "spars": [6, 30, 33, 35, 37, 47], "diff": [6, 8, 37, 48], "style": [6, 7, 14, 26, 29, 34, 37], "introduct": [6, 35, 52], "between": [6, 11, 14, 27, 29, 32, 33, 34, 37, 41, 42, 43, 46, 48, 49, 50, 51, 54], "schema": [6, 13, 37, 40], "secur": [6, 14, 28], "scheme": [6, 11, 12, 28, 32, 33, 34, 46], "gatewai": [6, 14, 24, 27, 47, 51, 52, 53], "cloudform": [6, 14, 27, 47], "special": [7, 10, 15, 17, 18, 19, 20, 21, 28, 30, 31, 34, 36, 37, 38, 40, 44], "maven": 7, "central": 7, "repres": [7, 8, 10, 14, 17, 18, 20, 29, 30, 31, 33, 34, 37, 39, 43, 44, 46, 48, 49, 50], "abbrevi": [7, 14, 37], "uppercas": [7, 8], "letter": [7, 8, 14, 15, 30, 37], "xmlrequest": [7, 8], "instanceid": [7, 49], "rational": [7, 38], "strict": [7, 8, 37], "word": [7, 8, 14, 35, 42], "predict": [7, 25, 37], "python": [7, 37], "wish": [7, 14, 31, 42, 50], "snake_cas": 7, "camel": [7, 8], "split": [7, 34, 37, 47], "apart": 7, "danger": [7, 34, 37, 38, 49], "allowedabbrevi": 7, "adher": [7, 8, 16, 29, 33, 34, 36, 37, 38, 42, 44, 45, 48, 49], "consist": [7, 8, 10, 30, 32, 33, 34, 37, 38, 48, 49], "uppercamelcas": [7, 8, 49], "lowercamelcas": [7, 8], "understand": [7, 10, 17, 18, 20, 21, 26, 28, 37, 40, 41, 49, 53], "lead": [7, 14, 30, 33, 34, 49], "membernam": [7, 37], "upper": [7, 30, 49], "text": [7, 11, 14, 15, 19, 20, 21, 29, 31, 35, 37, 46, 48], "perpetu": 7, "cultur": 7, "bias": 7, "bia": 7, "term": 7, "suggest": 7, "altern": 7, "noninclus": 7, "substr": [7, 11], "trail": [7, 14, 30, 33], "whitespac": [7, 14, 34, 42], "append": [7, 14, 15, 19, 29, 42, 46], "occur": [7, 8, 29, 37, 38, 42, 50], "messag": [7, 10, 15, 19, 21, 30, 31, 35, 37, 40, 44, 46, 48, 50, 55], "intent": [7, 37, 42, 49], "impact": [7, 19, 37, 38], "whitelist": 7, "blacklist": 7, "past": 7, "denial": [7, 30], "skin": 7, "color": [7, 33], "inclus": [7, 10, 29, 30, 37, 49], "clearli": [7, 42], "commun": [7, 38, 40], "allowlist": 7, "denylist": 7, "someth": [7, 33, 37, 38, 44, 49], "keyword": [7, 10, 34], "unless": [7, 14, 15, 16, 17, 18, 19, 20, 21, 28, 33, 35, 37, 40, 49, 55], "excludedefault": 7, "mankind": 7, "humankind": 7, "mailman": 7, "mail": 7, "carrier": 7, "postal": 7, "worker": 7, "reserv": [7, 33, 38, 48], "manner": 7, "evalu": [7, 16, 29, 30, 32, 33, 42, 46, 55], "detail": [7, 11, 14, 17, 18, 23, 29, 33, 37, 48, 50, 51, 53], "symbol": [7, 30, 34, 37], "safe": [7, 15, 19, 21, 29, 30, 37, 43, 45, 51], "Its": 7, "displai": 7, "why": [7, 31, 37], "fooreservedword": 7, "codenam": 7, "tabl": [7, 14, 16, 17, 18, 20, 21, 26, 30, 37, 41, 42, 45, 47, 48, 49], "createcodenameinput": 7, "codenameresourc": 7, "referencedcodenam": 7, "verb": 7, "properli": [7, 26, 46, 51], "function": [7, 11, 14, 29, 33, 35, 37, 40, 43, 49, 51, 54, 55], "help": [7, 10, 29, 30, 34, 38, 46, 49], "consum": [7, 29, 30, 31, 37, 43], "come": [7, 34, 37, 48], "famili": 7, "g": [7, 8, 14, 29, 33, 36, 37, 41, 44, 48], "batch": [7, 14], "honor": [7, 45], "suggestaltern": 7, "At": [7, 30, 33, 55], "deregist": 7, "transit": [7, 10, 30, 37, 49], "repeat": [7, 37, 45, 46], "As": [7, 15, 18, 19, 20, 21, 29, 31, 33, 41, 43, 46, 51], "tablenam": [7, 41], "redund": 7, "exactmatch": 7, "dedic": [7, 37], "problem": [7, 42, 49, 50], "diverg": 7, "exclus": [7, 33, 37, 43], "ever": [7, 37], "unnecessarili": 7, "ty": 7, "pagin": [7, 10, 35, 37, 47], "unbound": [7, 29], "sla": 7, "verbsrequirepagin": 7, "verbssuggestpagin": 7, "inputmembersrequirepagin": 7, "maxresult": [7, 29, 34, 37], "pages": [7, 10, 29], "nexttoken": [7, 10, 29, 37], "pagetoken": 7, "token": [7, 11, 14, 34, 35, 42], "outputmembersrequirepagin": 7, "marker": 7, "nextpag": 7, "begin": [7, 14, 33, 34], "exact": [7, 10, 33, 37, 40, 41, 48], "purpos": [7, 14, 37, 49, 50, 53, 55], "underscor": [7, 30], "mix": 7, "foobar": 7, "foo_bar": 7, "idiomat": [7, 29, 37, 44], "additionalpattern": 7, "regular": [7, 11, 16, 30], "express": [7, 11, 13, 16, 30, 40, 42, 46, 53], "involv": [7, 14], "extend": [7, 29, 37, 55], "abstractvalid": 7, "validationev": 7, "mypackag": 7, "collector": 7, "documentationtrait": 7, "documentationvalid": 7, "hastrait": 7, "tolist": 7, "validatorservic": 7, "nodemapp": 7, "forbiddendocumentationvalid": 7, "forbiddendocument": 7, "final": [7, 10, 14, 49, 53], "getforbid": 7, "void": [7, 37, 39], "setforbid": 7, "super": [7, 16, 38], "deseri": [7, 17, 18, 19, 33, 35, 37, 40, 46, 50, 51, 53], "pojo": 7, "mapper": 7, "constructor": [7, 51], "violat": [7, 33, 38, 42, 49, 55], "flatmap": [7, 45], "validateshap": 7, "orelseget": 7, "grab": 7, "expecttrait": 7, "docstr": 7, "getvalu": 7, "point": [7, 10, 29, 33, 34, 37, 38, 42, 51, 55], "meow": 7, "emiteachselector": [7, 35, 42], "pretti": [7, 38], "far": 7, "smithi": [8, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 28, 29, 30, 31, 32, 33, 36, 38, 39, 40, 41, 42, 43, 44, 45, 46], "idl": [8, 10, 35, 36, 37, 39, 43, 46, 47], "resembl": 8, "length": [8, 15, 17, 18, 19, 29, 33, 34, 35, 37, 38, 42, 43, 46, 47, 48, 49, 51, 55], "min": [8, 30, 34, 37, 42], "max": [8, 30, 33, 34, 37, 42], "1000": [8, 14, 34], "myshap": [8, 30, 36, 37, 42], "anothershap": 8, "mystructur": [8, 14, 15, 19, 30, 31, 34, 35, 36, 37, 40, 45], "mytrait": [8, 34], "utf": [8, 10, 11, 15, 19, 21, 34, 37, 45, 48], "8": [8, 10, 11, 15, 19, 21, 29, 34, 37, 45, 48, 49], "feed": [8, 34], "000a": [8, 34], "licens": 8, "copyright": 8, "exactli": [8, 30, 34, 37, 42, 46, 48, 49], "blank": [8, 34], "four": [8, 34], "space": [8, 14, 29, 38], "colon": [8, 14, 42], "horizont": [8, 34], "nois": 8, "fooid": [8, 13], "convent": [8, 14, 37, 46, 47, 48], "normal": [8, 14, 17, 18, 20, 34, 37, 40], "xmlhttprequest": 8, "camelcas": 8, "lowercas": [8, 14, 30, 37], "dot": [8, 29, 33], "dynamodb": [8, 11, 14, 41], "view": 9, "io": 9, "typescript": 9, "introduc": [10, 37, 49], "learn": [10, 14, 24, 27], "test": [10, 11, 13, 14, 16, 27, 29, 30, 32, 33, 34, 35, 37, 38, 40, 41, 43, 44, 45, 47, 48, 49], "uninterpret": [10, 37], "bit": [10, 37], "rang": [10, 29, 34, 35, 37, 38, 42, 47], "128": [10, 37], "127": [10, 37], "16": [10, 37], "32": [10, 37], "768": [10, 37], "767": [10, 37], "31": [10, 11, 37], "64": [10, 16, 37], "63": [10, 14, 37], "precis": [10, 37, 40, 49], "ieee": [10, 15, 17, 18, 19, 20, 21, 37], "754": [10, 15, 17, 18, 19, 20, 21, 37], "biginteg": [10, 15, 17, 18, 19, 20, 21, 30, 33, 34, 36, 37, 39, 42, 45, 49], "arbitrarili": [10, 37], "bigdecim": [10, 15, 17, 18, 19, 20, 21, 30, 33, 34, 36, 37, 39, 42, 45, 49], "decim": [10, 37, 49], "instant": [10, 30, 37], "utc": [10, 37, 40], "offset": [10, 37, 40], "timezon": [10, 37], "untyp": [10, 34], "homogen": [10, 37], "fix": [10, 29, 30, 37, 40], "heterogen": [10, 34, 37], "demonstr": [10, 46], "we": 10, "citi": 10, "forecast": [10, 37, 41], "mani": [10, 14, 15, 17, 18, 19, 20, 21, 23, 29, 33, 34, 37, 46], "singleton": 10, "listciti": 10, "getciti": 10, "getforecast": [10, 37, 55], "getcurrenttim": 10, "tripl": 10, "slash": [10, 14, 33, 34], "ast": [10, 34, 35, 37, 47], "cityid": 10, "parent": [10, 11, 14, 37], "per": [10, 14, 29, 33, 34, 37], "put": [10, 13, 14, 33, 36, 41, 42], "canon": [10, 12, 37], "readonli": [10, 13, 31, 32, 33, 35, 37, 41, 47], "getcityinput": 10, "getcityoutput": 10, "nosuchresourc": [10, 41], "coordin": [10, 40], "citycoordin": 10, "latitud": 10, "longitud": 10, "resourcetyp": 10, "And": [10, 33, 35], "getforecastinput": [10, 37], "getforecastoutput": [10, 37], "chanceofrain": [10, 37], "side": [10, 15, 17, 18, 19, 20, 21, 29, 42, 49, 50, 53], "inputtoken": [10, 29], "outputtoken": [10, 29], "truncat": [10, 15, 17, 18, 19, 20, 21, 29, 37, 40], "item": [10, 19, 29, 30, 37, 42, 45], "listcitiesinput": 10, "listcitiesoutput": 10, "citysummari": 10, "subsequ": [10, 29, 38, 42], "retriev": [10, 14, 17, 18, 20, 29, 36, 37, 38, 42], "usual": [10, 11, 23], "good": [10, 49, 55], "idea": [10, 49, 55], "grow": 10, "unpredict": [10, 29], "size": [10, 12, 15, 17, 18, 19, 20, 21, 29, 30, 33, 43], "give": [10, 14, 37, 46, 49], "relationship": [10, 33, 35, 36, 37, 41], "link": [10, 14, 31, 41], "dry": 10, "fit": [10, 37, 40], "design": [10, 14, 29, 33, 38, 40, 41], "getcurrenttimeinput": 10, "getcurrenttimeoutput": 10, "now": 10, "Then": [10, 11, 37], "uncom": 10, "task": [10, 49], "sure": 10, "That": [10, 30, 33, 49], "try": 10, "plenti": 10, "explor": 10, "teach": 10, "everyth": 10, "know": [10, 29, 43, 44, 49], "sampl": [10, 15, 19], "three": [10, 34, 37, 42, 46, 51], "laid": 10, "request": [11, 12, 13, 17, 18, 20, 21, 22, 23, 25, 26, 27, 32, 33, 35, 37, 42, 48, 49, 50, 51, 53, 54], "usageidentifierkei": 11, "formerli": 11, "usag": [11, 14], "plan": 11, "2018": [11, 12, 14, 42, 51, 55], "beyond": [11, 37], "customauthtyp": 11, "embed": 11, "uniform": 11, "west": [11, 14, 26], "2015": 11, "account_id": [11, 12], "lambda_function_nam": 11, "service_api": 11, "host": [11, 14, 19, 24, 32, 33, 46], "remain": [11, 34, 49], "initi": [11, 12, 14, 19, 29, 35, 37, 48], "functionarn": 11, "role": [11, 14], "identitysourc": 11, "hold": [11, 15], "submit": 11, "cach": [11, 33, 42], "querystr": 11, "deriv": [11, 13, 14, 27, 32], "verifi": [11, 42], "null": [11, 15, 17, 18, 19, 20, 21, 30, 32, 34, 37, 44, 46, 49], "401": 11, "unauthor": 11, "identityvalidationexpress": 11, "incom": [11, 51, 53, 54], "aud": 11, "resultttlinsecond": 11, "ttl": 11, "equal": [11, 29, 34, 35, 37, 42, 49], "greater": [11, 29, 34, 42, 49], "300": [11, 49], "maximum": [11, 19, 29, 30, 33, 49], "3600": 11, "hour": [11, 29, 49], "z": [11, 14, 30, 42, 48, 49], "100": [11, 33, 34, 37], "hierarch": [11, 14, 48], "depth": 11, "http_proxi": 11, "aws_proxi": 11, "notif": [11, 14], "httpmethod": 11, "post": [11, 13, 15, 17, 18, 19, 33, 43, 46], "unspecifi": 11, "manual": [11, 29], "grant": [11, 16], "polici": [11, 14, 16], "passthroughbehavior": 11, "unmap": 11, "when_no_templ": 11, "when_no_match": 11, "handl": [11, 14, 17, 18, 20, 21, 26, 31, 37, 48, 51, 52, 53, 54], "timeoutinmilli": 11, "timeout": 11, "50": [11, 33, 37, 40], "m": 11, "29": [11, 28, 40], "000": 11, "vpclink": 11, "connectiontyp": 11, "network": [11, 29, 54], "internet": [11, 50], "routabl": 11, "vpc_link": 11, "balanc": [11, 14, 29, 49], "vpc": 11, "cachenamespac": 11, "payloadformatvers": 11, "proxi": [11, 19, 33], "cachekeyparamet": 11, "whose": [11, 14, 32, 48], "desir": [11, 34, 42, 49], "012345678901": 11, "helloworld": 11, "exec": 11, "stage": 11, "xml": [11, 26, 27, 35, 40, 47], "statuscod": 11, "responseparamet": 11, "requestid": [11, 15, 19, 21], "cid": 11, "responsetempl": 11, "302": 11, "redirect": 11, "400": [11, 19, 20, 21, 33, 40, 46, 55], "myoper": [11, 16, 31, 33, 36, 37, 46], "convert_to_text": 11, "convert_to_binari": 11, "decod": [11, 29, 33, 46, 54], "predefin": [11, 44], "userid": [11, 37], "op": 11, "respect": [11, 16, 19, 49], "statu": [11, 20, 21, 27, 31, 32, 33, 40, 44, 46, 49, 50], "select": [11, 14, 42, 49], "regex": [11, 14, 30, 46], "errormessag": [11, 30, 42, 46], "failur": [11, 30, 46, 50, 55], "throw": [11, 29, 50, 51, 53], "integrationrespons": 11, "2xx": 11, "suppli": [11, 14, 37, 38, 51, 53, 55], "scope": [12, 14, 35, 37, 45], "arnnamespac": [12, 16, 27], "comput": [12, 13, 14, 16, 23, 34, 42, 49], "annot": [12, 13, 14, 15, 16, 19, 26, 28, 29, 30, 31, 32, 33, 41, 43, 44, 45, 48], "amount": [12, 19, 34, 49], "calcul": [12, 23], "putth": [12, 14, 33], "putthingsinput": [12, 14], "putthingsoutput": [12, 14], "sha256": [12, 14, 23], "cognito": [12, 14], "pool": 12, "element": [12, 15, 19, 21, 29, 30, 37, 46], "user_pool_id": 12, "additionalschema": 13, "interact": 13, "additionalfooproperti": 13, "fooresourc": 13, "barproperti": 13, "responsecod": 13, "getfoo": [13, 29], "getfoorequest": 13, "getfoorespons": 13, "httplabel": [13, 20, 21, 35, 43, 46, 47], "httpresponsecod": [13, 19, 35, 47], "createfoo": 13, "updatefoo": 13, "createfoorequest": 13, "createfoorespons": 13, "createproperti": 13, "complexproperti": 13, "mutableproperti": 13, "writeproperti": 13, "createwriteproperti": 13, "readproperti": 13, "idempot": [13, 33, 35, 36, 37, 41, 47], "updatefoorequest": 13, "anotherproperti": 13, "fulli": [13, 14, 34, 37, 48], "fooproperti": 13, "taglist": [13, 14], "immutableset": 13, "updatedat": 13, "createdat": 13, "secret": 13, "password": 13, "alias": 13, "alia": [13, 42], "fooalia": 13, "culmin": 13, "httpqueri": [13, 20, 21, 35, 42, 46, 47], "addedproperti": 13, "immut": 13, "primari": [13, 40, 51], "none": [13, 14, 29, 37, 39, 49], "product": [14, 33, 34, 37, 38, 40, 42, 45], "cloudformationservic": 14, "across": [14, 29, 30, 33, 34, 36, 37, 46, 47, 49], "summar": 14, "onc": [14, 29, 36, 37, 43, 48], "publicli": 14, "brand": 14, "serviceid": 14, "inappropri": [14, 29], "taken": [14, 33, 40], "offici": [14, 29, 52], "storag": 14, "off": [14, 29, 54], "digit": [14, 30, 34, 37, 45, 49], "explicitli": [14, 16, 19, 26, 29, 33, 37, 40, 41, 42, 43, 48, 53], "overridden": 14, "though": [14, 30, 49, 51], "php": 14, "apigatewaycli": 14, "major": [14, 31, 34], "resourcenam": 14, "face": [14, 50], "eventsourc": 14, "cloudtrail": 14, "record": 14, "amazonaw": [14, 26, 49], "ec2": [14, 27, 49], "swf": 14, "cloudwatch": 14, "monitor": 14, "Such": [14, 37], "dash": 14, "partit": [14, 29], "subject": [14, 29, 48], "therefor": [14, 42], "substitut": [14, 46, 48], "percent": [14, 33, 46], "myresourceid": 14, "noregion": 14, "noaccount": 14, "partitionnam": 14, "china": 14, "beij": 14, "cn": 14, "rd": 14, "resid": 14, "hyphen": 14, "123456789012": 14, "vari": 14, "databas": 14, "elast": 14, "beanstalk": 14, "elasticbeanstalk": 14, "app": 14, "myenviron": 14, "david": 14, "eu": 14, "db": 14, "mysql": 14, "bucket": [14, 24, 41, 49], "my_corporate_bucket": 14, "exampleobject": 14, "png": 14, "myresourc": [14, 16, 33, 37], "myid": 14, "accountid": [14, 24], "insert": [14, 33, 37, 38, 45], "someresourc": [14, 36], "someservic": 14, "someresourceid": 14, "context": [14, 29, 31, 35, 37, 38, 52, 53, 55], "previou": [14, 29, 34, 37, 38, 42], "simpletyp": [14, 38, 42, 45], "conjunct": 14, "machin": [14, 24, 27, 37], "imag": [14, 31], "audio": 14, "video": [14, 40], "transfer": [14, 15, 19, 33, 40], "forego": 14, "administr": 14, "statist": 14, "analyt": 14, "rule": [14, 15, 19, 30, 33, 35, 36, 38, 40, 42, 49, 50], "plane": 14, "cellular": 14, "infrastructur": 14, "expir": [14, 29], "address": [14, 24, 37, 49], "cacheperiodinminut": 14, "denot": [14, 34], "illustr": [14, 30, 37, 42], "describeendpoint": 14, "getobject": 14, "invalidendpointerror": 14, "fooservic": 14, "09": [14, 42], "describeendpointsinput": 14, "describeendpointsoutput": 14, "httperror": [14, 20, 21, 29, 35, 42, 44, 46, 47, 50, 55], "421": 14, "getobjectinput": 14, "getobjectoutput": 14, "synchron": 14, "asynchron": [14, 43, 48, 49], "priorit": 14, "evict": 14, "minut": [14, 49], "refresh": 14, "period": [14, 17, 18, 29, 32, 49], "highest": [14, 29], "continu": [14, 35, 37, 42, 49, 55], "lru": 14, "global": [14, 16], "requestalgorithmmemb": 14, "algorithm": [14, 28, 29, 34, 49], "crc32c": 14, "crc32": 14, "sha1": 14, "requestchecksumrequir": 14, "md5": [14, 29], "requestvalidationmodememb": 14, "responsealgorithm": 14, "validationmod": 14, "putsometh": [14, 29], "checksumalgorithm": 14, "putsomethinginput": [14, 29], "putsomethingoutput": [14, 29], "httpheader": [14, 20, 21, 29, 32, 35, 43, 46, 47], "trailer": [14, 33], "chunk": [14, 15, 19], "skip": [14, 42, 46], "rais": 14, "conform": [14, 16, 38, 53], "directli": [14, 37, 41, 51, 53, 54, 55], "scenario": [14, 29], "unsign": [14, 27], "thu": [14, 42, 43], "supersed": [14, 37], "exhaust": [14, 15, 19, 26], "acm": [14, 31], "certif": 14, "manag": [14, 29, 33, 37], "auto": 14, "scale": 14, "appstream": 14, "athena": 14, "budget": 14, "clouddirectori": 14, "cloudfront": 14, "cloudhsm": 14, "v2": 14, "cloudsearch": 14, "domain": [14, 32, 37, 42], "codebuild": 14, "codecommit": 14, "codedeploi": 14, "codepipelin": 14, "codestar": 14, "cost": [14, 49], "report": [14, 35], "pipelin": 14, "dax": 14, "acceler": 14, "devic": 14, "farm": 14, "direct": [14, 29, 30, 34, 35, 37], "migrat": [14, 19], "cloud": 14, "ecr": 14, "registri": 14, "ec": 14, "ef": 14, "elasticach": 14, "transcod": 14, "emr": 14, "mapreduc": 14, "elasticsearch": 14, "firehos": 14, "kinesi": 14, "gamelift": 14, "glacier": [14, 24, 27], "glue": 14, "greengrass": 14, "health": 14, "importexport": 14, "inspector": 14, "iot": 14, "km": 14, "lex": 14, "lightsail": 14, "marketplac": 14, "entitl": 14, "commerc": 14, "meter": 14, "hub": 14, "mobil": 14, "mturk": 14, "turk": 14, "opswork": 14, "opsworkscm": 14, "chef": 14, "pinpoint": 14, "polli": 14, "redshift": 14, "rekognit": 14, "53": [14, 19], "simpledb": 14, "catalog": 14, "se": 14, "email": 14, "shield": 14, "sm": 14, "snowbal": 14, "sn": 14, "sq": 14, "ssm": 14, "sfn": 14, "st": 14, "waf": 14, "workdoc": 14, "workspac": 14, "xrai": 14, "rai": 14, "awsqueri": [15, 27, 47], "xmlnamespac": [15, 19, 21, 35, 47], "05": [15, 17, 18, 19, 51, 55], "mystruct": 15, "xmlname": [15, 19, 21, 26, 35, 47], "cor": [15, 17, 18, 19, 20, 21, 35, 47], "hostprefix": [15, 17, 18, 19, 20, 21, 32, 33, 46], "xmlattribut": [15, 19, 21, 35, 40, 47], "xmlflatten": [15, 19, 21, 35, 47], "unwrap": [15, 19, 21, 26, 45], "xmln": [15, 19, 21, 26, 45], "requestcompress": [15, 17, 18, 19, 20, 21, 35, 47], "compress": [15, 17, 18, 19, 20, 21, 35, 53], "index": [15, 19, 46], "increment": [15, 19], "counter": [15, 19, 49], "shall": [15, 17, 18, 19, 20, 21, 29, 35], "3986": [15, 19, 32, 33], "concaten": [15, 19, 33, 34, 37, 38], "scientif": [15, 19, 21, 45], "notat": [15, 19, 21, 35, 45], "expon": [15, 19, 21, 45], "unfortun": [15, 17, 18, 19, 20, 21], "parser": [15, 17, 18, 19, 20, 21, 34, 36, 46], "unabl": [15, 17, 18, 19, 20, 21], "pars": [15, 17, 18, 19, 20, 21, 34, 37, 40, 42, 46, 53], "exce": [15, 17, 18, 19, 20, 21, 49], "suit": [15, 17, 18, 19, 20, 21, 46], "ec2querystructuresinput": 15, "hasquerynam": 15, "ignorem": 15, "hasqueryandxmlnam": 15, "usesxmlnam": 15, "temp": [15, 19], "ec2querystructur": 15, "example0": 15, "example1": [15, 19, 45], "example2": [15, 19, 45], "example3": [15, 19, 45], "ec2querylistsinput": 15, "listarg": [15, 19], "stringlist": [15, 19, 29, 34], "complexlistarg": [15, 19], "greetinglist": [15, 19], "renamedlistarg": 15, "greetingstruct": [15, 19], "ec2querylist": 15, "hola": [15, 19], "success": [15, 19, 33, 34, 49], "xmltest": [15, 19], "xmltestrespons": [15, 19], "testvalu": [15, 19], "comprehens": [15, 19, 21], "distinguish": [15, 17, 18, 19, 20, 21], "invalidgreet": [15, 19, 21, 46], "anotherset": [15, 19, 21], "hypothet": [15, 19, 21, 28, 37, 40], "posit": [15, 17, 18, 19, 20, 21, 48], "neg": [15, 17, 18, 19, 20, 21, 29], "Not": [15, 17, 18, 19, 20, 21, 37, 43], "norm": [15, 17, 18, 19, 20, 21, 37, 49], "github": [15, 17, 18, 19, 20, 21, 35, 42], "lang": [15, 17, 18, 19, 20, 21, 35], "tree": [15, 17, 18, 19, 20, 21, 23, 34, 36], "todo": [15, 17, 18, 20, 21, 26, 42], "permit": [15, 17, 18, 19, 20, 21, 33, 34, 37], "__type": [15, 17, 18, 19, 20, 21], "serviceerror": [15, 18, 19, 20, 21], "henc": [15, 18, 19, 20, 21], "infer": 16, "augment": [16, 35, 41], "brief": 16, "entail": 16, "myresourcefoo": 16, "otherservic": 16, "definedcontextkei": 16, "2017": [16, 28, 36, 37, 40], "11": [16, 28, 36, 37, 40, 49], "62": [16, 49], "ipaddress": 16, "arrayofarn": 16, "arrayofbinari": 16, "arrayofbool": 16, "arrayofd": 16, "arrayofipaddress": 16, "arrayofnumer": 16, "arrayofstr": 16, "datetim": 16, "profil": 16, "iso": 16, "8601": 16, "4632": 16, "unord": [16, 37, 42], "ancestor": 16, "had": 16, "otheroper": 16, "princip": 16, "iamus": 16, "iamrol": 16, "federatedus": 16, "deviat": [16, 45], "superresourc": 16, "superid": 16, "myinnerresourc": 16, "innerresourc": 16, "yum": 16, "innerresourceyum": 16, "eventstreamhttp": [17, 18, 20, 21], "layer": [17, 18, 20, 21, 40, 53], "negoti": [17, 18, 20, 21], "alpn": [17, 18, 20, 21], "h2": [17, 18, 20, 21], "7230": [17, 18, 33], "join": [17, 18, 54], "myop": [17, 18], "unix": [17, 18, 20, 34, 37, 40, 46], "observ": [17, 18, 20], "still": [17, 18, 29, 37, 48, 49, 50, 51, 55], "amzn": [17, 18, 19, 20], "errortyp": [17, 18, 20, 46, 49], "legaci": [17, 18, 20], "sometim": [17, 18, 20, 42, 54], "sanit": [17, 18, 20], "fooerror": [17, 18, 20], "coral": [17, 18, 20], "protocoltest": [17, 18, 20], "restjson": [17, 18, 20, 42], "readabl": [19, 37, 44], "querystructuresinput": 19, "querystructur": 19, "querylistsinput": 19, "flattenedlistarg": 19, "listargwithxmlnamememb": 19, "listwithxmlnam": 19, "notic": [19, 41], "flattenedlistargwithxmlnam": 19, "querylist": 19, "querymapsinput": 19, "maparg": 19, "stringmap": [19, 33], "renamedmaparg": 19, "complexmaparg": 19, "complexmap": 19, "mapwithxmlmembernam": 19, "mapwithxmlnam": 19, "k": 19, "v": 19, "querymap": 19, "responsemetadata": 19, "ok": [19, 37], "mon": 19, "27": [19, 29], "jul": 19, "2009": 19, "12": [19, 30, 49], "28": [19, 42], "gmt": [19, 40], "xmltestresult": 19, "c6104cbe": 19, "af31": 19, "11e0": 19, "8154": 19, "cbc7ccf896c7": 19, "errorrespons": [19, 21], "bad": [19, 49, 55], "sender": [19, 21, 29], "One": [19, 21, 36, 37, 42, 46, 48, 51], "whomev": [19, 21], "fault": [19, 21, 44], "perspect": [19, 21], "500": [19, 20, 21, 33, 42], "invalidth": 19, "invalidthingexcept": 19, "compatibli": [19, 31], "awsjson1_0": [19, 27, 47], "04": [20, 21, 33, 37, 40, 42], "awsjson1_1": [20, 27, 47], "httpqueryparam": [20, 21, 35, 47], "plain": [20, 21, 29, 31, 37, 46], "octet": [20, 21], "anyth": [20, 38], "noerrorwrap": 21, "upload": 23, "archiv": 23, "uploadarch": 23, "uploadmultipartpart": 23, "hash": 23, "checksum": [24, 27, 29], "predictendpoint": 24, "closest": 26, "compos": [26, 37, 42], "unset": 26, "prepend": [26, 32, 33], "bucketnam": [26, 33, 41], "dualstack": 26, "endpointprefix": [26, 27], "restxml": [26, 27, 47], "abridg": 26, "getbucketloc": 26, "getbucketlocationinput": 26, "getbucketlocationoutput": 26, "locationconstraint": 26, "bucketlocationconstraint": 26, "us_west_2": 26, "shown": 26, "core": [27, 35, 37, 39, 47], "cloudtraileventsourc": 27, "docid": 27, "arnrefer": [27, 47], "classif": 27, "controlplan": [27, 42, 47], "dataplan": [27, 42, 47], "clientendpointdiscoveri": [27, 47], "clientdiscoveredendpoint": [27, 47], "clientendpointdiscoveryid": [27, 47], "httpchecksum": [27, 47], "httpchecksumrequir": [27, 35, 47], "appendix": [27, 33, 35], "unsignedpayload": [27, 47], "actionpermissiondescript": [27, 47], "conditionkei": [27, 47], "defineconditionkei": [27, 47], "disableconditionkeyinfer": [27, 47], "supportedprincipaltyp": [27, 47], "iamresourc": [27, 47], "share": [27, 33, 37, 46], "contenthandl": 27, "requestparamet": 27, "requesttempl": 27, "cfnresourc": [27, 47], "cfnexcludeproperti": [27, 47], "cfnmutabl": [27, 47], "cfnadditionalidentifi": [27, 47], "cfndefaultvalu": [27, 47], "complianc": [27, 35, 47], "www": [27, 31, 33], "urlencod": 27, "resolut": [27, 35, 41], "awsqueryerror": [27, 47], "awsquerycompat": [27, 47], "ec2queri": [27, 47], "ec2querynam": [27, 47], "fooexampl": 28, "weatherservic": [28, 40, 55], "algorithmauth": 28, "algorithmauthalgorithm": 28, "sha": 28, "basic": [28, 33, 53], "2617": 28, "digest": 28, "bearer": 28, "6750": 28, "unauthent": 28, "pingserv": 28, "someunauthenticatedoper": 28, "servicewithnoauthtrait": 28, "servicewithauthtrait": 28, "invalid": [28, 30, 31, 32, 33, 34, 37, 38, 42, 43, 46, 48, 49], "invalidexampl": 28, "discard": [29, 37, 48], "replai": 29, "uuid": 29, "retri": 29, "due": [29, 37, 49, 54], "allocatewidget": 29, "allocatewidgetinput": 29, "clienttoken": 29, "deletesometh": 29, "deletesomethinginput": 29, "deletesomethingoutput": 29, "inher": [29, 37], "getsometh": [29, 37], "getsomethinginput": [29, 37], "getsomethingoutput": [29, 37], "503": 29, "serviceunavailableerror": 29, "429": [29, 44], "throttlingerror": [29, 43, 44], "intention": 29, "divid": 29, "discret": 29, "cursor": 29, "fill": 29, "meet": 29, "latenc": 29, "getfoosinput": 29, "getfoosoutput": 29, "seri": 29, "abnf": [29, 35, 36, 37, 42, 45, 46, 49], "resultwrapp": 29, "natur": [29, 49], "ten": 29, "sort": 29, "rank": 29, "reach": [29, 49], "relev": 29, "yet": [29, 37], "seen": 29, "iter": [29, 33, 34], "last": [29, 33, 34, 49], "free": 29, "back": [29, 30, 37, 53, 55], "stop": [29, 42, 49], "impli": [29, 38], "tail": 29, "infinit": 29, "loop": 29, "opaqu": [29, 37], "extrem": 29, "hard": [29, 37], "proof": 29, "recogn": [29, 50], "24": [29, 49], "quickli": [29, 49], "phase": [29, 53], "ephemer": 29, "reject": [29, 31, 37, 46, 51], "certain": [29, 33, 55], "smaller": 29, "sum": 29, "presenc": [29, 37], "absenc": 29, "1864": 29, "requireslength": [29, 35, 47], "avoid": [29, 30, 37, 38, 49], "gzip": 29, "streamingmemb": 29, "streamingfoo": 29, "disable_request_compress": 29, "older": 29, "9110": 29, "putwithcontentencod": 29, "customencod": 29, "brotli": 29, "putwithcontentencodinginput": 29, "prior": [29, 32, 43], "mismatch": [29, 50], "small": 29, "minimum": [29, 30, 34, 49], "threshold": 29, "request_min_compression_size_byt": 29, "lowest": 29, "disablerequestcompress": 29, "trigger": [29, 49], "10485760": 29, "10240": 29, "requestmincompressionsizebyt": 29, "qualiti": [29, 48], "tradeoff": 29, "speed": 29, "els": [29, 49], "constrain": [30, 38, 42, 51], "constant": [30, 46], "encourag": [30, 53], "reliabl": 30, "ascii": 30, "latin": 30, "zero": [30, 34, 37, 42, 43, 48], "z_": 30, "z_0": 30, "stricter": 30, "commonmark": [30, 31, 34, 46, 49], "categor": [30, 46, 49], "mystr": [30, 31, 34, 35, 36, 37, 38], "t2": 30, "nano": 30, "t2_nano": 30, "burstabl": 30, "baselin": 30, "cpu": 30, "burst": 30, "ebsonli": 30, "micro": 30, "t2_micro": 30, "m256": 30, "mega": 30, "m256_mega": 30, "primarili": [30, 44], "failwhenmiss": [30, 42], "integerref": 30, "notfound": [30, 37, 49], "invalidshape1": 30, "invalidshape2": 30, "invalidshape3": 30, "validshap": 30, "validshape2": 30, "syntact": 30, "unicod": [30, 34], "scalar": [30, 42], "ecma": 30, "262": 30, "dialect": 30, "recurs": [30, 35], "lookahead": 30, "behind": [30, 51], "chosen": 30, "care": [30, 31, 33, 38], "expens": 30, "malform": 30, "owasp": 30, "implicitli": [30, 37, 40, 41, 53], "w": [30, 34], "wherea": [30, 31, 49], "real": 30, "fall": [30, 37, 50], "myint": 30, "foostr": 30, "mylist": [30, 34, 36, 37, 45], "codepoint": 30, "matter": 30, "mathemat": 30, "partial": 30, "numberofitem": 30, "positiveinteg": 30, "7": [30, 33, 40, 48, 49], "shoppingcart": 30, "materi": 31, "somestr": 31, "otherstr": 31, "constraint": [31, 33, 34, 35, 37, 38, 42, 44, 46, 47, 48, 55], "myoperationinput": [31, 33, 36, 37], "myoperationoutput": [31, 36, 37], "myoperationerror": 31, "pend": 31, "ref": 31, "benefit": [31, 37, 51], "putcontentsinput": 31, "validatecont": 31, "transmit": [31, 43], "visibl": 31, "particular": [31, 33, 37, 48, 49, 53], "experiment": 31, "somestructur": 31, "proper": [31, 42], "friendli": 31, "mysimpleimageservic": 31, "userinfo": 32, "port": 32, "risk": 32, "getstatu": [32, 33], "getstatusinput": [32, 33], "getstatusoutput": [32, 33], "surround": [32, 33], "close": [32, 33, 34, 42, 48], "brace": [32, 33, 34, 48], "label_nam": [32, 33], "abc": [32, 40], "immedi": [32, 33, 34, 37], "adjac": [32, 33], "def": [32, 40], "decor": [32, 48], "inject": [32, 38], "expans": [32, 38], "AND": 32, "spam": 32, "egg": 32, "poorli": 33, "interoper": 33, "204": 33, "205": 33, "299": 33, "999": [33, 37], "putobject": 33, "putobjectinput": 33, "objectkei": [33, 41], "paramnam": 33, "somevalu": [33, 48], "myblob": 33, "safeti": [33, 51], "characterist": 33, "5": [33, 34, 40, 42, 46, 49], "v1": 33, "fragment": 33, "getservic": 33, "getserviceoutput": 33, "yourhost": 33, "ye": [33, 48], "miss": [33, 34, 35, 37, 42, 46], "captur": [33, 37, 42], "span": [33, 34, 38, 48], "label1": 33, "label2": 33, "portion": 33, "requiredkei": 33, "otherkei": 33, "requiredvalu": 33, "disregard": 33, "othervalu": 33, "qualifi": [33, 34, 37, 42], "whole": [33, 51], "middl": 33, "greedili": 33, "longest": 33, "ambigu": [33, 35, 37], "delimit": [33, 34, 38, 42], "legal": 33, "illeg": 33, "occupi": 33, "bam": [33, 34], "coexist": 33, "404": 33, "myerror": 33, "rfc7230": 33, "imf": [33, 40], "fixdat": [33, 40], "7231": [33, 40], "enforc": [33, 37, 38], "practic": [33, 37, 38], "carefulli": 33, "discourag": 33, "te": 33, "upgrad": 33, "agent": 33, "3339": [33, 37, 40, 45, 48], "1985": [33, 37, 40], "12t23": [33, 37, 40], "20": [33, 37, 40, 42], "52z": [33, 37], "3a20": 33, "3a50": 33, "unreserv": 33, "random": [33, 49], "getrandombinarydata": 33, "getrandombinarydatainput": 33, "getrandombinarydataoutput": 33, "contenttyp": 33, "raw": [33, 51], "differenti": [33, 34, 37], "listth": [33, 36], "listthingsinput": 33, "listthingsoutput": 33, "breviti": 33, "concern": [33, 43], "myparam": 33, "mapofstr": 33, "meaning": [33, 37, 39, 50], "putthinginput": 33, "thingid": 33, "realid": 33, "fakeid": 33, "othertag": 33, "postth": 33, "postthinginput": 33, "anothertag": 33, "lasttag": 33, "201": 33, "cross": 33, "browser": 33, "maxag": 33, "600": 33, "ag": [33, 34], "additionalallowedhead": 33, "additionalexposedhead": 33, "publishmessag": [33, 43], "publishmessagesinput": [33, 43], "messagestream": [33, 43], "invalidoper": 33, "invalidoperationinput": 33, "grammar": [34, 35, 36], "usestat": 34, "shorter": 34, "5234": [34, 35], "controlsect": 34, "metadatasect": 34, "shapesect": 34, "sp": 34, "nl": 34, "x20": [34, 42], "x09": 34, "tab": 34, "x0a": 34, "x0d": 34, "0a": 34, "r": 34, "10ffff": [34, 42], "documentationcom": 34, "linecom": 34, "notnl": 34, "controlstat": 34, "nodeobjectkei": 34, "nodevalu": [34, 37], "br": 34, "metadatastat": 34, "nodearrai": 34, "nodeobject": 34, "nodekeyword": 34, "nodestringvalu": 34, "trailingcomma": 34, "nodeobjectkvp": 34, "quotedtext": 34, "minu": [34, 49], "int": 34, "frac": 34, "exp": 34, "x2e": 34, "x31": 34, "39": [34, 49], "x65": 34, "x45": 34, "decimalpoint": 34, "digitonetonin": 34, "x2d": 34, "x2b": 34, "x30": 34, "textblock": 34, "dquot": [34, 42], "quotedchar": 34, "21": [34, 42], "x23": [34, 42], "5b": [34, 42], "x5d": [34, 42], "escapedchar": 34, "preserveddoubl": 34, "unicodeescap": 34, "hex": 34, "x41": [34, 49], "46": 34, "x61": 34, "66": 34, "x5c": 34, "threedquot": 34, "namespacestat": 34, "usesect": 34, "shapestat": 34, "absoluterootshapeid": [34, 37], "applystat": 34, "traitstat": [34, 37], "shapebodi": 34, "simpleshapestat": 34, "liststat": 34, "setstat": 34, "mapstat": 34, "structurestat": 34, "unionstat": 34, "servicestat": 34, "operationstat": 34, "resourcestat": 34, "simpletypenam": 34, "listmemb": 34, "explicitlistmemb": 34, "setmemb": 34, "explicitsetmemb": 34, "mapmemb": 34, "mapkei": 34, "mapvalu": 34, "explicitmapkei": 34, "explicitmapvalu": 34, "structurememb": 34, "explicitstructurememb": 34, "unionmemb": 34, "explicitunionmemb": 34, "traitbodi": 34, "traitbodyvalu": 34, "traitstructur": 34, "traitstructurekvp": 34, "termin": [34, 43], "minor": 34, "unexpect": [34, 43, 50], "less": [34, 37, 42, 49], "greet": [34, 46], "unquot": 34, "examplesyntacticshapeid": 34, "mymap": [34, 45], "anothertrait": 34, "satisfi": [34, 38, 42], "myboolean": 34, "invalidshap": 34, "quot": [34, 38, 42], "incorrect": 34, "sugar": 34, "inconsequenti": 34, "syntacticshapeidtarget": 34, "bring": [34, 37], "attent": 34, "broken": 34, "unintention": 34, "rare": [34, 37], "stringset": [34, 37], "integermap": [34, 36, 37], "myunion": [34, 36, 37], "i32": [34, 37], "modelrepositori": 34, "pingservic": 34, "13": [34, 45, 49], "unavail": 34, "badrequest": [34, 37], "pingserviceinput": 34, "pingserviceoutput": 34, "unavailableerror": 34, "badrequesterror": [34, 36, 37], "sprocketresourc": 34, "sprocketid": 34, "getsprocket": [34, 44], "sprocket": 34, "placement": 34, "enclos": [34, 42], "parenthesi": 34, "anim": 34, "kingdom": 34, "structuredtrait": [34, 37], "mystring1": 34, "mystring2": 34, "bracket": [34, 42], "myset": [34, 36, 45], "analog": 34, "advantag": 34, "456": 34, "an_arrai": 34, "1e": 34, "0e": 34, "cr": 34, "u000d": 34, "crlf": 34, "u000du000a": 34, "lf": 34, "u000a": 34, "platform": [34, 46], "concert": 34, "sequenc": 34, "0022": 34, "005c": 34, "002f": 34, "0008": 34, "backspac": 34, "000c": 34, "ff": 34, "000d": 34, "carriag": 34, "0009": 34, "ht": 34, "hhhh": 34, "uhhhh": 34, "hexadecim": 34, "noth": [34, 42], "heavili": 34, "inspir": 34, "jep": 34, "355": 34, "indent": [34, 38], "div": 34, "p": 34, "insignific": [34, 42], "rewritten": 34, "ill": 34, "count": 34, "wholli": 34, "third": 34, "fourth": 34, "margin": 34, "move": [34, 37, 49], "right": [34, 42, 43], "bear": 34, "visual": [34, 37], "trim": 34, "nbar": 34, "unescap": 34, "interpret": [34, 35, 40, 43, 46], "nbaz": 34, "intermix": 34, "2119": 35, "backu": 35, "naur": 35, "reader": 35, "invit": 35, "welcom": 35, "complementari": 35, "alongsid": [35, 37, 53], "idref": [35, 42, 47], "uniqueitem": [35, 37, 47], "errorexampl": 35, "unstabl": [35, 38, 47], "refin": [35, 37, 47], "protocoldefinit": [35, 42, 46, 47, 48], "authdefinit": [35, 42, 46, 47], "optionalauth": [35, 47], "idempotencytoken": [35, 46, 47], "retryabl": [35, 43, 44, 47], "noreplac": [35, 37, 47], "implicit": 35, "resourceidentifi": [35, 37, 47], "comparison": [35, 37, 38, 40], "neighbor": 35, "undirect": 35, "revers": [35, 53], "topdown": 35, "var": [35, 38], "emitnoneselector": 35, "lexic": 35, "statement": [35, 37, 42], "block": [35, 37], "isomorph": 36, "driver": 36, "simplic": 36, "stringmemb": 36, "numbermemb": 36, "getservertim": [36, 37], "someerror": [36, 37], "widget": [36, 37], "smithywidget": 36, "foowidget": [36, 37], "collectionoper": [36, 37, 42], "cyclic": [36, 37], "hierarchi": [36, 37, 42], "forecastid": [36, 37, 41], "createth": 36, "getth": [36, 49], "updateth": 36, "deleteth": 36, "someinstanceoper": 36, "somecollectionoper": 36, "notfounderror": [36, 37], "struct": [36, 45], "framework": [37, 49, 50, 53, 55], "facilit": 37, "figur": [37, 49], "concept": [37, 38], "improv": [37, 49], "modular": 37, "assembl": 37, "human": [37, 44], "aim": 37, "streamlin": 37, "ecosystem": 37, "graph": [37, 42], "shape_nam": 37, "member_nam": 37, "basi": 37, "atom": 37, "primit": 37, "unlik": [37, 45], "diagram": 37, "shapenam": [37, 41], "_________": 37, "_______": 37, "________": 37, "reusabl": 37, "formal": 37, "rootshapeid": [37, 42], "shapeidmemb": 37, "identifierstart": 37, "identifierchar": 37, "alpha": [37, 45, 49, 55], "pascalcas": 37, "inflect": 37, "facet": 37, "acronym": 37, "resourcearn": 37, "iochannel": 37, "htmlentiti": 37, "html_entiti": 37, "ideal": 37, "snake": 37, "prolept": 37, "gregorian": 37, "calendar": 37, "local": 37, "midnight": 37, "januari": [37, 40], "0001": 37, "ce": 37, "23": 37, "59": 37, "decemb": 37, "9999": 37, "tempor": 37, "millisecond": [37, 40], "broad": 37, "guarante": [37, 49], "unstructur": 37, "rigid": 37, "purview": 37, "simple_shape_stat": 37, "pre": 37, "list_stat": 37, "nullabl": 37, "dens": 37, "sparselist": [37, 44], "set_stat": 37, "agre": 37, "challeng": 37, "map_stat": 37, "sparsemap": [37, 44], "structure_stat": 37, "layout": 37, "similarli": 37, "variant": [37, 46], "union_stat": 37, "player": 37, "game": 37, "playeract": 37, "quit": 37, "directedact": 37, "jump": 37, "singular": 37, "unittyp": [37, 39], "imposs": [37, 43, 46], "validlist": 37, "intermediatestructur": 37, "recursivelist": 37, "mutual": 37, "recursiveshape1": 37, "recursivememb": 37, "recursiveshape2": 37, "service_stat": 37, "incident": 37, "fundament": 37, "getservertimeoutput": 37, "ubiquit": 37, "discern": 37, "badrequestexcept": 37, "thrown": [37, 50], "essenti": [37, 42, 55], "despit": 37, "sparingli": 37, "widget1": 37, "undeclar": 37, "operation_stat": 37, "mysideeffectoper": 37, "flexibl": [37, 49], "resource_stat": 37, "verbatim": 37, "resourcec": 37, "invalid1": 37, "invalid2": 37, "someotherstr": 37, "weatherdata": 37, "batchputforecast": 37, "batchputforecastsinput": 37, "batchputforecastsoutput": 37, "batchputforecastlist": 37, "historicalforecast": [37, 41], "historicalid": [37, 41], "historicalforecastid": [37, 41], "gethistoricalforecast": 37, "listhistoricalforecast": 37, "gethistoricalforecastinput": 37, "gethistoricalforecastoutput": 37, "customforecastidnam": 37, "customhistoricalidnam": 37, "putforecast": 37, "createforecast": 37, "updateforecast": 37, "deleteforecast": 37, "listforecast": 37, "putforecastinput": 37, "putforecastoutput": 37, "rfc7231": 37, "createforecastinput": 37, "createforecastoutput": 37, "resourcenotfound": 37, "updateforecastinput": 37, "updateforecastoutput": 37, "deleteforecastinput": 37, "deleteforecastoutput": 37, "listforecastsinput": 37, "listforecastsoutput": 37, "forecastlist": 37, "done": [37, 46, 48], "collis": 37, "prohibit": 37, "round": 37, "fraction": [37, 40], "mytraitnam": 37, "breakingchang": 37, "breakingchangerul": 37, "lorem": 37, "stringshap": 37, "ipsum": 37, "dolor": 37, "stand": 37, "mystring4": 37, "analysi": 37, "riski": 37, "review": 37, "problemat": 37, "cannotadd": 37, "cannottoaddorremov": 37, "namelist": 37, "han": 37, "luke": 37, "chewi": 37, "job": 37, "smuggler": 37, "jedi": 37, "ghost": 37, "wide": 37, "validconflict": 37, "lack": [37, 44], "et": 37, "al": 37, "higher": 37, "simpli": [37, 43, 50, 51, 53], "happen": [37, 49, 50, 53], "reconcil": 37, "guidanc": 37, "defer": 37, "customiz": 38, "great": 38, "deal": 38, "disciplin": 38, "coher": 38, "particularli": 38, "checkstyl": 38, "findbug": 38, "bug": [38, 49, 50], "pitfal": 38, "power": 38, "rigor": 38, "processor": 38, "somevalid": 38, "customeventid": 38, "someproperti": 38, "unknownvalidator_": 38, "unknownvalidator_foo": 38, "wrong": [38, 51], "unsuppress": 38, "unreferencedshap": 38, "overlybroadvalid": 38, "bindtotrait": 38, "messagetempl": 38, "missingdocument": 38, "operationinputnam": 38, "operationoutputnam": 38, "lifecyclegetnam": 38, "lifecycledeletenam": 38, "contextu": 38, "documentedstr": 38, "granular": [38, 40], "selector_context_valu": 38, "pipe": [38, 42], "goodby": 38, "unstabletrait": 38, "donotusem": 38, "nothing": 38, "descend": [38, 42], "print": 38, "omiss": 38, "rememb": 38, "missingconstrainttrait": 38, "did": 38, "forget": 38, "minim": [39, 49], "primitiveboolean": 39, "primitivebyt": 39, "primitiveshort": 39, "primitiveinteg": 39, "primitivelong": 39, "primitivefloat": 39, "primitivedoubl": 39, "noinlinedocumentsupport": 40, "jsonexampl": 40, "xmlexampl": 40, "configurableexampl": 40, "6838": 40, "quicktim": 40, "videodata": 40, "isol": 40, "aid": 40, "helper": 40, "contract": [40, 53], "contrast": 40, "520z": 40, "gracefulli": [40, 46], "tue": 40, "apr": 40, "2014": 40, "18": 40, "30": 40, "38": 40, "elaps": 40, "00": 40, "univers": [40, 53], "thursdai": 40, "1970": 40, "1515531081": 40, "liber": 40, "improperli": 40, "createt": 41, "updatet": 41, "derefer": 41, "5988": 41, "circumst": 41, "historicalrefer": 41, "customforecastid": 41, "customhistoricalid": 41, "anotherhistoricalrefer": 41, "meteorologist": 41, "forecastinform": 41, "someid": 41, "someshapeidentifi": 41, "meteorologistid": 41, "otherdata": 41, "someothershap": 41, "simpleresourc": 41, "simpleresourcerefer": 41, "serv": [41, 53], "said": 41, "filenam": 41, "getfil": 41, "getfileinput": 41, "getfileoutput": 41, "dsl": 42, "travers": 42, "thought": 42, "multidigraph": 42, "vertex": 42, "edg": [42, 46], "individu": [42, 51], "yield": [42, 53], "clear": 42, "hand": 42, "cast": 42, "80": 42, "fixm": 42, "assert": [42, 46, 51], "allowedtag": 42, "operationainput": 42, "badvalu": 42, "badenum": 42, "goodvalu": 42, "goodenum": 42, "tri": [42, 46], "negat": 42, "solv": 42, "neither": [42, 55], "criteria": 42, "chain": 42, "further": 42, "selectorforwarddirectedneighbor": 42, "y": [42, 48], "atyp": 42, "intenum": 42, "toler": 42, "variad": 42, "predic": 42, "soon": 42, "old": 42, "disqualifi": 42, "again": 42, "08": 42, "eagerli": 42, "selectorvariableset": 42, "reassign": 42, "selectorvariableget": 42, "authtrait": 42, "hasdigestauth": 42, "hasbasicauth": 42, "noauth": 42, "pseudo": 42, "matched_shap": 42, "current_shap": 42, "auth_trait": 42, "get_recursive_neighbor": 42, "__trait_auth_values_project": 42, "__auth_traits_id_project": 42, "issubset": 42, "selectorexpress": 42, "selectorshapetyp": 42, "selectorattr": 42, "selectorscopedattr": 42, "selectorfunct": 42, "selectorforwardundirectedneighbor": 42, "selectorreverseundirectedneighbor": 42, "selectorforwardrecursiveneighbor": 42, "selectorreversedirectedneighbor": 42, "selectordirectedrelationship": 42, "selectorkei": 42, "selectorattrcomparison": 42, "selectorcompar": 42, "selectorattrvalu": 42, "selectorpath": 42, "selectorpathseg": 42, "selectorvalu": 42, "selectorfunctionproperti": 42, "selectortext": 42, "selectorstringcompar": 42, "selectornumericcompar": 42, "selectorprojectioncompar": 42, "selectorscopedassert": 42, "selectorscopedvalu": 42, "selectorcontextvalu": 42, "selectorfunctionarg": 42, "selectorsinglequotedtext": 42, "selectordoublequotedtext": 42, "selectorsinglequotedchar": 42, "selectordoublequotedchar": 42, "26": 42, "x28": 42, "selectortest": 42, "skippreludeshap": 42, "atleastten": 42, "atleaston": 42, "atmostf": 42, "streamingoper": 43, "streamingoperationinput": 43, "streamingoperationoutput": 43, "streamingblob": 43, "finit": 43, "finitestreamingblob": 43, "duplex": 43, "simplex": 43, "frame": 43, "capabl": 43, "room": 43, "publishev": 43, "leaveev": 43, "subscribetomov": 43, "subscribetomovementsinput": 43, "subscribetomovementsoutput": 43, "movement": 43, "movementev": 43, "down": 43, "veloc": 43, "compris": 43, "opportun": [43, 53, 55], "subscribetomessag": 43, "subscribetomessagesinput": 43, "subscribetomessagesoutput": 43, "lifetim": 43, "connectionlifetim": 43, "dispatch": 43, "subscribetoev": 43, "subscribetoeventsinput": 43, "subscribetoeventsoutput": 43, "event1": 43, "event2": 43, "event3": 43, "exampleev": 43, "significantli": 44, "rust": 44, "boxedinteg": 44, "unbox": 44, "getsprocketinput": 44, "getsprocketrequest": 44, "getsprocketoutput": 44, "outermost": 45, "astruct": 45, "bstruct": 45, "dmfsdwu": 45, "1578255206": 45, "05t20": 45, "26z": 45, "flat": 45, "choic": [45, 53], "key1": 45, "key2": 45, "key3": 45, "notfoo": 45, "notflat": 45, "xmlidentifi": 45, "anotherstructur": 45, "junit": 46, "00000000": 46, "0000": 46, "4000": 46, "8000": 46, "000000000000": 46, "httprequesttestcas": 46, "unsupport": 46, "resolvedhost": 46, "discrep": 46, "authschem": 46, "queryparam": 46, "forbidqueryparam": 46, "requirequeryparam": 46, "forbidhead": 46, "requirehead": 46, "zm9vcg": 46, "bodymediatyp": 46, "runner": 46, "extract": [46, 49, 51], "vendorparam": 46, "disk": 46, "vendorparamsshap": 46, "appliesto": 46, "undesir": 46, "say_hello": 46, "exampleprotocol": 46, "teddi": 46, "20there": 46, "sayhello": 46, "sayhelloinput": 46, "httpresponsetestcas": 46, "say_goodby": 46, "farewel": 46, "bye": 46, "saygoodby": 46, "saygoodbyeinput": 46, "saygoodbyeoutput": 46, "invalid_greet": 46, "httpmalformedrequesttestcas": 46, "exercis": 46, "testparamet": 46, "permut": 46, "total": [46, 49], "codewrit": 46, "l": 46, "formatt": 46, "messageregex": 46, "varianc": 46, "invertnumb": 46, "numbervalu": 46, "malformedlongsinpathsreject": 46, "badnumer": 46, "001": 46, "2abc": 46, "boolean_coercion": 46, "float_trunc": 46, "trailing_char": 46, "invertnumberinput": 46, "waiter": 47, "eventhead": [47, 48], "eventpayload": [47, 48], "subscrib": 47, "topiclabel": 47, "httpmalformedrequesttest": 47, "httprequesttest": 47, "httpresponsetest": 47, "waitabl": 47, "transport": [48, 50, 53], "transmiss": 48, "establish": 48, "live": 48, "session": 48, "broker": 48, "qo": 48, "degre": 48, "deliv": 48, "repli": [48, 53], "alert": 48, "peer": 48, "packet": 48, "disconnect": 48, "exampleoperationinput": 48, "wildcard": 48, "extran": 48, "postfoo": 48, "postfooinput": 48, "anothervalu": 48, "destroi": 48, "unsubscrib": 48, "subscribeforev": 48, "subscribeforeventsinput": 48, "subscribeforeventsoutput": 48, "eventstream": 48, "2f": 48, "met": 48, "notc": 48, "mqttjson": 48, "const": [48, 51, 55], "poll": 49, "enter": 49, "eventu": 49, "cumbersom": 49, "prone": 49, "goal": 49, "onto": [49, 51], "who": 49, "turn": 49, "wait": 49, "pseudocod": 49, "instanceterminatedwait": 49, "builder": 49, "myclient": 49, "singletonlist": 49, "totalallowedwaittim": 49, "durat": 49, "bucketexist": 49, "headbucket": 49, "headbucketinput": 49, "headbucketoutput": 49, "delai": 49, "exceed": 49, "5a": 49, "willing": 49, "deadlin": 49, "surpris": 49, "caught": 49, "inspect": 49, "cancel": 49, "attemptceil": 49, "maxdelai": 49, "overflow": 49, "larger": 49, "mindelai": 49, "120": 49, "logarithm": 49, "maxwaittim": 49, "remainingtim": 49, "subtract": 49, "needlessli": 49, "cumul": 49, "298": 49, "295": 49, "289": 49, "283": 49, "22": 49, "261": 49, "101": 49, "199": 49, "43": 49, "144": 49, "156": 49, "168": 49, "132": 49, "71": 49, "239": 49, "61": 49, "42": 49, "281": 49, "19": 49, "290": 49, "296": 49, "oppos": 49, "strategi": 49, "linear": 49, "spent": 49, "stabil": 49, "respond": 49, "overhead": 49, "agreement": 49, "few": 49, "fewer": 49, "increas": 49, "overload": 49, "unnecessari": 49, "protect": 49, "intuit": 49, "slightli": 49, "aggress": 49, "finish": 49, "inputoutput": 49, "succe": [49, 53], "footnot": 49, "truli": 49, "analyz": 49, "waitabletraitjmespathproblem": 49, "stringequ": 49, "booleanequ": 49, "allstringequ": 49, "anystringequ": 49, "thingexist": 49, "fast": 49, "getthinginput": 49, "getthingoutput": 49, "groupexist": 49, "listgroup": 49, "listgroupsinput": 49, "listgroupsoutput": 49, "outlin": 49, "overli": 49, "confid": 49, "difficult": 49, "simplifi": 49, "statenam": 49, "snapshot": 49, "snapshotdelet": 49, "snapshotremov": 49, "objectexist": 49, "conversiontaskdelet": 49, "runinstancecomplet": 49, "terminateinstancecomplet": 49, "instancerun": 49, "instancetermin": 49, "notexist": 49, "incomplet": 49, "validationerror": 49, "suppos": 49, "startresourc": 49, "stopresourc": 49, "resourcerun": 49, "getresourc": 49, "getresourceinput": 49, "getresourceoutput": 49, "subclass": 50, "internalfailur": 50, "render": [50, 55], "categori": 50, "low": [50, 53, 54], "catch": 50, "unintend": 50, "disclosur": 50, "javascript": 50, "typeerror": 50, "unpars": [50, 53], "circuit": [50, 55], "robot": 50, "traffic": 50, "latter": 50, "misconfigur": 50, "incorrectli": 50, "415": 50, "406": 50, "requesttyp": 51, "httprequest": [51, 54, 55], "responsetyp": 51, "httprespons": [51, 54, 55], "promis": 51, "situat": 51, "j": [51, 53], "stringwizard": 51, "echo": 51, "ssdk": [51, 53, 55], "stringwizardservicehandl": 51, "echohandl": 51, "lengthhandl": 51, "conveni": [51, 53], "getlengthhandl": 51, "lengthserverinput": 51, "lengthserveroutput": 51, "getlengthparamet": 51, "distribut": 51, "busi": 51, "o": [51, 55], "async": [51, 55], "lambdahandl": 51, "apigatewayproxyhandl": 51, "apigatewayproxyresult": [51, 54], "shim": [51, 53, 54], "convertev": [51, 54], "await": 51, "convertversion1respons": [51, 54], "although": 51, "stringwizardservic": 51, "getstringwizardservicehandl": 51, "__servicehandl": 51, "__httprequest": 51, "__httprespons": 51, "echoserverinput": 51, "echoserveroutput": 51, "convei": 51, "unmodel": [51, 53], "handlercontext": 51, "userarn": 51, "requestcontext": 51, "unmodifi": 51, "flow": 52, "servicehandl": [52, 55], "factori": [52, 55], "synthet": 52, "unavoid": 52, "focu": 53, "entrypoint": 53, "ones": 53, "prebuilt": 53, "easi": 53, "encapsul": 53, "band": 53, "pertin": 53, "unknownoperationexcept": 53, "serializationexcept": 53, "refactor": 53, "incorpor": 53, "favorit": 53, "middlewar": 53, "preprocess": 53, "postprocess": 53, "plug": 53, "fight": 53, "heavyweight": 53, "shelf": 54, "front": 54, "npm": 54, "apigatewayproxyev": 54, "isbase64encod": 54, "late": 55, "internalfailureexcept": 55, "roll": 55, "validationexcept": 55, "accomplish": 55, "refus": 55, "disabledefaultvalid": 55, "codegen": 55, "packagevers": 55, "decid": 55, "validationcustom": 55, "getexampleoperationhandl": 55, "exampleoperationserverinput": 55, "exampleoperationserveroutput": 55, "validationfailur": 55, "enumvalidationfailur": 55, "lengthvalidationfailur": 55, "patternvalidationfailur": 55, "rangevalidationfailur": 55, "requiredvalidationfailur": 55, "uniqueitemsvalidationfailur": 55, "validationcontext": 55, "serviceexcept": 55, "question": 55, "badinput": 55, "getgetforecasthandl": 55, "ctx": 55, "badinputerror": 55}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"smithi": [0, 1, 2, 3, 4, 5, 6, 7, 9, 10, 34, 35, 37, 47, 48, 49, 50, 51, 52, 53, 54, 55], "build": [0, 1, 2, 3, 5, 10], "us": [0, 4, 14, 35], "json": [0, 3, 5, 17, 18, 20, 36], "project": [0, 1, 9, 42], "artifact": [0, 1], "transform": 0, "appli": [0, 34, 36, 37], "changestringenumstoenumshap": 0, "changetyp": 0, "excludeshapesbytag": 0, "excludeshapesbytrait": 0, "includeshapesbytag": 0, "includenamespac": 0, "includeservic": 0, "excludetag": 0, "excludetrait": 0, "excludetraitsbytag": 0, "filtersuppress": 0, "includetag": 0, "includetrait": 0, "includetraitsbytag": 0, "excludemetadata": 0, "includemetadata": 0, "flattennamespac": 0, "removetraitdefinit": 0, "removeunusedshap": 0, "renameshap": 0, "environ": 0, "variabl": [0, 38, 42], "plugin": [0, 1], "model": [0, 1, 2, 4, 7, 8, 10, 13, 14, 37, 38, 39, 43, 48, 49], "info": 0, "sourc": [0, 1], "gradl": 1, "instal": 1, "extens": [1, 3], "properti": [1, 13, 36], "gener": [1, 5, 23, 50, 51, 52, 53, 54, 55], "tag": [1, 31], "from": [1, 5], "complet": [1, 10], "exampl": [1, 3, 10, 13, 14, 15, 19, 31, 46, 49], "system": 2, "overview": [2, 7, 19, 34, 37, 46, 48], "guid": [2, 6, 8], "convert": 3, "openapi": 3, "introduct": [3, 5, 38, 42, 48, 53], "differ": [3, 5, 17, 18], "between": [3, 5, 17, 18], "unsupport": 3, "featur": 3, "configur": [3, 5], "set": [3, 5, 25, 34, 36, 37, 45], "schema": [3, 5], "secur": 3, "scheme": 3, "trait": [3, 4, 5, 8, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 26, 28, 29, 30, 31, 32, 33, 34, 37, 38, 40, 41, 42, 43, 44, 45, 47, 48, 49], "convers": 3, "amazon": [3, 11, 22, 23, 25, 26, 54], "api": [3, 4, 11, 14, 22, 54], "gatewai": [3, 11, 22, 54], "binari": 3, "type": [3, 11, 16, 20, 21, 36, 37, 42, 44, 45], "request": [3, 14, 15, 19, 29, 43, 46], "valid": [3, 7, 33, 38, 48, 55], "integr": [3, 11], "cor": [3, 33], "function": [3, 42], "author": [3, 11], "aw": [3, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 24, 26, 27, 47, 54], "cloudform": [3, 5, 13], "substitut": 3, "cognito": 3, "user": 3, "pool": 3, "kei": [3, 15, 16, 19], "usag": 3, "plan": 3, "other": [3, 5, 34], "influenc": [3, 5], "code": [3, 5, 19], "evolv": 4, "updat": [4, 37], "servic": [4, 10, 14, 24, 27, 34, 36, 37, 42], "oper": [4, 10, 15, 17, 18, 19, 20, 34, 36, 37], "structur": [4, 8, 11, 15, 19, 31, 34, 36, 37, 45, 49], "boolean": 4, "evolut": 4, "union": [4, 15, 19, 34, 36, 37, 45, 49], "box": [4, 44], "shape": [4, 8, 10, 15, 17, 18, 19, 20, 21, 34, 36, 37, 39, 42, 45], "spars": [4, 44], "list": [4, 10, 34, 36, 37, 45], "map": [4, 19, 34, 36, 37, 45], "diff": 4, "resourc": [5, 10, 13, 14, 34, 36, 37, 41, 49], "linter": 7, "lint": 7, "abbreviationnam": 7, "camelcas": 7, "noninclusiveterm": 7, "reservedword": 7, "wildcard": 7, "standardoperationverb": 7, "repeatedshapenam": 7, "inputoutputstructurereus": 7, "missingpaginatedtrait": 7, "shouldhaveusedtimestamp": 7, "write": 7, "custom": [7, 22, 23, 24, 25, 26, 27, 45, 55], "style": 8, "file": [8, 37], "encod": 8, "new": 8, "line": [8, 34], "format": [8, 14, 38, 46], "indent": 8, "whitespac": 8, "trail": [8, 34], "comma": 8, "name": [8, 14, 45, 49], "member": [8, 36, 37], "abbrevi": 8, "namespac": [8, 34], "read": [9, 37], "more": 9, "document": [9, 31, 34, 35], "implement": [9, 29], "link": 9, "quick": 10, "start": 10, "what": 10, "i": [10, 42], "weather": 10, "": 10, "syntax": 10, "defin": [10, 34, 37], "review": 10, "non": [10, 15, 17, 18, 19, 20, 21, 42], "lifecycl": [10, 37], "next": 10, "step": 10, "apigatewai": 11, "apikeysourc": 11, "requestvalid": 11, "mockintegr": 11, "share": 11, "data": [11, 14, 49, 53], "contenthandl": 11, "string": [11, 33, 34, 42], "requestparamet": 11, "requesttempl": 11, "respons": [11, 14, 15, 19, 21, 43, 46], "templat": [11, 14, 38, 48], "paramet": [11, 46], "authent": [12, 28], "auth": [12, 28], "sigv4": 12, "unsignedpayload": 12, "unsign": 12, "payload": 12, "signatur": 12, "version": [12, 23, 34], "4": 12, "cognitouserpool": 12, "cfnresourc": 13, "cfnexcludeproperti": 13, "mutabl": 13, "cfnmutabl": 13, "cfnname": 13, "cfnadditionalidentifi": 13, "cfndefaultvalu": 13, "core": 14, "specif": [14, 27, 35, 47], "sdkid": 14, "choos": 14, "an": 14, "sdk": 14, "id": [14, 34, 37, 41, 42], "client": [14, 29, 32, 43], "cloudformationnam": 14, "arnnamespac": 14, "cloudtraileventsourc": 14, "docid": 14, "endpointprefix": 14, "arn": 14, "rel": [14, 34], "identifi": [14, 37], "arnrefer": 14, "classif": 14, "controlplan": 14, "dataplan": 14, "endpoint": [14, 26, 32, 54], "discoveri": 14, "clientendpointdiscoveri": 14, "clientdiscoveredendpoint": 14, "clientendpointdiscoveryid": 14, "behavior": [14, 17, 18, 29, 32, 43], "cach": 14, "protocol": [14, 15, 17, 18, 19, 20, 21, 27, 40, 46, 48, 50], "httpchecksum": 14, "http": [14, 19, 20, 21, 33, 46], "checksum": [14, 23], "resolv": 14, "locat": 14, "httpchecksumrequir": [14, 29], "appendix": 14, "A": 14, "ec2": 15, "queri": [15, 19, 33], "ec2queri": 15, "ec2querynam": 15, "resolut": [15, 19, 34, 37], "support": [15, 17, 18, 19, 20, 21, 54], "serial": [15, 17, 18, 19, 20, 21, 33, 43, 45, 48], "x": [15, 19, 23], "www": [15, 19], "form": [15, 19], "urlencod": [15, 19], "collect": [15, 19], "xml": [15, 19, 21, 45], "error": [15, 17, 18, 19, 20, 21, 43, 44, 46, 50], "numer": [15, 17, 18, 19, 20, 21, 42], "float": [15, 17, 18, 19, 20, 21], "doubl": [15, 17, 18, 19, 20, 21], "complianc": [15, 17, 18, 19, 20, 21, 42, 46], "test": [15, 17, 18, 19, 20, 21, 42, 46], "renam": [15, 17, 18, 19, 20, 21], "iam": 16, "actionpermissiondescript": 16, "conditionkei": 16, "defineconditionkei": 16, "condit": 16, "disableconditionkeyinfer": 16, "requiredact": 16, "supportedprincipaltyp": 16, "iamresourc": 16, "deriv": 16, "1": [17, 18], "0": 17, "awsjson1_0": [17, 18], "empti": [17, 18, 42], "bodi": [17, 18], "awsjson1_1": [17, 18], "statu": 19, "awsqueri": 19, "awsqueryerror": 19, "awsquerycompat": 19, "restjson1": 20, "content": [20, 21, 35], "bind": [20, 21, 33, 37, 38, 45, 48], "restxml": 21, "accept": 22, "header": [22, 23, 33], "glacier": 23, "amz": 23, "default": [23, 37, 55], "valu": [23, 25, 30, 34, 37, 42], "accountid": 23, "machin": 25, "learn": 25, "host": [25, 26], "predictendpoint": 25, "s3": 26, "bucket": 26, "address": 26, "virtual": 26, "dual": 26, "stack": 26, "transfer": 26, "acceler": 26, "s3unwrappedxmloutput": 26, "authdefinit": 28, "httpbasicauth": 28, "httpdigestauth": 28, "httpbearerauth": 28, "httpapikeyauth": 28, "optionalauth": 28, "idempotencytoken": 29, "idempot": 29, "readonli": 29, "retryabl": 29, "pagin": 29, "continu": 29, "token": 29, "backward": 29, "compat": 29, "requestcompress": 29, "compress": 29, "constraint": 30, "enum": [30, 49], "idref": 30, "length": 30, "pattern": [30, 33], "privat": 30, "rang": 30, "requir": 30, "uniqueitem": 30, "equal": 30, "preced": 30, "deprec": 31, "errorexampl": 31, "externaldocument": 31, "intern": 31, "recommend": 31, "sensit": 31, "sinc": 31, "titl": 31, "unstabl": 31, "label": [32, 33, 48], "hostlabel": 32, "method": 33, "uri": 33, "liter": 33, "charact": [33, 34], "sequenc": 33, "greedi": 33, "conflict": [33, 37, 48], "avoid": 33, "httperror": 33, "httpheader": 33, "restrict": 33, "httplabel": 33, "httppayload": 33, "httpprefixhead": 33, "httpqueri": 33, "httpqueryparam": 33, "httpresponsecod": 33, "messag": [33, 38, 43], "event": [33, 38, 43], "stream": [33, 43], "idl": 34, "lexic": [34, 42], "note": [34, 42], "abnf": 34, "comment": 34, "control": 34, "section": 34, "statement": 34, "metadata": [34, 37, 38], "refer": [34, 36, 41], "syntact": 34, "simpl": [34, 36, 37, 45, 49], "node": [34, 37, 42], "escap": 34, "text": 34, "block": 34, "incident": 34, "white": 34, "space": 34, "remov": 34, "signific": 34, "convent": 35, "thi": 35, "tabl": 35, "ast": 36, "top": 36, "level": 36, "The": 37, "semant": 37, "aggreg": 37, "unit": 37, "recurs": [37, 42], "definit": [37, 48], "closur": 37, "implicit": [37, 41, 49], "explicit": 37, "put": 37, "creat": 37, "delet": 37, "extern": 37, "annot": 37, "break": 37, "chang": 37, "rule": 37, "merg": 37, "miss": 38, "sever": 38, "suppress": 38, "built": 38, "emiteachselector": 38, "emitnoneselector": 38, "prelud": 39, "protocoldefinit": 40, "jsonnam": 40, "mediatyp": 40, "timestampformat": 40, "noreplac": 41, "resourceidentifi": 41, "selector": 42, "match": 42, "attribut": [42, 45], "exist": 42, "comparison": 42, "compar": 42, "scope": 42, "context": [42, 51], "And": 42, "logic": 42, "multipl": 42, "case": 42, "insensit": 42, "neighbor": 42, "forward": 42, "undirect": 42, "direct": 42, "revers": 42, "relationship": 42, "topdown": 42, "var": 42, "grammar": 42, "deseri": 43, "blob": 43, "requireslength": 43, "initi": 43, "server": [43, 50, 51, 52, 53, 54, 55], "eventhead": 43, "eventpayload": 43, "refin": 44, "input": 44, "output": 44, "element": 45, "xmlname": 45, "wrap": 45, "flatten": 45, "xmlattribut": 45, "xmlflatten": 45, "xmlnamespac": 45, "httprequesttest": 46, "httpresponsetest": 46, "httpmalformedrequesttest": 46, "httpmalformedrequestdefinit": 46, "httpmalformedresponsedefinit": 46, "httpmalformedresponsebodydefinit": 46, "httpmalformedresponsebodyassert": 46, "malform": 46, "addit": 47, "index": 47, "mqtt": 48, "topic": 48, "publish": 48, "subscrib": 48, "topiclabel": 48, "waiter": 49, "waitabl": 49, "workflow": 49, "retri": 49, "why": 49, "exponenti": 49, "backoff": 49, "jitter": 49, "acceptor": 49, "acceptorst": 49, "matcher": 49, "pathmatch": 49, "jmespath": 49, "static": 49, "analysi": 49, "pathcompar": 49, "best": 49, "practic": 49, "keep": 49, "express": 49, "after": 49, "state": 49, "do": 49, "onli": 49, "termin": 49, "failur": 49, "typescript": [50, 51, 52, 53, 54, 55], "handl": 50, "synthet": 50, "unavoid": 50, "internalfailureexcept": 50, "serializationexcept": 50, "unknownoperationexcept": 50, "unsupportedmediatypeexcept": 50, "notacceptableexcept": 50, "handler": 51, "servicehandl": 51, "factori": 51, "flow": 53, "rest": 54, "lambda": 54}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 57}, "alltitles": {"smithy-build": [[0, "smithy-build"]], "Using smithy-build.json": [[0, "using-smithy-build-json"]], "Projections": [[0, "projections"]], "Projection artifacts": [[0, "projection-artifacts"]], "Transforms": [[0, "transforms"]], "apply": [[0, "apply"]], "changeStringEnumsToEnumShapes": [[0, "changestringenumstoenumshapes"]], "changeTypes": [[0, "changetypes"]], "excludeShapesByTag": [[0, "excludeshapesbytag"]], "excludeShapesByTrait": [[0, "excludeshapesbytrait"]], "includeShapesByTag": [[0, "includeshapesbytag"]], "includeNamespaces": [[0, "includenamespaces"]], "includeServices": [[0, "includeservices"]], "excludeTags": [[0, "excludetags"]], "excludeTraits": [[0, "excludetraits"]], "excludeTraitsByTag": [[0, "excludetraitsbytag"]], "filterSuppressions": [[0, "filtersuppressions"]], "includeTags": [[0, "includetags"]], "includeTraits": [[0, "includetraits"]], "includeTraitsByTag": [[0, "includetraitsbytag"]], "excludeMetadata": [[0, "excludemetadata"]], "includeMetadata": [[0, "includemetadata"]], "flattenNamespaces": [[0, "flattennamespaces"]], "removeTraitDefinitions": [[0, "removetraitdefinitions"]], "removeUnusedShapes": [[0, "removeunusedshapes"]], "renameShapes": [[0, "renameshapes"]], "Environment variables": [[0, "environment-variables"]], "Plugins": [[0, "plugins"]], "model plugin": [[0, "model-plugin"]], "build-info plugin": [[0, "build-info-plugin"]], "sources plugin": [[0, "sources-plugin"]], "Smithy Gradle Plugin": [[1, "smithy-gradle-plugin"]], "Installation": [[1, "installation"]], "Smithy model sources": [[1, "smithy-model-sources"]], "Building Smithy models": [[1, "building-smithy-models"]], "Smithy extension properties": [[1, "smithy-extension-properties"]], "Building a source model": [[1, "building-a-source-model"]], "Generating a projection": [[1, "generating-a-projection"]], "Projection tags": [[1, "projection-tags"]], "Building artifacts from Smithy models": [[1, "building-artifacts-from-smithy-models"]], "Complete Examples": [[1, "complete-examples"]], "Building Smithy Models": [[2, "building-smithy-models"]], "Build system overview": [[2, "build-system-overview"]], "Build system guides": [[2, "build-system-guides"]], "Converting Smithy to OpenAPI": [[3, "converting-smithy-to-openapi"]], "Introduction": [[3, "introduction"], [5, "introduction"], [38, "introduction"], [42, "introduction"], [48, "introduction"]], "Differences between Smithy and OpenAPI": [[3, "differences-between-smithy-and-openapi"]], "Unsupported features": [[3, "unsupported-features"]], "Converting to OpenAPI with smithy-build": [[3, "converting-to-openapi-with-smithy-build"]], "OpenAPI configuration settings": [[3, "openapi-configuration-settings"]], "JSON schema configuration settings": [[3, "json-schema-configuration-settings"], [5, "json-schema-configuration-settings"]], "Security schemes": [[3, "security-schemes"]], "@examples trait conversion": [[3, "examples-trait-conversion"]], "Amazon API Gateway extensions": [[3, "amazon-api-gateway-extensions"]], "Amazon API Gateway configuration settings": [[3, "amazon-api-gateway-configuration-settings"]], "Binary types": [[3, "binary-types"]], "Request validators": [[3, "request-validators"]], "Integrations": [[3, "integrations"]], "CORS functionality": [[3, "cors-functionality"]], "Authorizers": [[3, "authorizers"]], "AWS CloudFormation substitutions": [[3, "aws-cloudformation-substitutions"]], "Amazon Cognito User Pools": [[3, "amazon-cognito-user-pools"]], "Amazon API Gateway API key usage plans": [[3, "amazon-api-gateway-api-key-usage-plans"]], "Other traits that influence API Gateway": [[3, "other-traits-that-influence-api-gateway"]], "Converting to OpenAPI with code": [[3, "converting-to-openapi-with-code"]], "Evolving Models": [[4, "evolving-models"]], "Updating services": [[4, "updating-services"]], "Updating operations": [[4, "updating-operations"]], "Updating structures": [[4, "updating-structures"]], "Booleans and API evolution": [[4, "booleans-and-api-evolution"]], "Updating unions": [[4, "updating-unions"]], "Boxed shapes": [[4, "boxed-shapes"]], "Sparse lists and maps": [[4, "sparse-lists-and-maps"]], "Updating traits": [[4, "updating-traits"]], "Using Smithy Diff": [[4, "using-smithy-diff"]], "Generating CloudFormation Resource Schemas from Smithy": [[5, "generating-cloudformation-resource-schemas-from-smithy"]], "Differences between Smithy resources and CloudFormation Resource Schemas": [[5, "differences-between-smithy-resources-and-cloudformation-resource-schemas"]], "Generating Schemas with smithy-build": [[5, "generating-schemas-with-smithy-build"]], "CloudFormation configuration settings": [[5, "cloudformation-configuration-settings"]], "Other traits that influence generation": [[5, "other-traits-that-influence-generation"]], "Generating Schemas with code": [[5, "generating-schemas-with-code"]], "Smithy Guides": [[6, "smithy-guides"]], "Model linters": [[7, "model-linters"]], "Linting overview": [[7, "linting-overview"]], "Linters in smithy-linters": [[7, "linters-in-smithy-linters"]], "AbbreviationName": [[7, "abbreviationname"]], "CamelCase": [[7, "camelcase"]], "NoninclusiveTerms": [[7, "noninclusiveterms"]], "ReservedWords": [[7, "reservedwords"]], "Wildcards in ReservedWords": [[7, "wildcards-in-reservedwords"]], "StandardOperationVerb": [[7, "standardoperationverb"]], "RepeatedShapeName": [[7, "repeatedshapename"]], "InputOutputStructureReuse": [[7, "inputoutputstructurereuse"]], "MissingPaginatedTrait": [[7, "missingpaginatedtrait"]], "ShouldHaveUsedTimestamp": [[7, "shouldhaveusedtimestamp"]], "Writing custom validators": [[7, "writing-custom-validators"]], "Writing custom Linters": [[7, "writing-custom-linters"]], "Style Guide": [[8, "style-guide"]], "Model files": [[8, "model-files"]], "File encoding": [[8, "file-encoding"]], "New lines": [[8, "new-lines"]], "Model file structure": [[8, "model-file-structure"]], "Formatting": [[8, "formatting"]], "Indentation": [[8, "indentation"]], "Whitespace": [[8, "whitespace"]], "Trailing commas": [[8, "trailing-commas"]], "Naming": [[8, "naming"]], "Shape names": [[8, "shape-names"]], "Member names": [[8, "member-names"]], "Trait names": [[8, "trait-names"]], "Abbreviations": [[8, "abbreviations"]], "Namespace names": [[8, "namespace-names"]], "Smithy": [[9, "smithy"]], "Read more": [[9, "read-more"]], "Documentation": [[9, null]], "Implementations": [[9, null]], "Project links": [[9, null]], "Quick start": [[10, "quick-start"]], "What is Smithy?": [[10, "what-is-smithy"]], "Shapes and traits": [[10, "shapes-and-traits"]], "Weather Service": [[10, "weather-service"]], "What's that syntax?": [[10, null]], "Defining resources": [[10, "defining-resources"]], "Review": [[10, null], [10, null], [10, null]], "Defining operations": [[10, "defining-operations"]], "Listing resources": [[10, "listing-resources"]], "Non-Lifecycle Operations": [[10, "non-lifecycle-operations"]], "Building the Model": [[10, "building-the-model"]], "Next steps": [[10, "next-steps"]], "Complete example": [[10, "complete-example"]], "Amazon API Gateway traits": [[11, "amazon-api-gateway-traits"]], "aws.apigateway#apiKeySource trait": [[11, "aws-apigateway-apikeysource-trait"]], "aws.apigateway#authorizers trait": [[11, "aws-apigateway-authorizers-trait"]], "aws.apigateway#authorizer trait": [[11, "aws-apigateway-authorizer-trait"]], "aws.apigateway#requestValidator trait": [[11, "aws-apigateway-requestvalidator-trait"]], "aws.apigateway#integration trait": [[11, "aws-apigateway-integration-trait"]], "aws.apigateway#mockIntegration trait": [[11, "aws-apigateway-mockintegration-trait"]], "Shared trait data types": [[11, "shared-trait-data-types"]], "ContentHandling string": [[11, "contenthandling-string"]], "requestParameters structure": [[11, "requestparameters-structure"]], "requestTemplates structure": [[11, "requesttemplates-structure"]], "responses structure": [[11, "responses-structure"]], "response structure": [[11, "response-structure"]], "Response templates structure": [[11, "response-templates-structure"]], "Response parameters structure": [[11, "response-parameters-structure"]], "AWS Authentication Traits": [[12, "aws-authentication-traits"]], "aws.auth#sigv4 trait": [[12, "aws-auth-sigv4-trait"]], "aws.auth#unsignedPayload trait": [[12, "aws-auth-unsignedpayload-trait"]], "Unsigned Payloads and signature version 4": [[12, "unsigned-payloads-and-signature-version-4"]], "aws.auth#cognitoUserPools trait": [[12, "aws-auth-cognitouserpools-trait"]], "AWS CloudFormation traits": [[13, "aws-cloudformation-traits"]], "aws.cloudformation#cfnResource trait": [[13, "aws-cloudformation-cfnresource-trait"]], "Resource properties": [[13, "resource-properties"]], "aws.cloudformation#cfnExcludeProperty trait": [[13, "aws-cloudformation-cfnexcludeproperty-trait"]], "Property mutability": [[13, "property-mutability"]], "aws.cloudformation#cfnMutability trait": [[13, "aws-cloudformation-cfnmutability-trait"]], "aws.cloudformation#cfnName trait": [[13, "aws-cloudformation-cfnname-trait"]], "aws.cloudformation#cfnAdditionalIdentifier trait": [[13, "aws-cloudformation-cfnadditionalidentifier-trait"]], "aws.cloudformation#cfnDefaultValue trait": [[13, "aws-cloudformation-cfndefaultvalue-trait"]], "Example model": [[13, "example-model"]], "AWS Core Specification": [[14, "aws-core-specification"]], "aws.api#service trait": [[14, "aws-api-service-trait"]], "sdkId": [[14, "sdkid"]], "Choosing an SDK service ID": [[14, "choosing-an-sdk-service-id"]], "Using SDK service ID for client naming": [[14, "using-sdk-service-id-for-client-naming"]], "cloudFormationName": [[14, "cloudformationname"]], "arnNamespace": [[14, "arnnamespace"]], "cloudTrailEventSource": [[14, "cloudtraileventsource"]], "docId": [[14, "docid"]], "endpointPrefix": [[14, "endpointprefix"]], "aws.api#arn trait": [[14, "aws-api-arn-trait"]], "Format of an ARN": [[14, "format-of-an-arn"]], "Relative ARN templates": [[14, "relative-arn-templates"]], "Using an ARN as a resource identifier": [[14, "using-an-arn-as-a-resource-identifier"]], "aws.api#arnReference trait": [[14, "aws-api-arnreference-trait"]], "aws.api#data trait": [[14, "aws-api-data-trait"]], "Data Classifications": [[14, "data-classifications"]], "aws.api#controlPlane trait": [[14, "aws-api-controlplane-trait"]], "aws.api#dataPlane trait": [[14, "aws-api-dataplane-trait"]], "Client Endpoint Discovery": [[14, "client-endpoint-discovery"]], "aws.api#clientEndpointDiscovery trait": [[14, "aws-api-clientendpointdiscovery-trait"]], "aws.api#clientDiscoveredEndpoint trait": [[14, "aws-api-clientdiscoveredendpoint-trait"]], "aws.api#clientEndpointDiscoveryId trait": [[14, "aws-api-clientendpointdiscoveryid-trait"]], "Example Model": [[14, "example-model"]], "Client Behavior": [[14, "client-behavior"], [32, "client-behavior"]], "Caching": [[14, "caching"]], "aws.protocols#httpChecksum trait": [[14, "aws-protocols-httpchecksum-trait"]], "Client behavior": [[14, "aws-protocols-httpchecksum-trait-behavior"], [29, "client-behavior"], [43, "client-behavior"]], "HTTP request checksums": [[14, "http-request-checksums"], [14, "id10"]], "HTTP response checksums": [[14, "http-response-checksums"], [14, "id11"]], "Service behavior": [[14, "service-behavior"]], "Resolving checksum name": [[14, "resolving-checksum-name"]], "Resolving checksum location": [[14, "resolving-checksum-location"]], "Behavior with httpChecksumRequired": [[14, "behavior-with-httpchecksumrequired"]], "Appendix": [[14, "appendix"]], "Appendix A: Example SDK service IDs": [[14, "appendix-a-example-sdk-service-ids"]], "AWS EC2 query protocol": [[15, "aws-ec2-query-protocol"]], "aws.protocols#ec2Query trait": [[15, "aws-protocols-ec2query-trait"]], "aws.protocols#ec2QueryName trait": [[15, "aws-protocols-ec2queryname-trait"]], "Query key resolution": [[15, "query-key-resolution"], [19, "query-key-resolution"]], "Supported traits": [[15, "supported-traits"], [17, "supported-traits"], [18, "supported-traits"], [19, "supported-traits"], [20, "supported-traits"], [21, "supported-traits"]], "Request serialization": [[15, "request-serialization"], [19, "request-serialization"]], "x-www-form-urlencoded shape serialization": [[15, "x-www-form-urlencoded-shape-serialization"], [19, "x-www-form-urlencoded-shape-serialization"]], "Examples": [[15, "examples"]], "Structures and Unions": [[15, "structures-and-unions"]], "Collections": [[15, "collections"], [19, "collections"]], "Response serialization": [[15, "response-serialization"], [19, "response-serialization"]], "XML shape serialization": [[15, "xml-shape-serialization"], [19, "xml-shape-serialization"], [21, "xml-shape-serialization"]], "Operation error serialization": [[15, "operation-error-serialization"], [17, "operation-error-serialization"], [18, "operation-error-serialization"], [19, "operation-error-serialization"], [20, "operation-error-serialization"]], "Non-numeric float and double serialization": [[15, "non-numeric-float-and-double-serialization"], [17, "non-numeric-float-and-double-serialization"], [18, "non-numeric-float-and-double-serialization"], [19, "non-numeric-float-and-double-serialization"], [20, "non-numeric-float-and-double-serialization"], [21, "non-numeric-float-and-double-serialization"]], "Protocol compliance tests": [[15, "protocol-compliance-tests"], [17, "protocol-compliance-tests"], [18, "protocol-compliance-tests"], [19, "protocol-compliance-tests"], [20, "protocol-compliance-tests"], [21, "protocol-compliance-tests"]], "Error shape renaming": [[15, "error-shape-renaming"], [17, "error-shape-renaming"], [18, "error-shape-renaming"], [19, "error-shape-renaming"], [20, "error-shape-renaming"], [21, "error-shape-renaming"]], "AWS IAM traits": [[16, "aws-iam-traits"]], "aws.iam#actionPermissionDescription trait": [[16, "aws-iam-actionpermissiondescription-trait"]], "aws.iam#conditionKeys trait": [[16, "aws-iam-conditionkeys-trait"]], "aws.iam#defineConditionKeys trait": [[16, "aws-iam-defineconditionkeys-trait"]], "Condition Key Types": [[16, "condition-key-types"]], "aws.iam#disableConditionKeyInference trait": [[16, "aws-iam-disableconditionkeyinference-trait"]], "aws.iam#requiredActions trait": [[16, "aws-iam-requiredactions-trait"]], "aws.iam#supportedPrincipalTypes trait": [[16, "aws-iam-supportedprincipaltypes-trait"]], "aws.iam#iamResource trait": [[16, "aws-iam-iamresource-trait"]], "Deriving Condition Keys": [[16, "deriving-condition-keys"]], "AWS JSON 1.0 protocol": [[17, "aws-json-1-0-protocol"]], "aws.protocols#awsJson1_0 trait": [[17, "aws-protocols-awsjson1-0-trait"]], "Protocol Behaviors": [[17, "protocol-behaviors"], [18, "protocol-behaviors"]], "Shape serialization": [[17, "shape-serialization"], [18, "shape-serialization"]], "Empty body serialization": [[17, "empty-body-serialization"], [18, "empty-body-serialization"]], "Differences between awsJson1_0 and awsJson1_1": [[17, "differences-between-awsjson1-0-and-awsjson1-1"], [18, "differences-between-awsjson1-0-and-awsjson1-1"]], "AWS JSON 1.1 protocol": [[18, "aws-json-1-1-protocol"]], "aws.protocols#awsJson1_1 trait": [[18, "aws-protocols-awsjson1-1-trait"]], "AWS query protocol": [[19, "aws-query-protocol"]], "Overview": [[19, "overview"], [46, "overview"]], "Example requests": [[19, "example-requests"]], "Structures and unions": [[19, "structures-and-unions"]], "Maps": [[19, "maps"]], "Error HTTP response status code resolution": [[19, "error-http-response-status-code-resolution"]], "Error \"Code\" resolution": [[19, "error-code-resolution"]], "aws.protocols#awsQuery trait": [[19, "aws-protocols-awsquery-trait"]], "aws.protocols#awsQueryError trait": [[19, "aws-protocols-awsqueryerror-trait"]], "aws.protocols#awsQueryCompatible trait": [[19, "aws-protocols-awsquerycompatible-trait"]], "AWS restJson1 protocol": [[20, "aws-restjson1-protocol"]], "aws.protocols#restJson1 trait": [[20, "aws-protocols-restjson1-trait"]], "Content-Type": [[20, "content-type"], [21, "content-type"]], "JSON shape serialization": [[20, "json-shape-serialization"]], "HTTP binding serialization": [[20, "http-binding-serialization"], [21, "http-binding-serialization"]], "AWS restXml protocol": [[21, "aws-restxml-protocol"]], "aws.protocols#restXml trait": [[21, "aws-protocols-restxml-trait"]], "Error response serialization": [[21, "error-response-serialization"]], "Amazon API Gateway Customizations": [[22, "amazon-api-gateway-customizations"]], "Accept header": [[22, "accept-header"]], "Amazon Glacier Customizations": [[23, "amazon-glacier-customizations"]], "X-Amz-Glacier-Version header": [[23, "x-amz-glacier-version-header"]], "Default value for accountId": [[23, "default-value-for-accountid"]], "Default checksum generation": [[23, "default-checksum-generation"]], "AWS Service Customizations": [[24, "aws-service-customizations"], [27, "aws-service-customizations"]], "Amazon Machine Learning Customizations": [[25, "amazon-machine-learning-customizations"]], "Set host to value of PredictEndpoint": [[25, "set-host-to-value-of-predictendpoint"]], "Amazon S3 Customizations": [[26, "amazon-s3-customizations"]], "S3 Bucket Addressing": [[26, "s3-bucket-addressing"]], "S3 Bucket Virtual Hosting": [[26, "s3-bucket-virtual-hosting"]], "S3 Dual-Stack Endpoints": [[26, "s3-dual-stack-endpoints"]], "S3 Transfer Acceleration Endpoints": [[26, "s3-transfer-acceleration-endpoints"]], "S3 Traits": [[26, "s3-traits"]], "aws.customizations#s3UnwrappedXmlOutput trait": [[26, "aws-customizations-s3unwrappedxmloutput-trait"]], "AWS specifications": [[27, "aws-specifications"], [47, "aws-specifications"]], "AWS Protocols": [[27, "aws-protocols"]], "Authentication traits": [[28, "authentication-traits"]], "authDefinition trait": [[28, "authdefinition-trait"]], "httpBasicAuth trait": [[28, "httpbasicauth-trait"]], "httpDigestAuth trait": [[28, "httpdigestauth-trait"]], "httpBearerAuth trait": [[28, "httpbearerauth-trait"]], "httpApiKeyAuth trait": [[28, "httpapikeyauth-trait"]], "optionalAuth trait": [[28, "optionalauth-trait"]], "auth trait": [[28, "auth-trait"]], "Behavior traits": [[29, "behavior-traits"]], "idempotencyToken trait": [[29, "idempotencytoken-trait"]], "idempotent trait": [[29, "idempotent-trait"]], "readonly trait": [[29, "readonly-trait"]], "retryable trait": [[29, "retryable-trait"]], "paginated trait": [[29, "paginated-trait"]], "Pagination Behavior": [[29, "pagination-behavior"]], "Continuation tokens": [[29, "continuation-tokens"]], "Backward compatibility": [[29, "backward-compatibility"], [29, "id8"]], "httpChecksumRequired trait": [[29, "httpchecksumrequired-trait"]], "requestCompression trait": [[29, "requestcompression-trait"]], "Request compression behavior": [[29, "request-compression-behavior"]], "Client Implementation": [[29, "client-implementation"]], "Constraint traits": [[30, "constraint-traits"]], "enum trait": [[30, "enum-trait"]], "idRef trait": [[30, "idref-trait"]], "length trait": [[30, "length-trait"]], "pattern trait": [[30, "pattern-trait"]], "private trait": [[30, "private-trait"]], "range trait": [[30, "range-trait"]], "required trait": [[30, "required-trait"]], "uniqueItems trait": [[30, "uniqueitems-trait"]], "Value equality": [[30, "value-equality"]], "Trait precedence": [[30, "trait-precedence"]], "Documentation traits": [[31, "documentation-traits"]], "deprecated trait": [[31, "deprecated-trait"]], "documentation trait": [[31, "documentation-trait"]], "examples trait": [[31, "examples-trait"]], "ErrorExample structure": [[31, "errorexample-structure"]], "externalDocumentation trait": [[31, "externaldocumentation-trait"]], "internal trait": [[31, "internal-trait"]], "recommended trait": [[31, "recommended-trait"]], "sensitive trait": [[31, "sensitive-trait"]], "since trait": [[31, "since-trait"]], "tags trait": [[31, "tags-trait"]], "title trait": [[31, "title-trait"]], "unstable trait": [[31, "unstable-trait"]], "Endpoint Traits": [[32, "endpoint-traits"]], "endpoint trait": [[32, "endpoint-trait"]], "Labels": [[32, "labels"], [33, "labels"]], "hostLabel trait": [[32, "hostlabel-trait"]], "HTTP binding traits": [[33, "http-binding-traits"]], "http trait": [[33, "http-trait"]], "method": [[33, "method"]], "uri": [[33, "uri"]], "Literal character sequences": [[33, "literal-character-sequences"]], "Query string literals": [[33, "query-string-literals"]], "Greedy labels": [[33, "greedy-labels"]], "Pattern Validation and Conflict Avoidance": [[33, "pattern-validation-and-conflict-avoidance"]], "httpError trait": [[33, "httperror-trait"]], "httpHeader trait": [[33, "httpheader-trait"]], "Restricted HTTP headers": [[33, "restricted-http-headers"]], "httpLabel trait": [[33, "httplabel-trait"]], "httpPayload trait": [[33, "httppayload-trait"]], "httpPrefixHeaders trait": [[33, "httpprefixheaders-trait"]], "httpQuery trait": [[33, "httpquery-trait"]], "httpQueryParams trait": [[33, "httpqueryparams-trait"]], "httpResponseCode trait": [[33, "httpresponsecode-trait"]], "cors trait": [[33, "cors-trait"]], "Serializing HTTP messages": [[33, "serializing-http-messages"]], "Event streams": [[33, "event-streams"], [43, "event-streams"]], "Smithy IDL": [[34, "smithy-idl"]], "Smithy IDL overview": [[34, "smithy-idl-overview"]], "Lexical notes": [[34, "lexical-notes"]], "Smithy IDL ABNF": [[34, "smithy-idl-abnf"]], "Comments": [[34, "comments"]], "Control section": [[34, "control-section"]], "Version statement": [[34, "version-statement"]], "Metadata section": [[34, "metadata-section"]], "Shape section": [[34, "shape-section"]], "Namespaces": [[34, "namespaces"]], "Referring to shapes": [[34, "referring-to-shapes"]], "Relative shape ID resolution": [[34, "relative-shape-id-resolution"]], "Syntactic shape IDs": [[34, "syntactic-shape-ids"]], "Defining shapes": [[34, "defining-shapes"]], "Simple shapes": [[34, "simple-shapes"], [36, "simple-shapes"], [37, "simple-shapes"]], "List shapes": [[34, "list-shapes"]], "Set shapes": [[34, "set-shapes"]], "Map shapes": [[34, "map-shapes"]], "Structure shapes": [[34, "structure-shapes"]], "Union shapes": [[34, "union-shapes"]], "Service shape": [[34, "service-shape"], [36, "service-shape"]], "Operation shape": [[34, "operation-shape"], [36, "operation-shape"]], "Resource shape": [[34, "resource-shape"], [36, "resource-shape"]], "Documentation comment": [[34, "documentation-comment"]], "Applying traits": [[34, "applying-traits"]], "Trait values": [[34, "trait-values"]], "Structure, map, and union trait values": [[34, "structure-map-and-union-trait-values"]], "List and set trait values": [[34, "list-and-set-trait-values"]], "Other trait values": [[34, "other-trait-values"]], "Apply statement": [[34, "apply-statement"]], "Node values": [[34, "node-values"], [37, "node-values"]], "String values": [[34, "string-values"]], "String escape characters": [[34, "string-escape-characters"]], "Text blocks": [[34, "text-blocks"]], "Incidental white space removal": [[34, "incidental-white-space-removal"]], "Significant trailing line": [[34, "significant-trailing-line"]], "Escapes in text blocks": [[34, "escapes-in-text-blocks"]], "Smithy specification": [[35, "smithy-specification"], [47, "smithy-specification"]], "Conventions used in this document": [[35, "conventions-used-in-this-document"]], "Table of contents": [[35, "table-of-contents"]], "JSON AST": [[36, "json-ast"]], "Top level properties": [[36, "top-level-properties"]], "AST shapes": [[36, "ast-shapes"]], "List and set shapes": [[36, "list-and-set-shapes"]], "AST member": [[36, "ast-member"]], "AST shape reference": [[36, "ast-shape-reference"]], "Map shape": [[36, "map-shape"]], "Structure and union shapes": [[36, "structure-and-union-shapes"]], "AST apply type": [[36, "ast-apply-type"]], "The Smithy model": [[37, "the-smithy-model"]], "Smithy overview": [[37, "smithy-overview"]], "The semantic model": [[37, "the-semantic-model"]], "Shapes": [[37, "shapes"]], "Shape ID": [[37, "shape-id"]], "Shape ID conflicts": [[37, "shape-id-conflicts"]], "Aggregate shapes": [[37, "aggregate-shapes"]], "Member": [[37, "member"]], "List": [[37, "list"]], "Set": [[37, "set"]], "Map": [[37, "map"]], "Structure": [[37, "structure"]], "Default structure member values": [[37, "default-structure-member-values"]], "Union": [[37, "union"]], "Unit type": [[37, "unit-type"]], "Recursive shape definitions": [[37, "recursive-shape-definitions"]], "Service shapes": [[37, "service-shapes"]], "Service": [[37, "service"]], "Service operations": [[37, "service-operations"]], "Service resources": [[37, "service-resources"]], "Service closure": [[37, "service-closure"]], "Operation": [[37, "operation"]], "Resource": [[37, "resource"]], "Resource Identifiers": [[37, "resource-identifiers"]], "Binding identifiers to operations": [[37, "binding-identifiers-to-operations"]], "Implicit identifier bindings": [[37, "implicit-identifier-bindings"]], "Explicit identifier bindings": [[37, "explicit-identifier-bindings"]], "Resource lifecycle operations": [[37, "resource-lifecycle-operations"]], "Put lifecycle": [[37, "put-lifecycle"]], "Create lifecycle": [[37, "create-lifecycle"]], "Read lifecycle": [[37, "read-lifecycle"]], "Update lifecycle": [[37, "update-lifecycle"]], "Delete lifecycle": [[37, "delete-lifecycle"]], "List lifecycle": [[37, "list-lifecycle"]], "Traits": [[37, "traits"]], "Applying traits to shapes": [[37, "applying-traits-to-shapes"]], "Applying traits externally": [[37, "applying-traits-externally"]], "Trait conflict resolution": [[37, "trait-conflict-resolution"]], "Trait node values": [[37, "trait-node-values"]], "Defining traits": [[37, "defining-traits"]], "Annotation traits": [[37, "annotation-traits"]], "Trait breaking change rules": [[37, "trait-breaking-change-rules"]], "Model metadata": [[37, "model-metadata"]], "Merging metadata": [[37, "merging-metadata"]], "Node value types": [[37, "node-value-types"]], "Merging model files": [[37, "merging-model-files"]], "Model validation": [[38, "model-validation"]], "Validators": [[38, "validators"]], "Missing validators": [[38, "missing-validators"]], "Severity": [[38, "severity"]], "Suppressions": [[38, "suppressions"]], "suppress trait": [[38, "suppress-trait"]], "Suppression metadata": [[38, "suppression-metadata"]], "Built-in validators": [[38, "built-in-validators"]], "EmitEachSelector": [[38, "emiteachselector"]], "Binding events to traits": [[38, "binding-events-to-traits"]], "Message templates": [[38, "message-templates"]], "Variable message formatting": [[38, "variable-message-formatting"]], "EmitNoneSelector": [[38, "emitnoneselector"]], "Prelude model": [[39, "prelude-model"]], "Prelude shapes": [[39, "prelude-shapes"]], "Protocol traits": [[40, "protocol-traits"]], "protocolDefinition trait": [[40, "protocoldefinition-trait"]], "jsonName trait": [[40, "jsonname-trait"]], "mediaType trait": [[40, "mediatype-trait"]], "timestampFormat trait": [[40, "timestampformat-trait"]], "Resource traits": [[41, "resource-traits"]], "noReplace trait": [[41, "noreplace-trait"]], "references trait": [[41, "references-trait"]], "Implicit ids": [[41, "implicit-ids"]], "resourceIdentifier trait": [[41, "resourceidentifier-trait"]], "Selectors": [[42, "selectors"]], "Matching shapes with selectors": [[42, "matching-shapes-with-selectors"]], "Matching shapes by type": [[42, "matching-shapes-by-type"]], "Attribute selectors": [[42, "attribute-selectors"]], "Attribute existence": [[42, "attribute-existence"]], "Attribute comparison": [[42, "attribute-comparison"]], "String comparators": [[42, "string-comparators"]], "Numeric comparators": [[42, "numeric-comparators"]], "Attributes": [[42, "attributes"]], "id attribute": [[42, "id-attribute"]], "service attribute": [[42, "service-attribute"]], "trait attribute": [[42, "trait-attribute"]], "Node attribute": [[42, "node-attribute"]], "Empty attribute": [[42, "empty-attribute"]], "Projection attribute": [[42, "projection-attribute"]], "Comparisons to non-projections": [[42, "comparisons-to-non-projections"]], "Comparisons to projections": [[42, "comparisons-to-projections"]], "Projection comparators": [[42, "projection-comparators"]], "Scoped attribute selectors": [[42, "scoped-attribute-selectors"]], "Context values": [[42, "context-values"]], "And-logic": [[42, "and-logic"]], "Matching multiple values": [[42, "matching-multiple-values"]], "Case insensitive comparisons": [[42, "case-insensitive-comparisons"]], "Neighbors": [[42, "neighbors"]], "Forward undirected neighbor": [[42, "forward-undirected-neighbor"]], "Forward directed neighbors": [[42, "forward-directed-neighbors"]], "Forward recursive neighbors": [[42, "forward-recursive-neighbors"]], "Reverse undirected neighbor": [[42, "reverse-undirected-neighbor"]], "Reverse directed neighbor": [[42, "reverse-directed-neighbor"]], "Relationships": [[42, "relationships"]], "Functions": [[42, "functions"]], ":test": [[42, "test"]], ":is": [[42, "is"]], ":not": [[42, "not"]], ":topdown": [[42, "topdown"]], "Variables": [[42, "variables"]], "var attribute": [[42, "var-attribute"]], "Grammar": [[42, "grammar"]], "Lexical note": [[42, null]], "Compliance Tests": [[42, "compliance-tests"]], "Streaming Traits": [[43, "streaming-traits"]], "streaming trait": [[43, "streaming-trait"]], "Deserializing streaming blobs": [[43, "deserializing-streaming-blobs"]], "requiresLength trait": [[43, "requireslength-trait"]], "Modeled errors in event streams": [[43, "modeled-errors-in-event-streams"]], "Initial messages": [[43, "initial-messages"]], "Initial-request": [[43, "initial-request"]], "Initial-response": [[43, "initial-response"]], "Initial message client and server behavior": [[43, "initial-message-client-and-server-behavior"]], "Event message serialization": [[43, "event-message-serialization"]], "Event stream traits": [[43, "event-stream-traits"]], "eventHeader trait": [[43, "eventheader-trait"]], "eventPayload trait": [[43, "eventpayload-trait"]], "Type refinement traits": [[44, "type-refinement-traits"]], "box trait": [[44, "box-trait"]], "error trait": [[44, "error-trait"]], "input trait": [[44, "input-trait"]], "output trait": [[44, "output-trait"]], "sparse trait": [[44, "sparse-trait"]], "XML binding traits": [[45, "xml-binding-traits"]], "Serializing XML shapes": [[45, "serializing-xml-shapes"]], "Structure and union serialization": [[45, "structure-and-union-serialization"]], "Custom XML element names": [[45, "custom-xml-element-names"]], "XML attributes": [[45, "xml-attributes"]], "xmlName on structures and unions": [[45, "xmlname-on-structures-and-unions"]], "Simple type serialization": [[45, "simple-type-serialization"]], "List and set serialization": [[45, "list-and-set-serialization"]], "Wrapped list serialization": [[45, "wrapped-list-serialization"]], "Flattened list serialization": [[45, "flattened-list-serialization"]], "Map serialization": [[45, "map-serialization"]], "Wrapped map serialization": [[45, "wrapped-map-serialization"]], "Flattened map serialization": [[45, "flattened-map-serialization"]], "xmlAttribute trait": [[45, "xmlattribute-trait"]], "xmlFlattened trait": [[45, "xmlflattened-trait"]], "xmlName trait": [[45, "xmlname-trait"]], "xmlNamespace trait": [[45, "xmlnamespace-trait"]], "HTTP Protocol Compliance Tests": [[46, "http-protocol-compliance-tests"]], "Parameter format": [[46, "parameter-format"]], "httpRequestTests": [[46, "httprequesttests"]], "HTTP request example": [[46, "http-request-example"]], "httpResponseTests": [[46, "httpresponsetests"]], "HTTP response example": [[46, "http-response-example"]], "HTTP error response example": [[46, "http-error-response-example"]], "httpMalformedRequestTests": [[46, "httpmalformedrequesttests"]], "HttpMalformedRequestDefinition": [[46, "httpmalformedrequestdefinition"]], "HttpMalformedResponseDefinition": [[46, "httpmalformedresponsedefinition"]], "HttpMalformedResponseBodyDefinition": [[46, "httpmalformedresponsebodydefinition"]], "HttpMalformedResponseBodyAssertion": [[46, "httpmalformedresponsebodyassertion"]], "HTTP malformed request example": [[46, "http-malformed-request-example"]], "Specifications": [[47, "specifications"]], "Additional specifications": [[47, "additional-specifications"]], "Trait Index": [[47, "trait-index"]], "MQTT Protocol Bindings": [[48, "mqtt-protocol-bindings"]], "MQTT overview": [[48, "mqtt-overview"]], "MQTT topic templates": [[48, "mqtt-topic-templates"]], "smithy.mqtt#publish trait": [[48, "smithy-mqtt-publish-trait"]], "Publish validation": [[48, "publish-validation"]], "smithy.mqtt#subscribe trait": [[48, "smithy-mqtt-subscribe-trait"]], "Subscribe validation": [[48, "subscribe-validation"]], "smithy.mqtt#topicLabel trait": [[48, "smithy-mqtt-topiclabel-trait"]], "Label serialization": [[48, "label-serialization"]], "Topic conflicts": [[48, "topic-conflicts"]], "Model definition": [[48, "model-definition"]], "Waiters": [[49, "waiters"]], "smithy.waiters#waitable trait": [[49, "smithy-waiters-waitable-trait"]], "Waiter names": [[49, "waiter-names"]], "Waiter workflow": [[49, "waiter-workflow"]], "Waiter retries": [[49, "waiter-retries"]], "Why exponential backoff with jitter?": [[49, "why-exponential-backoff-with-jitter"]], "Waiter structure": [[49, "waiter-structure"]], "Acceptor structure": [[49, "acceptor-structure"]], "AcceptorState enum": [[49, "acceptorstate-enum"]], "Matcher union": [[49, "matcher-union"]], "PathMatcher structure": [[49, "pathmatcher-structure"]], "JMESPath data model": [[49, "jmespath-data-model"]], "JMESPath static analysis": [[49, "jmespath-static-analysis"]], "PathComparator enum": [[49, "pathcomparator-enum"]], "Waiter examples": [[49, "waiter-examples"]], "Waiter best-practices": [[49, "waiter-best-practices"]], "Keep JMESPath expressions simple": [[49, "keep-jmespath-expressions-simple"]], "Name waiters after the resource and state": [[49, "name-waiters-after-the-resource-and-state"]], "Do not model implicit acceptors": [[49, "do-not-model-implicit-acceptors"]], "Only model terminal failure states": [[49, "only-model-terminal-failure-states"]], "Smithy Server Generator for TypeScript error handling": [[50, "smithy-server-generator-for-typescript-error-handling"]], "Synthetic errors": [[50, "synthetic-errors"]], "Unavoidable errors": [[50, "unavoidable-errors"]], "InternalFailureException": [[50, "internalfailureexception"]], "SerializationException": [[50, "serializationexception"]], "UnknownOperationException": [[50, "unknownoperationexception"]], "Protocol errors": [[50, "protocol-errors"]], "UnsupportedMediaTypeException": [[50, "unsupportedmediatypeexception"]], "NotAcceptableException": [[50, "notacceptableexception"]], "Smithy Server Generator for TypeScript handlers": [[51, "smithy-server-generator-for-typescript-handlers"]], "ServiceHandler factories": [[51, "servicehandler-factories"]], "Contexts": [[51, "contexts"]], "Smithy Server Generator for TypeScript": [[52, "smithy-server-generator-for-typescript"]], "Introduction to the Smithy Server Generator for TypeScript": [[53, "introduction-to-the-smithy-server-generator-for-typescript"]], "Data flow": [[53, "data-flow"]], "Smithy Server Generator for TypeScript supported endpoints": [[54, "smithy-server-generator-for-typescript-supported-endpoints"]], "Amazon API Gateway REST APIs and AWS Lambda": [[54, "amazon-api-gateway-rest-apis-and-aws-lambda"]], "Smithy Server Generator for TypeScript validation": [[55, "smithy-server-generator-for-typescript-validation"]], "Default validation": [[55, "default-validation"]], "Custom validation": [[55, "custom-validation"]]}, "indexentries": {"rfc": [[3, "index-0"], [3, "index-1"], [5, "index-0"], [5, "index-1"], [15, "index-0"], [16, "index-0"], [19, "index-0"], [28, "index-0"], [28, "index-1"], [28, "index-2"], [29, "index-0"], [29, "index-1"], [32, "index-0"], [33, "index-0"], [33, "index-1"], [33, "index-2"], [33, "index-3"], [33, "index-4"], [33, "index-5"], [33, "index-6"], [33, "index-7"], [33, "index-8"], [33, "index-9"], [35, "index-0"], [35, "index-1"], [37, "index-0"], [37, "index-1"], [37, "index-2"], [37, "index-3"], [40, "index-0"], [40, "index-1"], [40, "index-2"], [41, "index-0"], [48, "index-0"]], "rfc 6901": [[3, "index-0"], [5, "index-0"], [37, "index-3"]], "rfc 6902": [[3, "index-1"], [5, "index-1"]], "rfc 3986": [[15, "index-0"], [19, "index-0"]], "rfc 4632": [[16, "index-0"]], "rfc 2617": [[28, "index-0"], [28, "index-1"]], "rfc 6750": [[28, "index-2"]], "rfc 1864": [[29, "index-0"]], "rfc 9110#section-8.4": [[29, "index-1"]], "rfc 3986#section-3.2.2": [[32, "index-0"]], "rfc 3339": [[33, "index-4"], [33, "index-9"], [37, "index-0"], [37, "index-2"], [48, "index-0"]], "rfc 3986#section-2.1": [[33, "index-6"], [33, "index-8"]], "rfc 3986#section-2.3": [[33, "index-5"], [33, "index-7"]], "rfc 7230#appendix-b": [[33, "index-0"]], "rfc 7230#section-3.2": [[33, "index-2"]], "rfc 7230#section-5.3.1": [[33, "index-1"]], "rfc 7231#section-7.1.1.1": [[33, "index-3"], [40, "index-2"]], "rfc 2119": [[35, "index-0"]], "rfc 5234": [[35, "index-1"]], "rfc 7231#section-4.3.4": [[37, "index-1"]], "rfc 3339#section-5.6": [[40, "index-1"]], "rfc 6838": [[40, "index-0"]], "rfc 5988#section-4": [[41, "index-0"]]}}) \ No newline at end of file diff --git a/1.0/spec/aws/amazon-apigateway.html b/1.0/spec/aws/amazon-apigateway.html index 942a5ac4501..cd5aac7cc16 100644 --- a/1.0/spec/aws/amazon-apigateway.html +++ b/1.0/spec/aws/amazon-apigateway.html @@ -312,7 +312,7 @@

Amazon API Gateway traitsservice
Value type

string set to one of the following values:

-

+
@@ -389,7 +389,7 @@

Amazon API Gateway traits -

+
@@ -549,7 +549,7 @@

Amazon API Gateway traits:test(service, operation)
Value type

string value set to one of the following:

-

+
@@ -636,7 +636,7 @@

Amazon API Gateway traitsaws.apigateway#integration trait is a structure that supports the following members:

-

+
@@ -819,7 +819,7 @@

Amazon API Gateway traitsaws.apigateway#mockIntegration trait is a structure that supports the following members:

-

+
@@ -940,7 +940,7 @@

Shared trait data types

Properties

-

+
@@ -983,7 +983,7 @@

Shared trait data typesSpecifies mapping templates for a request payload of the specified media types.

Properties

-

+
@@ -1020,7 +1020,7 @@

Shared trait data types

Properties

-

+
@@ -1086,7 +1086,7 @@

Shared trait data types

Properties

-

+
@@ -1146,7 +1146,7 @@

Shared trait data types

Properties

-

+
@@ -1189,7 +1189,7 @@

Shared trait data types

Properties

-

+
diff --git a/1.0/spec/aws/aws-auth.html b/1.0/spec/aws/aws-auth.html index 3588eae09a4..23653980c41 100644 --- a/1.0/spec/aws/aws-auth.html +++ b/1.0/spec/aws/aws-auth.html @@ -311,7 +311,7 @@
Trait selector
service
Trait value

An object that supports the following properties:

-
+
@@ -433,7 +433,7 @@

Unsigned Payloads and signature version 4service
Trait value

An object that supports the following properties:

-

+
diff --git a/1.0/spec/aws/aws-cloudformation.html b/1.0/spec/aws/aws-cloudformation.html index 54782e700f8..08a0df7713a 100644 --- a/1.0/spec/aws/aws-cloudformation.html +++ b/1.0/spec/aws/aws-cloudformation.html @@ -322,7 +322,7 @@

The aws.cloudformation#cfnResource trait is a structure that supports the following members:

-
+
@@ -563,7 +563,7 @@

The computed resource property mutabilities are:

-
+
@@ -640,7 +640,7 @@

The cfnMutability trait overrides any derived mutability setting on a member. The values of the mutability trait have the following meanings:

-
+
@@ -1083,7 +1083,7 @@

Example model -

+
diff --git a/1.0/spec/aws/aws-core.html b/1.0/spec/aws/aws-core.html index 5f83af87c12..cefc9e3c498 100644 --- a/1.0/spec/aws/aws-core.html +++ b/1.0/spec/aws/aws-core.html @@ -543,7 +543,7 @@

Using SDK service ID for client namingaws.api#arn trait is a structure that supports the following members:

-

+
@@ -771,7 +771,7 @@

Using an ARN as a resource identifieraws.api#arnReference trait is a structure that supports the following optional members:

-

+
@@ -934,7 +934,7 @@

Using an ARN as a resource identifier -

+
@@ -973,7 +973,7 @@

Using an ARN as a resource identifieraws.api#data trait.

-

+
@@ -1123,7 +1123,7 @@

Using an ARN as a resource identifieraws.api#clientEndpointDiscovery trait is a structure that supports the following members:

-

+
@@ -1175,7 +1175,7 @@

Using an ARN as a resource identifieraws.api#clientDiscoveredEndpoint trait is a structure that supports the following members:

-

+
@@ -1335,7 +1335,7 @@

CachinghttpChecksum trait is a structure that contains the following members:

-

+
@@ -1564,7 +1564,7 @@

HTTP response checksums -

+
diff --git a/1.0/spec/aws/aws-ec2-query-protocol.html b/1.0/spec/aws/aws-ec2-query-protocol.html index 8e9a8fd8e3b..42fab70610d 100644 --- a/1.0/spec/aws/aws-ec2-query-protocol.html +++ b/1.0/spec/aws/aws-ec2-query-protocol.html @@ -416,7 +416,7 @@

  • Use the default value for the member, if present:

    -
    • +
    @@ -445,7 +445,7 @@

    Supported traitsaws.protocols#ec2Query protocol supports the following traits that affect serialization:

    -

    +
    @@ -516,7 +516,7 @@

    Request serialization

    Requests MUST include the following key value pairs in the serialized body:

    -

    +
    @@ -547,7 +547,7 @@

    Request serializationx-www-form-urlencoded shape serialization#

    Simple shapes are serialized according to the following rules:

    -
    +
    @@ -611,7 +611,7 @@

    x-www-form-urlencoded shape serialization -

    +
    @@ -755,7 +755,7 @@

    Response serialization

    XML shape serialization#

    -

    +
    @@ -898,7 +898,7 @@

    XML shape serializationec2Query protocol treats those special values as strings with the following values:

    -

    +
    diff --git a/1.0/spec/aws/aws-iam.html b/1.0/spec/aws/aws-iam.html index 7fc150ac125..ba6e0a0cfa0 100644 --- a/1.0/spec/aws/aws-iam.html +++ b/1.0/spec/aws/aws-iam.html @@ -455,7 +455,7 @@ "^([A-Za-z0-9][A-Za-z0-9-\\.]{0,62}:[^:]+)$". Each condition key structure supports the following members:

    -
    +
    @@ -547,7 +547,7 @@

    The following table describes the available types a condition key can have. Condition keys in IAM policies can be evaluated with condition operators.

    -
    +
    @@ -803,7 +803,7 @@

    The aws.iam#iamResource trait is a structure that supports the following members:

    -
    +
    @@ -885,7 +885,7 @@

    The computed condition keys for the service are:

    -
    +
    diff --git a/1.0/spec/aws/aws-json-1_0-protocol.html b/1.0/spec/aws/aws-json-1_0-protocol.html index 346b7ce7de6..3b2ed7bd6b5 100644 --- a/1.0/spec/aws/aws-json-1_0-protocol.html +++ b/1.0/spec/aws/aws-json-1_0-protocol.html @@ -310,12 +310,12 @@ responses with JSON documents.
    Trait selector
    service
    Value type
    Structure
    -
    See
    Protocol tests
    +
    See
    Protocol tests

    aws.protocols#awsJson1_0 is a structure that supports the following members:

    -
    +
    @@ -425,7 +425,7 @@

    Supported traitsawsJson1_0 protocol supports the following traits that affect serialization:

    -

    +
    @@ -465,7 +465,7 @@

    Protocol BehaviorsHTTP binding traits MUST be ignored if they are present.

    The awsJson1_0 protocol uses the following headers:

    -

    +
    @@ -507,7 +507,7 @@

    Shape serialization -

    +
    @@ -610,7 +610,7 @@

    Non-numeric float and double serializationawsJson1_0 protocol treats those special values as strings with the following values:

    -

    +
    diff --git a/1.0/spec/aws/aws-json-1_1-protocol.html b/1.0/spec/aws/aws-json-1_1-protocol.html index 5a22cc1dde6..3eaffff099a 100644 --- a/1.0/spec/aws/aws-json-1_1-protocol.html +++ b/1.0/spec/aws/aws-json-1_1-protocol.html @@ -310,12 +310,12 @@ responses with JSON documents.
    Trait selector
    service
    Value type
    Structure
    -
    See
    Protocol tests
    +
    See
    Protocol tests

    aws.protocols#awsJson1_1 is a structure that supports the following members:

    -
    +
    @@ -425,7 +425,7 @@

    Supported traitsawsJson1_1 protocol supports the following traits that affect serialization:

    -

    +
    @@ -465,7 +465,7 @@

    Protocol BehaviorsHTTP binding traits MUST be ignored if they are present.

    The awsJson1_1 protocol uses the following headers:

    -

    +
    @@ -507,7 +507,7 @@

    Shape serialization -

    +
    @@ -610,7 +610,7 @@

    Non-numeric float and double serializationawsJson1_1 protocol treats those special values as strings with the following values:

    -

    +
    diff --git a/1.0/spec/aws/aws-query-protocol.html b/1.0/spec/aws/aws-query-protocol.html index c48b6ae7076..b05a583f734 100644 --- a/1.0/spec/aws/aws-query-protocol.html +++ b/1.0/spec/aws/aws-query-protocol.html @@ -343,7 +343,7 @@

    Supported traitsaws.protocols#awsQuery protocol supports the following traits that affect serialization:

    -

    +
    @@ -410,7 +410,7 @@

    Request serialization

    Requests MUST include the following key value pairs in the serialized body:

    -

    +
    @@ -441,7 +441,7 @@

    Request serializationx-www-form-urlencoded shape serialization#

    Simple shapes are serialized according to the following rules:

    -
    +
    @@ -505,7 +505,7 @@

    x-www-form-urlencoded shape serialization -

    +
    @@ -562,7 +562,7 @@

    x-www-form-urlencoded shape serializationUse the default value for the member:

    -

    +
    @@ -805,7 +805,7 @@

    Response serialization

    XML shape serialization#

    -

    +
    @@ -955,7 +955,7 @@

    XML shape serializationawsQuery protocol treats those special values as strings with the following values:

    -

    +
    @@ -1010,7 +1010,7 @@

    XML shape serializationService shapes with the xmlNamespace trait

    Value type
    Annotation trait.
    -
    See
    Protocol tests
    +
    See
    Protocol tests
    namespace smithy.example
@@ -1056,7 +1056,7 @@ 
    XML shape serialization
 
    Value type
    structure that supports the following members:
    
 
    
-

    +
    diff --git a/1.0/spec/aws/aws-restjson1-protocol.html b/1.0/spec/aws/aws-restjson1-protocol.html index cc952f2edca..9c4f7f54750 100644 --- a/1.0/spec/aws/aws-restjson1-protocol.html +++ b/1.0/spec/aws/aws-restjson1-protocol.html @@ -318,7 +318,7 @@

    aws.protocols#restJson1 is a structure that supports the following members:

    -
    +
    @@ -428,7 +428,7 @@

    Supported traitsaws.protocols#restJson1 protocol supports the following traits that affect serialization:

    -

    +
    @@ -512,7 +512,7 @@

    Content-TypehttpPayload trait:

    -

    +
    @@ -548,7 +548,7 @@

    Content-Type

    JSON shape serialization#

    -

    +
    @@ -649,7 +649,7 @@

    Non-numeric float and double serializationaws.protocols#restJson1 protocol treats those special values as strings with the following values:

    -

    +
    diff --git a/1.0/spec/aws/aws-restxml-protocol.html b/1.0/spec/aws/aws-restxml-protocol.html index 3791d007c06..8bfd0e2c6a0 100644 --- a/1.0/spec/aws/aws-restxml-protocol.html +++ b/1.0/spec/aws/aws-restxml-protocol.html @@ -314,7 +314,7 @@

    aws.protocols#restXml is a structure that supports the following members:

    -
    +
    @@ -424,7 +424,7 @@

    Supported traitsaws.protocols#restXml protocol supports the following traits that affect serialization:

    -

    +
    @@ -519,7 +519,7 @@

    Content-TypehttpPayload trait:

    -

    +
    @@ -555,7 +555,7 @@

    Content-Type

    XML shape serialization#

    -

    +
    @@ -673,7 +673,7 @@

    Non-numeric float and double serializationaws.protocols#restXml protocol treats those special values as strings with the following values:

    -

    +
    diff --git a/1.0/spec/aws/customizations/s3-customizations.html b/1.0/spec/aws/customizations/s3-customizations.html index 5a4e0caa5e7..8720e4c41a1 100644 --- a/1.0/spec/aws/customizations/s3-customizations.html +++ b/1.0/spec/aws/customizations/s3-customizations.html @@ -311,7 +311,7 @@

    S3 Bucket AddressingS3 Bucket Virtual Hosting settings:

    -

    +
    @@ -371,7 +371,7 @@

    S3 Bucket Addressing
    -

    +
    @@ -405,7 +405,7 @@

    S3 Dual-Stack EndpointsS3 Bucket Virtual Hosting setting resolved to "virtual" to enable this setting.

    -

    +
    @@ -435,7 +435,7 @@

    S3 Transfer Acceleration EndpointsS3 Bucket Virtual Hosting setting resolved to "virtual" to enable this setting.

    -

    +
    diff --git a/1.0/spec/core/auth-traits.html b/1.0/spec/core/auth-traits.html index d499b490c4d..4f4df6775b9 100644 --- a/1.0/spec/core/auth-traits.html +++ b/1.0/spec/core/auth-traits.html @@ -312,7 +312,7 @@
    Trait selector
    [trait|trait]
    Value type

    An object with the following properties:

    -
    +
    @@ -459,7 +459,7 @@

    The httpApiKeyAuth trait is an object that supports the following properties:

    -
    +
    diff --git a/1.0/spec/core/behavior-traits.html b/1.0/spec/core/behavior-traits.html index 9283fb03083..3f55ef2f028 100644 --- a/1.0/spec/core/behavior-traits.html +++ b/1.0/spec/core/behavior-traits.html @@ -387,7 +387,7 @@

    8. Behavior traits

    The retryable trait is a structure that contains the following members:

    -

    +
    @@ -435,7 +435,7 @@

    8. Behavior traits

    The paginated trait is a structure that contains the following members:

    -

    +
    @@ -782,7 +782,7 @@

    8.5.4. Backward compatibilityrequestCompression trait is a structure that contains the following members:

    -

    +
    diff --git a/1.0/spec/core/constraint-traits.html b/1.0/spec/core/constraint-traits.html index c1f2e128aa2..dd977459ec1 100644 --- a/1.0/spec/core/constraint-traits.html +++ b/1.0/spec/core/constraint-traits.html @@ -315,7 +315,7 @@ set of allowable values.

    An enum definition is a structure that supports the following members:

    -
    +
    @@ -474,7 +474,7 @@

    The idRef trait is a structure that supports the following optional members:

    -
    +
    @@ -624,7 +624,7 @@

    The length trait is a structure that contains the following members:

    -
    +
    @@ -786,7 +786,7 @@

    The range trait is a structure that contains the following members:

    -
    +
    diff --git a/1.0/spec/core/documentation-traits.html b/1.0/spec/core/documentation-traits.html index 296fd0aece1..1f5a7e2ec73 100644 --- a/1.0/spec/core/documentation-traits.html +++ b/1.0/spec/core/documentation-traits.html @@ -313,7 +313,7 @@

    The deprecated trait is a structure that supports the following members:

    -
    +
    @@ -450,7 +450,7 @@

    Each example trait value is a structure with the following members:

    -
    +
    @@ -545,7 +545,7 @@

    The ErrorExample structure defines an error example using the following members:

    -
    +
    @@ -629,7 +629,7 @@
    Trait selector
    structure > member
    Value type

    Structure with the following members:

    -
    +
    diff --git a/1.0/spec/core/endpoint-traits.html b/1.0/spec/core/endpoint-traits.html index 05b91f22cf2..10fea14c184 100644 --- a/1.0/spec/core/endpoint-traits.html +++ b/1.0/spec/core/endpoint-traits.html @@ -313,7 +313,7 @@

    The endpoint trait is a structure that contains the following members:

    -
    +
    diff --git a/1.0/spec/core/http-traits.html b/1.0/spec/core/http-traits.html index 7e5cc4d9ebc..be6a79a7f09 100644 --- a/1.0/spec/core/http-traits.html +++ b/1.0/spec/core/http-traits.html @@ -325,7 +325,7 @@

    The http trait is a structure that supports the following members:

    -
    +
    @@ -444,7 +444,7 @@

    11.1.2.1. Literal character sequences

    Given an endpoint of https://yourhost and a pattern of /my/uri/path:

    -

    +
    @@ -503,7 +503,7 @@

    11.1.2.1. Literal character sequences

    Given a pattern of /my/uri/{label} and an endpoint of http://yourhost:

    -

    +
    @@ -553,7 +553,7 @@

    11.1.2.1. Literal character sequences/my/uri/{label1}/{label2} and an endpoint of http://yourhost:

    -

    +
    @@ -601,7 +601,7 @@

    11.1.2.3. Query string literalsLiterals can be in the form of required keys without values. Given a pattern of /path?requiredKey and an endpoint of http://yourhost:

    -

    +
    @@ -646,7 +646,7 @@

    11.1.2.3. Query string literals/path?requiredKey=requiredValue and an endpoint of http://yourhost:

    -

    +
    @@ -695,7 +695,7 @@

    11.1.2.3. Query string literals

    Given a pattern of /my/uri/{label+} and an endpoint of http://yourhost:

    -

    +
    @@ -735,7 +735,7 @@

    11.1.2.3. Query string literals/prefix/{label+}/suffix and an endpoint of https://yourhost:

    -

    +
    @@ -909,7 +909,7 @@

    11.1.2.5. Pattern Validation and Conflic

    Various HTTP headers are highly discouraged for the httpHeader and httpPrefixHeaders traits.

    -

    +
    @@ -1441,7 +1441,7 @@

    11.1.2.5. Pattern Validation and Conflic

    The cors trait is a structure that supports the following members:

    -

    +
    diff --git a/1.0/spec/core/idl.html b/1.0/spec/core/idl.html index d06ca597ec4..948957d23c1 100644 --- a/1.0/spec/core/idl.html +++ b/1.0/spec/core/idl.html @@ -705,7 +705,7 @@

    16.2. Lexical notessemantic model.

    The following control statements are currently supported:

    -

    +
    @@ -1882,7 +1882,7 @@

    16.8.1. String values -

    +
    diff --git a/1.0/spec/core/json-ast.html b/1.0/spec/core/json-ast.html index ff4f90bc2e6..349a4ed9ebb 100644 --- a/1.0/spec/core/json-ast.html +++ b/1.0/spec/core/json-ast.html @@ -319,7 +319,7 @@

    17.1. Top level properties -

    +
    @@ -624,7 +624,7 @@

    17.8. Structure and union shapesService shapes are defined using an object. Service shapes defined in JSON support the same properties as the Smithy IDL.

    -

    +
    @@ -714,7 +714,7 @@

    17.8. Structure and union shapesResource shapes are defined using an object. Resource shapes defined in JSON support the same properties as the Smithy IDL.

    -

    +
    @@ -837,7 +837,7 @@

    17.8. Structure and union shapesOperation shapes are defined using an object with the following properties:

    -

    +
    diff --git a/1.0/spec/core/model-validation.html b/1.0/spec/core/model-validation.html index 6b3c0802b34..a07d006d973 100644 --- a/1.0/spec/core/model-validation.html +++ b/1.0/spec/core/model-validation.html @@ -326,7 +326,7 @@

    15.1. Introductionvalidators array supports the following properties:

    -

    +
    @@ -488,7 +488,7 @@

    15.1. IntroductionEach suppression object in the suppressions array supports the following properties:

    -

    +
    @@ -561,7 +561,7 @@

    15.5. Built-in validatorsDANGER
    Configuration
    -

    +
    @@ -745,7 +745,7 @@

    15.5. Built-in validators -

    +
    @@ -792,7 +792,7 @@

    15.5. Built-in validators -

    +
    @@ -815,7 +815,7 @@

    15.5.1.3. Variable message formattingDifferent types of variables expand to different kinds of strings in message templates.

    -

    +
    @@ -899,7 +899,7 @@

    15.5.1.3. Variable message formatting
    Default severity
    DANGER
    Configuration
    -

    +
    diff --git a/1.0/spec/core/model.html b/1.0/spec/core/model.html index 49d6ebe6d79..97818cdf638 100644 --- a/1.0/spec/core/model.html +++ b/1.0/spec/core/model.html @@ -595,7 +595,7 @@

    1.4. Simple shapes#

    Simple types are types that do not contain nested types or shape references.

    -
    +
    @@ -746,7 +746,7 @@

    Aggregate types define shapes that are composed of other shapes. Aggregate shapes reference other shapes using members.

    -
    +
    @@ -1290,7 +1290,7 @@

    1.5.8. Recursive shape definitionsService types have specific semantics and define services, resources, and operations.

    -

    +
    @@ -1322,7 +1322,7 @@

    1.5.8. Recursive shape definitionsservice_statement.

    The service shape supports the following properties:

    -

    +
    @@ -1617,7 +1617,7 @@

    1.5.8. Recursive shape definitionsoperation_statement.

    An operation supports the following members:

    -

    +
    @@ -1715,7 +1715,7 @@

    1.5.8. Recursive shape definitionsresource_statement.

    A resource supports the following members:

    -

    +
    @@ -2483,7 +2483,7 @@

    1.6.4.3. Explicit identifier bindingsnode values.

    -

    +
    @@ -2623,7 +2623,7 @@

    1.6.4.3. Explicit identifier bindingsTrait properties

    smithy.api#trait is a structure that supports the following members:

    -

    +
    @@ -2860,7 +2860,7 @@

    1.6.4.3. Explicit identifier bindings
    -

    +
    @@ -3210,7 +3210,7 @@

    1.9.1. Node value types -

    +
    diff --git a/1.0/spec/core/protocol-traits.html b/1.0/spec/core/protocol-traits.html index 1b1c19dcfe3..ee1e3bdfbd6 100644 --- a/1.0/spec/core/protocol-traits.html +++ b/1.0/spec/core/protocol-traits.html @@ -315,7 +315,7 @@

    6. Protocol traitsTrait selector
    [trait|trait]
    Value type

    An object with the following properties:

    -

    +
    @@ -554,7 +554,7 @@

    6. Protocol traitsTimestamp formats

    Smithy defines the following built-in timestamp formats:

    -

    +
    diff --git a/1.0/spec/core/resource-traits.html b/1.0/spec/core/resource-traits.html index bdfb3131cd6..b5114abbcc0 100644 --- a/1.0/spec/core/resource-traits.html +++ b/1.0/spec/core/resource-traits.html @@ -374,7 +374,7 @@

    9. Resource traitsThe references trait is a list of Reference structures that contain the following members:

    -

    +
    diff --git a/1.0/spec/core/selectors.html b/1.0/spec/core/selectors.html index f815d7b7ae6..f49e4987a9d 100644 --- a/1.0/spec/core/selectors.html +++ b/1.0/spec/core/selectors.html @@ -347,7 +347,7 @@

    14.2. Matching shapes with selectors14.3. Matching shapes by type#

    Shapes can be matched by type using the following tokens:

    -
    +
    @@ -496,7 +496,7 @@

    14.4.2. Attribute comparison -

    +
    @@ -588,7 +588,7 @@

    14.4.2. Attribute comparisonsmithy:Number productions when converted to a string.

    -

    +
    @@ -636,7 +636,7 @@

    14.4.2. Attribute comparison -

    +
    @@ -1047,7 +1047,7 @@

    14.5.6.2. Comparisons to projections
    -

    +
    @@ -1292,7 +1292,7 @@

    14.7.5. Reverse directed neighbor

    14.7.6. Relationships#

    The table below lists the labeled directed relationships from each shape.

    -

    +
    @@ -1831,7 +1831,7 @@

    14.11. Compliance Testsmetadata called selectorTests. This metadata contains a list of test cases, each including a selector, the expected matched shapes, and additional configuration options. The test case contains the following properties:

    -

    +
    diff --git a/1.0/spec/core/xml-traits.html b/1.0/spec/core/xml-traits.html index 6caac7dc71c..742dc03ea16 100644 --- a/1.0/spec/core/xml-traits.html +++ b/1.0/spec/core/xml-traits.html @@ -400,7 +400,7 @@

    12.1.1.3. 12.1.2. Simple type serialization#

    The following table defines how simple types are serialized in XML documents.

    -
    +
    @@ -1131,7 +1131,7 @@

    12.1.4.2. Flattened map serialization

    The xmlNamespace trait is a structure that contains the following members:

    -

    +
    diff --git a/1.0/spec/http-protocol-compliance-tests.html b/1.0/spec/http-protocol-compliance-tests.html index a976fd00e78..854c7968543 100644 --- a/1.0/spec/http-protocol-compliance-tests.html +++ b/1.0/spec/http-protocol-compliance-tests.html @@ -362,7 +362,7 @@

    Parameter formathttpRequestTests trait is a list of HttpRequestTestCase structures that support the following members:

    -

    +
    @@ -508,8 +508,10 @@

    Parameter format

    -
    params document

    Defines the input parameters used to generate the HTTP request. These -parameters MUST be compatible with the input of the operation.

    +

    For clients, defines the input parameters used to generate the HTTP +request. For servers, defines the input parameters extracted from the +HTTP request. These parameters MUST be compatible with the input of the +operation.

    Parameter values that contain binary data MUST be defined using values that can be represented in plain text (for example, use "foo" and not "Zm9vCg=="). While this limits the kinds of binary values @@ -632,7 +634,7 @@

    HTTP request exampleThe httpResponseTests trait is a list of HttpResponseTestCase structures that support the following members:

    - +
    @@ -706,9 +708,10 @@

    HTTP request example

    -
    params document

    Defines the output or error parameters used to generate the HTTP -response. These parameters MUST be compatible with the targeted -operation's output or the targeted error structure.

    +

    For clients, defines the output or error parameters extracted from the +HTTP response. For servers, defines the output or error parameters used +to generate the HTTP response. These parameters MUST be compatible with +the targeted operation's output or the targeted error structure.

    Parameter values that contain binary data MUST be defined using values that can be represented in plain text (for example, use "foo" and not "Zm9vCg=="). While this limits the kinds of binary values @@ -890,7 +893,7 @@

    HTTP error response examplehttpMalformedRequestTests trait is a list of HttpMalformedRequestTestCase structures that support the following members:

    - +
    @@ -953,7 +956,7 @@

    HTTP error response exampleCodeWriter. They are available as named +the documentation for CodeWriter. They are available as named parameters, and implementations must support both the L and S formatters.

    @@ -972,7 +975,7 @@

    HTTP error response example

    HttpMalformedRequestDefinition#

    -

    +
    @@ -1038,7 +1041,7 @@

    HTTP error response example

    HttpMalformedResponseDefinition#

    -

    +
    @@ -1075,7 +1078,7 @@

    HTTP error response example

    HttpMalformedResponseBodyDefinition#

    -

    +
    @@ -1107,7 +1110,7 @@

    HTTP error response example -

    +
    diff --git a/1.0/spec/mqtt.html b/1.0/spec/mqtt.html index 94daf71b20a..13b2167bec6 100644 --- a/1.0/spec/mqtt.html +++ b/1.0/spec/mqtt.html @@ -593,7 +593,7 @@

    Topic conflicts -

    +
    diff --git a/1.0/spec/waiters.html b/1.0/spec/waiters.html index 42eb8e7cd3c..96077344a3c 100644 --- a/1.0/spec/waiters.html +++ b/1.0/spec/waiters.html @@ -592,7 +592,7 @@

    Why exponential backoff with jitter? -

    +
    @@ -647,7 +647,7 @@

    Why exponential backoff with jitter?

    Acceptor structure#

    -

    +
    @@ -678,7 +678,7 @@

    Why exponential backoff with jitter?

    AcceptorState enum#

    Acceptors cause a waiter to transition into one of the following states:

    -

    +
    @@ -711,7 +711,7 @@

    Why exponential backoff with jitter? -

    +
    @@ -769,7 +769,7 @@

    Why exponential backoff with jitter? -

    +
    @@ -926,7 +926,7 @@

    JMESPath static analysis -

    +
    diff --git a/2.0/_sources/additional-specs/http-protocol-compliance-tests.rst.txt b/2.0/_sources/additional-specs/http-protocol-compliance-tests.rst.txt index da92e4f562b..5a0703bc52a 100644 --- a/2.0/_sources/additional-specs/http-protocol-compliance-tests.rst.txt +++ b/2.0/_sources/additional-specs/http-protocol-compliance-tests.rst.txt @@ -208,8 +208,10 @@ that support the following members: to parse and validate the expected data against generated data. * - params - ``document`` - - Defines the input parameters used to generate the HTTP request. These - parameters MUST be compatible with the input of the operation. + - For clients, defines the input parameters used to generate the HTTP + request. For servers, defines the input parameters extracted from the + HTTP request. These parameters MUST be compatible with the input of the + operation. Parameter values that contain binary data MUST be defined using values that can be represented in plain text (for example, use "foo" @@ -393,9 +395,10 @@ structures that support the following members: base64 encoded. * - params - ``document`` - - Defines the output or error parameters used to generate the HTTP - response. These parameters MUST be compatible with the targeted - operation's output or the targeted error structure. + - For clients, defines the output or error parameters extracted from the + HTTP response. For servers, defines the output or error parameters used + to generate the HTTP response. These parameters MUST be compatible with + the targeted operation's output or the targeted error structure. Parameter values that contain binary data MUST be defined using values that can be represented in plain text (for example, use "foo" diff --git a/2.0/_sources/additional-specs/index.rst.txt b/2.0/_sources/additional-specs/index.rst.txt index cf3743324a3..e9c8638b4a6 100644 --- a/2.0/_sources/additional-specs/index.rst.txt +++ b/2.0/_sources/additional-specs/index.rst.txt @@ -15,6 +15,7 @@ start with ``smithy.*`` where "*" is anything other than ``api``. waiters mqtt rules-engine/index + protocols/index .. seealso:: diff --git a/2.0/_sources/additional-specs/protocols/index.rst.txt b/2.0/_sources/additional-specs/protocols/index.rst.txt new file mode 100644 index 00000000000..9d41bef0040 --- /dev/null +++ b/2.0/_sources/additional-specs/protocols/index.rst.txt @@ -0,0 +1,10 @@ +.. _protocols: + +========= +Protocols +========= + +.. toctree:: + :maxdepth: 1 + + smithy-rpc-v2 diff --git a/2.0/_sources/additional-specs/protocols/smithy-rpc-v2.rst.txt b/2.0/_sources/additional-specs/protocols/smithy-rpc-v2.rst.txt new file mode 100644 index 00000000000..2b2e4664bda --- /dev/null +++ b/2.0/_sources/additional-specs/protocols/smithy-rpc-v2.rst.txt @@ -0,0 +1,484 @@ +.. _smithy-rpc-v2-cbor: + +=========================== +Smithy RPC v2 CBOR protocol +=========================== + +This specification defines the ``smithy.protocols#rpcv2Cbor`` protocol. This +protocol is used to expose services that serialize RPC payloads as CBOR. + +.. smithy-trait:: smithy.protocols#rpcv2Cbor +.. _smithy.protocols#rpcv2Cbor-trait: + + +------------------------------------ +``smithy.protocols#rpcv2Cbor`` trait +------------------------------------ + +Summary + Adds support for an RPC-based protocol over HTTP that sends requests and + responses with CBOR payloads. +Trait selector + ``service`` +Value type + Structure +See + `Protocol tests `_ + +``smithy.protocols#rpcv2Cbor`` is a structure that supports the following +members: + +.. list-table:: + :header-rows: 1 + :widths: 10 20 70 + + * - Property + - Type + - Description + * - http + - ``[string]`` + - The priority ordered list of supported HTTP protocol versions. + * - eventStreamHttp + - ``[string]`` + - The priority ordered list of supported HTTP protocol versions + that are required when using :ref:`event streams ` + with the service. If not set, this value defaults to the value + of the ``http`` member. Any entry in ``eventStreamHttp`` MUST + also appear in ``http``. + +Each entry in ``http`` and ``eventStreamHttp`` SHOULD be a valid +`Application-Layer Protocol Negotiation (ALPN) Protocol ID`_ (for example, +``http/1.1``, ``h2``, etc). Clients SHOULD pick the first protocol in the +list they understand when connecting to a service. A client SHOULD assume +that a service supports ``http/1.1`` when no ``http`` or ``eventStreamHttp`` +values are provided. + +The following example defines a service that uses +``smithy.protocols#rpcv2Cbor``. + +.. code-block:: smithy + + $version: "2" + + namespace smithy.example + + use smithy.protocols#rpcv2Cbor + + @rpcv2Cbor + service MyService { + version: "2020-07-02" + } + +The following example defines a service that requires the use of +``h2`` when using event streams. + +.. code-block:: smithy + + $version: "2" + + namespace smithy.example + + use smithy.protocols#rpcv2Cbor + + @rpcv2Cbor( + http: ["h2", "http/1.1"], + eventStreamHttp: ["h2"] + ) + service MyService { + version: "2020-02-05" + } + +The following example defines a service that requires the use of +``h2`` or ``http/1.1`` when using event streams, where ``h2`` is +preferred over ``http/1.1``. + +.. code-block:: smithy + + $version: "2" + + namespace smithy.example + + use smithy.protocols#rpcv2Cbor + + @rpcv2Cbor( + http: ["h2", "http/1.1"], + eventStreamHttp: ["h2", "http/1.1"] + ) + service MyService { + version: "2020-02-05" + } + +The following example defines a service that requires the use of +``h2`` for all requests, including event streams. + +.. code-block:: smithy + + $version: "2" + + namespace smithy.example + + use smithy.protocols#rpcv2Cbor + + @rpcv2Cbor(http: ["h2"]) + service MyService { + version: "2020-02-05" + } + + +---------------- +Supported traits +---------------- + +The ``smithy.protocols#rpcv2Cbor`` protocol supports the following traits +that affect serialization: + +.. list-table:: + :header-rows: 1 + :widths: 20 80 + + * - Trait + - Description + * - :ref:`cors ` + - Indicates that the service supports CORS. + * - :ref:`endpoint ` + - Configures a custom operation endpoint. + * - :ref:`hostLabel ` + - Binds a top-level operation input structure member to a label in + the hostPrefix of an endpoint trait. + * - :ref:`httpError ` + - A ``client`` error has a default status code of ``400``, and a + ``server`` error has a default status code of ``500``. The + ``httpError`` trait is used to define a custom status code. + * - :ref:`requestCompression ` + - Indicates that an operation supports compressing requests from clients + to services. + + +------------------ +Protocol behaviors +------------------ + +Implementations of the ``smithy.protocols#rpcv2Cbor`` protocol comply with the +following rules: + +~~~~~~~~ +Requests +~~~~~~~~ + +Every request for the ``rpcv2Cbor`` protocol MUST contain a ``Smithy-Protocol`` +header with the value of ``rpc-v2-cbor``. + +Every request for the ``rpcv2Cbor`` protocol MUST be sent using the HTTP +``POST`` method. :ref:`HTTP binding traits ` MUST be ignored when +building ``rpcv2Cbor`` requests if they are present. + +Every request for the ``rpcv2Cbor`` protocol MUST be sent to a URL with the +following form: ``{prefix?}/service/{serviceName}/operation/{operationName}`` + +* The Smithy RPCv2 CBOR protocol will only use the last four segments of the + URL when routing requests. For example, a service could use a ``v1`` prefix + in the URL path, which would not affect the operation a request is routed + to: ``v1/service/FooService/operation/BarOperation`` +* The ``serviceName`` segment MUST be replaced by the :token:`shape name ` + of the service's :ref:`shape-id` in the Smithy model. The ``serviceName`` + produced by client implementations MUST NOT contain the namespace of the + ``service`` shape. Service implementations SHOULD accept an absolute shape + ID as the content of this segment with the ``#`` character replaced with a + ``.`` character, routing it the same as if only the name was specified. For + example, if the ``service``'s absolute shape ID is + ``com.example#TheService``, a service should accept both ``TheService`` and + ``com.example.TheService`` as values for the ``serviceName`` segment. +* The ``operationName`` segment MUST be replaced by the name of the ``operation`` + shape in the Smithy. The ``operationName`` produced by client + implementations MUST NOT contain the namespace of the ``operation`` shape. + Service implementations MUST NOT accept an absolute shape ID as the content + of this segment. + +Requests for the ``rpcv2Cbor`` protocol MUST use the following behavior for +setting a ``Content-Type`` header: + +* Buffered RPC requests: the value of the ``Content-Type`` header MUST be + ``application/cbor``. +* Event streaming requests: the value of the ``Content-Type`` header MUST be + ``application/vnd.amazon.eventstream``. +* Requests for operations with no defined input type (as in, they target the + ``Unit`` shape) MUST NOT contain bodies in their HTTP requests. The + ``Content-Type`` for the serialization format MUST NOT be set. + +Requests for the ``rpcv2Cbor`` protocol MUST NOT contain an ``X-Amz-Target`` or +``X-Amzn-Target`` header. An ``rpcv2Cbor`` request is malformed if it contains +either of these headers. Server-side implementations MUST reject such requests +for security reasons. + +Buffered RPC requests for the ``rpcv2Cbor`` protocol SHOULD include a +``Content-Length`` header. Event streaming requests MUST NOT specify a content +length (instead using ``Transfer-Encoding: chunked`` on HTTP/1.1). + +Event streaming requests for the ``rpcv2Cbor`` protocol MUST include an +``Accept`` header set to the value ``application/vnd.amazon.eventstream``. +Other forms of content streaming MAY be added in the future, utilizing +different values for ``Accept``. + +In summary, the ``rpcv2Cbor`` protocol defines behavior for the following +headers for requests: + +.. list-table:: + :header-rows: 1 + :widths: 18 18 64 + + * - Header + - Status + - Description + * - ``Smithy-Protocol`` + - Required + - The value of ``rpc-v2-cbor``. + * - ``Content-Type`` + - Required with request bodies + - The value of ``application/cbor``. For event streaming requests, this + is ``application/vnd.amazon.eventstream``. + * - ``Content-Length`` + - Conditional + - The standard ``Content-Length`` header defined by :rfc:`7230#section-3.3.2`. + For event streaming requests, this MUST NOT be set. + * - ``Accept`` + - Conditional + - For event streaming requests, to the value ``application/vnd.amazon.eventstream``. + + +~~~~~~~~~ +Responses +~~~~~~~~~ + +The status code for successful ``rpcv2Cbor`` responses MUST be ``200``. + +The status code for error ``rpcv2Cbor`` MUST be determined by the following +steps: + +1. If the :ref:`httpError ` trait is set on the error shape, + its value is used. +2. If the :ref:`error ` trait is set to ``server``, the value + MUST be ``500``. +3. Otherwise, the value MUST be ``400``. + +Every response for the ``rpcv2Cbor`` protocol MUST contain a ``Smithy-Protocol`` +header with the value of ``rpc-v2-cbor``. The response MUST match the value of +the ``Smithy-Protocol`` header from the request. + +Responses for the ``rpcv2Cbor`` protocol MUST use the following behavior for +setting a ``Content-Type`` header: + +* Buffered RPC responses: the value of the ``Content-Type`` header MUST be + ``application/cbor``. +* Event streaming responses: the value of the ``Content-Type`` header MUST be + ``application/vnd.amazon.eventstream``. +* Responses for operations with no defined output type (as in, they target the + ``Unit`` shape) MUST NOT contain bodies in their HTTP responses. The + ``Content-Type`` for the serialization format MUST NOT be set. + +Buffered RPC responses for the ``rpcv2Cbor`` protocol SHOULD include a +``Content-Length`` header. Event streaming responses SHOULD NOT specify a +content length (instead using ``Transfer-Encoding: chunked`` on HTTP/1.1). + +Responses for the ``rpcv2Cbor`` protocol SHOULD NOT contain the +``X-Amzn-ErrorType`` header. Type information is always serialized in the +payload. Clients MUST ignore this header. See `Operation error serialization`_ +for information on the serialization of error responses. + +In summary, the ``rpcv2Cbor`` protocol defines behavior for the following +headers for responses: + +.. list-table:: + :header-rows: 1 + :widths: 18 18 64 + + * - Header + - Status + - Description + * - ``Smithy-Protocol`` + - Required + - The value of ``rpc-v2-cbor``. + * - ``Content-Type`` + - Required with request bodies + - The value of ``application/cbor``. For event streaming requests, this + is ``application/vnd.amazon.eventstream``. + * - ``Content-Length`` + - Conditional + - The standard ``Content-Length`` header defined by :rfc:`7230#section-3.3.2`. + For event streaming requests, this SHOULD NOT be set. + + +------------------- +Shape serialization +------------------- + +The ``smithy.protocols#rpcv2Cbor`` protocol serializes all shapes into a CBOR +document body with no HTTP bindings supported. The following table shows how +to convert each shape type: + +.. list-table:: + :header-rows: 1 + :widths: 25 75 + + * - Smithy type + - CBOR representation + * - ``blob`` + - :rfc:`Major type 2 (byte string) <8949#section-3.1-2.5>` + * - ``boolean`` + - :rfc:`Major type 7 (simple) <8949#section-3.1-2.15>` + * - ``byte`` + - :rfc:`Major type 0 (unsigned integer) <8949#section-3.1-2.1>` or + :rfc:`major type 1 (negative integer) <8949#section-3.1-2.3>` + * - ``short`` + - :rfc:`Major type 0 (unsigned integer) <8949#section-3.1-2.1>` or + :rfc:`major type 1 (negative integer) <8949#section-3.1-2.3>` + * - ``integer`` + - :rfc:`Major type 0 (unsigned integer) <8949#section-3.1-2.1>` or + :rfc:`major type 1 (negative integer) <8949#section-3.1-2.3>` + * - ``long`` + - :rfc:`Major type 0 (unsigned integer) <8949#section-3.1-2.1>` or + :rfc:`major type 1 (negative integer) <8949#section-3.1-2.3>` + * - ``float`` + - :rfc:`Major type 7 (float) <8949#section-3.1-2.15>` + * - ``double`` + - :rfc:`Major type 7 (float) <8949#section-3.1-2.15>` + * - ``bigDecimal`` + - :rfc:`Major type 6 <8949#section-3.1-2.13>`, value + :rfc:`tags 2 (unsigned bignum) or 3 (negative bignum) <8949#section-3.4>` + * - ``bigInteger`` + - :rfc:`Major type 6 <8949#section-3.1-2.13>`, value + :rfc:`tag 4 (decimal fraction) <8949#section-3.4>` + * - ``string`` + - :rfc:`Major type 3 (text string) <8949#section-3.1-2.7>` + * - ``timestamp`` + - See `Timestamp type serialization`_. + * - ``document`` + - Document types are not currently supported in this protocol. + * - ``list`` + - :rfc:`Major type 4 (array of data items) <8949#section-3.1-2.9>` + * - ``map`` + - :rfc:`Major type 5 (map of pairs of data items) <8949#section-3.1-2.11>`, + each key/value pair is a pair in the type + * - ``structure`` + - :rfc:`Major type 5 (map of pairs of data items) <8949#section-3.1-2.11>`, + each member is the key to a pair in the type + * - ``union`` + - :rfc:`Major type 5 (map of pairs of data items) <8949#section-3.1-2.11>`, + each member is the key to a pair in the type. + + A union is serialized identically as a ``structure`` + shape, but only a single member can be set to a non-null value. + Deserializers MUST ignore an unrecognized ``__type`` member if present. + +Values that are ``null`` MUST be omitted from wire contents where not subject +to `default value serialization`_ rules. + +If an implementation does not support arbitrary precision (``bigInteger`` and +``bigDecimal`` Smithy types), it MUST fail when attempting to deserialize a +value of that type. + +.. note:: + The ``undefined`` CBOR value, CBOR :rfc:`major type 7 <8949#section-3.1-2.15>` + :rfc:`value 23 <8949#section-3.3>`, is not supported. Clients SHOULD NOT + serialize to this CBOR value and SHOULD deserialize this CBOR value to + ``null``. Servers MUST NOT serialize to this CBOR value and MUST + deserialize this CBOR value to ``null``. + +~~~~~~~~~~~~~~~~~~~~~~~~~~ +Numeric type serialization +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Numeric types (``byte``, ``short``, ``integer``, ``long``, ``float``, and ``double``) +SHOULD be serialized into the smallest possible CBOR type representation that +can contain its value. For example, a field modeled as a ``long`` with a value of +1 should be sent in a single byte. + +Floating-point numeric types (``float`` and ``double``) MAY be serialized into +non-floating-point numeric types (``byte``, ``short``, ``integer``, and ``long``) if +and only if the conversion would not cause a loss of precision. For example, a +field modeled as a ``float`` with a value of 256 may be sent as an integer. + +As support for half-precision floating-point values is inconsistent across +implementations, floating-point numeric types SHOULD NOT serialize into a +half-precision (16 bit) numeric CBOR values. Implementations MUST be capable of +deserializing half-precision numeric CBOR values (including -Infinity, +Infinity, and NAN) into their Smithy type representation. + +Numeric types MUST be deserialized into their Smithy type representation. For +example, a field modeled as a ``long`` with a single byte value of 1 must be +deserialized into a long. + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Timestamp type serialization +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Timestamps are serialized as :rfc:`major type 6 <8949#section-3.1-2.13>`, value +:rfc:`tag 1 (epoch-based date/time) <8949#section-3.4>` to indicate the tagged +value is an epoch timestamp. Values are either :rfc:`major type 0 (unsigned integer) <8949#section-3.1-2.1>` +or :rfc:`major type 1 (negative integer) <8949#section-3.1-2.3>` for integer +values or :rfc:`major type 7 <8949#section-3.1-2.15>`, +:rfc:`value 25 (half-precision float), 26 (single-precision float), or 27 (double-precision float) <8949#section-3.3>` +for floating-point values. + +As support for half-precision floating-point values is inconsistent across +implementations, timestamp types SHOULD NOT serialize into a half-precision +(16 bit) numeric CBOR value for the tagged value. + +This protocol uses ``epoch-seconds``, also known as Unix timestamps, with +millisecond (1/1000th of a second) resolution. The :ref:`timestampFormat ` +MUST NOT be respected to customize timestamp serialization. + + +~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Default value serialization +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To avoid information disclosure, service serializers SHOULD omit the default +value of structure members that are marked with the :ref:`internal trait `. + +Client deserializers SHOULD attempt to error correct structures that omit a +:ref:`required ` member by filling in a default zero value for +the member. Error correction allows clients to continue to function while the +server is in error. + +---------------------------------- +Operation response deserialization +---------------------------------- + +Clients MUST use the following rules to interpret responses and determine how +to deserialize them: + +1. If the response does not have the same ``Smithy-Protocol`` header as the + request, it MUST be considered malformed. Clients who receive a malformed + response MUST handle it (i.e. throw a reasonable exception) based solely on + the HTTP response code. No attempt should be made to interpret the response + body or headers. +2. If the response code is ``200``, the request is successful and the response + payload SHALL be deserialized as the ``output`` shape defined on the + operation. +3. Finally, if the response code is not ``200``, the response payload is an + exception and SHALL be deserialized according to `Operation error serialization`_ + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Operation error serialization +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Error responses in the ``rpcv2Cbor`` protocol MUST be serialized identically to +standard responses with one additional component to distinguish which error is +contained: a body field named ``__type``. This value of this component MUST +contain the error’s absolute :ref:`shape-id`. + +By default, all error shapes have a ``message`` field containing an +error-specific message meant for human consumers of API errors. Services MUST +support generating this field and serializing it when responding. Clients MUST +support generating this field and deserializing it from responses. + +The ``Code`` response body field and ``code`` response body field MUST NOT be +used to distinguish which error is contained in a response. + +Clients who receive a malformed error response MUST handle it based solely on +the HTTP response code (i.e. throw a reasonable exception). No attempt should +be made to interpret the response body or headers. + +.. include:: ../../aws/protocols/error-rename-simple.rst.template + +.. _`Application-Layer Protocol Negotiation (ALPN) Protocol ID`: https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids diff --git a/2.0/_sources/aws/protocols/aws-query-protocol.rst.txt b/2.0/_sources/aws/protocols/aws-query-protocol.rst.txt index 2ccc4574ce3..b917034423a 100644 --- a/2.0/_sources/aws/protocols/aws-query-protocol.rst.txt +++ b/2.0/_sources/aws/protocols/aws-query-protocol.rst.txt @@ -549,19 +549,20 @@ The following example defines an error that uses a custom "Code" of Summary When using the :ref:`awsQuery ` protocol, - custom ``Code`` and ``HTTP response code`` values can be defined for an error response via - the :ref:`awsQueryError ` trait. - - The ``awsQueryCompatible`` trait allows services to backward compatibly migrate from ``awsQuery`` to - :ref:`awsJson1_0 ` without removing values defined in the ``awsQueryError`` trait. - - This trait adds the ``x-amzn-query-error`` header in the form of ``Code;Fault`` to error responses. - ``Code`` is the value defined in the :ref:`awsQueryError `, - and ``Fault`` is one of ``Sender`` or ``Receiver``. - + custom ``Code`` and ``HTTP response code`` values can be defined for an + error response via the :ref:`awsQueryError ` + trait. + + The ``awsQueryCompatible`` trait allows services to backward compatibly + migrate from ``awsQuery`` to :ref:`awsJson1_0 ` + without removing values defined in the ``awsQueryError`` trait. + + This trait adds the ``x-amzn-query-error`` header in the form of + ``Code;Fault`` to error responses. ``Code`` is the value defined in the + :ref:`awsQueryError `, and ``Fault`` is + one of ``Sender`` or ``Receiver``. Trait selector ``service [trait|awsJson1_0]`` - Value type Annotation trait @@ -587,6 +588,11 @@ Value type message: String } +.. important:: + + AWS client implementations of the ``smithy.protocols#rpcv2Cbor`` protocol + MUST support the ``aws.protocols#awsQueryCompatible`` trait. + .. _awsQuery-compliance-tests: diff --git a/2.0/_static/basic.css b/2.0/_static/basic.css index eeb0519a69b..4e9a9f1faca 100644 --- a/2.0/_static/basic.css +++ b/2.0/_static/basic.css @@ -236,16 +236,6 @@ div.body p, div.body dd, div.body li, div.body blockquote { a.headerlink { visibility: hidden; } -a.brackets:before, -span.brackets > a:before{ - content: "["; -} - -a.brackets:after, -span.brackets > a:after { - content: "]"; -} - h1:hover > a.headerlink, h2:hover > a.headerlink, @@ -334,11 +324,15 @@ aside.sidebar { p.sidebar-title { font-weight: bold; } +nav.contents, +aside.topic, div.admonition, div.topic, blockquote { clear: left; } /* -- topics ---------------------------------------------------------------- */ +nav.contents, +aside.topic, div.topic { border: 1px solid #ccc; padding: 7px; @@ -377,6 +371,8 @@ div.body p.centered { div.sidebar > :last-child, aside.sidebar > :last-child, +nav.contents > :last-child, +aside.topic > :last-child, div.topic > :last-child, div.admonition > :last-child { margin-bottom: 0; @@ -384,6 +380,8 @@ div.admonition > :last-child { div.sidebar::after, aside.sidebar::after, +nav.contents::after, +aside.topic::after, div.topic::after, div.admonition::after, blockquote::after { @@ -608,19 +606,26 @@ ol.simple p, ul.simple p { margin-bottom: 0; } -dl.footnote > dt, -dl.citation > dt { +aside.footnote > span, +div.citation > span { float: left; - margin-right: 0.5em; } - -dl.footnote > dd, -dl.citation > dd { +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { margin-bottom: 0em; } - -dl.footnote > dd:after, -dl.citation > dd:after { +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { content: ""; clear: both; } @@ -636,10 +641,6 @@ dl.field-list > dt { padding-left: 0.5em; padding-right: 5px; } -dl.field-list > dt:after { - content: ":"; -} - dl.field-list > dd { padding-left: 0.5em; diff --git a/2.0/additional-specs/http-protocol-compliance-tests.html b/2.0/additional-specs/http-protocol-compliance-tests.html index ddc6a8ca0d6..3abe0906f13 100644 --- a/2.0/additional-specs/http-protocol-compliance-tests.html +++ b/2.0/additional-specs/http-protocol-compliance-tests.html @@ -249,16 +249,20 @@
  • Rules engine standard library
    • +
  • Protocols
    • -
  • AWS integrations
      +
    +
    • +
  • AWS integrations
    • +
    @@ -547,8 +551,10 @@

    Parameter format

    -
    params document

    Defines the input parameters used to generate the HTTP request. These -parameters MUST be compatible with the input of the operation.

    +

    For clients, defines the input parameters used to generate the HTTP +request. For servers, defines the input parameters extracted from the +HTTP request. These parameters MUST be compatible with the input of the +operation.

    Parameter values that contain binary data MUST be defined using values that can be represented in plain text (for example, use "foo" and not "Zm9vCg=="). While this limits the kinds of binary values @@ -672,7 +678,7 @@

    HTTP request exampleThe httpResponseTests trait is a list of HttpResponseTestCase structures that support the following members:

    - +
    @@ -746,9 +752,10 @@

    HTTP request example

    - or other required elements. + thead: [ 1, "
    params document

    Defines the output or error parameters used to generate the HTTP -response. These parameters MUST be compatible with the targeted -operation's output or the targeted error structure.

    +

    For clients, defines the output or error parameters extracted from the +HTTP response. For servers, defines the output or error parameters used +to generate the HTTP response. These parameters MUST be compatible with +the targeted operation's output or the targeted error structure.

    Parameter values that contain binary data MUST be defined using values that can be represented in plain text (for example, use "foo" and not "Zm9vCg=="). While this limits the kinds of binary values @@ -889,7 +896,7 @@

    HTTP error response examplehttpMalformedRequestTests trait is a list of HttpMalformedRequestTestCase structures that support the following members:

    - +
    @@ -952,7 +959,7 @@

    HTTP error response exampleCodeWriter. They are available as named +the documentation for CodeWriter. They are available as named parameters, and implementations must support both the L and S formatters.

    @@ -971,7 +978,7 @@

    HTTP error response example

    HttpMalformedRequestDefinition#

    -

    +
    @@ -1037,7 +1044,7 @@

    HTTP error response example

    HttpMalformedResponseDefinition#

    -

    +
    @@ -1074,7 +1081,7 @@

    HTTP error response example

    HttpMalformedResponseBodyDefinition#

    -

    +
    @@ -1106,7 +1113,7 @@

    HTTP error response example -

    +
    diff --git a/2.0/additional-specs/index.html b/2.0/additional-specs/index.html index f36b12b7b3f..4cf0cb6e938 100644 --- a/2.0/additional-specs/index.html +++ b/2.0/additional-specs/index.html @@ -249,16 +249,20 @@
  • Rules engine standard library
    • +
  • Protocols
    • -
  • AWS integrations
      +
    +
    • +
  • AWS integrations
    • +
    diff --git a/2.0/additional-specs/protocols/index.html b/2.0/additional-specs/protocols/index.html new file mode 100644 index 00000000000..893142fa2cf --- /dev/null +++ b/2.0/additional-specs/protocols/index.html @@ -0,0 +1,422 @@ + + + + + + + + Protocols - Smithy 2.0 + + + + + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
    +
    +
    + +
    +
    +
    Smithy 2.0
     +
    +
    +
    + +
    + +
    +
    + +
    +
    +
    + + + + + Back to top + +
    +
    + + + + +
    + +
    + +
    + +
    + +
    + +
    +
    + + + + + + + + + + + \ No newline at end of file diff --git a/2.0/additional-specs/protocols/smithy-rpc-v2.html b/2.0/additional-specs/protocols/smithy-rpc-v2.html new file mode 100644 index 00000000000..4534e18f1d1 --- /dev/null +++ b/2.0/additional-specs/protocols/smithy-rpc-v2.html @@ -0,0 +1,964 @@ + + + + + + + + Smithy RPC v2 CBOR protocol - Smithy 2.0 + + + + + + + + + + + + + + + + + + + + Contents + + + + + + Menu + + + + + + + + Expand + + + + + + Light mode + + + + + + + + + + + + + + Dark mode + + + + + + + Auto light/dark mode + + + + + + + + + + + + + + + + + + + +
    +
    +
    + +
    +
    +
    Smithy 2.0
     +
    +
    +
    + +
    + +
    +
    + +
    +
    +
    + + + + + Back to top + +
    +
    + + + + +
    + +
    + +
    +
    +
    +

    Smithy RPC v2 CBOR protocol#

    +

    This specification defines the smithy.protocols#rpcv2Cbor protocol. This +protocol is used to expose services that serialize RPC payloads as CBOR.

    +
    +

    smithy.protocols#rpcv2Cbor trait#

    +
    +
    Summary
    Adds support for an RPC-based protocol over HTTP that sends requests and +responses with CBOR payloads.
    +
    Trait selector
    service
    +
    Value type
    Structure
    +
    See
    Protocol tests
    +
    +

    smithy.protocols#rpcv2Cbor is a structure that supports the following +members:

    +
    +
    +++++ + + + + + + + + + + + + + + + + +
    PropertyTypeDescription
    http[string]The priority ordered list of supported HTTP protocol versions.
    eventStreamHttp[string]The priority ordered list of supported HTTP protocol versions +that are required when using event streams +with the service. If not set, this value defaults to the value +of the http member. Any entry in eventStreamHttp MUST +also appear in http.
    +
     +

    Each entry in http and eventStreamHttp SHOULD be a valid +Application-Layer Protocol Negotiation (ALPN) Protocol ID (for example, +http/1.1, h2, etc). Clients SHOULD pick the first protocol in the +list they understand when connecting to a service. A client SHOULD assume +that a service supports http/1.1 when no http or eventStreamHttp +values are provided.

    +

    The following example defines a service that uses +smithy.protocols#rpcv2Cbor.

    +
    $version: "2"
+
+namespace smithy.example
+
+use smithy.protocols#rpcv2Cbor
+
+@rpcv2Cbor
+service MyService {
+    version: "2020-07-02"
+}
+
    +
    +

    The following example defines a service that requires the use of +h2 when using event streams.

    +
    $version: "2"
+
+namespace smithy.example
+
+use smithy.protocols#rpcv2Cbor
+
+@rpcv2Cbor(
+    http: ["h2", "http/1.1"],
+    eventStreamHttp: ["h2"]
+)
+service MyService {
+    version: "2020-02-05"
+}
+
    +
    +

    The following example defines a service that requires the use of +h2 or http/1.1 when using event streams, where h2 is +preferred over http/1.1.

    +
    $version: "2"
+
+namespace smithy.example
+
+use smithy.protocols#rpcv2Cbor
+
+@rpcv2Cbor(
+    http: ["h2", "http/1.1"],
+    eventStreamHttp: ["h2", "http/1.1"]
+)
+service MyService {
+    version: "2020-02-05"
+}
+
    +
    +

    The following example defines a service that requires the use of +h2 for all requests, including event streams.

    +
    $version: "2"
+
+namespace smithy.example
+
+use smithy.protocols#rpcv2Cbor
+
+@rpcv2Cbor(http: ["h2"])
+service MyService {
+    version: "2020-02-05"
+}
+
    +
    + +
    +

    Supported traits#

    +

    The smithy.protocols#rpcv2Cbor protocol supports the following traits +that affect serialization:

    +
    + ++++ + + + + + + + + + + + + + + + + + + + + + + +
    TraitDescription
    corsIndicates that the service supports CORS.
    endpointConfigures a custom operation endpoint.
    hostLabelBinds a top-level operation input structure member to a label in +the hostPrefix of an endpoint trait.
    httpErrorA client error has a default status code of 400, and a +server error has a default status code of 500. The +httpError trait is used to define a custom status code.
    requestCompressionIndicates that an operation supports compressing requests from clients +to services.
    +
    +
    +
    +

    Protocol behaviors#

    +

    Implementations of the smithy.protocols#rpcv2Cbor protocol comply with the +following rules:

    +
    +

    Requests#

    +

    Every request for the rpcv2Cbor protocol MUST contain a Smithy-Protocol +header with the value of rpc-v2-cbor.

    +

    Every request for the rpcv2Cbor protocol MUST be sent using the HTTP +POST method. HTTP binding traits MUST be ignored when +building rpcv2Cbor requests if they are present.

    +

    Every request for the rpcv2Cbor protocol MUST be sent to a URL with the +following form: {prefix?}/service/{serviceName}/operation/{operationName}

    +
      +
    • +
      The Smithy RPCv2 CBOR protocol will only use the last four segments of the
      URL when routing requests. For example, a service could use a v1 prefix +in the URL path, which would not affect the operation a request is routed +to: v1/service/FooService/operation/BarOperation
      +
      +
      • +
    • +
      The serviceName segment MUST be replaced by the shape name
      of the service's Shape ID in the Smithy model. The serviceName +produced by client implementations MUST NOT contain the namespace of the +service shape. Service implementations SHOULD accept an absolute shape +ID as the content of this segment with the # character replaced with a +. character, routing it the same as if only the name was specified. For +example, if the service's absolute shape ID is +com.example#TheService, a service should accept both TheService and +com.example.TheService as values for the serviceName segment.
      +
      +
      • +
    • +
      The operationName segment MUST be replaced by the name of the operation
      shape in the Smithy. The operationName produced by client +implementations MUST NOT contain the namespace of the operation shape. +Service implementations MUST NOT accept an absolute shape ID as the content +of this segment.
      +
      +
      • +
    +

    Requests for the rpcv2Cbor protocol MUST use the following behavior for +setting a Content-Type header:

    +
      +
    • +
      Buffered RPC requests: the value of the Content-Type header MUST be
      application/cbor.
      +
      +
      • +
    • +
      Event streaming requests: the value of the Content-Type header MUST be
      application/vnd.amazon.eventstream.
      +
      +
      • +
    • +
      Requests for operations with no defined input type (as in, they target the
      Unit shape) MUST NOT contain bodies in their HTTP requests. The +Content-Type for the serialization format MUST NOT be set.
      +
      +
      • +
    +

    Requests for the rpcv2Cbor protocol MUST NOT contain an X-Amz-Target or +X-Amzn-Target header. An rpcv2Cbor request is malformed if it contains +either of these headers. Server-side implementations MUST reject such requests +for security reasons.

    +

    Buffered RPC requests for the rpcv2Cbor protocol SHOULD include a +Content-Length header. Event streaming requests MUST NOT specify a content +length (instead using Transfer-Encoding: chunked on HTTP/1.1).

    +

    Event streaming requests for the rpcv2Cbor protocol MUST include an +Accept header set to the value application/vnd.amazon.eventstream. +Other forms of content streaming MAY be added in the future, utilizing +different values for Accept.

    +

    In summary, the rpcv2Cbor protocol defines behavior for the following +headers for requests:

    +
    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + +
    HeaderStatusDescription
    Smithy-ProtocolRequiredThe value of rpc-v2-cbor.
    Content-TypeRequired with request bodiesThe value of application/cbor. For event streaming requests, this +is application/vnd.amazon.eventstream.
    Content-LengthConditionalThe standard Content-Length header defined by RFC 7230#section-3.3.2. +For event streaming requests, this MUST NOT be set.
    AcceptConditionalFor event streaming requests, to the value application/vnd.amazon.eventstream.
    +
    +
    +
    +

    Responses#

    +

    The status code for successful rpcv2Cbor responses MUST be 200.

    +

    The status code for error rpcv2Cbor MUST be determined by the following +steps:

    +
      +
    1. If the httpError trait is set on the error shape, +its value is used.
      2. +
    2. If the error trait is set to server, the value +MUST be 500.
      3. +
    3. Otherwise, the value MUST be 400.
      4. +
    +

    Every response for the rpcv2Cbor protocol MUST contain a Smithy-Protocol +header with the value of rpc-v2-cbor. The response MUST match the value of +the Smithy-Protocol header from the request.

    +

    Responses for the rpcv2Cbor protocol MUST use the following behavior for +setting a Content-Type header:

    +
      +
    • Buffered RPC responses: the value of the Content-Type header MUST be +application/cbor.
      • +
    • Event streaming responses: the value of the Content-Type header MUST be +application/vnd.amazon.eventstream.
      • +
    • Responses for operations with no defined output type (as in, they target the +Unit shape) MUST NOT contain bodies in their HTTP responses. The +Content-Type for the serialization format MUST NOT be set.
      • +
    +

    Buffered RPC responses for the rpcv2Cbor protocol SHOULD include a +Content-Length header. Event streaming responses SHOULD NOT specify a +content length (instead using Transfer-Encoding: chunked on HTTP/1.1).

    +

    Responses for the rpcv2Cbor protocol SHOULD NOT contain the +X-Amzn-ErrorType header. Type information is always serialized in the +payload. Clients MUST ignore this header. See Operation error serialization +for information on the serialization of error responses.

    +

    In summary, the rpcv2Cbor protocol defines behavior for the following +headers for responses:

    +
    + +++++ + + + + + + + + + + + + + + + + + + + + +
    HeaderStatusDescription
    Smithy-ProtocolRequiredThe value of rpc-v2-cbor.
    Content-TypeRequired with request bodiesThe value of application/cbor. For event streaming requests, this +is application/vnd.amazon.eventstream.
    Content-LengthConditionalThe standard Content-Length header defined by RFC 7230#section-3.3.2. +For event streaming requests, this SHOULD NOT be set.
    +
    +
    +
    +
    +

    Shape serialization#

    +

    The smithy.protocols#rpcv2Cbor protocol serializes all shapes into a CBOR +document body with no HTTP bindings supported. The following table shows how +to convert each shape type:

    +
    + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Smithy typeCBOR representation
    blobMajor type 2 (byte string)
    booleanMajor type 7 (simple)
    byteMajor type 0 (unsigned integer) or +major type 1 (negative integer)
    shortMajor type 0 (unsigned integer) or +major type 1 (negative integer)
    integerMajor type 0 (unsigned integer) or +major type 1 (negative integer)
    longMajor type 0 (unsigned integer) or +major type 1 (negative integer)
    floatMajor type 7 (float)
    doubleMajor type 7 (float)
    bigDecimalMajor type 6, value +tags 2 (unsigned bignum) or 3 (negative bignum)
    bigIntegerMajor type 6, value +tag 4 (decimal fraction)
    stringMajor type 3 (text string)
    timestampSee Timestamp type serialization.
    documentDocument types are not currently supported in this protocol.
    listMajor type 4 (array of data items)
    mapMajor type 5 (map of pairs of data items), +each key/value pair is a pair in the type
    structureMajor type 5 (map of pairs of data items), +each member is the key to a pair in the type
    union

    Major type 5 (map of pairs of data items), +each member is the key to a pair in the type.

    +

    A union is serialized identically as a structure +shape, but only a single member can be set to a non-null value. +Deserializers MUST ignore an unrecognized __type member if present.

    +
    +
    +

    Values that are null MUST be omitted from wire contents where not subject +to default value serialization rules.

    +

    If an implementation does not support arbitrary precision (bigInteger and +bigDecimal Smithy types), it MUST fail when attempting to deserialize a +value of that type.

    +
    +

    Note

    +

    The undefined CBOR value, CBOR major type 7 +value 23, is not supported. Clients SHOULD NOT +serialize to this CBOR value and SHOULD deserialize this CBOR value to +null. Servers MUST NOT serialize to this CBOR value and MUST +deserialize this CBOR value to null.

    +
    +
    +

    Numeric type serialization#

    +

    Numeric types (byte, short, integer, long, float, and double) +SHOULD be serialized into the smallest possible CBOR type representation that +can contain its value. For example, a field modeled as a long with a value of +1 should be sent in a single byte.

    +

    Floating-point numeric types (float and double) MAY be serialized into +non-floating-point numeric types (byte, short, integer, and long) if +and only if the conversion would not cause a loss of precision. For example, a +field modeled as a float with a value of 256 may be sent as an integer.

    +

    As support for half-precision floating-point values is inconsistent across +implementations, floating-point numeric types SHOULD NOT serialize into a +half-precision (16 bit) numeric CBOR values. Implementations MUST be capable of +deserializing half-precision numeric CBOR values (including -Infinity, +Infinity, and NAN) into their Smithy type representation.

    +

    Numeric types MUST be deserialized into their Smithy type representation. For +example, a field modeled as a long with a single byte value of 1 must be +deserialized into a long.

    +
    +
    +

    Timestamp type serialization#

    +

    Timestamps are serialized as major type 6, value +tag 1 (epoch-based date/time) to indicate the tagged +value is an epoch timestamp. Values are either major type 0 (unsigned integer) +or major type 1 (negative integer) for integer +values or major type 7, +value 25 (half-precision float), 26 (single-precision float), or 27 (double-precision float) +for floating-point values.

    +

    As support for half-precision floating-point values is inconsistent across +implementations, timestamp types SHOULD NOT serialize into a half-precision +(16 bit) numeric CBOR value for the tagged value.

    +

    This protocol uses epoch-seconds, also known as Unix timestamps, with +millisecond (1/1000th of a second) resolution. The timestampFormat +MUST NOT be respected to customize timestamp serialization.

    +
    +
    +

    Default value serialization#

    +

    To avoid information disclosure, service serializers SHOULD omit the default +value of structure members that are marked with the internal trait.

    +

    Client deserializers SHOULD attempt to error correct structures that omit a +required member by filling in a default zero value for +the member. Error correction allows clients to continue to function while the +server is in error.

    +
    +
    +
    +

    Operation response deserialization#

    +

    Clients MUST use the following rules to interpret responses and determine how +to deserialize them:

    +
      +
    1. +
      If the response does not have the same Smithy-Protocol header as the
      request, it MUST be considered malformed. Clients who receive a malformed +response MUST handle it (i.e. throw a reasonable exception) based solely on +the HTTP response code. No attempt should be made to interpret the response +body or headers.
      +
      +
      2. +
    2. +
      If the response code is 200, the request is successful and the response
      payload SHALL be deserialized as the output shape defined on the +operation.
      +
      +
      3. +
    3. +
      Finally, if the response code is not 200, the response payload is an
      exception and SHALL be deserialized according to Operation error serialization
      +
      +
      4. +
    +
    +

    Operation error serialization#

    +

    Error responses in the rpcv2Cbor protocol MUST be serialized identically to +standard responses with one additional component to distinguish which error is +contained: a body field named __type. This value of this component MUST +contain the error’s absolute Shape ID.

    +

    By default, all error shapes have a message field containing an +error-specific message meant for human consumers of API errors. Services MUST +support generating this field and serializing it when responding. Clients MUST +support generating this field and deserializing it from responses.

    +

    The Code response body field and code response body field MUST NOT be +used to distinguish which error is contained in a response.

    +

    Clients who receive a malformed error response MUST handle it based solely on +the HTTP response code (i.e. throw a reasonable exception). No attempt should +be made to interpret the response body or headers.

    +
    +
    +
    +

    Error shape renaming#

    +

    By default, Smithy permits renaming shapes to disambiguate shape ID conflicts in +the service closure via the rename property. However, services using this protocol are +not allowed to rename error shapes (shapes with error trait applied).

    +
    + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/2.0/additional-specs/rules-engine/index.html b/2.0/additional-specs/rules-engine/index.html index bc5f3a3d690..3e0e98f2af3 100644 --- a/2.0/additional-specs/rules-engine/index.html +++ b/2.0/additional-specs/rules-engine/index.html @@ -249,16 +249,20 @@
  • Rules engine standard library
    • +
  • Protocols
    • -
  • AWS integrations
      +
    +
    • +
  • AWS integrations

    • ", "
    " ], + col: [ 2, "", "
    " ], + tr: [ 2, "", "
    " ], + td: [ 3, "", "
    " ], + + _default: [ 0, "", "" ] +}; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +var + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = Object.create( null ); + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + return result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + + which: function( event ) { + var button = event.button; + + // Add which for key events + if ( event.which == null && rkeyEvent.test( event.type ) ) { + return event.charCode != null ? event.charCode : event.keyCode; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { + if ( button & 1 ) { + return 1; + } + + if ( button & 2 ) { + return 3; + } + + if ( button & 4 ) { + return 2; + } + + return 0; + } + + return event.which; + } +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.get( src ); + events = pdataOld.events; + + if ( events ) { + dataPriv.remove( dest, "handle events" ); + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = flat( args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html; + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var swap = function( elem, options, callback ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px"; + tr.style.height = "1px"; + trChild.style.height = "9px"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = parseInt( trStyle.height ) > 3; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( + dataPriv.get( cur, "events" ) || Object.create( null ) + )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = { guid: Date.now() }; + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ) + .filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ) + .map( function( _i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Use a noop converter for missing script + if ( !isSuccess && jQuery.inArray( "script", s.dataTypes ) > -1 ) { + s.converters[ "text script" ] = function() {}; + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( _i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + + +jQuery._evalUrl = function( url, options, doc ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( "\r\n"; + +// inject VBScript +document.write(IEBinaryToArray_ByteStr_Script); + +global.JSZipUtils._getBinaryFromXHR = function (xhr) { + var binary = xhr.responseBody; + var byteMapping = {}; + for ( var i = 0; i < 256; i++ ) { + for ( var j = 0; j < 256; j++ ) { + byteMapping[ String.fromCharCode( i + (j << 8) ) ] = + String.fromCharCode(i) + String.fromCharCode(j); + } + } + var rawBytes = IEBinaryToArray_ByteStr(binary); + var lastChr = IEBinaryToArray_ByteStr_Last(binary); + return rawBytes.replace(/[\s\S]/g, function( match ) { + return byteMapping[match]; + }) + lastChr; +}; + +// enforcing Stuk's coding style +// vim: set shiftwidth=4 softtabstop=4: + +},{}]},{},[1]) +; diff --git a/javadoc/1.47.0/jquery/jszip-utils/dist/jszip-utils-ie.min.js b/javadoc/1.47.0/jquery/jszip-utils/dist/jszip-utils-ie.min.js new file mode 100644 index 00000000000..93d8bc8ef28 --- /dev/null +++ b/javadoc/1.47.0/jquery/jszip-utils/dist/jszip-utils-ie.min.js @@ -0,0 +1,10 @@ +/*! + +JSZipUtils - A collection of cross-browser utilities to go along with JSZip. + + +(c) 2014 Stuart Knightley, David Duponchel +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip-utils/master/LICENSE.markdown. + +*/ +!function a(b,c,d){function e(g,h){if(!c[g]){if(!b[g]){var i="function"==typeof require&&require;if(!h&&i)return i(g,!0);if(f)return f(g,!0);throw new Error("Cannot find module '"+g+"'")}var j=c[g]={exports:{}};b[g][0].call(j.exports,function(a){var c=b[g][1][a];return e(c?c:a)},j,j.exports,a,b,c,d)}return c[g].exports}for(var f="function"==typeof require&&require,g=0;g\r\n";document.write(b),a.JSZipUtils._getBinaryFromXHR=function(a){for(var b=a.responseBody,c={},d=0;256>d;d++)for(var e=0;256>e;e++)c[String.fromCharCode(d+(e<<8))]=String.fromCharCode(d)+String.fromCharCode(e);var f=IEBinaryToArray_ByteStr(b),g=IEBinaryToArray_ByteStr_Last(b);return f.replace(/[\s\S]/g,function(a){return c[a]})+g}},{}]},{},[1]); diff --git a/javadoc/1.47.0/jquery/jszip-utils/dist/jszip-utils.js b/javadoc/1.47.0/jquery/jszip-utils/dist/jszip-utils.js new file mode 100644 index 00000000000..775895ec92d --- /dev/null +++ b/javadoc/1.47.0/jquery/jszip-utils/dist/jszip-utils.js @@ -0,0 +1,118 @@ +/*! + +JSZipUtils - A collection of cross-browser utilities to go along with JSZip. + + +(c) 2014 Stuart Knightley, David Duponchel +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip-utils/master/LICENSE.markdown. + +*/ +!function(e){"object"==typeof exports?module.exports=e():"function"==typeof define&&define.amd?define(e):"undefined"!=typeof window?window.JSZipUtils=e():"undefined"!=typeof global?global.JSZipUtils=e():"undefined"!=typeof self&&(self.JSZipUtils=e())}(function(){var define,module,exports;return (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);throw new Error("Cannot find module '"+o+"'")}var f=n[o]={exports:{}};t[o][0].call(f.exports,function(e){var n=t[o][1][e];return s(n?n:e)},f,f.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o + +(c) 2014 Stuart Knightley, David Duponchel +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip-utils/master/LICENSE.markdown. + +*/ +!function(a){"object"==typeof exports?module.exports=a():"function"==typeof define&&define.amd?define(a):"undefined"!=typeof window?window.JSZipUtils=a():"undefined"!=typeof global?global.JSZipUtils=a():"undefined"!=typeof self&&(self.JSZipUtils=a())}(function(){return function a(b,c,d){function e(g,h){if(!c[g]){if(!b[g]){var i="function"==typeof require&&require;if(!h&&i)return i(g,!0);if(f)return f(g,!0);throw new Error("Cannot find module '"+g+"'")}var j=c[g]={exports:{}};b[g][0].call(j.exports,function(a){var c=b[g][1][a];return e(c?c:a)},j,j.exports,a,b,c,d)}return c[g].exports}for(var f="function"==typeof require&&require,g=0;g + +(c) 2009-2016 Stuart Knightley +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip/master/LICENSE.markdown. + +JSZip uses the library pako released under the MIT license : +https://github.com/nodeca/pako/blob/master/LICENSE +*/ + +(function(f){if(typeof exports==="object"&&typeof module!=="undefined"){module.exports=f()}else if(typeof define==="function"&&define.amd){define([],f)}else{var g;if(typeof window!=="undefined"){g=window}else if(typeof global!=="undefined"){g=global}else if(typeof self!=="undefined"){g=self}else{g=this}g.JSZip = f()}})(function(){var define,module,exports;return (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);var f=new Error("Cannot find module '"+o+"'");throw f.code="MODULE_NOT_FOUND",f}var l=n[o]={exports:{}};t[o][0].call(l.exports,function(e){var n=t[o][1][e];return s(n?n:e)},l,l.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o> 2; + enc2 = ((chr1 & 3) << 4) | (chr2 >> 4); + enc3 = remainingBytes > 1 ? (((chr2 & 15) << 2) | (chr3 >> 6)) : 64; + enc4 = remainingBytes > 2 ? (chr3 & 63) : 64; + + output.push(_keyStr.charAt(enc1) + _keyStr.charAt(enc2) + _keyStr.charAt(enc3) + _keyStr.charAt(enc4)); + + } + + return output.join(""); +}; + +// public method for decoding +exports.decode = function(input) { + var chr1, chr2, chr3; + var enc1, enc2, enc3, enc4; + var i = 0, resultIndex = 0; + + var dataUrlPrefix = "data:"; + + if (input.substr(0, dataUrlPrefix.length) === dataUrlPrefix) { + // This is a common error: people give a data url + // (data:image/png;base64,iVBOR...) with a {base64: true} and + // wonders why things don't work. + // We can detect that the string input looks like a data url but we + // *can't* be sure it is one: removing everything up to the comma would + // be too dangerous. + throw new Error("Invalid base64 input, it looks like a data url."); + } + + input = input.replace(/[^A-Za-z0-9\+\/\=]/g, ""); + + var totalLength = input.length * 3 / 4; + if(input.charAt(input.length - 1) === _keyStr.charAt(64)) { + totalLength--; + } + if(input.charAt(input.length - 2) === _keyStr.charAt(64)) { + totalLength--; + } + if (totalLength % 1 !== 0) { + // totalLength is not an integer, the length does not match a valid + // base64 content. That can happen if: + // - the input is not a base64 content + // - the input is *almost* a base64 content, with a extra chars at the + // beginning or at the end + // - the input uses a base64 variant (base64url for example) + throw new Error("Invalid base64 input, bad content length."); + } + var output; + if (support.uint8array) { + output = new Uint8Array(totalLength|0); + } else { + output = new Array(totalLength|0); + } + + while (i < input.length) { + + enc1 = _keyStr.indexOf(input.charAt(i++)); + enc2 = _keyStr.indexOf(input.charAt(i++)); + enc3 = _keyStr.indexOf(input.charAt(i++)); + enc4 = _keyStr.indexOf(input.charAt(i++)); + + chr1 = (enc1 << 2) | (enc2 >> 4); + chr2 = ((enc2 & 15) << 4) | (enc3 >> 2); + chr3 = ((enc3 & 3) << 6) | enc4; + + output[resultIndex++] = chr1; + + if (enc3 !== 64) { + output[resultIndex++] = chr2; + } + if (enc4 !== 64) { + output[resultIndex++] = chr3; + } + + } + + return output; +}; + +},{"./support":30,"./utils":32}],2:[function(require,module,exports){ +'use strict'; + +var external = require("./external"); +var DataWorker = require('./stream/DataWorker'); +var Crc32Probe = require('./stream/Crc32Probe'); +var DataLengthProbe = require('./stream/DataLengthProbe'); + +/** + * Represent a compressed object, with everything needed to decompress it. + * @constructor + * @param {number} compressedSize the size of the data compressed. + * @param {number} uncompressedSize the size of the data after decompression. + * @param {number} crc32 the crc32 of the decompressed file. + * @param {object} compression the type of compression, see lib/compressions.js. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the compressed data. + */ +function CompressedObject(compressedSize, uncompressedSize, crc32, compression, data) { + this.compressedSize = compressedSize; + this.uncompressedSize = uncompressedSize; + this.crc32 = crc32; + this.compression = compression; + this.compressedContent = data; +} + +CompressedObject.prototype = { + /** + * Create a worker to get the uncompressed content. + * @return {GenericWorker} the worker. + */ + getContentWorker: function () { + var worker = new DataWorker(external.Promise.resolve(this.compressedContent)) + .pipe(this.compression.uncompressWorker()) + .pipe(new DataLengthProbe("data_length")); + + var that = this; + worker.on("end", function () { + if (this.streamInfo['data_length'] !== that.uncompressedSize) { + throw new Error("Bug : uncompressed data size mismatch"); + } + }); + return worker; + }, + /** + * Create a worker to get the compressed content. + * @return {GenericWorker} the worker. + */ + getCompressedWorker: function () { + return new DataWorker(external.Promise.resolve(this.compressedContent)) + .withStreamInfo("compressedSize", this.compressedSize) + .withStreamInfo("uncompressedSize", this.uncompressedSize) + .withStreamInfo("crc32", this.crc32) + .withStreamInfo("compression", this.compression) + ; + } +}; + +/** + * Chain the given worker with other workers to compress the content with the + * given compression. + * @param {GenericWorker} uncompressedWorker the worker to pipe. + * @param {Object} compression the compression object. + * @param {Object} compressionOptions the options to use when compressing. + * @return {GenericWorker} the new worker compressing the content. + */ +CompressedObject.createWorkerFrom = function (uncompressedWorker, compression, compressionOptions) { + return uncompressedWorker + .pipe(new Crc32Probe()) + .pipe(new DataLengthProbe("uncompressedSize")) + .pipe(compression.compressWorker(compressionOptions)) + .pipe(new DataLengthProbe("compressedSize")) + .withStreamInfo("compression", compression); +}; + +module.exports = CompressedObject; + +},{"./external":6,"./stream/Crc32Probe":25,"./stream/DataLengthProbe":26,"./stream/DataWorker":27}],3:[function(require,module,exports){ +'use strict'; + +var GenericWorker = require("./stream/GenericWorker"); + +exports.STORE = { + magic: "\x00\x00", + compressWorker : function (compressionOptions) { + return new GenericWorker("STORE compression"); + }, + uncompressWorker : function () { + return new GenericWorker("STORE decompression"); + } +}; +exports.DEFLATE = require('./flate'); + +},{"./flate":7,"./stream/GenericWorker":28}],4:[function(require,module,exports){ +'use strict'; + +var utils = require('./utils'); + +/** + * The following functions come from pako, from pako/lib/zlib/crc32.js + * released under the MIT license, see pako https://github.com/nodeca/pako/ + */ + +// Use ordinary array, since untyped makes no boost here +function makeTable() { + var c, table = []; + + for(var n =0; n < 256; n++){ + c = n; + for(var k =0; k < 8; k++){ + c = ((c&1) ? (0xEDB88320 ^ (c >>> 1)) : (c >>> 1)); + } + table[n] = c; + } + + return table; +} + +// Create table on load. Just 255 signed longs. Not a problem. +var crcTable = makeTable(); + + +function crc32(crc, buf, len, pos) { + var t = crcTable, end = pos + len; + + crc = crc ^ (-1); + + for (var i = pos; i < end; i++ ) { + crc = (crc >>> 8) ^ t[(crc ^ buf[i]) & 0xFF]; + } + + return (crc ^ (-1)); // >>> 0; +} + +// That's all for the pako functions. + +/** + * Compute the crc32 of a string. + * This is almost the same as the function crc32, but for strings. Using the + * same function for the two use cases leads to horrible performances. + * @param {Number} crc the starting value of the crc. + * @param {String} str the string to use. + * @param {Number} len the length of the string. + * @param {Number} pos the starting position for the crc32 computation. + * @return {Number} the computed crc32. + */ +function crc32str(crc, str, len, pos) { + var t = crcTable, end = pos + len; + + crc = crc ^ (-1); + + for (var i = pos; i < end; i++ ) { + crc = (crc >>> 8) ^ t[(crc ^ str.charCodeAt(i)) & 0xFF]; + } + + return (crc ^ (-1)); // >>> 0; +} + +module.exports = function crc32wrapper(input, crc) { + if (typeof input === "undefined" || !input.length) { + return 0; + } + + var isArray = utils.getTypeOf(input) !== "string"; + + if(isArray) { + return crc32(crc|0, input, input.length, 0); + } else { + return crc32str(crc|0, input, input.length, 0); + } +}; + +},{"./utils":32}],5:[function(require,module,exports){ +'use strict'; +exports.base64 = false; +exports.binary = false; +exports.dir = false; +exports.createFolders = true; +exports.date = null; +exports.compression = null; +exports.compressionOptions = null; +exports.comment = null; +exports.unixPermissions = null; +exports.dosPermissions = null; + +},{}],6:[function(require,module,exports){ +/* global Promise */ +'use strict'; + +// load the global object first: +// - it should be better integrated in the system (unhandledRejection in node) +// - the environment may have a custom Promise implementation (see zone.js) +var ES6Promise = null; +if (typeof Promise !== "undefined") { + ES6Promise = Promise; +} else { + ES6Promise = require("lie"); +} + +/** + * Let the user use/change some implementations. + */ +module.exports = { + Promise: ES6Promise +}; + +},{"lie":37}],7:[function(require,module,exports){ +'use strict'; +var USE_TYPEDARRAY = (typeof Uint8Array !== 'undefined') && (typeof Uint16Array !== 'undefined') && (typeof Uint32Array !== 'undefined'); + +var pako = require("pako"); +var utils = require("./utils"); +var GenericWorker = require("./stream/GenericWorker"); + +var ARRAY_TYPE = USE_TYPEDARRAY ? "uint8array" : "array"; + +exports.magic = "\x08\x00"; + +/** + * Create a worker that uses pako to inflate/deflate. + * @constructor + * @param {String} action the name of the pako function to call : either "Deflate" or "Inflate". + * @param {Object} options the options to use when (de)compressing. + */ +function FlateWorker(action, options) { + GenericWorker.call(this, "FlateWorker/" + action); + + this._pako = null; + this._pakoAction = action; + this._pakoOptions = options; + // the `meta` object from the last chunk received + // this allow this worker to pass around metadata + this.meta = {}; +} + +utils.inherits(FlateWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +FlateWorker.prototype.processChunk = function (chunk) { + this.meta = chunk.meta; + if (this._pako === null) { + this._createPako(); + } + this._pako.push(utils.transformTo(ARRAY_TYPE, chunk.data), false); +}; + +/** + * @see GenericWorker.flush + */ +FlateWorker.prototype.flush = function () { + GenericWorker.prototype.flush.call(this); + if (this._pako === null) { + this._createPako(); + } + this._pako.push([], true); +}; +/** + * @see GenericWorker.cleanUp + */ +FlateWorker.prototype.cleanUp = function () { + GenericWorker.prototype.cleanUp.call(this); + this._pako = null; +}; + +/** + * Create the _pako object. + * TODO: lazy-loading this object isn't the best solution but it's the + * quickest. The best solution is to lazy-load the worker list. See also the + * issue #446. + */ +FlateWorker.prototype._createPako = function () { + this._pako = new pako[this._pakoAction]({ + raw: true, + level: this._pakoOptions.level || -1 // default compression + }); + var self = this; + this._pako.onData = function(data) { + self.push({ + data : data, + meta : self.meta + }); + }; +}; + +exports.compressWorker = function (compressionOptions) { + return new FlateWorker("Deflate", compressionOptions); +}; +exports.uncompressWorker = function () { + return new FlateWorker("Inflate", {}); +}; + +},{"./stream/GenericWorker":28,"./utils":32,"pako":38}],8:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var GenericWorker = require('../stream/GenericWorker'); +var utf8 = require('../utf8'); +var crc32 = require('../crc32'); +var signature = require('../signature'); + +/** + * Transform an integer into a string in hexadecimal. + * @private + * @param {number} dec the number to convert. + * @param {number} bytes the number of bytes to generate. + * @returns {string} the result. + */ +var decToHex = function(dec, bytes) { + var hex = "", i; + for (i = 0; i < bytes; i++) { + hex += String.fromCharCode(dec & 0xff); + dec = dec >>> 8; + } + return hex; +}; + +/** + * Generate the UNIX part of the external file attributes. + * @param {Object} unixPermissions the unix permissions or null. + * @param {Boolean} isDir true if the entry is a directory, false otherwise. + * @return {Number} a 32 bit integer. + * + * adapted from http://unix.stackexchange.com/questions/14705/the-zip-formats-external-file-attribute : + * + * TTTTsstrwxrwxrwx0000000000ADVSHR + * ^^^^____________________________ file type, see zipinfo.c (UNX_*) + * ^^^_________________________ setuid, setgid, sticky + * ^^^^^^^^^________________ permissions + * ^^^^^^^^^^______ not used ? + * ^^^^^^ DOS attribute bits : Archive, Directory, Volume label, System file, Hidden, Read only + */ +var generateUnixExternalFileAttr = function (unixPermissions, isDir) { + + var result = unixPermissions; + if (!unixPermissions) { + // I can't use octal values in strict mode, hence the hexa. + // 040775 => 0x41fd + // 0100664 => 0x81b4 + result = isDir ? 0x41fd : 0x81b4; + } + return (result & 0xFFFF) << 16; +}; + +/** + * Generate the DOS part of the external file attributes. + * @param {Object} dosPermissions the dos permissions or null. + * @param {Boolean} isDir true if the entry is a directory, false otherwise. + * @return {Number} a 32 bit integer. + * + * Bit 0 Read-Only + * Bit 1 Hidden + * Bit 2 System + * Bit 3 Volume Label + * Bit 4 Directory + * Bit 5 Archive + */ +var generateDosExternalFileAttr = function (dosPermissions, isDir) { + + // the dir flag is already set for compatibility + return (dosPermissions || 0) & 0x3F; +}; + +/** + * Generate the various parts used in the construction of the final zip file. + * @param {Object} streamInfo the hash with information about the compressed file. + * @param {Boolean} streamedContent is the content streamed ? + * @param {Boolean} streamingEnded is the stream finished ? + * @param {number} offset the current offset from the start of the zip file. + * @param {String} platform let's pretend we are this platform (change platform dependents fields) + * @param {Function} encodeFileName the function to encode the file name / comment. + * @return {Object} the zip parts. + */ +var generateZipParts = function(streamInfo, streamedContent, streamingEnded, offset, platform, encodeFileName) { + var file = streamInfo['file'], + compression = streamInfo['compression'], + useCustomEncoding = encodeFileName !== utf8.utf8encode, + encodedFileName = utils.transformTo("string", encodeFileName(file.name)), + utfEncodedFileName = utils.transformTo("string", utf8.utf8encode(file.name)), + comment = file.comment, + encodedComment = utils.transformTo("string", encodeFileName(comment)), + utfEncodedComment = utils.transformTo("string", utf8.utf8encode(comment)), + useUTF8ForFileName = utfEncodedFileName.length !== file.name.length, + useUTF8ForComment = utfEncodedComment.length !== comment.length, + dosTime, + dosDate, + extraFields = "", + unicodePathExtraField = "", + unicodeCommentExtraField = "", + dir = file.dir, + date = file.date; + + + var dataInfo = { + crc32 : 0, + compressedSize : 0, + uncompressedSize : 0 + }; + + // if the content is streamed, the sizes/crc32 are only available AFTER + // the end of the stream. + if (!streamedContent || streamingEnded) { + dataInfo.crc32 = streamInfo['crc32']; + dataInfo.compressedSize = streamInfo['compressedSize']; + dataInfo.uncompressedSize = streamInfo['uncompressedSize']; + } + + var bitflag = 0; + if (streamedContent) { + // Bit 3: the sizes/crc32 are set to zero in the local header. + // The correct values are put in the data descriptor immediately + // following the compressed data. + bitflag |= 0x0008; + } + if (!useCustomEncoding && (useUTF8ForFileName || useUTF8ForComment)) { + // Bit 11: Language encoding flag (EFS). + bitflag |= 0x0800; + } + + + var extFileAttr = 0; + var versionMadeBy = 0; + if (dir) { + // dos or unix, we set the dos dir flag + extFileAttr |= 0x00010; + } + if(platform === "UNIX") { + versionMadeBy = 0x031E; // UNIX, version 3.0 + extFileAttr |= generateUnixExternalFileAttr(file.unixPermissions, dir); + } else { // DOS or other, fallback to DOS + versionMadeBy = 0x0014; // DOS, version 2.0 + extFileAttr |= generateDosExternalFileAttr(file.dosPermissions, dir); + } + + // date + // @see http://www.delorie.com/djgpp/doc/rbinter/it/52/13.html + // @see http://www.delorie.com/djgpp/doc/rbinter/it/65/16.html + // @see http://www.delorie.com/djgpp/doc/rbinter/it/66/16.html + + dosTime = date.getUTCHours(); + dosTime = dosTime << 6; + dosTime = dosTime | date.getUTCMinutes(); + dosTime = dosTime << 5; + dosTime = dosTime | date.getUTCSeconds() / 2; + + dosDate = date.getUTCFullYear() - 1980; + dosDate = dosDate << 4; + dosDate = dosDate | (date.getUTCMonth() + 1); + dosDate = dosDate << 5; + dosDate = dosDate | date.getUTCDate(); + + if (useUTF8ForFileName) { + // set the unicode path extra field. unzip needs at least one extra + // field to correctly handle unicode path, so using the path is as good + // as any other information. This could improve the situation with + // other archive managers too. + // This field is usually used without the utf8 flag, with a non + // unicode path in the header (winrar, winzip). This helps (a bit) + // with the messy Windows' default compressed folders feature but + // breaks on p7zip which doesn't seek the unicode path extra field. + // So for now, UTF-8 everywhere ! + unicodePathExtraField = + // Version + decToHex(1, 1) + + // NameCRC32 + decToHex(crc32(encodedFileName), 4) + + // UnicodeName + utfEncodedFileName; + + extraFields += + // Info-ZIP Unicode Path Extra Field + "\x75\x70" + + // size + decToHex(unicodePathExtraField.length, 2) + + // content + unicodePathExtraField; + } + + if(useUTF8ForComment) { + + unicodeCommentExtraField = + // Version + decToHex(1, 1) + + // CommentCRC32 + decToHex(crc32(encodedComment), 4) + + // UnicodeName + utfEncodedComment; + + extraFields += + // Info-ZIP Unicode Path Extra Field + "\x75\x63" + + // size + decToHex(unicodeCommentExtraField.length, 2) + + // content + unicodeCommentExtraField; + } + + var header = ""; + + // version needed to extract + header += "\x0A\x00"; + // general purpose bit flag + header += decToHex(bitflag, 2); + // compression method + header += compression.magic; + // last mod file time + header += decToHex(dosTime, 2); + // last mod file date + header += decToHex(dosDate, 2); + // crc-32 + header += decToHex(dataInfo.crc32, 4); + // compressed size + header += decToHex(dataInfo.compressedSize, 4); + // uncompressed size + header += decToHex(dataInfo.uncompressedSize, 4); + // file name length + header += decToHex(encodedFileName.length, 2); + // extra field length + header += decToHex(extraFields.length, 2); + + + var fileRecord = signature.LOCAL_FILE_HEADER + header + encodedFileName + extraFields; + + var dirRecord = signature.CENTRAL_FILE_HEADER + + // version made by (00: DOS) + decToHex(versionMadeBy, 2) + + // file header (common to file and central directory) + header + + // file comment length + decToHex(encodedComment.length, 2) + + // disk number start + "\x00\x00" + + // internal file attributes TODO + "\x00\x00" + + // external file attributes + decToHex(extFileAttr, 4) + + // relative offset of local header + decToHex(offset, 4) + + // file name + encodedFileName + + // extra field + extraFields + + // file comment + encodedComment; + + return { + fileRecord: fileRecord, + dirRecord: dirRecord + }; +}; + +/** + * Generate the EOCD record. + * @param {Number} entriesCount the number of entries in the zip file. + * @param {Number} centralDirLength the length (in bytes) of the central dir. + * @param {Number} localDirLength the length (in bytes) of the local dir. + * @param {String} comment the zip file comment as a binary string. + * @param {Function} encodeFileName the function to encode the comment. + * @return {String} the EOCD record. + */ +var generateCentralDirectoryEnd = function (entriesCount, centralDirLength, localDirLength, comment, encodeFileName) { + var dirEnd = ""; + var encodedComment = utils.transformTo("string", encodeFileName(comment)); + + // end of central dir signature + dirEnd = signature.CENTRAL_DIRECTORY_END + + // number of this disk + "\x00\x00" + + // number of the disk with the start of the central directory + "\x00\x00" + + // total number of entries in the central directory on this disk + decToHex(entriesCount, 2) + + // total number of entries in the central directory + decToHex(entriesCount, 2) + + // size of the central directory 4 bytes + decToHex(centralDirLength, 4) + + // offset of start of central directory with respect to the starting disk number + decToHex(localDirLength, 4) + + // .ZIP file comment length + decToHex(encodedComment.length, 2) + + // .ZIP file comment + encodedComment; + + return dirEnd; +}; + +/** + * Generate data descriptors for a file entry. + * @param {Object} streamInfo the hash generated by a worker, containing information + * on the file entry. + * @return {String} the data descriptors. + */ +var generateDataDescriptors = function (streamInfo) { + var descriptor = ""; + descriptor = signature.DATA_DESCRIPTOR + + // crc-32 4 bytes + decToHex(streamInfo['crc32'], 4) + + // compressed size 4 bytes + decToHex(streamInfo['compressedSize'], 4) + + // uncompressed size 4 bytes + decToHex(streamInfo['uncompressedSize'], 4); + + return descriptor; +}; + + +/** + * A worker to concatenate other workers to create a zip file. + * @param {Boolean} streamFiles `true` to stream the content of the files, + * `false` to accumulate it. + * @param {String} comment the comment to use. + * @param {String} platform the platform to use, "UNIX" or "DOS". + * @param {Function} encodeFileName the function to encode file names and comments. + */ +function ZipFileWorker(streamFiles, comment, platform, encodeFileName) { + GenericWorker.call(this, "ZipFileWorker"); + // The number of bytes written so far. This doesn't count accumulated chunks. + this.bytesWritten = 0; + // The comment of the zip file + this.zipComment = comment; + // The platform "generating" the zip file. + this.zipPlatform = platform; + // the function to encode file names and comments. + this.encodeFileName = encodeFileName; + // Should we stream the content of the files ? + this.streamFiles = streamFiles; + // If `streamFiles` is false, we will need to accumulate the content of the + // files to calculate sizes / crc32 (and write them *before* the content). + // This boolean indicates if we are accumulating chunks (it will change a lot + // during the lifetime of this worker). + this.accumulate = false; + // The buffer receiving chunks when accumulating content. + this.contentBuffer = []; + // The list of generated directory records. + this.dirRecords = []; + // The offset (in bytes) from the beginning of the zip file for the current source. + this.currentSourceOffset = 0; + // The total number of entries in this zip file. + this.entriesCount = 0; + // the name of the file currently being added, null when handling the end of the zip file. + // Used for the emitted metadata. + this.currentFile = null; + + + + this._sources = []; +} +utils.inherits(ZipFileWorker, GenericWorker); + +/** + * @see GenericWorker.push + */ +ZipFileWorker.prototype.push = function (chunk) { + + var currentFilePercent = chunk.meta.percent || 0; + var entriesCount = this.entriesCount; + var remainingFiles = this._sources.length; + + if(this.accumulate) { + this.contentBuffer.push(chunk); + } else { + this.bytesWritten += chunk.data.length; + + GenericWorker.prototype.push.call(this, { + data : chunk.data, + meta : { + currentFile : this.currentFile, + percent : entriesCount ? (currentFilePercent + 100 * (entriesCount - remainingFiles - 1)) / entriesCount : 100 + } + }); + } +}; + +/** + * The worker started a new source (an other worker). + * @param {Object} streamInfo the streamInfo object from the new source. + */ +ZipFileWorker.prototype.openedSource = function (streamInfo) { + this.currentSourceOffset = this.bytesWritten; + this.currentFile = streamInfo['file'].name; + + var streamedContent = this.streamFiles && !streamInfo['file'].dir; + + // don't stream folders (because they don't have any content) + if(streamedContent) { + var record = generateZipParts(streamInfo, streamedContent, false, this.currentSourceOffset, this.zipPlatform, this.encodeFileName); + this.push({ + data : record.fileRecord, + meta : {percent:0} + }); + } else { + // we need to wait for the whole file before pushing anything + this.accumulate = true; + } +}; + +/** + * The worker finished a source (an other worker). + * @param {Object} streamInfo the streamInfo object from the finished source. + */ +ZipFileWorker.prototype.closedSource = function (streamInfo) { + this.accumulate = false; + var streamedContent = this.streamFiles && !streamInfo['file'].dir; + var record = generateZipParts(streamInfo, streamedContent, true, this.currentSourceOffset, this.zipPlatform, this.encodeFileName); + + this.dirRecords.push(record.dirRecord); + if(streamedContent) { + // after the streamed file, we put data descriptors + this.push({ + data : generateDataDescriptors(streamInfo), + meta : {percent:100} + }); + } else { + // the content wasn't streamed, we need to push everything now + // first the file record, then the content + this.push({ + data : record.fileRecord, + meta : {percent:0} + }); + while(this.contentBuffer.length) { + this.push(this.contentBuffer.shift()); + } + } + this.currentFile = null; +}; + +/** + * @see GenericWorker.flush + */ +ZipFileWorker.prototype.flush = function () { + + var localDirLength = this.bytesWritten; + for(var i = 0; i < this.dirRecords.length; i++) { + this.push({ + data : this.dirRecords[i], + meta : {percent:100} + }); + } + var centralDirLength = this.bytesWritten - localDirLength; + + var dirEnd = generateCentralDirectoryEnd(this.dirRecords.length, centralDirLength, localDirLength, this.zipComment, this.encodeFileName); + + this.push({ + data : dirEnd, + meta : {percent:100} + }); +}; + +/** + * Prepare the next source to be read. + */ +ZipFileWorker.prototype.prepareNextSource = function () { + this.previous = this._sources.shift(); + this.openedSource(this.previous.streamInfo); + if (this.isPaused) { + this.previous.pause(); + } else { + this.previous.resume(); + } +}; + +/** + * @see GenericWorker.registerPrevious + */ +ZipFileWorker.prototype.registerPrevious = function (previous) { + this._sources.push(previous); + var self = this; + + previous.on('data', function (chunk) { + self.processChunk(chunk); + }); + previous.on('end', function () { + self.closedSource(self.previous.streamInfo); + if(self._sources.length) { + self.prepareNextSource(); + } else { + self.end(); + } + }); + previous.on('error', function (e) { + self.error(e); + }); + return this; +}; + +/** + * @see GenericWorker.resume + */ +ZipFileWorker.prototype.resume = function () { + if(!GenericWorker.prototype.resume.call(this)) { + return false; + } + + if (!this.previous && this._sources.length) { + this.prepareNextSource(); + return true; + } + if (!this.previous && !this._sources.length && !this.generatedError) { + this.end(); + return true; + } +}; + +/** + * @see GenericWorker.error + */ +ZipFileWorker.prototype.error = function (e) { + var sources = this._sources; + if(!GenericWorker.prototype.error.call(this, e)) { + return false; + } + for(var i = 0; i < sources.length; i++) { + try { + sources[i].error(e); + } catch(e) { + // the `error` exploded, nothing to do + } + } + return true; +}; + +/** + * @see GenericWorker.lock + */ +ZipFileWorker.prototype.lock = function () { + GenericWorker.prototype.lock.call(this); + var sources = this._sources; + for(var i = 0; i < sources.length; i++) { + sources[i].lock(); + } +}; + +module.exports = ZipFileWorker; + +},{"../crc32":4,"../signature":23,"../stream/GenericWorker":28,"../utf8":31,"../utils":32}],9:[function(require,module,exports){ +'use strict'; + +var compressions = require('../compressions'); +var ZipFileWorker = require('./ZipFileWorker'); + +/** + * Find the compression to use. + * @param {String} fileCompression the compression defined at the file level, if any. + * @param {String} zipCompression the compression defined at the load() level. + * @return {Object} the compression object to use. + */ +var getCompression = function (fileCompression, zipCompression) { + + var compressionName = fileCompression || zipCompression; + var compression = compressions[compressionName]; + if (!compression) { + throw new Error(compressionName + " is not a valid compression method !"); + } + return compression; +}; + +/** + * Create a worker to generate a zip file. + * @param {JSZip} zip the JSZip instance at the right root level. + * @param {Object} options to generate the zip file. + * @param {String} comment the comment to use. + */ +exports.generateWorker = function (zip, options, comment) { + + var zipFileWorker = new ZipFileWorker(options.streamFiles, comment, options.platform, options.encodeFileName); + var entriesCount = 0; + try { + + zip.forEach(function (relativePath, file) { + entriesCount++; + var compression = getCompression(file.options.compression, options.compression); + var compressionOptions = file.options.compressionOptions || options.compressionOptions || {}; + var dir = file.dir, date = file.date; + + file._compressWorker(compression, compressionOptions) + .withStreamInfo("file", { + name : relativePath, + dir : dir, + date : date, + comment : file.comment || "", + unixPermissions : file.unixPermissions, + dosPermissions : file.dosPermissions + }) + .pipe(zipFileWorker); + }); + zipFileWorker.entriesCount = entriesCount; + } catch (e) { + zipFileWorker.error(e); + } + + return zipFileWorker; +}; + +},{"../compressions":3,"./ZipFileWorker":8}],10:[function(require,module,exports){ +'use strict'; + +/** + * Representation a of zip file in js + * @constructor + */ +function JSZip() { + // if this constructor is used without `new`, it adds `new` before itself: + if(!(this instanceof JSZip)) { + return new JSZip(); + } + + if(arguments.length) { + throw new Error("The constructor with parameters has been removed in JSZip 3.0, please check the upgrade guide."); + } + + // object containing the files : + // { + // "folder/" : {...}, + // "folder/data.txt" : {...} + // } + // NOTE: we use a null prototype because we do not + // want filenames like "toString" coming from a zip file + // to overwrite methods and attributes in a normal Object. + this.files = Object.create(null); + + this.comment = null; + + // Where we are in the hierarchy + this.root = ""; + this.clone = function() { + var newObj = new JSZip(); + for (var i in this) { + if (typeof this[i] !== "function") { + newObj[i] = this[i]; + } + } + return newObj; + }; +} +JSZip.prototype = require('./object'); +JSZip.prototype.loadAsync = require('./load'); +JSZip.support = require('./support'); +JSZip.defaults = require('./defaults'); + +// TODO find a better way to handle this version, +// a require('package.json').version doesn't work with webpack, see #327 +JSZip.version = "3.7.1"; + +JSZip.loadAsync = function (content, options) { + return new JSZip().loadAsync(content, options); +}; + +JSZip.external = require("./external"); +module.exports = JSZip; + +},{"./defaults":5,"./external":6,"./load":11,"./object":15,"./support":30}],11:[function(require,module,exports){ +'use strict'; +var utils = require('./utils'); +var external = require("./external"); +var utf8 = require('./utf8'); +var ZipEntries = require('./zipEntries'); +var Crc32Probe = require('./stream/Crc32Probe'); +var nodejsUtils = require("./nodejsUtils"); + +/** + * Check the CRC32 of an entry. + * @param {ZipEntry} zipEntry the zip entry to check. + * @return {Promise} the result. + */ +function checkEntryCRC32(zipEntry) { + return new external.Promise(function (resolve, reject) { + var worker = zipEntry.decompressed.getContentWorker().pipe(new Crc32Probe()); + worker.on("error", function (e) { + reject(e); + }) + .on("end", function () { + if (worker.streamInfo.crc32 !== zipEntry.decompressed.crc32) { + reject(new Error("Corrupted zip : CRC32 mismatch")); + } else { + resolve(); + } + }) + .resume(); + }); +} + +module.exports = function (data, options) { + var zip = this; + options = utils.extend(options || {}, { + base64: false, + checkCRC32: false, + optimizedBinaryString: false, + createFolders: false, + decodeFileName: utf8.utf8decode + }); + + if (nodejsUtils.isNode && nodejsUtils.isStream(data)) { + return external.Promise.reject(new Error("JSZip can't accept a stream when loading a zip file.")); + } + + return utils.prepareContent("the loaded zip file", data, true, options.optimizedBinaryString, options.base64) + .then(function (data) { + var zipEntries = new ZipEntries(options); + zipEntries.load(data); + return zipEntries; + }).then(function checkCRC32(zipEntries) { + var promises = [external.Promise.resolve(zipEntries)]; + var files = zipEntries.files; + if (options.checkCRC32) { + for (var i = 0; i < files.length; i++) { + promises.push(checkEntryCRC32(files[i])); + } + } + return external.Promise.all(promises); + }).then(function addFiles(results) { + var zipEntries = results.shift(); + var files = zipEntries.files; + for (var i = 0; i < files.length; i++) { + var input = files[i]; + zip.file(input.fileNameStr, input.decompressed, { + binary: true, + optimizedBinaryString: true, + date: input.date, + dir: input.dir, + comment: input.fileCommentStr.length ? input.fileCommentStr : null, + unixPermissions: input.unixPermissions, + dosPermissions: input.dosPermissions, + createFolders: options.createFolders + }); + } + if (zipEntries.zipComment.length) { + zip.comment = zipEntries.zipComment; + } + + return zip; + }); +}; + +},{"./external":6,"./nodejsUtils":14,"./stream/Crc32Probe":25,"./utf8":31,"./utils":32,"./zipEntries":33}],12:[function(require,module,exports){ +"use strict"; + +var utils = require('../utils'); +var GenericWorker = require('../stream/GenericWorker'); + +/** + * A worker that use a nodejs stream as source. + * @constructor + * @param {String} filename the name of the file entry for this stream. + * @param {Readable} stream the nodejs stream. + */ +function NodejsStreamInputAdapter(filename, stream) { + GenericWorker.call(this, "Nodejs stream input adapter for " + filename); + this._upstreamEnded = false; + this._bindStream(stream); +} + +utils.inherits(NodejsStreamInputAdapter, GenericWorker); + +/** + * Prepare the stream and bind the callbacks on it. + * Do this ASAP on node 0.10 ! A lazy binding doesn't always work. + * @param {Stream} stream the nodejs stream to use. + */ +NodejsStreamInputAdapter.prototype._bindStream = function (stream) { + var self = this; + this._stream = stream; + stream.pause(); + stream + .on("data", function (chunk) { + self.push({ + data: chunk, + meta : { + percent : 0 + } + }); + }) + .on("error", function (e) { + if(self.isPaused) { + this.generatedError = e; + } else { + self.error(e); + } + }) + .on("end", function () { + if(self.isPaused) { + self._upstreamEnded = true; + } else { + self.end(); + } + }); +}; +NodejsStreamInputAdapter.prototype.pause = function () { + if(!GenericWorker.prototype.pause.call(this)) { + return false; + } + this._stream.pause(); + return true; +}; +NodejsStreamInputAdapter.prototype.resume = function () { + if(!GenericWorker.prototype.resume.call(this)) { + return false; + } + + if(this._upstreamEnded) { + this.end(); + } else { + this._stream.resume(); + } + + return true; +}; + +module.exports = NodejsStreamInputAdapter; + +},{"../stream/GenericWorker":28,"../utils":32}],13:[function(require,module,exports){ +'use strict'; + +var Readable = require('readable-stream').Readable; + +var utils = require('../utils'); +utils.inherits(NodejsStreamOutputAdapter, Readable); + +/** +* A nodejs stream using a worker as source. +* @see the SourceWrapper in http://nodejs.org/api/stream.html +* @constructor +* @param {StreamHelper} helper the helper wrapping the worker +* @param {Object} options the nodejs stream options +* @param {Function} updateCb the update callback. +*/ +function NodejsStreamOutputAdapter(helper, options, updateCb) { + Readable.call(this, options); + this._helper = helper; + + var self = this; + helper.on("data", function (data, meta) { + if (!self.push(data)) { + self._helper.pause(); + } + if(updateCb) { + updateCb(meta); + } + }) + .on("error", function(e) { + self.emit('error', e); + }) + .on("end", function () { + self.push(null); + }); +} + + +NodejsStreamOutputAdapter.prototype._read = function() { + this._helper.resume(); +}; + +module.exports = NodejsStreamOutputAdapter; + +},{"../utils":32,"readable-stream":16}],14:[function(require,module,exports){ +'use strict'; + +module.exports = { + /** + * True if this is running in Nodejs, will be undefined in a browser. + * In a browser, browserify won't include this file and the whole module + * will be resolved an empty object. + */ + isNode : typeof Buffer !== "undefined", + /** + * Create a new nodejs Buffer from an existing content. + * @param {Object} data the data to pass to the constructor. + * @param {String} encoding the encoding to use. + * @return {Buffer} a new Buffer. + */ + newBufferFrom: function(data, encoding) { + if (Buffer.from && Buffer.from !== Uint8Array.from) { + return Buffer.from(data, encoding); + } else { + if (typeof data === "number") { + // Safeguard for old Node.js versions. On newer versions, + // Buffer.from(number) / Buffer(number, encoding) already throw. + throw new Error("The \"data\" argument must not be a number"); + } + return new Buffer(data, encoding); + } + }, + /** + * Create a new nodejs Buffer with the specified size. + * @param {Integer} size the size of the buffer. + * @return {Buffer} a new Buffer. + */ + allocBuffer: function (size) { + if (Buffer.alloc) { + return Buffer.alloc(size); + } else { + var buf = new Buffer(size); + buf.fill(0); + return buf; + } + }, + /** + * Find out if an object is a Buffer. + * @param {Object} b the object to test. + * @return {Boolean} true if the object is a Buffer, false otherwise. + */ + isBuffer : function(b){ + return Buffer.isBuffer(b); + }, + + isStream : function (obj) { + return obj && + typeof obj.on === "function" && + typeof obj.pause === "function" && + typeof obj.resume === "function"; + } +}; + +},{}],15:[function(require,module,exports){ +'use strict'; +var utf8 = require('./utf8'); +var utils = require('./utils'); +var GenericWorker = require('./stream/GenericWorker'); +var StreamHelper = require('./stream/StreamHelper'); +var defaults = require('./defaults'); +var CompressedObject = require('./compressedObject'); +var ZipObject = require('./zipObject'); +var generate = require("./generate"); +var nodejsUtils = require("./nodejsUtils"); +var NodejsStreamInputAdapter = require("./nodejs/NodejsStreamInputAdapter"); + + +/** + * Add a file in the current folder. + * @private + * @param {string} name the name of the file + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the data of the file + * @param {Object} originalOptions the options of the file + * @return {Object} the new file. + */ +var fileAdd = function(name, data, originalOptions) { + // be sure sub folders exist + var dataType = utils.getTypeOf(data), + parent; + + + /* + * Correct options. + */ + + var o = utils.extend(originalOptions || {}, defaults); + o.date = o.date || new Date(); + if (o.compression !== null) { + o.compression = o.compression.toUpperCase(); + } + + if (typeof o.unixPermissions === "string") { + o.unixPermissions = parseInt(o.unixPermissions, 8); + } + + // UNX_IFDIR 0040000 see zipinfo.c + if (o.unixPermissions && (o.unixPermissions & 0x4000)) { + o.dir = true; + } + // Bit 4 Directory + if (o.dosPermissions && (o.dosPermissions & 0x0010)) { + o.dir = true; + } + + if (o.dir) { + name = forceTrailingSlash(name); + } + if (o.createFolders && (parent = parentFolder(name))) { + folderAdd.call(this, parent, true); + } + + var isUnicodeString = dataType === "string" && o.binary === false && o.base64 === false; + if (!originalOptions || typeof originalOptions.binary === "undefined") { + o.binary = !isUnicodeString; + } + + + var isCompressedEmpty = (data instanceof CompressedObject) && data.uncompressedSize === 0; + + if (isCompressedEmpty || o.dir || !data || data.length === 0) { + o.base64 = false; + o.binary = true; + data = ""; + o.compression = "STORE"; + dataType = "string"; + } + + /* + * Convert content to fit. + */ + + var zipObjectContent = null; + if (data instanceof CompressedObject || data instanceof GenericWorker) { + zipObjectContent = data; + } else if (nodejsUtils.isNode && nodejsUtils.isStream(data)) { + zipObjectContent = new NodejsStreamInputAdapter(name, data); + } else { + zipObjectContent = utils.prepareContent(name, data, o.binary, o.optimizedBinaryString, o.base64); + } + + var object = new ZipObject(name, zipObjectContent, o); + this.files[name] = object; + /* + TODO: we can't throw an exception because we have async promises + (we can have a promise of a Date() for example) but returning a + promise is useless because file(name, data) returns the JSZip + object for chaining. Should we break that to allow the user + to catch the error ? + + return external.Promise.resolve(zipObjectContent) + .then(function () { + return object; + }); + */ +}; + +/** + * Find the parent folder of the path. + * @private + * @param {string} path the path to use + * @return {string} the parent folder, or "" + */ +var parentFolder = function (path) { + if (path.slice(-1) === '/') { + path = path.substring(0, path.length - 1); + } + var lastSlash = path.lastIndexOf('/'); + return (lastSlash > 0) ? path.substring(0, lastSlash) : ""; +}; + +/** + * Returns the path with a slash at the end. + * @private + * @param {String} path the path to check. + * @return {String} the path with a trailing slash. + */ +var forceTrailingSlash = function(path) { + // Check the name ends with a / + if (path.slice(-1) !== "/") { + path += "/"; // IE doesn't like substr(-1) + } + return path; +}; + +/** + * Add a (sub) folder in the current folder. + * @private + * @param {string} name the folder's name + * @param {boolean=} [createFolders] If true, automatically create sub + * folders. Defaults to false. + * @return {Object} the new folder. + */ +var folderAdd = function(name, createFolders) { + createFolders = (typeof createFolders !== 'undefined') ? createFolders : defaults.createFolders; + + name = forceTrailingSlash(name); + + // Does this folder already exist? + if (!this.files[name]) { + fileAdd.call(this, name, null, { + dir: true, + createFolders: createFolders + }); + } + return this.files[name]; +}; + +/** +* Cross-window, cross-Node-context regular expression detection +* @param {Object} object Anything +* @return {Boolean} true if the object is a regular expression, +* false otherwise +*/ +function isRegExp(object) { + return Object.prototype.toString.call(object) === "[object RegExp]"; +} + +// return the actual prototype of JSZip +var out = { + /** + * @see loadAsync + */ + load: function() { + throw new Error("This method has been removed in JSZip 3.0, please check the upgrade guide."); + }, + + + /** + * Call a callback function for each entry at this folder level. + * @param {Function} cb the callback function: + * function (relativePath, file) {...} + * It takes 2 arguments : the relative path and the file. + */ + forEach: function(cb) { + var filename, relativePath, file; + /* jshint ignore:start */ + // ignore warning about unwanted properties because this.files is a null prototype object + for (filename in this.files) { + file = this.files[filename]; + relativePath = filename.slice(this.root.length, filename.length); + if (relativePath && filename.slice(0, this.root.length) === this.root) { // the file is in the current root + cb(relativePath, file); // TODO reverse the parameters ? need to be clean AND consistent with the filter search fn... + } + } + /* jshint ignore:end */ + }, + + /** + * Filter nested files/folders with the specified function. + * @param {Function} search the predicate to use : + * function (relativePath, file) {...} + * It takes 2 arguments : the relative path and the file. + * @return {Array} An array of matching elements. + */ + filter: function(search) { + var result = []; + this.forEach(function (relativePath, entry) { + if (search(relativePath, entry)) { // the file matches the function + result.push(entry); + } + + }); + return result; + }, + + /** + * Add a file to the zip file, or search a file. + * @param {string|RegExp} name The name of the file to add (if data is defined), + * the name of the file to find (if no data) or a regex to match files. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data The file data, either raw or base64 encoded + * @param {Object} o File options + * @return {JSZip|Object|Array} this JSZip object (when adding a file), + * a file (when searching by string) or an array of files (when searching by regex). + */ + file: function(name, data, o) { + if (arguments.length === 1) { + if (isRegExp(name)) { + var regexp = name; + return this.filter(function(relativePath, file) { + return !file.dir && regexp.test(relativePath); + }); + } + else { // text + var obj = this.files[this.root + name]; + if (obj && !obj.dir) { + return obj; + } else { + return null; + } + } + } + else { // more than one argument : we have data ! + name = this.root + name; + fileAdd.call(this, name, data, o); + } + return this; + }, + + /** + * Add a directory to the zip file, or search. + * @param {String|RegExp} arg The name of the directory to add, or a regex to search folders. + * @return {JSZip} an object with the new directory as the root, or an array containing matching folders. + */ + folder: function(arg) { + if (!arg) { + return this; + } + + if (isRegExp(arg)) { + return this.filter(function(relativePath, file) { + return file.dir && arg.test(relativePath); + }); + } + + // else, name is a new folder + var name = this.root + arg; + var newFolder = folderAdd.call(this, name); + + // Allow chaining by returning a new object with this folder as the root + var ret = this.clone(); + ret.root = newFolder.name; + return ret; + }, + + /** + * Delete a file, or a directory and all sub-files, from the zip + * @param {string} name the name of the file to delete + * @return {JSZip} this JSZip object + */ + remove: function(name) { + name = this.root + name; + var file = this.files[name]; + if (!file) { + // Look for any folders + if (name.slice(-1) !== "/") { + name += "/"; + } + file = this.files[name]; + } + + if (file && !file.dir) { + // file + delete this.files[name]; + } else { + // maybe a folder, delete recursively + var kids = this.filter(function(relativePath, file) { + return file.name.slice(0, name.length) === name; + }); + for (var i = 0; i < kids.length; i++) { + delete this.files[kids[i].name]; + } + } + + return this; + }, + + /** + * Generate the complete zip file + * @param {Object} options the options to generate the zip file : + * - compression, "STORE" by default. + * - type, "base64" by default. Values are : string, base64, uint8array, arraybuffer, blob. + * @return {String|Uint8Array|ArrayBuffer|Buffer|Blob} the zip file + */ + generate: function(options) { + throw new Error("This method has been removed in JSZip 3.0, please check the upgrade guide."); + }, + + /** + * Generate the complete zip file as an internal stream. + * @param {Object} options the options to generate the zip file : + * - compression, "STORE" by default. + * - type, "base64" by default. Values are : string, base64, uint8array, arraybuffer, blob. + * @return {StreamHelper} the streamed zip file. + */ + generateInternalStream: function(options) { + var worker, opts = {}; + try { + opts = utils.extend(options || {}, { + streamFiles: false, + compression: "STORE", + compressionOptions : null, + type: "", + platform: "DOS", + comment: null, + mimeType: 'application/zip', + encodeFileName: utf8.utf8encode + }); + + opts.type = opts.type.toLowerCase(); + opts.compression = opts.compression.toUpperCase(); + + // "binarystring" is preferred but the internals use "string". + if(opts.type === "binarystring") { + opts.type = "string"; + } + + if (!opts.type) { + throw new Error("No output type specified."); + } + + utils.checkSupport(opts.type); + + // accept nodejs `process.platform` + if( + opts.platform === 'darwin' || + opts.platform === 'freebsd' || + opts.platform === 'linux' || + opts.platform === 'sunos' + ) { + opts.platform = "UNIX"; + } + if (opts.platform === 'win32') { + opts.platform = "DOS"; + } + + var comment = opts.comment || this.comment || ""; + worker = generate.generateWorker(this, opts, comment); + } catch (e) { + worker = new GenericWorker("error"); + worker.error(e); + } + return new StreamHelper(worker, opts.type || "string", opts.mimeType); + }, + /** + * Generate the complete zip file asynchronously. + * @see generateInternalStream + */ + generateAsync: function(options, onUpdate) { + return this.generateInternalStream(options).accumulate(onUpdate); + }, + /** + * Generate the complete zip file asynchronously. + * @see generateInternalStream + */ + generateNodeStream: function(options, onUpdate) { + options = options || {}; + if (!options.type) { + options.type = "nodebuffer"; + } + return this.generateInternalStream(options).toNodejsStream(onUpdate); + } +}; +module.exports = out; + +},{"./compressedObject":2,"./defaults":5,"./generate":9,"./nodejs/NodejsStreamInputAdapter":12,"./nodejsUtils":14,"./stream/GenericWorker":28,"./stream/StreamHelper":29,"./utf8":31,"./utils":32,"./zipObject":35}],16:[function(require,module,exports){ +/* + * This file is used by module bundlers (browserify/webpack/etc) when + * including a stream implementation. We use "readable-stream" to get a + * consistent behavior between nodejs versions but bundlers often have a shim + * for "stream". Using this shim greatly improve the compatibility and greatly + * reduce the final size of the bundle (only one stream implementation, not + * two). + */ +module.exports = require("stream"); + +},{"stream":undefined}],17:[function(require,module,exports){ +'use strict'; +var DataReader = require('./DataReader'); +var utils = require('../utils'); + +function ArrayReader(data) { + DataReader.call(this, data); + for(var i = 0; i < this.data.length; i++) { + data[i] = data[i] & 0xFF; + } +} +utils.inherits(ArrayReader, DataReader); +/** + * @see DataReader.byteAt + */ +ArrayReader.prototype.byteAt = function(i) { + return this.data[this.zero + i]; +}; +/** + * @see DataReader.lastIndexOfSignature + */ +ArrayReader.prototype.lastIndexOfSignature = function(sig) { + var sig0 = sig.charCodeAt(0), + sig1 = sig.charCodeAt(1), + sig2 = sig.charCodeAt(2), + sig3 = sig.charCodeAt(3); + for (var i = this.length - 4; i >= 0; --i) { + if (this.data[i] === sig0 && this.data[i + 1] === sig1 && this.data[i + 2] === sig2 && this.data[i + 3] === sig3) { + return i - this.zero; + } + } + + return -1; +}; +/** + * @see DataReader.readAndCheckSignature + */ +ArrayReader.prototype.readAndCheckSignature = function (sig) { + var sig0 = sig.charCodeAt(0), + sig1 = sig.charCodeAt(1), + sig2 = sig.charCodeAt(2), + sig3 = sig.charCodeAt(3), + data = this.readData(4); + return sig0 === data[0] && sig1 === data[1] && sig2 === data[2] && sig3 === data[3]; +}; +/** + * @see DataReader.readData + */ +ArrayReader.prototype.readData = function(size) { + this.checkOffset(size); + if(size === 0) { + return []; + } + var result = this.data.slice(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = ArrayReader; + +},{"../utils":32,"./DataReader":18}],18:[function(require,module,exports){ +'use strict'; +var utils = require('../utils'); + +function DataReader(data) { + this.data = data; // type : see implementation + this.length = data.length; + this.index = 0; + this.zero = 0; +} +DataReader.prototype = { + /** + * Check that the offset will not go too far. + * @param {string} offset the additional offset to check. + * @throws {Error} an Error if the offset is out of bounds. + */ + checkOffset: function(offset) { + this.checkIndex(this.index + offset); + }, + /** + * Check that the specified index will not be too far. + * @param {string} newIndex the index to check. + * @throws {Error} an Error if the index is out of bounds. + */ + checkIndex: function(newIndex) { + if (this.length < this.zero + newIndex || newIndex < 0) { + throw new Error("End of data reached (data length = " + this.length + ", asked index = " + (newIndex) + "). Corrupted zip ?"); + } + }, + /** + * Change the index. + * @param {number} newIndex The new index. + * @throws {Error} if the new index is out of the data. + */ + setIndex: function(newIndex) { + this.checkIndex(newIndex); + this.index = newIndex; + }, + /** + * Skip the next n bytes. + * @param {number} n the number of bytes to skip. + * @throws {Error} if the new index is out of the data. + */ + skip: function(n) { + this.setIndex(this.index + n); + }, + /** + * Get the byte at the specified index. + * @param {number} i the index to use. + * @return {number} a byte. + */ + byteAt: function(i) { + // see implementations + }, + /** + * Get the next number with a given byte size. + * @param {number} size the number of bytes to read. + * @return {number} the corresponding number. + */ + readInt: function(size) { + var result = 0, + i; + this.checkOffset(size); + for (i = this.index + size - 1; i >= this.index; i--) { + result = (result << 8) + this.byteAt(i); + } + this.index += size; + return result; + }, + /** + * Get the next string with a given byte size. + * @param {number} size the number of bytes to read. + * @return {string} the corresponding string. + */ + readString: function(size) { + return utils.transformTo("string", this.readData(size)); + }, + /** + * Get raw data without conversion, bytes. + * @param {number} size the number of bytes to read. + * @return {Object} the raw data, implementation specific. + */ + readData: function(size) { + // see implementations + }, + /** + * Find the last occurrence of a zip signature (4 bytes). + * @param {string} sig the signature to find. + * @return {number} the index of the last occurrence, -1 if not found. + */ + lastIndexOfSignature: function(sig) { + // see implementations + }, + /** + * Read the signature (4 bytes) at the current position and compare it with sig. + * @param {string} sig the expected signature + * @return {boolean} true if the signature matches, false otherwise. + */ + readAndCheckSignature: function(sig) { + // see implementations + }, + /** + * Get the next date. + * @return {Date} the date. + */ + readDate: function() { + var dostime = this.readInt(4); + return new Date(Date.UTC( + ((dostime >> 25) & 0x7f) + 1980, // year + ((dostime >> 21) & 0x0f) - 1, // month + (dostime >> 16) & 0x1f, // day + (dostime >> 11) & 0x1f, // hour + (dostime >> 5) & 0x3f, // minute + (dostime & 0x1f) << 1)); // second + } +}; +module.exports = DataReader; + +},{"../utils":32}],19:[function(require,module,exports){ +'use strict'; +var Uint8ArrayReader = require('./Uint8ArrayReader'); +var utils = require('../utils'); + +function NodeBufferReader(data) { + Uint8ArrayReader.call(this, data); +} +utils.inherits(NodeBufferReader, Uint8ArrayReader); + +/** + * @see DataReader.readData + */ +NodeBufferReader.prototype.readData = function(size) { + this.checkOffset(size); + var result = this.data.slice(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = NodeBufferReader; + +},{"../utils":32,"./Uint8ArrayReader":21}],20:[function(require,module,exports){ +'use strict'; +var DataReader = require('./DataReader'); +var utils = require('../utils'); + +function StringReader(data) { + DataReader.call(this, data); +} +utils.inherits(StringReader, DataReader); +/** + * @see DataReader.byteAt + */ +StringReader.prototype.byteAt = function(i) { + return this.data.charCodeAt(this.zero + i); +}; +/** + * @see DataReader.lastIndexOfSignature + */ +StringReader.prototype.lastIndexOfSignature = function(sig) { + return this.data.lastIndexOf(sig) - this.zero; +}; +/** + * @see DataReader.readAndCheckSignature + */ +StringReader.prototype.readAndCheckSignature = function (sig) { + var data = this.readData(4); + return sig === data; +}; +/** + * @see DataReader.readData + */ +StringReader.prototype.readData = function(size) { + this.checkOffset(size); + // this will work because the constructor applied the "& 0xff" mask. + var result = this.data.slice(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = StringReader; + +},{"../utils":32,"./DataReader":18}],21:[function(require,module,exports){ +'use strict'; +var ArrayReader = require('./ArrayReader'); +var utils = require('../utils'); + +function Uint8ArrayReader(data) { + ArrayReader.call(this, data); +} +utils.inherits(Uint8ArrayReader, ArrayReader); +/** + * @see DataReader.readData + */ +Uint8ArrayReader.prototype.readData = function(size) { + this.checkOffset(size); + if(size === 0) { + // in IE10, when using subarray(idx, idx), we get the array [0x00] instead of []. + return new Uint8Array(0); + } + var result = this.data.subarray(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = Uint8ArrayReader; + +},{"../utils":32,"./ArrayReader":17}],22:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var support = require('../support'); +var ArrayReader = require('./ArrayReader'); +var StringReader = require('./StringReader'); +var NodeBufferReader = require('./NodeBufferReader'); +var Uint8ArrayReader = require('./Uint8ArrayReader'); + +/** + * Create a reader adapted to the data. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the data to read. + * @return {DataReader} the data reader. + */ +module.exports = function (data) { + var type = utils.getTypeOf(data); + utils.checkSupport(type); + if (type === "string" && !support.uint8array) { + return new StringReader(data); + } + if (type === "nodebuffer") { + return new NodeBufferReader(data); + } + if (support.uint8array) { + return new Uint8ArrayReader(utils.transformTo("uint8array", data)); + } + return new ArrayReader(utils.transformTo("array", data)); +}; + +},{"../support":30,"../utils":32,"./ArrayReader":17,"./NodeBufferReader":19,"./StringReader":20,"./Uint8ArrayReader":21}],23:[function(require,module,exports){ +'use strict'; +exports.LOCAL_FILE_HEADER = "PK\x03\x04"; +exports.CENTRAL_FILE_HEADER = "PK\x01\x02"; +exports.CENTRAL_DIRECTORY_END = "PK\x05\x06"; +exports.ZIP64_CENTRAL_DIRECTORY_LOCATOR = "PK\x06\x07"; +exports.ZIP64_CENTRAL_DIRECTORY_END = "PK\x06\x06"; +exports.DATA_DESCRIPTOR = "PK\x07\x08"; + +},{}],24:[function(require,module,exports){ +'use strict'; + +var GenericWorker = require('./GenericWorker'); +var utils = require('../utils'); + +/** + * A worker which convert chunks to a specified type. + * @constructor + * @param {String} destType the destination type. + */ +function ConvertWorker(destType) { + GenericWorker.call(this, "ConvertWorker to " + destType); + this.destType = destType; +} +utils.inherits(ConvertWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +ConvertWorker.prototype.processChunk = function (chunk) { + this.push({ + data : utils.transformTo(this.destType, chunk.data), + meta : chunk.meta + }); +}; +module.exports = ConvertWorker; + +},{"../utils":32,"./GenericWorker":28}],25:[function(require,module,exports){ +'use strict'; + +var GenericWorker = require('./GenericWorker'); +var crc32 = require('../crc32'); +var utils = require('../utils'); + +/** + * A worker which calculate the crc32 of the data flowing through. + * @constructor + */ +function Crc32Probe() { + GenericWorker.call(this, "Crc32Probe"); + this.withStreamInfo("crc32", 0); +} +utils.inherits(Crc32Probe, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +Crc32Probe.prototype.processChunk = function (chunk) { + this.streamInfo.crc32 = crc32(chunk.data, this.streamInfo.crc32 || 0); + this.push(chunk); +}; +module.exports = Crc32Probe; + +},{"../crc32":4,"../utils":32,"./GenericWorker":28}],26:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var GenericWorker = require('./GenericWorker'); + +/** + * A worker which calculate the total length of the data flowing through. + * @constructor + * @param {String} propName the name used to expose the length + */ +function DataLengthProbe(propName) { + GenericWorker.call(this, "DataLengthProbe for " + propName); + this.propName = propName; + this.withStreamInfo(propName, 0); +} +utils.inherits(DataLengthProbe, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +DataLengthProbe.prototype.processChunk = function (chunk) { + if(chunk) { + var length = this.streamInfo[this.propName] || 0; + this.streamInfo[this.propName] = length + chunk.data.length; + } + GenericWorker.prototype.processChunk.call(this, chunk); +}; +module.exports = DataLengthProbe; + + +},{"../utils":32,"./GenericWorker":28}],27:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var GenericWorker = require('./GenericWorker'); + +// the size of the generated chunks +// TODO expose this as a public variable +var DEFAULT_BLOCK_SIZE = 16 * 1024; + +/** + * A worker that reads a content and emits chunks. + * @constructor + * @param {Promise} dataP the promise of the data to split + */ +function DataWorker(dataP) { + GenericWorker.call(this, "DataWorker"); + var self = this; + this.dataIsReady = false; + this.index = 0; + this.max = 0; + this.data = null; + this.type = ""; + + this._tickScheduled = false; + + dataP.then(function (data) { + self.dataIsReady = true; + self.data = data; + self.max = data && data.length || 0; + self.type = utils.getTypeOf(data); + if(!self.isPaused) { + self._tickAndRepeat(); + } + }, function (e) { + self.error(e); + }); +} + +utils.inherits(DataWorker, GenericWorker); + +/** + * @see GenericWorker.cleanUp + */ +DataWorker.prototype.cleanUp = function () { + GenericWorker.prototype.cleanUp.call(this); + this.data = null; +}; + +/** + * @see GenericWorker.resume + */ +DataWorker.prototype.resume = function () { + if(!GenericWorker.prototype.resume.call(this)) { + return false; + } + + if (!this._tickScheduled && this.dataIsReady) { + this._tickScheduled = true; + utils.delay(this._tickAndRepeat, [], this); + } + return true; +}; + +/** + * Trigger a tick a schedule an other call to this function. + */ +DataWorker.prototype._tickAndRepeat = function() { + this._tickScheduled = false; + if(this.isPaused || this.isFinished) { + return; + } + this._tick(); + if(!this.isFinished) { + utils.delay(this._tickAndRepeat, [], this); + this._tickScheduled = true; + } +}; + +/** + * Read and push a chunk. + */ +DataWorker.prototype._tick = function() { + + if(this.isPaused || this.isFinished) { + return false; + } + + var size = DEFAULT_BLOCK_SIZE; + var data = null, nextIndex = Math.min(this.max, this.index + size); + if (this.index >= this.max) { + // EOF + return this.end(); + } else { + switch(this.type) { + case "string": + data = this.data.substring(this.index, nextIndex); + break; + case "uint8array": + data = this.data.subarray(this.index, nextIndex); + break; + case "array": + case "nodebuffer": + data = this.data.slice(this.index, nextIndex); + break; + } + this.index = nextIndex; + return this.push({ + data : data, + meta : { + percent : this.max ? this.index / this.max * 100 : 0 + } + }); + } +}; + +module.exports = DataWorker; + +},{"../utils":32,"./GenericWorker":28}],28:[function(require,module,exports){ +'use strict'; + +/** + * A worker that does nothing but passing chunks to the next one. This is like + * a nodejs stream but with some differences. On the good side : + * - it works on IE 6-9 without any issue / polyfill + * - it weights less than the full dependencies bundled with browserify + * - it forwards errors (no need to declare an error handler EVERYWHERE) + * + * A chunk is an object with 2 attributes : `meta` and `data`. The former is an + * object containing anything (`percent` for example), see each worker for more + * details. The latter is the real data (String, Uint8Array, etc). + * + * @constructor + * @param {String} name the name of the stream (mainly used for debugging purposes) + */ +function GenericWorker(name) { + // the name of the worker + this.name = name || "default"; + // an object containing metadata about the workers chain + this.streamInfo = {}; + // an error which happened when the worker was paused + this.generatedError = null; + // an object containing metadata to be merged by this worker into the general metadata + this.extraStreamInfo = {}; + // true if the stream is paused (and should not do anything), false otherwise + this.isPaused = true; + // true if the stream is finished (and should not do anything), false otherwise + this.isFinished = false; + // true if the stream is locked to prevent further structure updates (pipe), false otherwise + this.isLocked = false; + // the event listeners + this._listeners = { + 'data':[], + 'end':[], + 'error':[] + }; + // the previous worker, if any + this.previous = null; +} + +GenericWorker.prototype = { + /** + * Push a chunk to the next workers. + * @param {Object} chunk the chunk to push + */ + push : function (chunk) { + this.emit("data", chunk); + }, + /** + * End the stream. + * @return {Boolean} true if this call ended the worker, false otherwise. + */ + end : function () { + if (this.isFinished) { + return false; + } + + this.flush(); + try { + this.emit("end"); + this.cleanUp(); + this.isFinished = true; + } catch (e) { + this.emit("error", e); + } + return true; + }, + /** + * End the stream with an error. + * @param {Error} e the error which caused the premature end. + * @return {Boolean} true if this call ended the worker with an error, false otherwise. + */ + error : function (e) { + if (this.isFinished) { + return false; + } + + if(this.isPaused) { + this.generatedError = e; + } else { + this.isFinished = true; + + this.emit("error", e); + + // in the workers chain exploded in the middle of the chain, + // the error event will go downward but we also need to notify + // workers upward that there has been an error. + if(this.previous) { + this.previous.error(e); + } + + this.cleanUp(); + } + return true; + }, + /** + * Add a callback on an event. + * @param {String} name the name of the event (data, end, error) + * @param {Function} listener the function to call when the event is triggered + * @return {GenericWorker} the current object for chainability + */ + on : function (name, listener) { + this._listeners[name].push(listener); + return this; + }, + /** + * Clean any references when a worker is ending. + */ + cleanUp : function () { + this.streamInfo = this.generatedError = this.extraStreamInfo = null; + this._listeners = []; + }, + /** + * Trigger an event. This will call registered callback with the provided arg. + * @param {String} name the name of the event (data, end, error) + * @param {Object} arg the argument to call the callback with. + */ + emit : function (name, arg) { + if (this._listeners[name]) { + for(var i = 0; i < this._listeners[name].length; i++) { + this._listeners[name][i].call(this, arg); + } + } + }, + /** + * Chain a worker with an other. + * @param {Worker} next the worker receiving events from the current one. + * @return {worker} the next worker for chainability + */ + pipe : function (next) { + return next.registerPrevious(this); + }, + /** + * Same as `pipe` in the other direction. + * Using an API with `pipe(next)` is very easy. + * Implementing the API with the point of view of the next one registering + * a source is easier, see the ZipFileWorker. + * @param {Worker} previous the previous worker, sending events to this one + * @return {Worker} the current worker for chainability + */ + registerPrevious : function (previous) { + if (this.isLocked) { + throw new Error("The stream '" + this + "' has already been used."); + } + + // sharing the streamInfo... + this.streamInfo = previous.streamInfo; + // ... and adding our own bits + this.mergeStreamInfo(); + this.previous = previous; + var self = this; + previous.on('data', function (chunk) { + self.processChunk(chunk); + }); + previous.on('end', function () { + self.end(); + }); + previous.on('error', function (e) { + self.error(e); + }); + return this; + }, + /** + * Pause the stream so it doesn't send events anymore. + * @return {Boolean} true if this call paused the worker, false otherwise. + */ + pause : function () { + if(this.isPaused || this.isFinished) { + return false; + } + this.isPaused = true; + + if(this.previous) { + this.previous.pause(); + } + return true; + }, + /** + * Resume a paused stream. + * @return {Boolean} true if this call resumed the worker, false otherwise. + */ + resume : function () { + if(!this.isPaused || this.isFinished) { + return false; + } + this.isPaused = false; + + // if true, the worker tried to resume but failed + var withError = false; + if(this.generatedError) { + this.error(this.generatedError); + withError = true; + } + if(this.previous) { + this.previous.resume(); + } + + return !withError; + }, + /** + * Flush any remaining bytes as the stream is ending. + */ + flush : function () {}, + /** + * Process a chunk. This is usually the method overridden. + * @param {Object} chunk the chunk to process. + */ + processChunk : function(chunk) { + this.push(chunk); + }, + /** + * Add a key/value to be added in the workers chain streamInfo once activated. + * @param {String} key the key to use + * @param {Object} value the associated value + * @return {Worker} the current worker for chainability + */ + withStreamInfo : function (key, value) { + this.extraStreamInfo[key] = value; + this.mergeStreamInfo(); + return this; + }, + /** + * Merge this worker's streamInfo into the chain's streamInfo. + */ + mergeStreamInfo : function () { + for(var key in this.extraStreamInfo) { + if (!this.extraStreamInfo.hasOwnProperty(key)) { + continue; + } + this.streamInfo[key] = this.extraStreamInfo[key]; + } + }, + + /** + * Lock the stream to prevent further updates on the workers chain. + * After calling this method, all calls to pipe will fail. + */ + lock: function () { + if (this.isLocked) { + throw new Error("The stream '" + this + "' has already been used."); + } + this.isLocked = true; + if (this.previous) { + this.previous.lock(); + } + }, + + /** + * + * Pretty print the workers chain. + */ + toString : function () { + var me = "Worker " + this.name; + if (this.previous) { + return this.previous + " -> " + me; + } else { + return me; + } + } +}; + +module.exports = GenericWorker; + +},{}],29:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var ConvertWorker = require('./ConvertWorker'); +var GenericWorker = require('./GenericWorker'); +var base64 = require('../base64'); +var support = require("../support"); +var external = require("../external"); + +var NodejsStreamOutputAdapter = null; +if (support.nodestream) { + try { + NodejsStreamOutputAdapter = require('../nodejs/NodejsStreamOutputAdapter'); + } catch(e) {} +} + +/** + * Apply the final transformation of the data. If the user wants a Blob for + * example, it's easier to work with an U8intArray and finally do the + * ArrayBuffer/Blob conversion. + * @param {String} type the name of the final type + * @param {String|Uint8Array|Buffer} content the content to transform + * @param {String} mimeType the mime type of the content, if applicable. + * @return {String|Uint8Array|ArrayBuffer|Buffer|Blob} the content in the right format. + */ +function transformZipOutput(type, content, mimeType) { + switch(type) { + case "blob" : + return utils.newBlob(utils.transformTo("arraybuffer", content), mimeType); + case "base64" : + return base64.encode(content); + default : + return utils.transformTo(type, content); + } +} + +/** + * Concatenate an array of data of the given type. + * @param {String} type the type of the data in the given array. + * @param {Array} dataArray the array containing the data chunks to concatenate + * @return {String|Uint8Array|Buffer} the concatenated data + * @throws Error if the asked type is unsupported + */ +function concat (type, dataArray) { + var i, index = 0, res = null, totalLength = 0; + for(i = 0; i < dataArray.length; i++) { + totalLength += dataArray[i].length; + } + switch(type) { + case "string": + return dataArray.join(""); + case "array": + return Array.prototype.concat.apply([], dataArray); + case "uint8array": + res = new Uint8Array(totalLength); + for(i = 0; i < dataArray.length; i++) { + res.set(dataArray[i], index); + index += dataArray[i].length; + } + return res; + case "nodebuffer": + return Buffer.concat(dataArray); + default: + throw new Error("concat : unsupported type '" + type + "'"); + } +} + +/** + * Listen a StreamHelper, accumulate its content and concatenate it into a + * complete block. + * @param {StreamHelper} helper the helper to use. + * @param {Function} updateCallback a callback called on each update. Called + * with one arg : + * - the metadata linked to the update received. + * @return Promise the promise for the accumulation. + */ +function accumulate(helper, updateCallback) { + return new external.Promise(function (resolve, reject){ + var dataArray = []; + var chunkType = helper._internalType, + resultType = helper._outputType, + mimeType = helper._mimeType; + helper + .on('data', function (data, meta) { + dataArray.push(data); + if(updateCallback) { + updateCallback(meta); + } + }) + .on('error', function(err) { + dataArray = []; + reject(err); + }) + .on('end', function (){ + try { + var result = transformZipOutput(resultType, concat(chunkType, dataArray), mimeType); + resolve(result); + } catch (e) { + reject(e); + } + dataArray = []; + }) + .resume(); + }); +} + +/** + * An helper to easily use workers outside of JSZip. + * @constructor + * @param {Worker} worker the worker to wrap + * @param {String} outputType the type of data expected by the use + * @param {String} mimeType the mime type of the content, if applicable. + */ +function StreamHelper(worker, outputType, mimeType) { + var internalType = outputType; + switch(outputType) { + case "blob": + case "arraybuffer": + internalType = "uint8array"; + break; + case "base64": + internalType = "string"; + break; + } + + try { + // the type used internally + this._internalType = internalType; + // the type used to output results + this._outputType = outputType; + // the mime type + this._mimeType = mimeType; + utils.checkSupport(internalType); + this._worker = worker.pipe(new ConvertWorker(internalType)); + // the last workers can be rewired without issues but we need to + // prevent any updates on previous workers. + worker.lock(); + } catch(e) { + this._worker = new GenericWorker("error"); + this._worker.error(e); + } +} + +StreamHelper.prototype = { + /** + * Listen a StreamHelper, accumulate its content and concatenate it into a + * complete block. + * @param {Function} updateCb the update callback. + * @return Promise the promise for the accumulation. + */ + accumulate : function (updateCb) { + return accumulate(this, updateCb); + }, + /** + * Add a listener on an event triggered on a stream. + * @param {String} evt the name of the event + * @param {Function} fn the listener + * @return {StreamHelper} the current helper. + */ + on : function (evt, fn) { + var self = this; + + if(evt === "data") { + this._worker.on(evt, function (chunk) { + fn.call(self, chunk.data, chunk.meta); + }); + } else { + this._worker.on(evt, function () { + utils.delay(fn, arguments, self); + }); + } + return this; + }, + /** + * Resume the flow of chunks. + * @return {StreamHelper} the current helper. + */ + resume : function () { + utils.delay(this._worker.resume, [], this._worker); + return this; + }, + /** + * Pause the flow of chunks. + * @return {StreamHelper} the current helper. + */ + pause : function () { + this._worker.pause(); + return this; + }, + /** + * Return a nodejs stream for this helper. + * @param {Function} updateCb the update callback. + * @return {NodejsStreamOutputAdapter} the nodejs stream. + */ + toNodejsStream : function (updateCb) { + utils.checkSupport("nodestream"); + if (this._outputType !== "nodebuffer") { + // an object stream containing blob/arraybuffer/uint8array/string + // is strange and I don't know if it would be useful. + // I you find this comment and have a good usecase, please open a + // bug report ! + throw new Error(this._outputType + " is not supported by this method"); + } + + return new NodejsStreamOutputAdapter(this, { + objectMode : this._outputType !== "nodebuffer" + }, updateCb); + } +}; + + +module.exports = StreamHelper; + +},{"../base64":1,"../external":6,"../nodejs/NodejsStreamOutputAdapter":13,"../support":30,"../utils":32,"./ConvertWorker":24,"./GenericWorker":28}],30:[function(require,module,exports){ +'use strict'; + +exports.base64 = true; +exports.array = true; +exports.string = true; +exports.arraybuffer = typeof ArrayBuffer !== "undefined" && typeof Uint8Array !== "undefined"; +exports.nodebuffer = typeof Buffer !== "undefined"; +// contains true if JSZip can read/generate Uint8Array, false otherwise. +exports.uint8array = typeof Uint8Array !== "undefined"; + +if (typeof ArrayBuffer === "undefined") { + exports.blob = false; +} +else { + var buffer = new ArrayBuffer(0); + try { + exports.blob = new Blob([buffer], { + type: "application/zip" + }).size === 0; + } + catch (e) { + try { + var Builder = self.BlobBuilder || self.WebKitBlobBuilder || self.MozBlobBuilder || self.MSBlobBuilder; + var builder = new Builder(); + builder.append(buffer); + exports.blob = builder.getBlob('application/zip').size === 0; + } + catch (e) { + exports.blob = false; + } + } +} + +try { + exports.nodestream = !!require('readable-stream').Readable; +} catch(e) { + exports.nodestream = false; +} + +},{"readable-stream":16}],31:[function(require,module,exports){ +'use strict'; + +var utils = require('./utils'); +var support = require('./support'); +var nodejsUtils = require('./nodejsUtils'); +var GenericWorker = require('./stream/GenericWorker'); + +/** + * The following functions come from pako, from pako/lib/utils/strings + * released under the MIT license, see pako https://github.com/nodeca/pako/ + */ + +// Table with utf8 lengths (calculated by first byte of sequence) +// Note, that 5 & 6-byte values and some 4-byte values can not be represented in JS, +// because max possible codepoint is 0x10ffff +var _utf8len = new Array(256); +for (var i=0; i<256; i++) { + _utf8len[i] = (i >= 252 ? 6 : i >= 248 ? 5 : i >= 240 ? 4 : i >= 224 ? 3 : i >= 192 ? 2 : 1); +} +_utf8len[254]=_utf8len[254]=1; // Invalid sequence start + +// convert string to array (typed, when possible) +var string2buf = function (str) { + var buf, c, c2, m_pos, i, str_len = str.length, buf_len = 0; + + // count binary size + for (m_pos = 0; m_pos < str_len; m_pos++) { + c = str.charCodeAt(m_pos); + if ((c & 0xfc00) === 0xd800 && (m_pos+1 < str_len)) { + c2 = str.charCodeAt(m_pos+1); + if ((c2 & 0xfc00) === 0xdc00) { + c = 0x10000 + ((c - 0xd800) << 10) + (c2 - 0xdc00); + m_pos++; + } + } + buf_len += c < 0x80 ? 1 : c < 0x800 ? 2 : c < 0x10000 ? 3 : 4; + } + + // allocate buffer + if (support.uint8array) { + buf = new Uint8Array(buf_len); + } else { + buf = new Array(buf_len); + } + + // convert + for (i=0, m_pos = 0; i < buf_len; m_pos++) { + c = str.charCodeAt(m_pos); + if ((c & 0xfc00) === 0xd800 && (m_pos+1 < str_len)) { + c2 = str.charCodeAt(m_pos+1); + if ((c2 & 0xfc00) === 0xdc00) { + c = 0x10000 + ((c - 0xd800) << 10) + (c2 - 0xdc00); + m_pos++; + } + } + if (c < 0x80) { + /* one byte */ + buf[i++] = c; + } else if (c < 0x800) { + /* two bytes */ + buf[i++] = 0xC0 | (c >>> 6); + buf[i++] = 0x80 | (c & 0x3f); + } else if (c < 0x10000) { + /* three bytes */ + buf[i++] = 0xE0 | (c >>> 12); + buf[i++] = 0x80 | (c >>> 6 & 0x3f); + buf[i++] = 0x80 | (c & 0x3f); + } else { + /* four bytes */ + buf[i++] = 0xf0 | (c >>> 18); + buf[i++] = 0x80 | (c >>> 12 & 0x3f); + buf[i++] = 0x80 | (c >>> 6 & 0x3f); + buf[i++] = 0x80 | (c & 0x3f); + } + } + + return buf; +}; + +// Calculate max possible position in utf8 buffer, +// that will not break sequence. If that's not possible +// - (very small limits) return max size as is. +// +// buf[] - utf8 bytes array +// max - length limit (mandatory); +var utf8border = function(buf, max) { + var pos; + + max = max || buf.length; + if (max > buf.length) { max = buf.length; } + + // go back from last position, until start of sequence found + pos = max-1; + while (pos >= 0 && (buf[pos] & 0xC0) === 0x80) { pos--; } + + // Fuckup - very small and broken sequence, + // return max, because we should return something anyway. + if (pos < 0) { return max; } + + // If we came to start of buffer - that means vuffer is too small, + // return max too. + if (pos === 0) { return max; } + + return (pos + _utf8len[buf[pos]] > max) ? pos : max; +}; + +// convert array to string +var buf2string = function (buf) { + var str, i, out, c, c_len; + var len = buf.length; + + // Reserve max possible length (2 words per char) + // NB: by unknown reasons, Array is significantly faster for + // String.fromCharCode.apply than Uint16Array. + var utf16buf = new Array(len*2); + + for (out=0, i=0; i 4) { utf16buf[out++] = 0xfffd; i += c_len-1; continue; } + + // apply mask on first byte + c &= c_len === 2 ? 0x1f : c_len === 3 ? 0x0f : 0x07; + // join the rest + while (c_len > 1 && i < len) { + c = (c << 6) | (buf[i++] & 0x3f); + c_len--; + } + + // terminated by end of string? + if (c_len > 1) { utf16buf[out++] = 0xfffd; continue; } + + if (c < 0x10000) { + utf16buf[out++] = c; + } else { + c -= 0x10000; + utf16buf[out++] = 0xd800 | ((c >> 10) & 0x3ff); + utf16buf[out++] = 0xdc00 | (c & 0x3ff); + } + } + + // shrinkBuf(utf16buf, out) + if (utf16buf.length !== out) { + if(utf16buf.subarray) { + utf16buf = utf16buf.subarray(0, out); + } else { + utf16buf.length = out; + } + } + + // return String.fromCharCode.apply(null, utf16buf); + return utils.applyFromCharCode(utf16buf); +}; + + +// That's all for the pako functions. + + +/** + * Transform a javascript string into an array (typed if possible) of bytes, + * UTF-8 encoded. + * @param {String} str the string to encode + * @return {Array|Uint8Array|Buffer} the UTF-8 encoded string. + */ +exports.utf8encode = function utf8encode(str) { + if (support.nodebuffer) { + return nodejsUtils.newBufferFrom(str, "utf-8"); + } + + return string2buf(str); +}; + + +/** + * Transform a bytes array (or a representation) representing an UTF-8 encoded + * string into a javascript string. + * @param {Array|Uint8Array|Buffer} buf the data de decode + * @return {String} the decoded string. + */ +exports.utf8decode = function utf8decode(buf) { + if (support.nodebuffer) { + return utils.transformTo("nodebuffer", buf).toString("utf-8"); + } + + buf = utils.transformTo(support.uint8array ? "uint8array" : "array", buf); + + return buf2string(buf); +}; + +/** + * A worker to decode utf8 encoded binary chunks into string chunks. + * @constructor + */ +function Utf8DecodeWorker() { + GenericWorker.call(this, "utf-8 decode"); + // the last bytes if a chunk didn't end with a complete codepoint. + this.leftOver = null; +} +utils.inherits(Utf8DecodeWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +Utf8DecodeWorker.prototype.processChunk = function (chunk) { + + var data = utils.transformTo(support.uint8array ? "uint8array" : "array", chunk.data); + + // 1st step, re-use what's left of the previous chunk + if (this.leftOver && this.leftOver.length) { + if(support.uint8array) { + var previousData = data; + data = new Uint8Array(previousData.length + this.leftOver.length); + data.set(this.leftOver, 0); + data.set(previousData, this.leftOver.length); + } else { + data = this.leftOver.concat(data); + } + this.leftOver = null; + } + + var nextBoundary = utf8border(data); + var usableData = data; + if (nextBoundary !== data.length) { + if (support.uint8array) { + usableData = data.subarray(0, nextBoundary); + this.leftOver = data.subarray(nextBoundary, data.length); + } else { + usableData = data.slice(0, nextBoundary); + this.leftOver = data.slice(nextBoundary, data.length); + } + } + + this.push({ + data : exports.utf8decode(usableData), + meta : chunk.meta + }); +}; + +/** + * @see GenericWorker.flush + */ +Utf8DecodeWorker.prototype.flush = function () { + if(this.leftOver && this.leftOver.length) { + this.push({ + data : exports.utf8decode(this.leftOver), + meta : {} + }); + this.leftOver = null; + } +}; +exports.Utf8DecodeWorker = Utf8DecodeWorker; + +/** + * A worker to endcode string chunks into utf8 encoded binary chunks. + * @constructor + */ +function Utf8EncodeWorker() { + GenericWorker.call(this, "utf-8 encode"); +} +utils.inherits(Utf8EncodeWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +Utf8EncodeWorker.prototype.processChunk = function (chunk) { + this.push({ + data : exports.utf8encode(chunk.data), + meta : chunk.meta + }); +}; +exports.Utf8EncodeWorker = Utf8EncodeWorker; + +},{"./nodejsUtils":14,"./stream/GenericWorker":28,"./support":30,"./utils":32}],32:[function(require,module,exports){ +'use strict'; + +var support = require('./support'); +var base64 = require('./base64'); +var nodejsUtils = require('./nodejsUtils'); +var setImmediate = require('set-immediate-shim'); +var external = require("./external"); + + +/** + * Convert a string that pass as a "binary string": it should represent a byte + * array but may have > 255 char codes. Be sure to take only the first byte + * and returns the byte array. + * @param {String} str the string to transform. + * @return {Array|Uint8Array} the string in a binary format. + */ +function string2binary(str) { + var result = null; + if (support.uint8array) { + result = new Uint8Array(str.length); + } else { + result = new Array(str.length); + } + return stringToArrayLike(str, result); +} + +/** + * Create a new blob with the given content and the given type. + * @param {String|ArrayBuffer} part the content to put in the blob. DO NOT use + * an Uint8Array because the stock browser of android 4 won't accept it (it + * will be silently converted to a string, "[object Uint8Array]"). + * + * Use only ONE part to build the blob to avoid a memory leak in IE11 / Edge: + * when a large amount of Array is used to create the Blob, the amount of + * memory consumed is nearly 100 times the original data amount. + * + * @param {String} type the mime type of the blob. + * @return {Blob} the created blob. + */ +exports.newBlob = function(part, type) { + exports.checkSupport("blob"); + + try { + // Blob constructor + return new Blob([part], { + type: type + }); + } + catch (e) { + + try { + // deprecated, browser only, old way + var Builder = self.BlobBuilder || self.WebKitBlobBuilder || self.MozBlobBuilder || self.MSBlobBuilder; + var builder = new Builder(); + builder.append(part); + return builder.getBlob(type); + } + catch (e) { + + // well, fuck ?! + throw new Error("Bug : can't construct the Blob."); + } + } + + +}; +/** + * The identity function. + * @param {Object} input the input. + * @return {Object} the same input. + */ +function identity(input) { + return input; +} + +/** + * Fill in an array with a string. + * @param {String} str the string to use. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to fill in (will be mutated). + * @return {Array|ArrayBuffer|Uint8Array|Buffer} the updated array. + */ +function stringToArrayLike(str, array) { + for (var i = 0; i < str.length; ++i) { + array[i] = str.charCodeAt(i) & 0xFF; + } + return array; +} + +/** + * An helper for the function arrayLikeToString. + * This contains static information and functions that + * can be optimized by the browser JIT compiler. + */ +var arrayToStringHelper = { + /** + * Transform an array of int into a string, chunk by chunk. + * See the performances notes on arrayLikeToString. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to transform. + * @param {String} type the type of the array. + * @param {Integer} chunk the chunk size. + * @return {String} the resulting string. + * @throws Error if the chunk is too big for the stack. + */ + stringifyByChunk: function(array, type, chunk) { + var result = [], k = 0, len = array.length; + // shortcut + if (len <= chunk) { + return String.fromCharCode.apply(null, array); + } + while (k < len) { + if (type === "array" || type === "nodebuffer") { + result.push(String.fromCharCode.apply(null, array.slice(k, Math.min(k + chunk, len)))); + } + else { + result.push(String.fromCharCode.apply(null, array.subarray(k, Math.min(k + chunk, len)))); + } + k += chunk; + } + return result.join(""); + }, + /** + * Call String.fromCharCode on every item in the array. + * This is the naive implementation, which generate A LOT of intermediate string. + * This should be used when everything else fail. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to transform. + * @return {String} the result. + */ + stringifyByChar: function(array){ + var resultStr = ""; + for(var i = 0; i < array.length; i++) { + resultStr += String.fromCharCode(array[i]); + } + return resultStr; + }, + applyCanBeUsed : { + /** + * true if the browser accepts to use String.fromCharCode on Uint8Array + */ + uint8array : (function () { + try { + return support.uint8array && String.fromCharCode.apply(null, new Uint8Array(1)).length === 1; + } catch (e) { + return false; + } + })(), + /** + * true if the browser accepts to use String.fromCharCode on nodejs Buffer. + */ + nodebuffer : (function () { + try { + return support.nodebuffer && String.fromCharCode.apply(null, nodejsUtils.allocBuffer(1)).length === 1; + } catch (e) { + return false; + } + })() + } +}; + +/** + * Transform an array-like object to a string. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to transform. + * @return {String} the result. + */ +function arrayLikeToString(array) { + // Performances notes : + // -------------------- + // String.fromCharCode.apply(null, array) is the fastest, see + // see http://jsperf.com/converting-a-uint8array-to-a-string/2 + // but the stack is limited (and we can get huge arrays !). + // + // result += String.fromCharCode(array[i]); generate too many strings ! + // + // This code is inspired by http://jsperf.com/arraybuffer-to-string-apply-performance/2 + // TODO : we now have workers that split the work. Do we still need that ? + var chunk = 65536, + type = exports.getTypeOf(array), + canUseApply = true; + if (type === "uint8array") { + canUseApply = arrayToStringHelper.applyCanBeUsed.uint8array; + } else if (type === "nodebuffer") { + canUseApply = arrayToStringHelper.applyCanBeUsed.nodebuffer; + } + + if (canUseApply) { + while (chunk > 1) { + try { + return arrayToStringHelper.stringifyByChunk(array, type, chunk); + } catch (e) { + chunk = Math.floor(chunk / 2); + } + } + } + + // no apply or chunk error : slow and painful algorithm + // default browser on android 4.* + return arrayToStringHelper.stringifyByChar(array); +} + +exports.applyFromCharCode = arrayLikeToString; + + +/** + * Copy the data from an array-like to an other array-like. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} arrayFrom the origin array. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} arrayTo the destination array which will be mutated. + * @return {Array|ArrayBuffer|Uint8Array|Buffer} the updated destination array. + */ +function arrayLikeToArrayLike(arrayFrom, arrayTo) { + for (var i = 0; i < arrayFrom.length; i++) { + arrayTo[i] = arrayFrom[i]; + } + return arrayTo; +} + +// a matrix containing functions to transform everything into everything. +var transform = {}; + +// string to ? +transform["string"] = { + "string": identity, + "array": function(input) { + return stringToArrayLike(input, new Array(input.length)); + }, + "arraybuffer": function(input) { + return transform["string"]["uint8array"](input).buffer; + }, + "uint8array": function(input) { + return stringToArrayLike(input, new Uint8Array(input.length)); + }, + "nodebuffer": function(input) { + return stringToArrayLike(input, nodejsUtils.allocBuffer(input.length)); + } +}; + +// array to ? +transform["array"] = { + "string": arrayLikeToString, + "array": identity, + "arraybuffer": function(input) { + return (new Uint8Array(input)).buffer; + }, + "uint8array": function(input) { + return new Uint8Array(input); + }, + "nodebuffer": function(input) { + return nodejsUtils.newBufferFrom(input); + } +}; + +// arraybuffer to ? +transform["arraybuffer"] = { + "string": function(input) { + return arrayLikeToString(new Uint8Array(input)); + }, + "array": function(input) { + return arrayLikeToArrayLike(new Uint8Array(input), new Array(input.byteLength)); + }, + "arraybuffer": identity, + "uint8array": function(input) { + return new Uint8Array(input); + }, + "nodebuffer": function(input) { + return nodejsUtils.newBufferFrom(new Uint8Array(input)); + } +}; + +// uint8array to ? +transform["uint8array"] = { + "string": arrayLikeToString, + "array": function(input) { + return arrayLikeToArrayLike(input, new Array(input.length)); + }, + "arraybuffer": function(input) { + return input.buffer; + }, + "uint8array": identity, + "nodebuffer": function(input) { + return nodejsUtils.newBufferFrom(input); + } +}; + +// nodebuffer to ? +transform["nodebuffer"] = { + "string": arrayLikeToString, + "array": function(input) { + return arrayLikeToArrayLike(input, new Array(input.length)); + }, + "arraybuffer": function(input) { + return transform["nodebuffer"]["uint8array"](input).buffer; + }, + "uint8array": function(input) { + return arrayLikeToArrayLike(input, new Uint8Array(input.length)); + }, + "nodebuffer": identity +}; + +/** + * Transform an input into any type. + * The supported output type are : string, array, uint8array, arraybuffer, nodebuffer. + * If no output type is specified, the unmodified input will be returned. + * @param {String} outputType the output type. + * @param {String|Array|ArrayBuffer|Uint8Array|Buffer} input the input to convert. + * @throws {Error} an Error if the browser doesn't support the requested output type. + */ +exports.transformTo = function(outputType, input) { + if (!input) { + // undefined, null, etc + // an empty string won't harm. + input = ""; + } + if (!outputType) { + return input; + } + exports.checkSupport(outputType); + var inputType = exports.getTypeOf(input); + var result = transform[inputType][outputType](input); + return result; +}; + +/** + * Return the type of the input. + * The type will be in a format valid for JSZip.utils.transformTo : string, array, uint8array, arraybuffer. + * @param {Object} input the input to identify. + * @return {String} the (lowercase) type of the input. + */ +exports.getTypeOf = function(input) { + if (typeof input === "string") { + return "string"; + } + if (Object.prototype.toString.call(input) === "[object Array]") { + return "array"; + } + if (support.nodebuffer && nodejsUtils.isBuffer(input)) { + return "nodebuffer"; + } + if (support.uint8array && input instanceof Uint8Array) { + return "uint8array"; + } + if (support.arraybuffer && input instanceof ArrayBuffer) { + return "arraybuffer"; + } +}; + +/** + * Throw an exception if the type is not supported. + * @param {String} type the type to check. + * @throws {Error} an Error if the browser doesn't support the requested type. + */ +exports.checkSupport = function(type) { + var supported = support[type.toLowerCase()]; + if (!supported) { + throw new Error(type + " is not supported by this platform"); + } +}; + +exports.MAX_VALUE_16BITS = 65535; +exports.MAX_VALUE_32BITS = -1; // well, "\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF" is parsed as -1 + +/** + * Prettify a string read as binary. + * @param {string} str the string to prettify. + * @return {string} a pretty string. + */ +exports.pretty = function(str) { + var res = '', + code, i; + for (i = 0; i < (str || "").length; i++) { + code = str.charCodeAt(i); + res += '\\x' + (code < 16 ? "0" : "") + code.toString(16).toUpperCase(); + } + return res; +}; + +/** + * Defer the call of a function. + * @param {Function} callback the function to call asynchronously. + * @param {Array} args the arguments to give to the callback. + */ +exports.delay = function(callback, args, self) { + setImmediate(function () { + callback.apply(self || null, args || []); + }); +}; + +/** + * Extends a prototype with an other, without calling a constructor with + * side effects. Inspired by nodejs' `utils.inherits` + * @param {Function} ctor the constructor to augment + * @param {Function} superCtor the parent constructor to use + */ +exports.inherits = function (ctor, superCtor) { + var Obj = function() {}; + Obj.prototype = superCtor.prototype; + ctor.prototype = new Obj(); +}; + +/** + * Merge the objects passed as parameters into a new one. + * @private + * @param {...Object} var_args All objects to merge. + * @return {Object} a new object with the data of the others. + */ +exports.extend = function() { + var result = {}, i, attr; + for (i = 0; i < arguments.length; i++) { // arguments is not enumerable in some browsers + for (attr in arguments[i]) { + if (arguments[i].hasOwnProperty(attr) && typeof result[attr] === "undefined") { + result[attr] = arguments[i][attr]; + } + } + } + return result; +}; + +/** + * Transform arbitrary content into a Promise. + * @param {String} name a name for the content being processed. + * @param {Object} inputData the content to process. + * @param {Boolean} isBinary true if the content is not an unicode string + * @param {Boolean} isOptimizedBinaryString true if the string content only has one byte per character. + * @param {Boolean} isBase64 true if the string content is encoded with base64. + * @return {Promise} a promise in a format usable by JSZip. + */ +exports.prepareContent = function(name, inputData, isBinary, isOptimizedBinaryString, isBase64) { + + // if inputData is already a promise, this flatten it. + var promise = external.Promise.resolve(inputData).then(function(data) { + + + var isBlob = support.blob && (data instanceof Blob || ['[object File]', '[object Blob]'].indexOf(Object.prototype.toString.call(data)) !== -1); + + if (isBlob && typeof FileReader !== "undefined") { + return new external.Promise(function (resolve, reject) { + var reader = new FileReader(); + + reader.onload = function(e) { + resolve(e.target.result); + }; + reader.onerror = function(e) { + reject(e.target.error); + }; + reader.readAsArrayBuffer(data); + }); + } else { + return data; + } + }); + + return promise.then(function(data) { + var dataType = exports.getTypeOf(data); + + if (!dataType) { + return external.Promise.reject( + new Error("Can't read the data of '" + name + "'. Is it " + + "in a supported JavaScript type (String, Blob, ArrayBuffer, etc) ?") + ); + } + // special case : it's way easier to work with Uint8Array than with ArrayBuffer + if (dataType === "arraybuffer") { + data = exports.transformTo("uint8array", data); + } else if (dataType === "string") { + if (isBase64) { + data = base64.decode(data); + } + else if (isBinary) { + // optimizedBinaryString === true means that the file has already been filtered with a 0xFF mask + if (isOptimizedBinaryString !== true) { + // this is a string, not in a base64 format. + // Be sure that this is a correct "binary string" + data = string2binary(data); + } + } + } + return data; + }); +}; + +},{"./base64":1,"./external":6,"./nodejsUtils":14,"./support":30,"set-immediate-shim":54}],33:[function(require,module,exports){ +'use strict'; +var readerFor = require('./reader/readerFor'); +var utils = require('./utils'); +var sig = require('./signature'); +var ZipEntry = require('./zipEntry'); +var utf8 = require('./utf8'); +var support = require('./support'); +// class ZipEntries {{{ +/** + * All the entries in the zip file. + * @constructor + * @param {Object} loadOptions Options for loading the stream. + */ +function ZipEntries(loadOptions) { + this.files = []; + this.loadOptions = loadOptions; +} +ZipEntries.prototype = { + /** + * Check that the reader is on the specified signature. + * @param {string} expectedSignature the expected signature. + * @throws {Error} if it is an other signature. + */ + checkSignature: function(expectedSignature) { + if (!this.reader.readAndCheckSignature(expectedSignature)) { + this.reader.index -= 4; + var signature = this.reader.readString(4); + throw new Error("Corrupted zip or bug: unexpected signature " + "(" + utils.pretty(signature) + ", expected " + utils.pretty(expectedSignature) + ")"); + } + }, + /** + * Check if the given signature is at the given index. + * @param {number} askedIndex the index to check. + * @param {string} expectedSignature the signature to expect. + * @return {boolean} true if the signature is here, false otherwise. + */ + isSignature: function(askedIndex, expectedSignature) { + var currentIndex = this.reader.index; + this.reader.setIndex(askedIndex); + var signature = this.reader.readString(4); + var result = signature === expectedSignature; + this.reader.setIndex(currentIndex); + return result; + }, + /** + * Read the end of the central directory. + */ + readBlockEndOfCentral: function() { + this.diskNumber = this.reader.readInt(2); + this.diskWithCentralDirStart = this.reader.readInt(2); + this.centralDirRecordsOnThisDisk = this.reader.readInt(2); + this.centralDirRecords = this.reader.readInt(2); + this.centralDirSize = this.reader.readInt(4); + this.centralDirOffset = this.reader.readInt(4); + + this.zipCommentLength = this.reader.readInt(2); + // warning : the encoding depends of the system locale + // On a linux machine with LANG=en_US.utf8, this field is utf8 encoded. + // On a windows machine, this field is encoded with the localized windows code page. + var zipComment = this.reader.readData(this.zipCommentLength); + var decodeParamType = support.uint8array ? "uint8array" : "array"; + // To get consistent behavior with the generation part, we will assume that + // this is utf8 encoded unless specified otherwise. + var decodeContent = utils.transformTo(decodeParamType, zipComment); + this.zipComment = this.loadOptions.decodeFileName(decodeContent); + }, + /** + * Read the end of the Zip 64 central directory. + * Not merged with the method readEndOfCentral : + * The end of central can coexist with its Zip64 brother, + * I don't want to read the wrong number of bytes ! + */ + readBlockZip64EndOfCentral: function() { + this.zip64EndOfCentralSize = this.reader.readInt(8); + this.reader.skip(4); + // this.versionMadeBy = this.reader.readString(2); + // this.versionNeeded = this.reader.readInt(2); + this.diskNumber = this.reader.readInt(4); + this.diskWithCentralDirStart = this.reader.readInt(4); + this.centralDirRecordsOnThisDisk = this.reader.readInt(8); + this.centralDirRecords = this.reader.readInt(8); + this.centralDirSize = this.reader.readInt(8); + this.centralDirOffset = this.reader.readInt(8); + + this.zip64ExtensibleData = {}; + var extraDataSize = this.zip64EndOfCentralSize - 44, + index = 0, + extraFieldId, + extraFieldLength, + extraFieldValue; + while (index < extraDataSize) { + extraFieldId = this.reader.readInt(2); + extraFieldLength = this.reader.readInt(4); + extraFieldValue = this.reader.readData(extraFieldLength); + this.zip64ExtensibleData[extraFieldId] = { + id: extraFieldId, + length: extraFieldLength, + value: extraFieldValue + }; + } + }, + /** + * Read the end of the Zip 64 central directory locator. + */ + readBlockZip64EndOfCentralLocator: function() { + this.diskWithZip64CentralDirStart = this.reader.readInt(4); + this.relativeOffsetEndOfZip64CentralDir = this.reader.readInt(8); + this.disksCount = this.reader.readInt(4); + if (this.disksCount > 1) { + throw new Error("Multi-volumes zip are not supported"); + } + }, + /** + * Read the local files, based on the offset read in the central part. + */ + readLocalFiles: function() { + var i, file; + for (i = 0; i < this.files.length; i++) { + file = this.files[i]; + this.reader.setIndex(file.localHeaderOffset); + this.checkSignature(sig.LOCAL_FILE_HEADER); + file.readLocalPart(this.reader); + file.handleUTF8(); + file.processAttributes(); + } + }, + /** + * Read the central directory. + */ + readCentralDir: function() { + var file; + + this.reader.setIndex(this.centralDirOffset); + while (this.reader.readAndCheckSignature(sig.CENTRAL_FILE_HEADER)) { + file = new ZipEntry({ + zip64: this.zip64 + }, this.loadOptions); + file.readCentralPart(this.reader); + this.files.push(file); + } + + if (this.centralDirRecords !== this.files.length) { + if (this.centralDirRecords !== 0 && this.files.length === 0) { + // We expected some records but couldn't find ANY. + // This is really suspicious, as if something went wrong. + throw new Error("Corrupted zip or bug: expected " + this.centralDirRecords + " records in central dir, got " + this.files.length); + } else { + // We found some records but not all. + // Something is wrong but we got something for the user: no error here. + // console.warn("expected", this.centralDirRecords, "records in central dir, got", this.files.length); + } + } + }, + /** + * Read the end of central directory. + */ + readEndOfCentral: function() { + var offset = this.reader.lastIndexOfSignature(sig.CENTRAL_DIRECTORY_END); + if (offset < 0) { + // Check if the content is a truncated zip or complete garbage. + // A "LOCAL_FILE_HEADER" is not required at the beginning (auto + // extractible zip for example) but it can give a good hint. + // If an ajax request was used without responseType, we will also + // get unreadable data. + var isGarbage = !this.isSignature(0, sig.LOCAL_FILE_HEADER); + + if (isGarbage) { + throw new Error("Can't find end of central directory : is this a zip file ? " + + "If it is, see https://stuk.github.io/jszip/documentation/howto/read_zip.html"); + } else { + throw new Error("Corrupted zip: can't find end of central directory"); + } + + } + this.reader.setIndex(offset); + var endOfCentralDirOffset = offset; + this.checkSignature(sig.CENTRAL_DIRECTORY_END); + this.readBlockEndOfCentral(); + + + /* extract from the zip spec : + 4) If one of the fields in the end of central directory + record is too small to hold required data, the field + should be set to -1 (0xFFFF or 0xFFFFFFFF) and the + ZIP64 format record should be created. + 5) The end of central directory record and the + Zip64 end of central directory locator record must + reside on the same disk when splitting or spanning + an archive. + */ + if (this.diskNumber === utils.MAX_VALUE_16BITS || this.diskWithCentralDirStart === utils.MAX_VALUE_16BITS || this.centralDirRecordsOnThisDisk === utils.MAX_VALUE_16BITS || this.centralDirRecords === utils.MAX_VALUE_16BITS || this.centralDirSize === utils.MAX_VALUE_32BITS || this.centralDirOffset === utils.MAX_VALUE_32BITS) { + this.zip64 = true; + + /* + Warning : the zip64 extension is supported, but ONLY if the 64bits integer read from + the zip file can fit into a 32bits integer. This cannot be solved : JavaScript represents + all numbers as 64-bit double precision IEEE 754 floating point numbers. + So, we have 53bits for integers and bitwise operations treat everything as 32bits. + see https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Operators/Bitwise_Operators + and http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-262.pdf section 8.5 + */ + + // should look for a zip64 EOCD locator + offset = this.reader.lastIndexOfSignature(sig.ZIP64_CENTRAL_DIRECTORY_LOCATOR); + if (offset < 0) { + throw new Error("Corrupted zip: can't find the ZIP64 end of central directory locator"); + } + this.reader.setIndex(offset); + this.checkSignature(sig.ZIP64_CENTRAL_DIRECTORY_LOCATOR); + this.readBlockZip64EndOfCentralLocator(); + + // now the zip64 EOCD record + if (!this.isSignature(this.relativeOffsetEndOfZip64CentralDir, sig.ZIP64_CENTRAL_DIRECTORY_END)) { + // console.warn("ZIP64 end of central directory not where expected."); + this.relativeOffsetEndOfZip64CentralDir = this.reader.lastIndexOfSignature(sig.ZIP64_CENTRAL_DIRECTORY_END); + if (this.relativeOffsetEndOfZip64CentralDir < 0) { + throw new Error("Corrupted zip: can't find the ZIP64 end of central directory"); + } + } + this.reader.setIndex(this.relativeOffsetEndOfZip64CentralDir); + this.checkSignature(sig.ZIP64_CENTRAL_DIRECTORY_END); + this.readBlockZip64EndOfCentral(); + } + + var expectedEndOfCentralDirOffset = this.centralDirOffset + this.centralDirSize; + if (this.zip64) { + expectedEndOfCentralDirOffset += 20; // end of central dir 64 locator + expectedEndOfCentralDirOffset += 12 /* should not include the leading 12 bytes */ + this.zip64EndOfCentralSize; + } + + var extraBytes = endOfCentralDirOffset - expectedEndOfCentralDirOffset; + + if (extraBytes > 0) { + // console.warn(extraBytes, "extra bytes at beginning or within zipfile"); + if (this.isSignature(endOfCentralDirOffset, sig.CENTRAL_FILE_HEADER)) { + // The offsets seem wrong, but we have something at the specified offset. + // So… we keep it. + } else { + // the offset is wrong, update the "zero" of the reader + // this happens if data has been prepended (crx files for example) + this.reader.zero = extraBytes; + } + } else if (extraBytes < 0) { + throw new Error("Corrupted zip: missing " + Math.abs(extraBytes) + " bytes."); + } + }, + prepareReader: function(data) { + this.reader = readerFor(data); + }, + /** + * Read a zip file and create ZipEntries. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the binary string representing a zip file. + */ + load: function(data) { + this.prepareReader(data); + this.readEndOfCentral(); + this.readCentralDir(); + this.readLocalFiles(); + } +}; +// }}} end of ZipEntries +module.exports = ZipEntries; + +},{"./reader/readerFor":22,"./signature":23,"./support":30,"./utf8":31,"./utils":32,"./zipEntry":34}],34:[function(require,module,exports){ +'use strict'; +var readerFor = require('./reader/readerFor'); +var utils = require('./utils'); +var CompressedObject = require('./compressedObject'); +var crc32fn = require('./crc32'); +var utf8 = require('./utf8'); +var compressions = require('./compressions'); +var support = require('./support'); + +var MADE_BY_DOS = 0x00; +var MADE_BY_UNIX = 0x03; + +/** + * Find a compression registered in JSZip. + * @param {string} compressionMethod the method magic to find. + * @return {Object|null} the JSZip compression object, null if none found. + */ +var findCompression = function(compressionMethod) { + for (var method in compressions) { + if (!compressions.hasOwnProperty(method)) { + continue; + } + if (compressions[method].magic === compressionMethod) { + return compressions[method]; + } + } + return null; +}; + +// class ZipEntry {{{ +/** + * An entry in the zip file. + * @constructor + * @param {Object} options Options of the current file. + * @param {Object} loadOptions Options for loading the stream. + */ +function ZipEntry(options, loadOptions) { + this.options = options; + this.loadOptions = loadOptions; +} +ZipEntry.prototype = { + /** + * say if the file is encrypted. + * @return {boolean} true if the file is encrypted, false otherwise. + */ + isEncrypted: function() { + // bit 1 is set + return (this.bitFlag & 0x0001) === 0x0001; + }, + /** + * say if the file has utf-8 filename/comment. + * @return {boolean} true if the filename/comment is in utf-8, false otherwise. + */ + useUTF8: function() { + // bit 11 is set + return (this.bitFlag & 0x0800) === 0x0800; + }, + /** + * Read the local part of a zip file and add the info in this object. + * @param {DataReader} reader the reader to use. + */ + readLocalPart: function(reader) { + var compression, localExtraFieldsLength; + + // we already know everything from the central dir ! + // If the central dir data are false, we are doomed. + // On the bright side, the local part is scary : zip64, data descriptors, both, etc. + // The less data we get here, the more reliable this should be. + // Let's skip the whole header and dash to the data ! + reader.skip(22); + // in some zip created on windows, the filename stored in the central dir contains \ instead of /. + // Strangely, the filename here is OK. + // I would love to treat these zip files as corrupted (see http://www.info-zip.org/FAQ.html#backslashes + // or APPNOTE#4.4.17.1, "All slashes MUST be forward slashes '/'") but there are a lot of bad zip generators... + // Search "unzip mismatching "local" filename continuing with "central" filename version" on + // the internet. + // + // I think I see the logic here : the central directory is used to display + // content and the local directory is used to extract the files. Mixing / and \ + // may be used to display \ to windows users and use / when extracting the files. + // Unfortunately, this lead also to some issues : http://seclists.org/fulldisclosure/2009/Sep/394 + this.fileNameLength = reader.readInt(2); + localExtraFieldsLength = reader.readInt(2); // can't be sure this will be the same as the central dir + // the fileName is stored as binary data, the handleUTF8 method will take care of the encoding. + this.fileName = reader.readData(this.fileNameLength); + reader.skip(localExtraFieldsLength); + + if (this.compressedSize === -1 || this.uncompressedSize === -1) { + throw new Error("Bug or corrupted zip : didn't get enough information from the central directory " + "(compressedSize === -1 || uncompressedSize === -1)"); + } + + compression = findCompression(this.compressionMethod); + if (compression === null) { // no compression found + throw new Error("Corrupted zip : compression " + utils.pretty(this.compressionMethod) + " unknown (inner file : " + utils.transformTo("string", this.fileName) + ")"); + } + this.decompressed = new CompressedObject(this.compressedSize, this.uncompressedSize, this.crc32, compression, reader.readData(this.compressedSize)); + }, + + /** + * Read the central part of a zip file and add the info in this object. + * @param {DataReader} reader the reader to use. + */ + readCentralPart: function(reader) { + this.versionMadeBy = reader.readInt(2); + reader.skip(2); + // this.versionNeeded = reader.readInt(2); + this.bitFlag = reader.readInt(2); + this.compressionMethod = reader.readString(2); + this.date = reader.readDate(); + this.crc32 = reader.readInt(4); + this.compressedSize = reader.readInt(4); + this.uncompressedSize = reader.readInt(4); + var fileNameLength = reader.readInt(2); + this.extraFieldsLength = reader.readInt(2); + this.fileCommentLength = reader.readInt(2); + this.diskNumberStart = reader.readInt(2); + this.internalFileAttributes = reader.readInt(2); + this.externalFileAttributes = reader.readInt(4); + this.localHeaderOffset = reader.readInt(4); + + if (this.isEncrypted()) { + throw new Error("Encrypted zip are not supported"); + } + + // will be read in the local part, see the comments there + reader.skip(fileNameLength); + this.readExtraFields(reader); + this.parseZIP64ExtraField(reader); + this.fileComment = reader.readData(this.fileCommentLength); + }, + + /** + * Parse the external file attributes and get the unix/dos permissions. + */ + processAttributes: function () { + this.unixPermissions = null; + this.dosPermissions = null; + var madeBy = this.versionMadeBy >> 8; + + // Check if we have the DOS directory flag set. + // We look for it in the DOS and UNIX permissions + // but some unknown platform could set it as a compatibility flag. + this.dir = this.externalFileAttributes & 0x0010 ? true : false; + + if(madeBy === MADE_BY_DOS) { + // first 6 bits (0 to 5) + this.dosPermissions = this.externalFileAttributes & 0x3F; + } + + if(madeBy === MADE_BY_UNIX) { + this.unixPermissions = (this.externalFileAttributes >> 16) & 0xFFFF; + // the octal permissions are in (this.unixPermissions & 0x01FF).toString(8); + } + + // fail safe : if the name ends with a / it probably means a folder + if (!this.dir && this.fileNameStr.slice(-1) === '/') { + this.dir = true; + } + }, + + /** + * Parse the ZIP64 extra field and merge the info in the current ZipEntry. + * @param {DataReader} reader the reader to use. + */ + parseZIP64ExtraField: function(reader) { + + if (!this.extraFields[0x0001]) { + return; + } + + // should be something, preparing the extra reader + var extraReader = readerFor(this.extraFields[0x0001].value); + + // I really hope that these 64bits integer can fit in 32 bits integer, because js + // won't let us have more. + if (this.uncompressedSize === utils.MAX_VALUE_32BITS) { + this.uncompressedSize = extraReader.readInt(8); + } + if (this.compressedSize === utils.MAX_VALUE_32BITS) { + this.compressedSize = extraReader.readInt(8); + } + if (this.localHeaderOffset === utils.MAX_VALUE_32BITS) { + this.localHeaderOffset = extraReader.readInt(8); + } + if (this.diskNumberStart === utils.MAX_VALUE_32BITS) { + this.diskNumberStart = extraReader.readInt(4); + } + }, + /** + * Read the central part of a zip file and add the info in this object. + * @param {DataReader} reader the reader to use. + */ + readExtraFields: function(reader) { + var end = reader.index + this.extraFieldsLength, + extraFieldId, + extraFieldLength, + extraFieldValue; + + if (!this.extraFields) { + this.extraFields = {}; + } + + while (reader.index + 4 < end) { + extraFieldId = reader.readInt(2); + extraFieldLength = reader.readInt(2); + extraFieldValue = reader.readData(extraFieldLength); + + this.extraFields[extraFieldId] = { + id: extraFieldId, + length: extraFieldLength, + value: extraFieldValue + }; + } + + reader.setIndex(end); + }, + /** + * Apply an UTF8 transformation if needed. + */ + handleUTF8: function() { + var decodeParamType = support.uint8array ? "uint8array" : "array"; + if (this.useUTF8()) { + this.fileNameStr = utf8.utf8decode(this.fileName); + this.fileCommentStr = utf8.utf8decode(this.fileComment); + } else { + var upath = this.findExtraFieldUnicodePath(); + if (upath !== null) { + this.fileNameStr = upath; + } else { + // ASCII text or unsupported code page + var fileNameByteArray = utils.transformTo(decodeParamType, this.fileName); + this.fileNameStr = this.loadOptions.decodeFileName(fileNameByteArray); + } + + var ucomment = this.findExtraFieldUnicodeComment(); + if (ucomment !== null) { + this.fileCommentStr = ucomment; + } else { + // ASCII text or unsupported code page + var commentByteArray = utils.transformTo(decodeParamType, this.fileComment); + this.fileCommentStr = this.loadOptions.decodeFileName(commentByteArray); + } + } + }, + + /** + * Find the unicode path declared in the extra field, if any. + * @return {String} the unicode path, null otherwise. + */ + findExtraFieldUnicodePath: function() { + var upathField = this.extraFields[0x7075]; + if (upathField) { + var extraReader = readerFor(upathField.value); + + // wrong version + if (extraReader.readInt(1) !== 1) { + return null; + } + + // the crc of the filename changed, this field is out of date. + if (crc32fn(this.fileName) !== extraReader.readInt(4)) { + return null; + } + + return utf8.utf8decode(extraReader.readData(upathField.length - 5)); + } + return null; + }, + + /** + * Find the unicode comment declared in the extra field, if any. + * @return {String} the unicode comment, null otherwise. + */ + findExtraFieldUnicodeComment: function() { + var ucommentField = this.extraFields[0x6375]; + if (ucommentField) { + var extraReader = readerFor(ucommentField.value); + + // wrong version + if (extraReader.readInt(1) !== 1) { + return null; + } + + // the crc of the comment changed, this field is out of date. + if (crc32fn(this.fileComment) !== extraReader.readInt(4)) { + return null; + } + + return utf8.utf8decode(extraReader.readData(ucommentField.length - 5)); + } + return null; + } +}; +module.exports = ZipEntry; + +},{"./compressedObject":2,"./compressions":3,"./crc32":4,"./reader/readerFor":22,"./support":30,"./utf8":31,"./utils":32}],35:[function(require,module,exports){ +'use strict'; + +var StreamHelper = require('./stream/StreamHelper'); +var DataWorker = require('./stream/DataWorker'); +var utf8 = require('./utf8'); +var CompressedObject = require('./compressedObject'); +var GenericWorker = require('./stream/GenericWorker'); + +/** + * A simple object representing a file in the zip file. + * @constructor + * @param {string} name the name of the file + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the data + * @param {Object} options the options of the file + */ +var ZipObject = function(name, data, options) { + this.name = name; + this.dir = options.dir; + this.date = options.date; + this.comment = options.comment; + this.unixPermissions = options.unixPermissions; + this.dosPermissions = options.dosPermissions; + + this._data = data; + this._dataBinary = options.binary; + // keep only the compression + this.options = { + compression : options.compression, + compressionOptions : options.compressionOptions + }; +}; + +ZipObject.prototype = { + /** + * Create an internal stream for the content of this object. + * @param {String} type the type of each chunk. + * @return StreamHelper the stream. + */ + internalStream: function (type) { + var result = null, outputType = "string"; + try { + if (!type) { + throw new Error("No output type specified."); + } + outputType = type.toLowerCase(); + var askUnicodeString = outputType === "string" || outputType === "text"; + if (outputType === "binarystring" || outputType === "text") { + outputType = "string"; + } + result = this._decompressWorker(); + + var isUnicodeString = !this._dataBinary; + + if (isUnicodeString && !askUnicodeString) { + result = result.pipe(new utf8.Utf8EncodeWorker()); + } + if (!isUnicodeString && askUnicodeString) { + result = result.pipe(new utf8.Utf8DecodeWorker()); + } + } catch (e) { + result = new GenericWorker("error"); + result.error(e); + } + + return new StreamHelper(result, outputType, ""); + }, + + /** + * Prepare the content in the asked type. + * @param {String} type the type of the result. + * @param {Function} onUpdate a function to call on each internal update. + * @return Promise the promise of the result. + */ + async: function (type, onUpdate) { + return this.internalStream(type).accumulate(onUpdate); + }, + + /** + * Prepare the content as a nodejs stream. + * @param {String} type the type of each chunk. + * @param {Function} onUpdate a function to call on each internal update. + * @return Stream the stream. + */ + nodeStream: function (type, onUpdate) { + return this.internalStream(type || "nodebuffer").toNodejsStream(onUpdate); + }, + + /** + * Return a worker for the compressed content. + * @private + * @param {Object} compression the compression object to use. + * @param {Object} compressionOptions the options to use when compressing. + * @return Worker the worker. + */ + _compressWorker: function (compression, compressionOptions) { + if ( + this._data instanceof CompressedObject && + this._data.compression.magic === compression.magic + ) { + return this._data.getCompressedWorker(); + } else { + var result = this._decompressWorker(); + if(!this._dataBinary) { + result = result.pipe(new utf8.Utf8EncodeWorker()); + } + return CompressedObject.createWorkerFrom(result, compression, compressionOptions); + } + }, + /** + * Return a worker for the decompressed content. + * @private + * @return Worker the worker. + */ + _decompressWorker : function () { + if (this._data instanceof CompressedObject) { + return this._data.getContentWorker(); + } else if (this._data instanceof GenericWorker) { + return this._data; + } else { + return new DataWorker(this._data); + } + } +}; + +var removedMethods = ["asText", "asBinary", "asNodeBuffer", "asUint8Array", "asArrayBuffer"]; +var removedFn = function () { + throw new Error("This method has been removed in JSZip 3.0, please check the upgrade guide."); +}; + +for(var i = 0; i < removedMethods.length; i++) { + ZipObject.prototype[removedMethods[i]] = removedFn; +} +module.exports = ZipObject; + +},{"./compressedObject":2,"./stream/DataWorker":27,"./stream/GenericWorker":28,"./stream/StreamHelper":29,"./utf8":31}],36:[function(require,module,exports){ +(function (global){ +'use strict'; +var Mutation = global.MutationObserver || global.WebKitMutationObserver; + +var scheduleDrain; + +{ + if (Mutation) { + var called = 0; + var observer = new Mutation(nextTick); + var element = global.document.createTextNode(''); + observer.observe(element, { + characterData: true + }); + scheduleDrain = function () { + element.data = (called = ++called % 2); + }; + } else if (!global.setImmediate && typeof global.MessageChannel !== 'undefined') { + var channel = new global.MessageChannel(); + channel.port1.onmessage = nextTick; + scheduleDrain = function () { + channel.port2.postMessage(0); + }; + } else if ('document' in global && 'onreadystatechange' in global.document.createElement('script')) { + scheduleDrain = function () { + + // Create a + + + + + +
    + +

    index.html

    +
    + + diff --git a/javadoc/1.47.0/overview-tree.html b/javadoc/1.47.0/overview-tree.html new file mode 100644 index 00000000000..69713312ae0 --- /dev/null +++ b/javadoc/1.47.0/overview-tree.html @@ -0,0 +1,1900 @@ + + + + + +Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For All Packages

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +

    Annotation Type Hierarchy

    +
      +
    • software.amazon.smithy.utils.SmithyGenerated (implements java.lang.annotation.Annotation)
      • +
    • software.amazon.smithy.utils.SmithyInternalApi (implements java.lang.annotation.Annotation)
      • +
    • software.amazon.smithy.utils.SmithyUnstableApi (implements java.lang.annotation.Annotation)
      • +
    +
    +
    +

    Enum Hierarchy

    + +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/package-search-index.js b/javadoc/1.47.0/package-search-index.js new file mode 100644 index 00000000000..b5ee670780b --- /dev/null +++ b/javadoc/1.47.0/package-search-index.js @@ -0,0 +1 @@ +packageSearchIndex = [{"l":"All Packages","url":"allpackages-index.html"},{"l":"software.amazon.smithy.aws.apigateway.openapi"},{"l":"software.amazon.smithy.aws.apigateway.traits"},{"l":"software.amazon.smithy.aws.cloudformation.schema"},{"l":"software.amazon.smithy.aws.cloudformation.schema.fromsmithy"},{"l":"software.amazon.smithy.aws.cloudformation.schema.fromsmithy.mappers"},{"l":"software.amazon.smithy.aws.cloudformation.schema.model"},{"l":"software.amazon.smithy.aws.cloudformation.traits"},{"l":"software.amazon.smithy.aws.iam.traits"},{"l":"software.amazon.smithy.aws.smoketests.model"},{"l":"software.amazon.smithy.aws.traits"},{"l":"software.amazon.smithy.aws.traits.auth"},{"l":"software.amazon.smithy.aws.traits.clientendpointdiscovery"},{"l":"software.amazon.smithy.aws.traits.customizations"},{"l":"software.amazon.smithy.aws.traits.protocols"},{"l":"software.amazon.smithy.aws.traits.tagging"},{"l":"software.amazon.smithy.build"},{"l":"software.amazon.smithy.build.model"},{"l":"software.amazon.smithy.build.plugins"},{"l":"software.amazon.smithy.build.processor"},{"l":"software.amazon.smithy.build.transforms"},{"l":"software.amazon.smithy.cli"},{"l":"software.amazon.smithy.cli.commands"},{"l":"software.amazon.smithy.cli.dependencies"},{"l":"software.amazon.smithy.codegen.core"},{"l":"software.amazon.smithy.codegen.core.directed"},{"l":"software.amazon.smithy.codegen.core.trace"},{"l":"software.amazon.smithy.codegen.core.writer"},{"l":"software.amazon.smithy.diff"},{"l":"software.amazon.smithy.diff.evaluators"},{"l":"software.amazon.smithy.jmespath"},{"l":"software.amazon.smithy.jmespath.ast"},{"l":"software.amazon.smithy.jsonschema"},{"l":"software.amazon.smithy.linters"},{"l":"software.amazon.smithy.model"},{"l":"software.amazon.smithy.model.knowledge"},{"l":"software.amazon.smithy.model.loader"},{"l":"software.amazon.smithy.model.loader.sourcecontext"},{"l":"software.amazon.smithy.model.neighbor"},{"l":"software.amazon.smithy.model.node"},{"l":"software.amazon.smithy.model.node.internal"},{"l":"software.amazon.smithy.model.pattern"},{"l":"software.amazon.smithy.model.selector"},{"l":"software.amazon.smithy.model.shapes"},{"l":"software.amazon.smithy.model.traits"},{"l":"software.amazon.smithy.model.traits.synthetic"},{"l":"software.amazon.smithy.model.transform"},{"l":"software.amazon.smithy.model.transform.plugins"},{"l":"software.amazon.smithy.model.validation"},{"l":"software.amazon.smithy.model.validation.linters"},{"l":"software.amazon.smithy.model.validation.node"},{"l":"software.amazon.smithy.model.validation.suppressions"},{"l":"software.amazon.smithy.model.validation.testrunner"},{"l":"software.amazon.smithy.model.validation.validators"},{"l":"software.amazon.smithy.mqtt.traits"},{"l":"software.amazon.smithy.mqtt.traits.validators"},{"l":"software.amazon.smithy.openapi"},{"l":"software.amazon.smithy.openapi.fromsmithy"},{"l":"software.amazon.smithy.openapi.fromsmithy.mappers"},{"l":"software.amazon.smithy.openapi.fromsmithy.protocols"},{"l":"software.amazon.smithy.openapi.fromsmithy.security"},{"l":"software.amazon.smithy.openapi.model"},{"l":"software.amazon.smithy.openapi.traits"},{"l":"software.amazon.smithy.protocol.traits"},{"l":"software.amazon.smithy.protocoltests.traits"},{"l":"software.amazon.smithy.rulesengine.analysis"},{"l":"software.amazon.smithy.rulesengine.aws.language.functions"},{"l":"software.amazon.smithy.rulesengine.aws.language.functions.partition"},{"l":"software.amazon.smithy.rulesengine.aws.traits"},{"l":"software.amazon.smithy.rulesengine.aws.validators"},{"l":"software.amazon.smithy.rulesengine.language"},{"l":"software.amazon.smithy.rulesengine.language.error"},{"l":"software.amazon.smithy.rulesengine.language.evaluation"},{"l":"software.amazon.smithy.rulesengine.language.evaluation.type"},{"l":"software.amazon.smithy.rulesengine.language.evaluation.value"},{"l":"software.amazon.smithy.rulesengine.language.syntax"},{"l":"software.amazon.smithy.rulesengine.language.syntax.expressions"},{"l":"software.amazon.smithy.rulesengine.language.syntax.expressions.functions"},{"l":"software.amazon.smithy.rulesengine.language.syntax.expressions.literal"},{"l":"software.amazon.smithy.rulesengine.language.syntax.parameters"},{"l":"software.amazon.smithy.rulesengine.language.syntax.rule"},{"l":"software.amazon.smithy.rulesengine.traits"},{"l":"software.amazon.smithy.rulesengine.validators"},{"l":"software.amazon.smithy.smoketests.traits"},{"l":"software.amazon.smithy.syntax"},{"l":"software.amazon.smithy.traitcodegen"},{"l":"software.amazon.smithy.traitcodegen.generators"},{"l":"software.amazon.smithy.traitcodegen.integrations"},{"l":"software.amazon.smithy.traitcodegen.integrations.core"},{"l":"software.amazon.smithy.traitcodegen.integrations.idref"},{"l":"software.amazon.smithy.traitcodegen.integrations.javadoc"},{"l":"software.amazon.smithy.traitcodegen.integrations.uniqueitems"},{"l":"software.amazon.smithy.traitcodegen.sections"},{"l":"software.amazon.smithy.traitcodegen.writer"},{"l":"software.amazon.smithy.utils"},{"l":"software.amazon.smithy.waiters"}] \ No newline at end of file diff --git a/javadoc/1.47.0/package-search-index.zip b/javadoc/1.47.0/package-search-index.zip new file mode 100644 index 0000000000000000000000000000000000000000..71dc82ee2fdfeb2c783bae55c9e4b37c4994470b GIT binary patch literal 871 zcmWIWW@Zs#;Nak3V4GSK!GHuLf$W0BR3-ORj{)C#?<;{3d|;oe2J z4S4o?9e+KA{lz--7yB-=Ivo-c{^!&*ajxI{xD%Vyy^`7&+-l8@ta>lV^zrfe`_|ik zZ~Oi3&UE<&@`(pF?Y@20=03~wOF!?0OY_KG@woT)-yPjKLf=gs-B{(~k^+uKOZ9Ut zTcmK4kwe{L)eM6V_x;3DH-xCDyiGFwJ;Qdw-1#pAZFAIC)%Mjf{^jR=s;GMAcD&2a zjDRPf%1d@K>;B*?`S?+glUsCWX3d5RVqN^Ci5Ht(-#!h`!gwh^g0ZoW6}Ofy$0>wXuVc52#&mnF&H zt2x~s8t>o|xn26=V6x{0zkS?(jtkYc6?k>7+VuF1sEBvqmiZ2^43C^#C^_q0`~$tF z%-^-Wp{m!`1iEkgbD`wuA)bu(kNf6^q?^>Ap7`p?AqJ=aALPyzNbXqh_`&pBv2Gr3 zePT9jV%vCZRS}PgQlxI0?$VXQdTXb1_kKPzE13V~(ek7JW~uY{i>|yf#Ynu&bMtS9 zd9&-+DS8N}y4uEbaZRjOn$&hwdrLCo!-%T3(wv>b0hY|6*Z>RVme<-E(7a>tciFWyU+s#js8Cdmgh;+iF?wvHe+R!f(4gQ)6kbU!Y~v!M!mc zEn1*n?ZvaiEw+I*YR6A9$f@$aGoJc0l7GMb&cjR$3`d0-7y`T*nM4>6c>!4tlowC|&YTh8&B_K+ O$_Rw+K$?pg!~+0KUVOX& literal 0 HcmV?d00001 diff --git a/javadoc/1.47.0/resources/glass.png b/javadoc/1.47.0/resources/glass.png new file mode 100644 index 0000000000000000000000000000000000000000..a7f591f467a1c0c949bbc510156a0c1afb860a6e GIT binary patch literal 499 zcmVJoRsvExf%rEN>jUL}qZ_~k#FbE+Q;{`;0FZwVNX2n-^JoI; zP;4#$8DIy*Yk-P>VN(DUKmPse7mx+ExD4O|;?E5D0Z5($mjO3`*anwQU^s{ZDK#Lz zj>~{qyaIx5K!t%=G&2IJNzg!ChRpyLkO7}Ry!QaotAHAMpbB3AF(}|_f!G-oI|uK6 z`id_dumai5K%C3Y$;tKS_iqMPHg<*|-@e`liWLAggVM!zAP#@l;=c>S03;{#04Z~5 zN_+ss=Yg6*hTr59mzMwZ@+l~q!+?ft!fF66AXT#wWavHt30bZWFCK%!BNk}LN?0Hg z1VF_nfs`Lm^DjYZ1(1uD0u4CSIr)XAaqW6IT{!St5~1{i=i}zAy76p%_|w8rh@@c0Axr!ns=D-X+|*sY6!@wacG9%)Qn*O zl0sa739kT-&_?#oVxXF6tOnqTD)cZ}2vi$`ZU8RLAlo8=_z#*P3xI~i!lEh+Pdu-L zx{d*wgjtXbnGX_Yf@Tc7Q3YhLhPvc8noGJs2DA~1DySiA&6V{5JzFt ojAY1KXm~va;tU{v7C?Xj0BHw!K;2aXV*mgE07*qoM6N<$f;4TDA^-pY literal 0 HcmV?d00001 diff --git a/javadoc/1.47.0/script.js b/javadoc/1.47.0/script.js new file mode 100644 index 00000000000..7dc93c48e35 --- /dev/null +++ b/javadoc/1.47.0/script.js @@ -0,0 +1,149 @@ +/* + * Copyright (c) 2013, 2018, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +var moduleSearchIndex; +var packageSearchIndex; +var typeSearchIndex; +var memberSearchIndex; +var tagSearchIndex; +function loadScripts(doc, tag) { + createElem(doc, tag, 'jquery/jszip/dist/jszip.js'); + createElem(doc, tag, 'jquery/jszip-utils/dist/jszip-utils.js'); + if (window.navigator.userAgent.indexOf('MSIE ') > 0 || window.navigator.userAgent.indexOf('Trident/') > 0 || + window.navigator.userAgent.indexOf('Edge/') > 0) { + createElem(doc, tag, 'jquery/jszip-utils/dist/jszip-utils-ie.js'); + } + createElem(doc, tag, 'search.js'); + + $.get(pathtoroot + "module-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "module-search-index.zip", function(e, data) { + JSZip.loadAsync(data).then(function(zip){ + zip.file("module-search-index.json").async("text").then(function(content){ + moduleSearchIndex = JSON.parse(content); + }); + }); + }); + }); + $.get(pathtoroot + "package-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "package-search-index.zip", function(e, data) { + JSZip.loadAsync(data).then(function(zip){ + zip.file("package-search-index.json").async("text").then(function(content){ + packageSearchIndex = JSON.parse(content); + }); + }); + }); + }); + $.get(pathtoroot + "type-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "type-search-index.zip", function(e, data) { + JSZip.loadAsync(data).then(function(zip){ + zip.file("type-search-index.json").async("text").then(function(content){ + typeSearchIndex = JSON.parse(content); + }); + }); + }); + }); + $.get(pathtoroot + "member-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "member-search-index.zip", function(e, data) { + JSZip.loadAsync(data).then(function(zip){ + zip.file("member-search-index.json").async("text").then(function(content){ + memberSearchIndex = JSON.parse(content); + }); + }); + }); + }); + $.get(pathtoroot + "tag-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "tag-search-index.zip", function(e, data) { + JSZip.loadAsync(data).then(function(zip){ + zip.file("tag-search-index.json").async("text").then(function(content){ + tagSearchIndex = JSON.parse(content); + }); + }); + }); + }); + if (!moduleSearchIndex) { + createElem(doc, tag, 'module-search-index.js'); + } + if (!packageSearchIndex) { + createElem(doc, tag, 'package-search-index.js'); + } + if (!typeSearchIndex) { + createElem(doc, tag, 'type-search-index.js'); + } + if (!memberSearchIndex) { + createElem(doc, tag, 'member-search-index.js'); + } + if (!tagSearchIndex) { + createElem(doc, tag, 'tag-search-index.js'); + } + $(window).resize(function() { + $('.navPadding').css('padding-top', $('.fixedNav').css("height")); + }); +} + +function createElem(doc, tag, path) { + var script = doc.createElement(tag); + var scriptElement = doc.getElementsByTagName(tag)[0]; + script.src = pathtoroot + path; + scriptElement.parentNode.insertBefore(script, scriptElement); +} + +function show(type) { + count = 0; + for (var key in data) { + var row = document.getElementById(key); + if ((data[key] & type) !== 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) { + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} + +function updateModuleFrame(pFrame, cFrame) { + top.packageFrame.location = pFrame; + top.classFrame.location = cFrame; +} diff --git a/javadoc/1.47.0/search.js b/javadoc/1.47.0/search.js new file mode 100644 index 00000000000..8492271e710 --- /dev/null +++ b/javadoc/1.47.0/search.js @@ -0,0 +1,326 @@ +/* + * Copyright (c) 2015, 2018, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +var noResult = {l: "No results found"}; +var catModules = "Modules"; +var catPackages = "Packages"; +var catTypes = "Types"; +var catMembers = "Members"; +var catSearchTags = "SearchTags"; +var highlight = "$&"; +var camelCaseRegexp = ""; +var secondaryMatcher = ""; +function getHighlightedText(item) { + var ccMatcher = new RegExp(camelCaseRegexp); + var label = item.replace(ccMatcher, highlight); + if (label === item) { + label = item.replace(secondaryMatcher, highlight); + } + return label; +} +function getURLPrefix(ui) { + var urlPrefix=""; + if (useModuleDirectories) { + var slash = "/"; + if (ui.item.category === catModules) { + return ui.item.l + slash; + } else if (ui.item.category === catPackages && ui.item.m) { + return ui.item.m + slash; + } else if ((ui.item.category === catTypes && ui.item.p) || ui.item.category === catMembers) { + $.each(packageSearchIndex, function(index, item) { + if (item.m && ui.item.p == item.l) { + urlPrefix = item.m + slash; + } + }); + return urlPrefix; + } else { + return urlPrefix; + } + } + return urlPrefix; +} +var watermark = 'Search'; +$(function() { + $("#search").val(''); + $("#search").prop("disabled", false); + $("#reset").prop("disabled", false); + $("#search").val(watermark).addClass('watermark'); + $("#search").blur(function() { + if ($(this).val().length == 0) { + $(this).val(watermark).addClass('watermark'); + } + }); + $("#search").on('click keydown', function() { + if ($(this).val() == watermark) { + $(this).val('').removeClass('watermark'); + } + }); + $("#reset").click(function() { + $("#search").val(''); + $("#search").focus(); + }); + $("#search").focus(); + $("#search")[0].setSelectionRange(0, 0); +}); +$.widget("custom.catcomplete", $.ui.autocomplete, { + _create: function() { + this._super(); + this.widget().menu("option", "items", "> :not(.ui-autocomplete-category)"); + }, + _renderMenu: function(ul, items) { + var rMenu = this, + currentCategory = ""; + rMenu.menu.bindings = $(); + $.each(items, function(index, item) { + var li; + if (item.l !== noResult.l && item.category !== currentCategory) { + ul.append("
  • " + item.category + "
    • "); + currentCategory = item.category; + } + li = rMenu._renderItemData(ul, item); + if (item.category) { + li.attr("aria-label", item.category + " : " + item.l); + li.attr("class", "resultItem"); + } else { + li.attr("aria-label", item.l); + li.attr("class", "resultItem"); + } + }); + }, + _renderItem: function(ul, item) { + var label = ""; + if (item.category === catModules) { + label = getHighlightedText(item.l); + } else if (item.category === catPackages) { + label = (item.m) + ? getHighlightedText(item.m + "/" + item.l) + : getHighlightedText(item.l); + } else if (item.category === catTypes) { + label = (item.p) + ? getHighlightedText(item.p + "." + item.l) + : getHighlightedText(item.l); + } else if (item.category === catMembers) { + label = getHighlightedText(item.p + "." + (item.c + "." + item.l)); + } else if (item.category === catSearchTags) { + label = getHighlightedText(item.l); + } else { + label = item.l; + } + var li = $("
  • ").appendTo(ul); + var div = $("
    ").appendTo(li); + if (item.category === catSearchTags) { + if (item.d) { + div.html(label + " (" + item.h + ")
    " + + item.d + "
    "); + } else { + div.html(label + " (" + item.h + ")"); + } + } else { + div.html(label); + } + return li; + } +}); +$(function() { + $("#search").catcomplete({ + minLength: 1, + delay: 100, + source: function(request, response) { + var result = new Array(); + var presult = new Array(); + var tresult = new Array(); + var mresult = new Array(); + var tgresult = new Array(); + var secondaryresult = new Array(); + var displayCount = 0; + var exactMatcher = new RegExp("^" + $.ui.autocomplete.escapeRegex(request.term) + "$", "i"); + camelCaseRegexp = ($.ui.autocomplete.escapeRegex(request.term)).split(/(?=[A-Z])/).join("([a-z0-9_$]*?)"); + var camelCaseMatcher = new RegExp("^" + camelCaseRegexp); + secondaryMatcher = new RegExp($.ui.autocomplete.escapeRegex(request.term), "i"); + + // Return the nested innermost name from the specified object + function nestedName(e) { + return e.l.substring(e.l.lastIndexOf(".") + 1); + } + + function concatResults(a1, a2) { + a1 = a1.concat(a2); + a2.length = 0; + return a1; + } + + if (moduleSearchIndex) { + var mdleCount = 0; + $.each(moduleSearchIndex, function(index, item) { + item.category = catModules; + if (exactMatcher.test(item.l)) { + result.push(item); + mdleCount++; + } else if (camelCaseMatcher.test(item.l)) { + result.push(item); + } else if (secondaryMatcher.test(item.l)) { + secondaryresult.push(item); + } + }); + displayCount = mdleCount; + result = concatResults(result, secondaryresult); + } + if (packageSearchIndex) { + var pCount = 0; + var pkg = ""; + $.each(packageSearchIndex, function(index, item) { + item.category = catPackages; + pkg = (item.m) + ? (item.m + "/" + item.l) + : item.l; + if (exactMatcher.test(item.l)) { + presult.push(item); + pCount++; + } else if (camelCaseMatcher.test(pkg)) { + presult.push(item); + } else if (secondaryMatcher.test(pkg)) { + secondaryresult.push(item); + } + }); + result = result.concat(concatResults(presult, secondaryresult)); + displayCount = (pCount > displayCount) ? pCount : displayCount; + } + if (typeSearchIndex) { + var tCount = 0; + $.each(typeSearchIndex, function(index, item) { + item.category = catTypes; + var s = nestedName(item); + if (exactMatcher.test(s)) { + tresult.push(item); + tCount++; + } else if (camelCaseMatcher.test(s)) { + tresult.push(item); + } else if (secondaryMatcher.test(item.p + "." + item.l)) { + secondaryresult.push(item); + } + }); + result = result.concat(concatResults(tresult, secondaryresult)); + displayCount = (tCount > displayCount) ? tCount : displayCount; + } + if (memberSearchIndex) { + var mCount = 0; + $.each(memberSearchIndex, function(index, item) { + item.category = catMembers; + var s = nestedName(item); + if (exactMatcher.test(s)) { + mresult.push(item); + mCount++; + } else if (camelCaseMatcher.test(s)) { + mresult.push(item); + } else if (secondaryMatcher.test(item.c + "." + item.l)) { + secondaryresult.push(item); + } + }); + result = result.concat(concatResults(mresult, secondaryresult)); + displayCount = (mCount > displayCount) ? mCount : displayCount; + } + if (tagSearchIndex) { + var tgCount = 0; + $.each(tagSearchIndex, function(index, item) { + item.category = catSearchTags; + if (exactMatcher.test(item.l)) { + tgresult.push(item); + tgCount++; + } else if (secondaryMatcher.test(item.l)) { + secondaryresult.push(item); + } + }); + result = result.concat(concatResults(tgresult, secondaryresult)); + displayCount = (tgCount > displayCount) ? tgCount : displayCount; + } + displayCount = (displayCount > 500) ? displayCount : 500; + var counter = function() { + var count = {Modules: 0, Packages: 0, Types: 0, Members: 0, SearchTags: 0}; + var f = function(item) { + count[item.category] += 1; + return (count[item.category] <= displayCount); + }; + return f; + }(); + response(result.filter(counter)); + }, + response: function(event, ui) { + if (!ui.content.length) { + ui.content.push(noResult); + } else { + $("#search").empty(); + } + }, + autoFocus: true, + position: { + collision: "flip" + }, + select: function(event, ui) { + if (ui.item.l !== noResult.l) { + var url = getURLPrefix(ui); + if (ui.item.category === catModules) { + if (useModuleDirectories) { + url += "module-summary.html"; + } else { + url = ui.item.l + "-summary.html"; + } + } else if (ui.item.category === catPackages) { + if (ui.item.url) { + url = ui.item.url; + } else { + url += ui.item.l.replace(/\./g, '/') + "/package-summary.html"; + } + } else if (ui.item.category === catTypes) { + if (ui.item.url) { + url = ui.item.url; + } else if (ui.item.p === "") { + url += ui.item.l + ".html"; + } else { + url += ui.item.p.replace(/\./g, '/') + "/" + ui.item.l + ".html"; + } + } else if (ui.item.category === catMembers) { + if (ui.item.p === "") { + url += ui.item.c + ".html" + "#"; + } else { + url += ui.item.p.replace(/\./g, '/') + "/" + ui.item.c + ".html" + "#"; + } + if (ui.item.url) { + url += ui.item.url; + } else { + url += ui.item.l; + } + } else if (ui.item.category === catSearchTags) { + url += ui.item.u; + } + if (top !== window) { + parent.classFrame.location = pathtoroot + url; + } else { + window.location.href = pathtoroot + url; + } + $("#search").focus(); + } + } + }); +}); diff --git a/javadoc/1.47.0/serialized-form.html b/javadoc/1.47.0/serialized-form.html new file mode 100644 index 00000000000..867cb837a92 --- /dev/null +++ b/javadoc/1.47.0/serialized-form.html @@ -0,0 +1,548 @@ + + + + + +Serialized Form (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Serialized Form

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/openapi/ApiGatewayConfig.ApiType.html b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/openapi/ApiGatewayConfig.ApiType.html new file mode 100644 index 00000000000..7e89761a8e7 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/openapi/ApiGatewayConfig.ApiType.html @@ -0,0 +1,416 @@ + + + + + +ApiGatewayConfig.ApiType (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.apigateway.openapi
    +

    Enum ApiGatewayConfig.ApiType

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Enum<ApiGatewayConfig.ApiType>
        • +
      • +
          +
        • software.amazon.smithy.aws.apigateway.openapi.ApiGatewayConfig.ApiType
          • +
        +
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        DISABLED +
        Disables API Gateway OpenAPI plugins.
        +
        HTTP +
        Generates an OpenAPI model for an API Gateway "HTTP" API.
        +
        REST +
        Generates an OpenAPI model for an API Gateway "REST" API.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static ApiGatewayConfig.ApiTypevalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static ApiGatewayConfig.ApiType[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + +
          +
        • +

          REST

          +
          public static final ApiGatewayConfig.ApiType REST
          +
          Generates an OpenAPI model for an API Gateway "REST" API. + +

          This is the default type of OpenAPI model to generate when not + specified.

          +
          +
          See Also:
          +
          REST API
          +
          +
          • +
        + + + +
          +
        • +

          HTTP

          +
          public static final ApiGatewayConfig.ApiType HTTP
          +
          Generates an OpenAPI model for an API Gateway "HTTP" API. + +

          This converter does not currently support for HTTP APIs.

          +
          +
          See Also:
          +
          HTTP API
          +
          +
          • +
        + + + + +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static ApiGatewayConfig.ApiType[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (ApiGatewayConfig.ApiType c : ApiGatewayConfig.ApiType.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static ApiGatewayConfig.ApiType valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/openapi/ApiGatewayConfig.html b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/openapi/ApiGatewayConfig.html new file mode 100644 index 00000000000..2eb03ae47bb --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/openapi/ApiGatewayConfig.html @@ -0,0 +1,488 @@ + + + + + +ApiGatewayConfig (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.apigateway.openapi
    +

    Class ApiGatewayConfig

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.apigateway.openapi.ApiGatewayConfig
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class ApiGatewayConfig
+extends java.lang.Object
      +
      API Gateway OpenAPI configuration.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ApiGatewayConfig

          +
          public ApiGatewayConfig()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getDisableCloudFormationSubstitution

          +
          public boolean getDisableCloudFormationSubstitution()
          +
          +
          Returns:
          +
          Returns true if CloudFormation substitutions are disabled.
          +
          +
          • +
        + + + +
          +
        • +

          setDisableCloudFormationSubstitution

          +
          public void setDisableCloudFormationSubstitution​(boolean disableCloudFormationSubstitution)
          +
          Disables CloudFormation substitutions of specific paths when they contain + ${} placeholders. When found, these are expanded into CloudFormation Fn::Sub + intrinsic functions.
          +
          +
          Parameters:
          +
          disableCloudFormationSubstitution - Set to true to disable intrinsics.
          +
          +
          • +
        + + + +
          +
        • +

          getApiGatewayType

          +
          public ApiGatewayConfig.ApiType getApiGatewayType()
          +
          +
          Returns:
          +
          the type of API Gateway API to generate.
          +
          +
          • +
        + + + +
          +
        • +

          setApiGatewayType

          +
          public void setApiGatewayType​(ApiGatewayConfig.ApiType apiGatewayType)
          +
          Sets the type of API Gateway API to generate. + +

          If not set, this value defaults to a "REST" API.

          +
          +
          Parameters:
          +
          apiGatewayType - API type to set.
          +
          +
          • +
        + + + +
          +
        • +

          getAdditionalAllowedCorsHeaders

          +
          @Deprecated
+public java.util.List<java.lang.String> getAdditionalAllowedCorsHeaders()
          +
          Deprecated. +
          Use getAdditionalAllowedCorsHeadersSet()
          +
          +
          • +
        + + + +
          +
        • +

          getAdditionalAllowedCorsHeadersSet

          +
          public java.util.Set<java.lang.String> getAdditionalAllowedCorsHeadersSet()
          +
          +
          Returns:
          +
          the set of additional allowed CORS headers.
          +
          +
          • +
        + + + +
          +
        • +

          setAdditionalAllowedCorsHeaders

          +
          public void setAdditionalAllowedCorsHeaders​(java.util.Collection<java.lang.String> additionalAllowedCorsHeaders)
          +
          Sets the additional allowed CORS headers.
          +
          +
          Parameters:
          +
          additionalAllowedCorsHeaders - additional cors headers to be allowed.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          setApiGatewayDefaults

          +
          public void setApiGatewayDefaults​(ApiGatewayDefaults apiGatewayDefaults)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/openapi/ApiGatewayDefaults.html b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/openapi/ApiGatewayDefaults.html new file mode 100644 index 00000000000..23a19d0441c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/openapi/ApiGatewayDefaults.html @@ -0,0 +1,408 @@ + + + + + +ApiGatewayDefaults (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.apigateway.openapi
    +

    Enum ApiGatewayDefaults

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Enum<ApiGatewayDefaults>
        • +
      • +
          +
        • software.amazon.smithy.aws.apigateway.openapi.ApiGatewayDefaults
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable, java.lang.Comparable<ApiGatewayDefaults>
      +
      +
      +
      public enum ApiGatewayDefaults
+extends java.lang.Enum<ApiGatewayDefaults>
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
        Modifier and TypeMethodDescription
        abstract voidsetDefaults​(OpenApiConfig config) 
        java.lang.StringtoString() 
        static ApiGatewayDefaultsvalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static ApiGatewayDefaults[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static ApiGatewayDefaults[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (ApiGatewayDefaults c : ApiGatewayDefaults.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static ApiGatewayDefaults valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Enum<ApiGatewayDefaults>
          +
          +
          • +
        + + + +
          +
        • +

          setDefaults

          +
          public abstract void setDefaults​(OpenApiConfig config)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/openapi/ApiGatewayExtension.html b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/openapi/ApiGatewayExtension.html new file mode 100644 index 00000000000..5da0bc5ae28 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/openapi/ApiGatewayExtension.html @@ -0,0 +1,352 @@ + + + + + +ApiGatewayExtension (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.apigateway.openapi
    +

    Class ApiGatewayExtension

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.apigateway.openapi.ApiGatewayExtension
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/openapi/ApiGatewayMapper.html b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/openapi/ApiGatewayMapper.html new file mode 100644 index 00000000000..726b65a1404 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/openapi/ApiGatewayMapper.html @@ -0,0 +1,305 @@ + + + + + +ApiGatewayMapper (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.apigateway.openapi
    +

    Interface ApiGatewayMapper

    +
    +
    +
    +
      +
    • +
      +
      All Superinterfaces:
      +
      OpenApiMapper
      +
      +
      +
      All Known Implementing Classes:
      +
      CorsHttpIntegration
      +
      +
      +
      public interface ApiGatewayMapper
+extends OpenApiMapper
      +
      An API Gateway mapper that only applies when the type of API being + converted matches the types of APIs handled by the mapper.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getApiTypes

          +
          java.util.List<ApiGatewayConfig.ApiType> getApiTypes()
          +
          Gets the types of API Gateway APIs that this mapper applies to. + +

          Return an empty list or null to apply to all possible API types + other than ApiGatewayConfig.ApiType.DISABLED. However, note + that it's typically safer to specify the exact API types that the + mapper supports.

          +
          +
          Returns:
          +
          Returns the list of API Gateway API types to apply to.
          +
          +
          • +
        + + + +
          +
        • +

          wrap

          +
          static OpenApiMapper wrap​(ApiGatewayMapper delegate)
          +
          Wraps and delegates to an ApiGatewayMapper IFF the configured + ApiGatewayConfig.ApiType matches the types of APIs that the + wrapped mapper applies to.
          +
          +
          Parameters:
          +
          delegate - Mapper to delegate to when it applies to the configured API type.
          +
          Returns:
          +
          Returns the wrapped mapper.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/openapi/CorsHttpIntegration.html b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/openapi/CorsHttpIntegration.html new file mode 100644 index 00000000000..98caee07665 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/openapi/CorsHttpIntegration.html @@ -0,0 +1,391 @@ + + + + + +CorsHttpIntegration (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.apigateway.openapi
    +

    Class CorsHttpIntegration

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.apigateway.openapi.CorsHttpIntegration
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ApiGatewayMapper, OpenApiMapper
      +
      +
      +
      public final class CorsHttpIntegration
+extends java.lang.Object
+implements ApiGatewayMapper
      +
      Adds support for the API Gateway x-amazon-apigateway-cors + extension for API Gateway HTTP APIs using values from the + Smithy cors trait. + +
        +
      • allowOrigins is populated based on the origin + property of the cors trait.
        • +
      • maxAge is populated based on the maxAge + property of the cors trait.
        • +
      • allowMethods is populated by scanning the generated + OpenAPI definition for every defined method.
        • +
      • exposedHeaders is set to "*" to expose all headers IFF + the service does not use HTTP credentials, and no value is provided + to the additionalExposedHeaders property of the Smithy + cors trait. Otherwise, this value is populated by finding + all of the response headers used by the protocol, modeled in the + service, and used by auth schemes.
        • +
      • allowedHeaders is set to "*" to allow all headers IFF + the service does not use HTTP credentials, and no value is provided + to the additionalAllowedHeaders property of the Smithy + cors trait. Otherwise, this value is populated by finding + all of the request headers used by the protocol, modeled in the + service, and used by auth schemes.
        • +
      • allowCredentials is set to true if any of the + auth schemes used in the API use HTTP credentials according + to Context.usesHttpCredentials().
        • +
      +
      +
      See Also:
      +
      API Gateway documentation
      +
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CorsHttpIntegration

          +
          public CorsHttpIntegration()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getApiTypes

          +
          public java.util.List<ApiGatewayConfig.ApiType> getApiTypes()
          +
          Description copied from interface: ApiGatewayMapper
          +
          Gets the types of API Gateway APIs that this mapper applies to. + +

          Return an empty list or null to apply to all possible API types + other than ApiGatewayConfig.ApiType.DISABLED. However, note + that it's typically safer to specify the exact API types that the + mapper supports.

          +
          +
          Specified by:
          +
          getApiTypes in interface ApiGatewayMapper
          +
          Returns:
          +
          Returns the list of API Gateway API types to apply to.
          +
          +
          • +
        + + + +
          +
        • +

          after

          +
          public OpenApi after​(Context<? extends Trait> context,
+                     OpenApi openapi)
          +
          Description copied from interface: OpenApiMapper
          +
          Updates an OpenApi object after it is built.
          +
          +
          Specified by:
          +
          after in interface OpenApiMapper
          +
          Parameters:
          +
          context - Conversion context.
          +
          openapi - OpenAPI object to modify.
          +
          Returns:
          +
          Returns the updated OpenApi object.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/openapi/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/openapi/package-summary.html new file mode 100644 index 00000000000..8023c82bc41 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/openapi/package-summary.html @@ -0,0 +1,217 @@ + + + + + +software.amazon.smithy.aws.apigateway.openapi (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.aws.apigateway.openapi

    +
    +
    +
      +
    • + + + + + + + + + + + + +
      Interface Summary 
      InterfaceDescription
      ApiGatewayMapper +
      An API Gateway mapper that only applies when the type of API being + converted matches the types of APIs handled by the mapper.
      +
      +
      • +
    • + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      ApiGatewayConfig +
      API Gateway OpenAPI configuration.
      +
      ApiGatewayExtension 
      CorsHttpIntegration +
      Adds support for the API Gateway x-amazon-apigateway-cors + extension for API Gateway HTTP APIs using values from the + Smithy cors trait.
      +
      +
      • +
    • + + + + + + + + + + + + + + + + +
      Enum Summary 
      EnumDescription
      ApiGatewayConfig.ApiType +
      The type of API Gateway service to generate.
      +
      ApiGatewayDefaults 
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/openapi/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/openapi/package-tree.html new file mode 100644 index 00000000000..40cbdd9965e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/openapi/package-tree.html @@ -0,0 +1,188 @@ + + + + + +software.amazon.smithy.aws.apigateway.openapi Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.aws.apigateway.openapi

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +

    Enum Hierarchy

    +
      +
    • java.lang.Object +
        +
      • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
        • +
      +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/ApiKeySourceTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/ApiKeySourceTrait.Provider.html new file mode 100644 index 00000000000..e31f4ce1d9d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/ApiKeySourceTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +ApiKeySourceTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.apigateway.traits
    +

    Class ApiKeySourceTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/ApiKeySourceTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/ApiKeySourceTrait.html new file mode 100644 index 00000000000..130de29fcf5 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/ApiKeySourceTrait.html @@ -0,0 +1,381 @@ + + + + + +ApiKeySourceTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.apigateway.traits
    +

    Class ApiKeySourceTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ApiKeySourceTrait

          +
          public ApiKeySourceTrait​(java.lang.String value,
+                         FromSourceLocation sourceLocation)
          +
          • +
        + + + +
          +
        • +

          ApiKeySourceTrait

          +
          public ApiKeySourceTrait​(java.lang.String value)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/AuthorizerDefinition.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/AuthorizerDefinition.Builder.html new file mode 100644 index 00000000000..8ed814b1833 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/AuthorizerDefinition.Builder.html @@ -0,0 +1,583 @@ + + + + + +AuthorizerDefinition.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.apigateway.traits
    +

    Class AuthorizerDefinition.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.apigateway.traits.AuthorizerDefinition.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          scheme

          +
          public AuthorizerDefinition.Builder scheme​(ShapeId scheme)
          +
          Sets the client authentication scheme name.
          +
          +
          Parameters:
          +
          scheme - Client authentication scheme.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          type

          +
          public AuthorizerDefinition.Builder type​(java.lang.String type)
          +
          Sets the type of the authorizer. + +

          If specifying information beyond the scheme, this value is + required. The value must be "token", for an authorizer with the + caller identity embedded in an authorization token, or "request", + for an authorizer with the caller identity contained in request + parameters.

          +
          +
          Parameters:
          +
          type - authorizer type.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          customAuthType

          +
          public AuthorizerDefinition.Builder customAuthType​(java.lang.String customAuthType)
          +
          Sets the customAuthType of the authorizer. + +

          This value is not used directly by APIGateway but will be used + for OpenAPI exports. This will default to "awsSigV4" if your scheme + is "aws.v4", or "custom" otherwise.

          +
          +
          Parameters:
          +
          customAuthType - the auth type (e.g. awsSigV4)
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          uri

          +
          public AuthorizerDefinition.Builder uri​(java.lang.String uri)
          +
          Sets the Uniform Resource Identifier (URI) of the authorizer + Lambda function. + +

          The syntax is as follows:

          +
          +
          Parameters:
          +
          uri - the Lambda URI to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          credentials

          +
          public AuthorizerDefinition.Builder credentials​(java.lang.String credentials)
          +
          Sets the Credentials required for invoking the authorizer, if any, in + the form of an ARN of an IAM execution role. + +

          For example, "arn:aws:iam::account-id:IAM_role".

          +
          +
          Parameters:
          +
          credentials - Credentials ARN to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          identitySource

          +
          public AuthorizerDefinition.Builder identitySource​(java.lang.String identitySource)
          +
          Sets the comma-separated list of mapping expressions of the request + parameters as the identity source. + +

          This property is only applicable for the authorizer of the + "request" type only.

          +
          +
          Parameters:
          +
          identitySource - Identity source CSV to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          identityValidationExpression

          +
          public AuthorizerDefinition.Builder identityValidationExpression​(java.lang.String identityValidationExpression)
          +
          Sets the regular expression for validating the token as the incoming + identity. For example, "^x-[a-z]+".
          +
          +
          Parameters:
          +
          identityValidationExpression - Expression to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          resultTtlInSeconds

          +
          public AuthorizerDefinition.Builder resultTtlInSeconds​(java.lang.Integer resultTtlInSeconds)
          +
          Sets the number of seconds during which the resulting IAM policy + is cached.
          +
          +
          Parameters:
          +
          resultTtlInSeconds - Number of seconds to cache.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          authorizerPayloadFormatVersion

          +
          public AuthorizerDefinition.Builder authorizerPayloadFormatVersion​(java.lang.String authorizerPayloadFormatVersion)
          +
          Sets the format of the payload returned by the authorizer.
          +
          +
          Parameters:
          +
          authorizerPayloadFormatVersion - format of the payload.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          enableSimpleResponses

          +
          public AuthorizerDefinition.Builder enableSimpleResponses​(java.lang.Boolean enableSimpleResponses)
          +
          Sets whether the authorizer returns simple responses.
          +
          +
          Parameters:
          +
          enableSimpleResponses - defines if authorizer should return simple responses.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/AuthorizerDefinition.html b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/AuthorizerDefinition.html new file mode 100644 index 00000000000..152d9fdc6eb --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/AuthorizerDefinition.html @@ -0,0 +1,628 @@ + + + + + +AuthorizerDefinition (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.apigateway.traits
    +

    Class AuthorizerDefinition

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.apigateway.traits.AuthorizerDefinition
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static AuthorizerDefinition.Builderbuilder() +
        Creates a builder for an Authorizer.
        +
        booleanequals​(java.lang.Object o) 
        java.util.Optional<java.lang.String>getAuthorizerPayloadFormatVersion() +
        Gets the format of the payload returned by the authorizer.
        +
        java.util.Optional<java.lang.String>getCredentials() +
        Gets the Credentials required for invoking the authorizer, if any, in + the form of an ARN of an IAM execution role.
        +
        java.util.Optional<java.lang.String>getCustomAuthType() +
        Gets the customAuthType of the authorizer.
        +
        java.util.Optional<java.lang.Boolean>getEnableSimpleResponses() +
        Gets whether the authorizer returns simple responses.
        +
        java.util.Optional<java.lang.String>getIdentitySource() +
        Gets the comma-separated list of mapping expressions of the request + parameters as the identity source.
        +
        java.util.Optional<java.lang.String>getIdentityValidationExpression() +
        Gets the regular expression for validating the token as the incoming + identity.
        +
        java.util.Optional<java.lang.Integer>getResultTtlInSeconds() +
        Gets the number of seconds during which the resulting IAM policy + is cached.
        +
        ShapeIdgetScheme() +
        Gets the Smithy scheme used as the client authentication type.
        +
        java.util.Optional<java.lang.String>getType() +
        Gets the type of the authorizer.
        +
        java.util.Optional<java.lang.String>getUri() +
        Gets the Uniform Resource Identifier (URI) of the authorizer + Lambda function.
        +
        inthashCode() 
        AuthorizerDefinition.BuildertoBuilder() +
        Take this object and create a builder that contains all of the + current property values of this object.
        +
        NodetoNode() +
        Converts a value to a Node.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          builder

          +
          public static AuthorizerDefinition.Builder builder()
          +
          Creates a builder for an Authorizer.
          +
          +
          Returns:
          +
          Returns the created builder.
          +
          +
          • +
        + + + +
          +
        • +

          getScheme

          +
          public ShapeId getScheme()
          +
          Gets the Smithy scheme used as the client authentication type.
          +
          +
          Returns:
          +
          Returns the defined client authentication type.
          +
          +
          • +
        + + + +
          +
        • +

          getType

          +
          public java.util.Optional<java.lang.String> getType()
          +
          Gets the type of the authorizer. + +

          If specifying information beyond the scheme, this value is + required. The value must be "token", for an authorizer with the + caller identity embedded in an authorization token, or "request", + for an authorizer with the caller identity contained in request + parameters.

          +
          +
          Returns:
          +
          Returns the optional authorizer type.
          +
          +
          • +
        + + + +
          +
        • +

          getUri

          +
          public java.util.Optional<java.lang.String> getUri()
          +
          Gets the Uniform Resource Identifier (URI) of the authorizer + Lambda function.
          +
          +
          Returns:
          +
          Returns the optional Lambda URI.
          +
          +
          • +
        + + + +
          +
        • +

          getCustomAuthType

          +
          public java.util.Optional<java.lang.String> getCustomAuthType()
          +
          Gets the customAuthType of the authorizer. + +

          This value is not used directly by APIGateway but will be used for + OpenAPI exports. This will default to "awsSigV4" if your scheme is + aws.auth#sigv4.

          +
          +
          Returns:
          +
          Returns the customAuthType.
          +
          +
          • +
        + + + +
          +
        • +

          getCredentials

          +
          public java.util.Optional<java.lang.String> getCredentials()
          +
          Gets the Credentials required for invoking the authorizer, if any, in + the form of an ARN of an IAM execution role. + +

          For example, "arn:aws:iam::account-id:IAM_role".

          +
          +
          Returns:
          +
          Returns the optional credential ARN.
          +
          +
          • +
        + + + +
          +
        • +

          getIdentitySource

          +
          public java.util.Optional<java.lang.String> getIdentitySource()
          +
          Gets the comma-separated list of mapping expressions of the request + parameters as the identity source. + +

          This property is only applicable for the authorizer of the + "request" type only.

          +
          +
          Returns:
          +
          Returns the optional identity source string.
          +
          +
          • +
        + + + +
          +
        • +

          getIdentityValidationExpression

          +
          public java.util.Optional<java.lang.String> getIdentityValidationExpression()
          +
          Gets the regular expression for validating the token as the incoming + identity. For example, "^x-[a-z]+".
          +
          +
          Returns:
          +
          Returns the identity regular expression.
          +
          +
          • +
        + + + +
          +
        • +

          getResultTtlInSeconds

          +
          public java.util.Optional<java.lang.Integer> getResultTtlInSeconds()
          +
          Gets the number of seconds during which the resulting IAM policy + is cached.
          +
          +
          Returns:
          +
          Returns the cache amount in seconds.
          +
          +
          • +
        + + + +
          +
        • +

          getAuthorizerPayloadFormatVersion

          +
          public java.util.Optional<java.lang.String> getAuthorizerPayloadFormatVersion()
          +
          Gets the format of the payload returned by the authorizer.
          +
          +
          Returns:
          +
          Returns payload type.
          +
          +
          • +
        + + + +
          +
        • +

          getEnableSimpleResponses

          +
          public java.util.Optional<java.lang.Boolean> getEnableSimpleResponses()
          +
          Gets whether the authorizer returns simple responses.
          +
          +
          Returns:
          +
          Returns true if authorizer returns a boolean, + false if it returns an IAM policy.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/AuthorizerIndex.html b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/AuthorizerIndex.html new file mode 100644 index 00000000000..5e39cbfc7f1 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/AuthorizerIndex.html @@ -0,0 +1,415 @@ + + + + + +AuthorizerIndex (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.apigateway.traits
    +

    Class AuthorizerIndex

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.apigateway.traits.AuthorizerIndex
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      KnowledgeIndex
      +
      +
      +
      public final class AuthorizerIndex
+extends java.lang.Object
+implements KnowledgeIndex
      +
      Computes the effective authorizers of each resource and + operation in a service. + +

      An effective authorizer of an operation first checks if the + operation has the authorizer trait, then the resource an operation + is bound to, then the service.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          AuthorizerIndex

          +
          public AuthorizerIndex​(Model model)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getAuthorizer

          +
          public java.util.Optional<java.lang.String> getAuthorizer​(ToShapeId service,
+                                                          ToShapeId shape)
          +
          Gets the effective authorizer name of a specific resource or operation + within a service.
          +
          +
          Parameters:
          +
          service - Service shape to query.
          +
          shape - Resource or operation shape ID to query.
          +
          Returns:
          +
          Returns the optionally resolved authorizer name.
          +
          +
          • +
        + + + +
          +
        • +

          getAuthorizer

          +
          public java.util.Optional<java.lang.String> getAuthorizer​(ToShapeId service)
          +
          Gets the effective authorizer name of a service.
          +
          +
          Parameters:
          +
          service - Service shape to query.
          +
          Returns:
          +
          Returns the optionally resolved authorizer name.
          +
          +
          • +
        + + + +
          +
        • +

          getAuthorizerValue

          +
          public java.util.Optional<AuthorizerDefinition> getAuthorizerValue​(ToShapeId service)
          +
          Gets the effective authorizer structure value of a service.
          +
          +
          Parameters:
          +
          service - Service shape to query.
          +
          Returns:
          +
          Returns the optionally resolved authorizer name.
          +
          +
          • +
        + + + +
          +
        • +

          getAuthorizerValue

          +
          public java.util.Optional<AuthorizerDefinition> getAuthorizerValue​(ToShapeId service,
+                                                                   ToShapeId shape)
          +
          Gets the effective authorizer structure value of a shape in a service.
          +
          +
          Parameters:
          +
          service - Service shape to query.
          +
          shape - Shape to get the authorizer of within the service.
          +
          Returns:
          +
          Returns the optionally resolved authorizer name.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/AuthorizerTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/AuthorizerTrait.Provider.html new file mode 100644 index 00000000000..23c61b1064e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/AuthorizerTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +AuthorizerTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.apigateway.traits
    +

    Class AuthorizerTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/AuthorizerTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/AuthorizerTrait.html new file mode 100644 index 00000000000..19bbb25dfde --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/AuthorizerTrait.html @@ -0,0 +1,382 @@ + + + + + +AuthorizerTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.apigateway.traits
    +

    Class AuthorizerTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          AuthorizerTrait

          +
          public AuthorizerTrait​(java.lang.String value,
+                       SourceLocation sourceLocation)
          +
          • +
        + + + +
          +
        • +

          AuthorizerTrait

          +
          public AuthorizerTrait​(java.lang.String value)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/AuthorizersTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/AuthorizersTrait.Builder.html new file mode 100644 index 00000000000..238893a0c06 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/AuthorizersTrait.Builder.html @@ -0,0 +1,428 @@ + + + + + +AuthorizersTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.apigateway.traits
    +

    Class AuthorizersTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public AuthorizersTrait build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        + + + +
          +
        • +

          putAuthorizer

          +
          public AuthorizersTrait.Builder putAuthorizer​(java.lang.String name,
+                                              AuthorizerDefinition authorizer)
          +
          Adds an authorizer.
          +
          +
          Parameters:
          +
          name - Name of the authorizer to add.
          +
          authorizer - Authorizer definition.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          authorizers

          +
          public AuthorizersTrait.Builder authorizers​(java.util.Map<java.lang.String,​AuthorizerDefinition> authorizers)
          +
          Replaces all of the authorizers with the given map.
          +
          +
          Parameters:
          +
          authorizers - Map of authorizer names to their definitions.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          removeAuthorizer

          +
          public AuthorizersTrait.Builder removeAuthorizer​(java.lang.String name)
          +
          Removes an authorizer by name.
          +
          +
          Parameters:
          +
          name - Name of the authorizer to remove.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          clearAuthorizers

          +
          public AuthorizersTrait.Builder clearAuthorizers()
          +
          Clears all of the authorizers in the builder.
          +
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/AuthorizersTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/AuthorizersTrait.Provider.html new file mode 100644 index 00000000000..16205e446be --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/AuthorizersTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +AuthorizersTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.apigateway.traits
    +

    Class AuthorizersTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/AuthorizersTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/AuthorizersTrait.html new file mode 100644 index 00000000000..8c1f5028eff --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/AuthorizersTrait.html @@ -0,0 +1,477 @@ + + + + + +AuthorizersTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.apigateway.traits
    +

    Class AuthorizersTrait

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      FromSourceLocation, ToNode, ToShapeId, Trait, ToSmithyBuilder<AuthorizersTrait>
      +
      +
      +
      public final class AuthorizersTrait
+extends AbstractTrait
+implements ToSmithyBuilder<AuthorizersTrait>
      +
      Defines a map of API Gateway x-amazon-apigateway-authorizer + values that correspond to Smithy authorization definitions. + +

      The key in each key-value pair of the aws.apigateway#authorizers + trait is an arbitrary name that's used to associate authorizer definitions + to operations. The scheme property of an authorizer must correspond + to the name of an authorization scheme of the service the trait is bound to. + When used to generate and OpenAPI model, the aws.apigateway#authorizers + trait is used to add the x-amazon-apigateway-authorizer OpenAPI + extension to the generated security scheme.

      +
      +
      See Also:
      +
      API Gateway Authorizers
      +
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          builder

          +
          public static AuthorizersTrait.Builder builder()
          +
          Creates a builder for the trait.
          +
          +
          Returns:
          +
          Returns the created builder.
          +
          +
          • +
        + + + +
          +
        • +

          getAuthorizer

          +
          public java.util.Optional<AuthorizerDefinition> getAuthorizer​(java.lang.String name)
          +
          Gets a specific authorizer by name.
          +
          +
          Parameters:
          +
          name - Name of the authorizer to get.
          +
          Returns:
          +
          Returns the optionally found authorizer.
          +
          +
          • +
        + + + +
          +
        • +

          getAuthorizers

          +
          public java.util.Map<java.lang.String,​AuthorizerDefinition> getAuthorizers()
          +
          Gets an immutable map of authorizer names to their definitions.
          +
          +
          Returns:
          +
          Returns the authorizers.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          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.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/AuthorizersTraitValidator.html b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/AuthorizersTraitValidator.html new file mode 100644 index 00000000000..cba51f0450a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/AuthorizersTraitValidator.html @@ -0,0 +1,348 @@ + + + + + +AuthorizersTraitValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.apigateway.traits
    +

    Class AuthorizersTraitValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class AuthorizersTraitValidator
+extends AbstractValidator
      +
      Validates if authorizers traits are well-defined.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          AuthorizersTraitValidator

          +
          public AuthorizersTraitValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/IntegrationResponse.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/IntegrationResponse.Builder.html new file mode 100644 index 00000000000..9f290226e1e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/IntegrationResponse.Builder.html @@ -0,0 +1,528 @@ + + + + + +IntegrationResponse.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.apigateway.traits
    +

    Class IntegrationResponse.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.apigateway.traits.IntegrationResponse.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + + + + + +
          +
        • +

          responseTemplates

          +
          public IntegrationResponse.Builder responseTemplates​(java.util.Map<java.lang.String,​java.lang.String> responseTemplates)
          +
          Sets a mapping of response MIME types to templates.
          +
          +
          Parameters:
          +
          responseTemplates - Map of MIME types to response templates.
          +
          Returns:
          +
          Returns the builder.
          +
          See Also:
          +
          IntegrationResponse.getResponseTemplates()
          +
          +
          • +
        + + + +
          +
        • +

          putResponseTemplate

          +
          public IntegrationResponse.Builder putResponseTemplate​(java.lang.String mimeType,
+                                                       java.lang.String template)
          +
          Adds a response template for a MIME type.
          +
          +
          Parameters:
          +
          mimeType - MIME type of the response template.
          +
          template - Response template for the payload.
          +
          Returns:
          +
          Returns the builder.
          +
          See Also:
          +
          IntegrationResponse.getResponseTemplates()
          +
          +
          • +
        + + + +
          +
        • +

          removeResponseTemplate

          +
          public IntegrationResponse.Builder removeResponseTemplate​(java.lang.String mimeType)
          +
          Remove a response template for a given MIME type.
          +
          +
          Parameters:
          +
          mimeType - MIME type to remove.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          responseParameters

          +
          public IntegrationResponse.Builder responseParameters​(java.util.Map<java.lang.String,​java.lang.String> responseParameters)
          +
          Sets response parameter mappings.
          +
          +
          Parameters:
          +
          responseParameters - Map of response expressions to expressions to apply to response.
          +
          Returns:
          +
          Returns the builder.
          +
          See Also:
          +
          IntegrationResponse.getResponseParameters()
          +
          +
          • +
        + + + +
          +
        • +

          putResponseParameter

          +
          public IntegrationResponse.Builder putResponseParameter​(java.lang.String name,
+                                                        java.lang.String value)
          +
          Sets a response parameter mapping.
          +
          +
          Parameters:
          +
          name - Name of the expression to extract.
          +
          value - Expression used to apply in the response.
          +
          Returns:
          +
          Returns the builder.
          +
          See Also:
          +
          IntegrationResponse.getResponseParameters()
          +
          +
          • +
        + + + +
          +
        • +

          removeResponseParameter

          +
          public IntegrationResponse.Builder removeResponseParameter​(java.lang.String name)
          +
          Removes a response parameter mapping.
          +
          +
          Parameters:
          +
          name - Expression to remove.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/IntegrationResponse.html b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/IntegrationResponse.html new file mode 100644 index 00000000000..f668441ba93 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/IntegrationResponse.html @@ -0,0 +1,531 @@ + + + + + +IntegrationResponse (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.apigateway.traits
    +

    Class IntegrationResponse

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.apigateway.traits.IntegrationResponse
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static IntegrationResponse.Builderbuilder() +
        Creates a builder used to build an IntegrationResponse.
        +
        booleanequals​(java.lang.Object o) 
        java.util.Optional<java.lang.String>getContentHandling() +
        Gets the response payload content handling type.
        +
        java.util.Optional<java.lang.String>getResponseParameter​(java.lang.String name) +
        Gets a specific response parameter by it's input mapping expression.
        +
        java.util.Map<java.lang.String,​java.lang.String>getResponseParameters() +
        Gets response parameters.
        +
        java.util.Optional<java.lang.String>getResponseTemplate​(java.lang.String mimeType) +
        Gets a specific response template by MIME type.
        +
        java.util.Map<java.lang.String,​java.lang.String>getResponseTemplates() +
        Gets a map of MIME types to mapping templates for the response payload.
        +
        java.lang.StringgetStatusCode() +
        Gets the status code of the response.
        +
        inthashCode() 
        IntegrationResponse.BuildertoBuilder() +
        Take this object and create a builder that contains all of the + current property values of this object.
        +
        NodetoNode() +
        Converts a value to a Node.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          builder

          +
          public static IntegrationResponse.Builder builder()
          +
          Creates a builder used to build an IntegrationResponse.
          +
          +
          Returns:
          +
          Returns the created builder.
          +
          +
          • +
        + + + +
          +
        • +

          getStatusCode

          +
          public java.lang.String getStatusCode()
          +
          Gets the status code of the response.
          +
          +
          Returns:
          +
          Returns the status code.
          +
          +
          • +
        + + + +
          +
        • +

          getContentHandling

          +
          public java.util.Optional<java.lang.String> getContentHandling()
          +
          Gets the response payload content handling type. + +

          Valid values are 1) CONVERT_TO_TEXT, for converting a binary payload + into a Base64-encoded string or converting a text payload into a + utf-8-encoded string or passing through the text payload natively + without modification, and 2) CONVERT_TO_BINARY, for converting a text + payload into Base64-decoded blob or passing through a binary payload + natively without modification.

          +
          +
          Returns:
          +
          Returns the content handling type.
          +
          +
          • +
        + + + +
          +
        • +

          getResponseTemplates

          +
          public java.util.Map<java.lang.String,​java.lang.String> getResponseTemplates()
          +
          Gets a map of MIME types to mapping templates for the response payload.
          +
          +
          Returns:
          +
          Returns the immutable map.
          +
          +
          • +
        + + + +
          +
        • +

          getResponseTemplate

          +
          public java.util.Optional<java.lang.String> getResponseTemplate​(java.lang.String mimeType)
          +
          Gets a specific response template by MIME type.
          +
          +
          Parameters:
          +
          mimeType - Response template MIME type.
          +
          Returns:
          +
          Returns the optionally found response template.
          +
          +
          • +
        + + + +
          +
        • +

          getResponseParameters

          +
          public java.util.Map<java.lang.String,​java.lang.String> getResponseParameters()
          +
          Gets response parameters.
          +
          +
          Returns:
          +
          Returns the map of parameter expressions to how they modify the response.
          +
          See Also:
          +
          Response parameters
          +
          +
          • +
        + + + +
          +
        • +

          getResponseParameter

          +
          public java.util.Optional<java.lang.String> getResponseParameter​(java.lang.String name)
          +
          Gets a specific response parameter by it's input mapping expression.
          +
          +
          Parameters:
          +
          name - Header name to retrieve.
          +
          Returns:
          +
          Returns the optionally found response parameter.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/IntegrationTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/IntegrationTrait.Builder.html new file mode 100644 index 00000000000..f7f4bd312cc --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/IntegrationTrait.Builder.html @@ -0,0 +1,922 @@ + + + + + +IntegrationTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.apigateway.traits
    +

    Class IntegrationTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public IntegrationTrait build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        + + + +
          +
        • +

          type

          +
          public IntegrationTrait.Builder type​(java.lang.String type)
          +
          Sets the integration type.
          +
          +
          Parameters:
          +
          type - Type to set (aws, aws_proxy, http, http_proxy).
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          uri

          +
          public IntegrationTrait.Builder uri​(java.lang.String uri)
          +
          Sets the URI of the integration endpoint.
          +
          +
          Parameters:
          +
          uri - The URI of the integration.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          credentials

          +
          public IntegrationTrait.Builder credentials​(java.lang.String credentials)
          +
          Specifies the credentials used by the integration, if any.
          +
          +
          Parameters:
          +
          credentials - Credentials to use.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          httpMethod

          +
          public IntegrationTrait.Builder httpMethod​(java.lang.String httpMethod)
          +
          Specifies the integration's HTTP method type.
          +
          +
          Parameters:
          +
          httpMethod - HTTP method to use.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          passThroughBehavior

          +
          public IntegrationTrait.Builder passThroughBehavior​(java.lang.String passThroughBehavior)
          +
          Configures the pass through behavior of the integration.
          +
          +
          Parameters:
          +
          passThroughBehavior - Pass through behavior setting.
          +
          Returns:
          +
          Returns the builder.
          +
          See Also:
          +
          IntegrationTrait.getPassThroughBehavior()
          +
          +
          • +
        + + + +
          +
        • +

          contentHandling

          +
          public IntegrationTrait.Builder contentHandling​(java.lang.String contentHandling)
          +
          Set the Request payload encoding conversion types. + +

          Valid values are: + +

            +
          • CONVERT_TO_TEXT, for converting a binary payload into a + Base64-encoded string or converting a text payload into a + utf-8-encoded string or passing through the text payload natively + without modification
            • +
          • CONVERT_TO_BINARY, for converting a text payload into + Base64-decoded blob or passing through a binary payload natively + without modification.
            • +
          +
          +
          Parameters:
          +
          contentHandling - Content handling property.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          timeoutInMillis

          +
          public IntegrationTrait.Builder timeoutInMillis​(java.lang.Integer timeoutInMillis)
          +
          Set the timeout in milliseconds. + +

          Integration timeouts between 50 ms and 29,000 ms. The default + setting used by API Gateway is 29,000 (or, 29 seconds).

          +
          +
          Parameters:
          +
          timeoutInMillis - Timeout in milliseconds.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          connectionId

          +
          public IntegrationTrait.Builder connectionId​(java.lang.String connectionId)
          +
          Sets the ID of a VpcLink when using a private integration.
          +
          +
          Parameters:
          +
          connectionId - VPC link ID.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          connectionType

          +
          public IntegrationTrait.Builder connectionType​(java.lang.String connectionType)
          +
          Sets the connection type.
          +
          +
          Parameters:
          +
          connectionType - Connection type to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          cacheNamespace

          +
          public IntegrationTrait.Builder cacheNamespace​(java.lang.String cacheNamespace)
          +
          Set an API-specific tag group of related cached parameters.
          +
          +
          Parameters:
          +
          cacheNamespace - Cache namespace to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          payloadFormatVersion

          +
          public IntegrationTrait.Builder payloadFormatVersion​(java.lang.String payloadFormatVersion)
          +
          Sets the payload format version. Required for HTTP APIs.
          +
          +
          Parameters:
          +
          payloadFormatVersion - Payload format version to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          addCacheKeyParameter

          +
          public IntegrationTrait.Builder addCacheKeyParameter​(java.lang.String cacheKeyParameter)
          +
          Adds a cache key parameter.
          +
          +
          Parameters:
          +
          cacheKeyParameter - Parameter to add.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          cacheKeyParameters

          +
          public IntegrationTrait.Builder cacheKeyParameters​(java.util.List<java.lang.String> cacheKeyParameters)
          +
          Sets a list of request parameters whose values are to be cached.
          +
          +
          Parameters:
          +
          cacheKeyParameters - Parameters to use in the cache.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          removeCacheKeyParameter

          +
          public IntegrationTrait.Builder removeCacheKeyParameter​(java.lang.String cacheKeyParameter)
          +
          Removes a specific cache key parameter.
          +
          +
          Parameters:
          +
          cacheKeyParameter - Parameter to remove.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          clearCacheKeyParameters

          +
          public IntegrationTrait.Builder clearCacheKeyParameters()
          +
          Clears all cache key parameters.
          +
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          putRequestParameter

          +
          public IntegrationTrait.Builder putRequestParameter​(java.lang.String input,
+                                                    java.lang.String output)
          +
          Adds a request parameter.
          +
          +
          Parameters:
          +
          input - Input request expression.
          +
          output - Output request expression.
          +
          Returns:
          +
          Returns the builder.
          +
          See Also:
          +
          IntegrationTrait.getRequestParameters()
          +
          +
          • +
        + + + +
          +
        • +

          requestParameters

          +
          public IntegrationTrait.Builder requestParameters​(java.util.Map<java.lang.String,​java.lang.String> requestParameters)
          +
          Sets request parameters.
          +
          +
          Parameters:
          +
          requestParameters - Map of parameters to add.
          +
          Returns:
          +
          Returns the builder.
          +
          See Also:
          +
          IntegrationTrait.getRequestParameters()
          +
          +
          • +
        + + + +
          +
        • +

          removeRequestParameter

          +
          public IntegrationTrait.Builder removeRequestParameter​(java.lang.String expression)
          +
          Remove a request parameter by expression.
          +
          +
          Parameters:
          +
          expression - Expression to remove.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          putRequestTemplate

          +
          public IntegrationTrait.Builder putRequestTemplate​(java.lang.String mimeType,
+                                                   java.lang.String template)
          +
          Adds a request template.
          +
          +
          Parameters:
          +
          mimeType - MIME type of the request template to set.
          +
          template - Request template to set.
          +
          Returns:
          +
          Returns the builder.
          +
          See Also:
          +
          IntegrationTrait.getRequestTemplates()
          +
          +
          • +
        + + + +
          +
        • +

          requestTemplates

          +
          public IntegrationTrait.Builder requestTemplates​(java.util.Map<java.lang.String,​java.lang.String> requestTemplates)
          +
          Sets request templates.
          +
          +
          Parameters:
          +
          requestTemplates - Map of MIME types to the corresponding template.
          +
          Returns:
          +
          Returns the builder.
          +
          See Also:
          +
          IntegrationTrait.getRequestTemplates()
          +
          +
          • +
        + + + +
          +
        • +

          removeRequestTemplate

          +
          public IntegrationTrait.Builder removeRequestTemplate​(java.lang.String mimeType)
          +
          Removes a request template by MIME type.
          +
          +
          Parameters:
          +
          mimeType - MIME type to remove.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          putResponse

          +
          public IntegrationTrait.Builder putResponse​(java.lang.String statusCodeRegex,
+                                            IntegrationResponse integrationResponse)
          +
          Adds a response for the given response regex.
          +
          +
          Parameters:
          +
          statusCodeRegex - Status code regular expression.
          +
          integrationResponse - Integration response to set.
          +
          Returns:
          +
          Returns the builder.
          +
          See Also:
          +
          IntegrationTrait.getResponses()
          +
          +
          • +
        + + + + + + + +
          +
        • +

          removeResponse

          +
          public IntegrationTrait.Builder removeResponse​(java.lang.String statusCodeRegex)
          +
          Removes a response by status code regex.
          +
          +
          Parameters:
          +
          statusCodeRegex - Status code regular expression to remove.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/IntegrationTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/IntegrationTrait.Provider.html new file mode 100644 index 00000000000..9ec0df9b9f2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/IntegrationTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +IntegrationTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.apigateway.traits
    +

    Class IntegrationTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/IntegrationTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/IntegrationTrait.html new file mode 100644 index 00000000000..a35ea14b95f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/IntegrationTrait.html @@ -0,0 +1,895 @@ + + + + + +IntegrationTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.apigateway.traits
    +

    Class IntegrationTrait

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        static ShapeIdID 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static IntegrationTrait.Builderbuilder() 
        protected ObjectNodecreateNode() +
        The result of toNode is used for hashCodes and equality.
        +
        static java.lang.StringformatComponent​(ToShapeId service, + ToShapeId operation, + java.lang.String component) +
        Replaces templated placeholders in an Integration trait.
        +
        java.util.List<java.lang.String>getCacheKeyParameters() +
        A list of request parameters whose values are to be cached.
        +
        java.util.Optional<java.lang.String>getCacheNamespace() +
        Gets an API-specific tag group of related cached parameters.
        +
        java.util.Optional<java.lang.String>getConnectionId() +
        Gets the ID of a VpcLink when using a private integration.
        +
        java.util.Optional<java.lang.String>getConnectionType() +
        Gets the connection type used by this integration.
        +
        java.util.Optional<java.lang.String>getContentHandling() +
        Get the Request payload encoding conversion types.
        +
        java.util.Optional<java.lang.String>getCredentials() +
        Gets the credentials required for the integration, if any.
        +
        java.lang.StringgetHttpMethod() +
        Gets the integration's HTTP method type.
        +
        java.util.Optional<java.lang.String>getPassThroughBehavior() +
        Gets the pass through behavior of the integration.
        +
        java.util.Optional<java.lang.String>getPayloadFormatVersion() +
        Gets the payload format version.
        +
        java.util.Optional<java.lang.String>getRequestParameter​(java.lang.String expression) +
        Get a specific request parameter by input expression.
        +
        java.util.Map<java.lang.String,​java.lang.String>getRequestParameters() +
        Gets the request parameter mappings of the integration.
        +
        java.util.Optional<java.lang.String>getRequestTemplate​(java.lang.String mimeType) +
        Gets a specific request template by MIME type.
        +
        java.util.Map<java.lang.String,​java.lang.String>getRequestTemplates() +
        Gets all request templates of the integration.
        +
        java.util.Optional<IntegrationResponse>getResponse​(java.lang.String statusCode) +
        Get a specific integration response by status code expression.
        +
        java.util.Map<java.lang.String,​IntegrationResponse>getResponses() +
        Gets all integration responses.
        +
        java.util.Optional<java.lang.Integer>getTimeoutInMillis() +
        Get the timeout in milliseconds.
        +
        java.lang.StringgetType() +
        Gets the integration type.
        +
        java.lang.StringgetUri() +
        Gets the Uniform Resource Identifier (URI) of the integration endpoint.
        +
        IntegrationTrait.BuildertoBuilder() +
        Take this object and create a builder that contains all of the + current property values of this object.
        +
        ObjectNodetoExpandedNode​(ToShapeId service, + ToShapeId operation) +
        Converts the trait an ObjectNode that finds and replaces the templated + serviceName and operationName labels in the "uri" and "credentials" + key-value pairs.
        +
        + +
          +
        • + + +

          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

        + + + + + + + +
          +
        • +

          getType

          +
          public java.lang.String getType()
          +
          Gets the integration type.
          +
          +
          Returns:
          +
          Returns the integration type.
          +
          +
          • +
        + + + +
          +
        • +

          getUri

          +
          public java.lang.String getUri()
          +
          Gets the Uniform Resource Identifier (URI) of the integration endpoint.
          +
          +
          Returns:
          +
          Returns the set URI of the integration.
          +
          +
          • +
        + + + +
          +
        • +

          getCredentials

          +
          public java.util.Optional<java.lang.String> getCredentials()
          +
          Gets the credentials required for the integration, if any. + +

          For AWS integrations, three options are available. To specify an + IAM Role for API Gateway to assume, use the role's + Amazon Resource Name (ARN). To require that the caller's identity + be passed through from the request, specify the string + arn:aws:iam::*:user/*. Resource-based permissions are used if + no credentials are provided.

          +
          +
          Returns:
          +
          Returns the optionally present credentials.
          +
          +
          • +
        + + + +
          +
        • +

          getHttpMethod

          +
          public java.lang.String getHttpMethod()
          +
          Gets the integration's HTTP method type.
          +
          +
          Returns:
          +
          Get the set HTTP method.
          +
          +
          • +
        + + + +
          +
        • +

          getPassThroughBehavior

          +
          public java.util.Optional<java.lang.String> getPassThroughBehavior()
          +
          Gets the pass through behavior of the integration. + +

          Specifies how a request payload of unmapped content type is + passed through the integration request without modification. + Supported values are when_no_templates, when_no_match, and never.

          +
          +
          Returns:
          +
          Returns the pass through setting.
          +
          See Also:
          +
          Pass through behavior
          +
          +
          • +
        + + + +
          +
        • +

          getContentHandling

          +
          public java.util.Optional<java.lang.String> getContentHandling()
          +
          Get the Request payload encoding conversion types. + +

          Valid values are: + +

            +
          • CONVERT_TO_TEXT, for converting a binary payload into a + Base64-encoded string or converting a text payload into a + utf-8-encoded string or passing through the text payload natively + without modification
            • +
          • CONVERT_TO_BINARY, for converting a text payload into + Base64-decoded blobor passing through a binary payload natively + without modification.
            • +
          +
          +
          Returns:
          +
          Returns the content-handling.
          +
          +
          • +
        + + + +
          +
        • +

          getTimeoutInMillis

          +
          public java.util.Optional<java.lang.Integer> getTimeoutInMillis()
          +
          Get the timeout in milliseconds. + +

          Integration timeouts between 50 ms and 29,000 ms. The default + setting used by API Gateway is 29,000 (or, 29 seconds).

          +
          +
          Returns:
          +
          Returns the optionally set timeout setting.
          +
          +
          • +
        + + + +
          +
        • +

          getConnectionId

          +
          public java.util.Optional<java.lang.String> getConnectionId()
          +
          Gets the ID of a VpcLink when using a private integration.
          +
          +
          Returns:
          +
          Returns the optionally present connection ID.
          +
          See Also:
          +
          VPC Link
          +
          +
          • +
        + + + +
          +
        • +

          getConnectionType

          +
          public java.util.Optional<java.lang.String> getConnectionType()
          +
          Gets the connection type used by this integration.
          +
          +
          Returns:
          +
          Returns the connection type.
          +
          +
          • +
        + + + +
          +
        • +

          getCacheNamespace

          +
          public java.util.Optional<java.lang.String> getCacheNamespace()
          +
          Gets an API-specific tag group of related cached parameters.
          +
          +
          Returns:
          +
          Returns the optionally present cache namespace.
          +
          +
          • +
        + + + +
          +
        • +

          getPayloadFormatVersion

          +
          public java.util.Optional<java.lang.String> getPayloadFormatVersion()
          +
          Gets the payload format version. Only used in HTTP APIs.
          +
          +
          Returns:
          +
          Returns the optional payload format version.
          +
          +
          • +
        + + + +
          +
        • +

          getCacheKeyParameters

          +
          public java.util.List<java.lang.String> getCacheKeyParameters()
          +
          A list of request parameters whose values are to be cached.
          +
          +
          Returns:
          +
          Returns the cache key parameters.
          +
          +
          • +
        + + + +
          +
        • +

          getRequestParameters

          +
          public java.util.Map<java.lang.String,​java.lang.String> getRequestParameters()
          +
          Gets the request parameter mappings of the integration. + +

          Each key is an expression used to extract a value from the request, + and each value is an expression of where to place the value in the + downstream request. Supported request parameters are querystring, path, + header, and body.

          +
          +
          Returns:
          +
          Returns the request parameters.
          +
          See Also:
          +
          Request parameters
          +
          +
          • +
        + + + +
          +
        • +

          getRequestParameter

          +
          public java.util.Optional<java.lang.String> getRequestParameter​(java.lang.String expression)
          +
          Get a specific request parameter by input expression.
          +
          +
          Parameters:
          +
          expression - Expression to get.
          +
          Returns:
          +
          Returns the optionally found request parameter.
          +
          +
          • +
        + + + +
          +
        • +

          getRequestTemplates

          +
          public java.util.Map<java.lang.String,​java.lang.String> getRequestTemplates()
          +
          Gets all request templates of the integration.
          +
          +
          Returns:
          +
          Returns a map of MIME types to request templates.
          +
          See Also:
          +
          Request templates
          +
          +
          • +
        + + + +
          +
        • +

          getRequestTemplate

          +
          public java.util.Optional<java.lang.String> getRequestTemplate​(java.lang.String mimeType)
          +
          Gets a specific request template by MIME type.
          +
          +
          Parameters:
          +
          mimeType - MIME type to get.
          +
          Returns:
          +
          Returns the optionally found template.
          +
          +
          • +
        + + + +
          +
        • +

          getResponses

          +
          public java.util.Map<java.lang.String,​IntegrationResponse> getResponses()
          +
          Gets all integration responses.
          +
          +
          Returns:
          +
          Returns a map of status code regular expressions to responses.
          +
          See Also:
          +
          Integration responses
          +
          +
          • +
        + + + +
          +
        • +

          getResponse

          +
          public java.util.Optional<IntegrationResponse> getResponse​(java.lang.String statusCode)
          +
          Get a specific integration response by status code expression.
          +
          +
          Parameters:
          +
          statusCode - Status code regular expression to search for.
          +
          Returns:
          +
          Returns the optionally found response object.
          +
          +
          • +
        + + + +
          +
        • +

          toExpandedNode

          +
          public ObjectNode toExpandedNode​(ToShapeId service,
+                                 ToShapeId operation)
          +
          Converts the trait an ObjectNode that finds and replaces the templated + serviceName and operationName labels in the "uri" and "credentials" + key-value pairs.
          +
          +
          Parameters:
          +
          service - Service shape ID to use when replacing {serviceName}.
          +
          operation - Operation shape ID to use when replacing {operationName}.
          +
          Returns:
          +
          Returns the expanded Node.
          +
          +
          • +
        + + + +
          +
        • +

          formatComponent

          +
          public static java.lang.String formatComponent​(ToShapeId service,
+                                               ToShapeId operation,
+                                               java.lang.String component)
          +
          Replaces templated placeholders in an Integration trait.
          +
          +
          Parameters:
          +
          service - Service shape ID to use when replacing {serviceName}.
          +
          operation - Operation shape ID to use when replacing {operationName}.
          +
          component - Templatized component to expand.
          +
          Returns:
          +
          Returns the expanded string.
          +
          +
          • +
        + + + +
          +
        • +

          createNode

          +
          protected ObjectNode 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.
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/IntegrationTraitIndex.html b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/IntegrationTraitIndex.html new file mode 100644 index 00000000000..a756e27e565 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/IntegrationTraitIndex.html @@ -0,0 +1,377 @@ + + + + + +IntegrationTraitIndex (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.apigateway.traits
    +

    Class IntegrationTraitIndex

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.apigateway.traits.IntegrationTraitIndex
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      KnowledgeIndex
      +
      +
      +
      public final class IntegrationTraitIndex
+extends java.lang.Object
+implements KnowledgeIndex
      +
      Computes the API Gateway integration for each operation, + resource, and service shape in a model.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          IntegrationTraitIndex

          +
          public IntegrationTraitIndex​(Model model)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getIntegrationTrait

          +
          public java.util.Optional<Trait> getIntegrationTrait​(ToShapeId service,
+                                                     ToShapeId shape)
          +
          Get the integration trait for a particular operation, resource, or + service bound within a service.
          +
          +
          Parameters:
          +
          service - Service shape or ShapeId thereof.
          +
          shape - Operation, service, or resource shape in the service. + When the service shape ID is provided, the integration trait of the + service is returned if present.
          +
          Returns:
          +
          The integration trait or an empty optional if none set
          +
          +
          • +
        + + + +
          +
        • +

          getIntegrationTrait

          +
          public <T extends Trait> java.util.Optional<T> getIntegrationTrait​(ToShapeId service,
+                                                                   ToShapeId shape,
+                                                                   java.lang.Class<T> type)
          +
          Get the integration trait for a particular operation, resource, or + service bound within a service of a specific type.
          +
          +
          Type Parameters:
          +
          T - Type of trait to retrieve.
          +
          Parameters:
          +
          service - Service shape or ShapeId thereof.
          +
          shape - Operation, service, or resource shape in the service. + When the service shape ID is provided, the integration trait of the + service is returned if present.
          +
          type - Integration trait type.
          +
          Returns:
          +
          The integration trait or an empty optional if none set or + if not of the expected type.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/MockIntegrationTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/MockIntegrationTrait.Builder.html new file mode 100644 index 00000000000..650cb44f553 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/MockIntegrationTrait.Builder.html @@ -0,0 +1,622 @@ + + + + + +MockIntegrationTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.apigateway.traits
    +

    Class MockIntegrationTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public MockIntegrationTrait build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        + + + + + + + +
          +
        • +

          contentHandling

          +
          public MockIntegrationTrait.Builder contentHandling​(java.lang.String contentHandling)
          +
          Set the Request payload encoding conversion types. + +

          Valid values are: + +

            +
          • CONVERT_TO_TEXT, for converting a binary payload into a + Base64-encoded string or converting a text payload into a + utf-8-encoded string or passing through the text payload natively + without modification
            • +
          • CONVERT_TO_BINARY, for converting a text payload into + Base64-decoded blob or passing through a binary payload natively + without modification.
            • +
          +
          +
          Parameters:
          +
          contentHandling - Content handling property.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          putRequestParameter

          +
          public MockIntegrationTrait.Builder putRequestParameter​(java.lang.String input,
+                                                        java.lang.String output)
          +
          Adds a request parameters.
          +
          +
          Parameters:
          +
          input - Input request expression.
          +
          output - Output request expression.
          +
          Returns:
          +
          Returns the builder.
          +
          See Also:
          +
          IntegrationTrait.getRequestParameters()
          +
          +
          • +
        + + + + + + + +
          +
        • +

          removeRequestParameter

          +
          public MockIntegrationTrait.Builder removeRequestParameter​(java.lang.String expression)
          +
          Remove a request parameter by expression.
          +
          +
          Parameters:
          +
          expression - Expression to remove.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          putRequestTemplate

          +
          public MockIntegrationTrait.Builder putRequestTemplate​(java.lang.String mimeType,
+                                                       java.lang.String template)
          +
          Adds a request template.
          +
          +
          Parameters:
          +
          mimeType - MIME type of the request template to set.
          +
          template - Request template to set.
          +
          Returns:
          +
          Returns the builder.
          +
          See Also:
          +
          IntegrationTrait.getRequestTemplates()
          +
          +
          • +
        + + + +
          +
        • +

          requestTemplates

          +
          public MockIntegrationTrait.Builder requestTemplates​(java.util.Map<java.lang.String,​java.lang.String> requestTemplates)
          +
          Sets request templates.
          +
          +
          Parameters:
          +
          requestTemplates - Map of MIME types to the corresponding template.
          +
          Returns:
          +
          Returns the builder.
          +
          See Also:
          +
          IntegrationTrait.getRequestTemplates()
          +
          +
          • +
        + + + +
          +
        • +

          removeRequestTemplate

          +
          public MockIntegrationTrait.Builder removeRequestTemplate​(java.lang.String mimeType)
          +
          Removes a request template by MIME type.
          +
          +
          Parameters:
          +
          mimeType - MIME type to remove.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          putResponse

          +
          public MockIntegrationTrait.Builder putResponse​(java.lang.String statusCodeRegex,
+                                                IntegrationResponse integrationResponse)
          +
          Adds a response for the given response regex.
          +
          +
          Parameters:
          +
          statusCodeRegex - Status code regular expression.
          +
          integrationResponse - Integration response to set.
          +
          Returns:
          +
          Returns the builder.
          +
          See Also:
          +
          IntegrationTrait.getResponses()
          +
          +
          • +
        + + + + + + + +
          +
        • +

          removeResponse

          +
          public MockIntegrationTrait.Builder removeResponse​(java.lang.String statusCodeRegex)
          +
          Removes a response by status code regex.
          +
          +
          Parameters:
          +
          statusCodeRegex - Status code regular expression to remove.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/MockIntegrationTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/MockIntegrationTrait.Provider.html new file mode 100644 index 00000000000..bdf5bd84913 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/MockIntegrationTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +MockIntegrationTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.apigateway.traits
    +

    Class MockIntegrationTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/MockIntegrationTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/MockIntegrationTrait.html new file mode 100644 index 00000000000..6f3744c4a68 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/MockIntegrationTrait.html @@ -0,0 +1,602 @@ + + + + + +MockIntegrationTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.apigateway.traits
    +

    Class MockIntegrationTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getPassThroughBehavior

          +
          public java.util.Optional<java.lang.String> getPassThroughBehavior()
          +
          Gets the pass through behavior of the integration. + +

          Specifies how a request payload of unmapped content type is + passed through the integration request without modification. + Supported values are when_no_templates, when_no_match, and never.

          +
          +
          Returns:
          +
          Returns the pass through setting.
          +
          See Also:
          +
          Pass through behavior
          +
          +
          • +
        + + + +
          +
        • +

          getRequestParameters

          +
          public java.util.Map<java.lang.String,​java.lang.String> getRequestParameters()
          +
          Gets the request parameter mappings of the integration. + +

          Each key is an expression used to extract a value from the request, + and each value is an expression of where to place the value in the + downstream request. Supported request parameters are querystring, path, + header, and body.

          +
          +
          Returns:
          +
          Returns the request parameters.
          +
          See Also:
          +
          Request parameters
          +
          +
          • +
        + + + +
          +
        • +

          getRequestParameter

          +
          public java.util.Optional<java.lang.String> getRequestParameter​(java.lang.String expression)
          +
          Get a specific request parameter by input expression.
          +
          +
          Parameters:
          +
          expression - Expression to get.
          +
          Returns:
          +
          Returns the optionally found request parameter.
          +
          +
          • +
        + + + +
          +
        • +

          getRequestTemplates

          +
          public java.util.Map<java.lang.String,​java.lang.String> getRequestTemplates()
          +
          Gets all request templates of the integration.
          +
          +
          Returns:
          +
          Returns a map of MIME types to request templates.
          +
          See Also:
          +
          Request templates
          +
          +
          • +
        + + + +
          +
        • +

          getRequestTemplate

          +
          public java.util.Optional<java.lang.String> getRequestTemplate​(java.lang.String mimeType)
          +
          Gets a specific request template by MIME type.
          +
          +
          Parameters:
          +
          mimeType - MIME type to get.
          +
          Returns:
          +
          Returns the optionally found template.
          +
          +
          • +
        + + + +
          +
        • +

          getResponses

          +
          public java.util.Map<java.lang.String,​IntegrationResponse> getResponses()
          +
          Gets all integration responses.
          +
          +
          Returns:
          +
          Returns a map of status code regular expressions to responses.
          +
          See Also:
          +
          Integration responses
          +
          +
          • +
        + + + +
          +
        • +

          getResponse

          +
          public java.util.Optional<IntegrationResponse> getResponse​(java.lang.String statusCode)
          +
          Get a specific integration response by status code expression.
          +
          +
          Parameters:
          +
          statusCode - Status code regular expression to search for.
          +
          Returns:
          +
          Returns the optionally found response object.
          +
          +
          • +
        + + + +
          +
        • +

          getContentHandling

          +
          public java.util.Optional<java.lang.String> getContentHandling()
          +
          Gets the contentHandling property of the integration.
          +
          +
          Returns:
          +
          Returns the contentHandling property.
          +
          +
          • +
        + + + +
          +
        • +

          createNode

          +
          protected ObjectNode 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.
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/RequestValidatorTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/RequestValidatorTrait.Provider.html new file mode 100644 index 00000000000..3040a767c0f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/RequestValidatorTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +RequestValidatorTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.apigateway.traits
    +

    Class RequestValidatorTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/RequestValidatorTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/RequestValidatorTrait.html new file mode 100644 index 00000000000..fa768eef0a2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/RequestValidatorTrait.html @@ -0,0 +1,381 @@ + + + + + +RequestValidatorTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.apigateway.traits
    +

    Class RequestValidatorTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          RequestValidatorTrait

          +
          public RequestValidatorTrait​(java.lang.String value,
+                             FromSourceLocation sourceLocation)
          +
          • +
        + + + +
          +
        • +

          RequestValidatorTrait

          +
          public RequestValidatorTrait​(java.lang.String value)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/package-summary.html new file mode 100644 index 00000000000..de1b483e82d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/package-summary.html @@ -0,0 +1,275 @@ + + + + + +software.amazon.smithy.aws.apigateway.traits (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.aws.apigateway.traits

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/package-tree.html new file mode 100644 index 00000000000..95523348d2c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/apigateway/traits/package-tree.html @@ -0,0 +1,206 @@ + + + + + +software.amazon.smithy.aws.apigateway.traits Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.aws.apigateway.traits

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/CfnConfig.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/CfnConfig.html new file mode 100644 index 00000000000..ec48960e41f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/CfnConfig.html @@ -0,0 +1,903 @@ + + + + + +CfnConfig (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.schema
    +

    Class CfnConfig

    +
    +
    + +
    +
      +
    • +
      +
      public final class CfnConfig
+extends JsonSchemaConfig
      +
      "cloudformation" smithy-build plugin configuration settings.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          SCHEMA_COMPONENTS_POINTER

          +
          public static final java.lang.String SCHEMA_COMPONENTS_POINTER
          +
          The JSON pointer to where CloudFormation schema shared resource properties should be written.
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CfnConfig

          +
          public CfnConfig()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setAlphanumericOnlyRefs

          +
          public void setAlphanumericOnlyRefs​(boolean alphanumericOnlyRefs)
          +
          Description copied from class: JsonSchemaConfig
          +
          Creates shape name pointers that strip out non-alphanumeric characters. + +

          This is necessary for compatibility with some vendors like + Amazon API Gateway that only allow alphanumeric shape names.

          +
          +
          Overrides:
          +
          setAlphanumericOnlyRefs in class JsonSchemaConfig
          +
          Parameters:
          +
          alphanumericOnlyRefs - Set to true to strip non-alphanumeric characters.
          +
          +
          • +
        + + + +
          +
        • +

          getDisableHandlerPermissionGeneration

          +
          public boolean getDisableHandlerPermissionGeneration()
          +
          • +
        + + + +
          +
        • +

          setDisableHandlerPermissionGeneration

          +
          public void setDisableHandlerPermissionGeneration​(boolean disableHandlerPermissionGeneration)
          +
          Set to true to disable generating handler property's permissions + lists for Resource Schemas. + +

          By default, handler permissions are automatically added to the handler + property's permissions list. This includes the lifecycle operation used + and any permissions listed in the aws.iam#requiredActions trait.

          +
          +
          Parameters:
          +
          disableHandlerPermissionGeneration - True to disable handler permissions + generation
          +
          +
          • +
        + + + +
          +
        • +

          getDisableDeprecatedPropertyGeneration

          +
          public boolean getDisableDeprecatedPropertyGeneration()
          +
          • +
        + + + +
          +
        • +

          setDisableDeprecatedPropertyGeneration

          +
          public void setDisableDeprecatedPropertyGeneration​(boolean disableDeprecatedPropertyGeneration)
          +
          Set to true to disable generating deprecatedProperties for Resource Schemas. + +

          By default, deprecated members are automatically added to the + deprecatedProperties schema property.

          +
          +
          Parameters:
          +
          disableDeprecatedPropertyGeneration - True to disable deprecatedProperties + generation, false otherwise.
          +
          +
          • +
        + + + +
          +
        • +

          getDisableRequiredPropertyGeneration

          +
          public boolean getDisableRequiredPropertyGeneration()
          +
          • +
        + + + +
          +
        • +

          setDisableRequiredPropertyGeneration

          +
          public void setDisableRequiredPropertyGeneration​(boolean disableRequiredPropertyGeneration)
          +
          Set to true to disable generating required for Resource Schemas. + +

          By default, required members are automatically added to the + required schema property.

          +
          +
          Parameters:
          +
          disableRequiredPropertyGeneration - True to disable required + generation, false otherwise.
          +
          +
          • +
        + + + +
          +
        • +

          getDisableCapitalizedProperties

          +
          public boolean getDisableCapitalizedProperties()
          +
          • +
        + + + +
          +
        • +

          setDisableCapitalizedProperties

          +
          public void setDisableCapitalizedProperties​(boolean disableCapitalizedProperties)
          +
          Set to true to disable automatically capitalizing names of properties + of Resource Schemas. + +

          By default, property names of Resource Schemas are capitalized if + no cfnName trait is applied.

          +
          +
          Parameters:
          +
          disableCapitalizedProperties - True to disable capitalizing property names, + false otherwise.
          +
          +
          • +
        + + + +
          +
        • +

          getExternalDocs

          +
          public java.util.List<java.lang.String> getExternalDocs()
          +
          • +
        + + + +
          +
        • +

          setExternalDocs

          +
          public void setExternalDocs​(java.util.List<java.lang.String> externalDocs)
          +
          Limits the source of converted "externalDocs" fields to the specified + priority ordered list of names in an externalDocumentation trait. + +

          This list is case insensitive. By default, this is a list of the + following values: "Documentation Url", "DocumentationUrl", "API Reference", + "User Guide", "Developer Guide", "Reference", and "Guide".

          +
          +
          Parameters:
          +
          externalDocs - External docs to look for and convert, in order.
          +
          +
          • +
        + + + +
          +
        • +

          getJsonAdd

          +
          public java.util.Map<ShapeId,​java.util.Map<java.lang.String,​Node>> getJsonAdd()
          +
          • +
        + + + +
          +
        • +

          setJsonAdd

          +
          public void setJsonAdd​(java.util.Map<ShapeId,​java.util.Map<java.lang.String,​Node>> jsonAdd)
          +
          Adds or replaces the JSON value in the generated resource schema + document at the given JSON pointer locations with a different JSON + value. + +

          The value must be a map where each key is a resource shape ID. The + value is a map where each key is a valid JSON pointer string as defined + in RFC 6901. Each value in the nested map is the JSON value to add or + replace at the given target. + +

          Values are added using similar semantics of the "add" operation + of JSON Patch, as specified in RFC 6902, with the exception that + adding properties to an undefined object will create nested + objects in the result as needed.

          +
          +
          Parameters:
          +
          jsonAdd - Map of JSON path to values to patch in.
          +
          +
          • +
        + + + +
          +
        • +

          setUseJsonName

          +
          public void setUseJsonName​(boolean useJsonName)
          +
          Description copied from class: JsonSchemaConfig
          +
          Uses the value of the jsonName trait when creating JSON schema + properties for structure and union shapes. + +

          This property has no effect if a PropertyNamingStrategy is + manually configured on a JsonSchemaConverter.

          +
          +
          Overrides:
          +
          setUseJsonName in class JsonSchemaConfig
          +
          Parameters:
          +
          useJsonName - Set to true to use jsonName traits when creating refs..
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getOrganizationName

          +
          public java.lang.String getOrganizationName()
          +
          • +
        + + + +
          +
        • +

          setOrganizationName

          +
          public void setOrganizationName​(java.lang.String organizationName)
          +
          Sets the "Organization" component for each of the generated resource's + type name. + +

          This value defaults to "AWS" if the aws.api#service trait is + present. Otherwise, the value is required configuration.

          +
          +
          Parameters:
          +
          organizationName - Name to use for the "Organization" component of resource type names.
          +
          See Also:
          +
          Type Name
          +
          +
          • +
        + + + +
          +
        • +

          getServiceName

          +
          public java.lang.String getServiceName()
          +
          • +
        + + + +
          +
        • +

          setServiceName

          +
          public void setServiceName​(java.lang.String serviceName)
          +
          Sets the "Service" component for each of the generated resource's + type name. + +

          This value defaults to the value of the aws.api#service/cloudFormationName + if the trait is present. Otherwise, the value defaults to the shape name of the + specified service shape.

          +
          +
          Parameters:
          +
          serviceName - Name to use for the "Service" component of resource type names.
          +
          See Also:
          +
          Type Name
          +
          +
          • +
        + + + +
          +
        • +

          getSourceDocs

          +
          public java.util.List<java.lang.String> getSourceDocs()
          +
          • +
        + + + +
          +
        • +

          setSourceDocs

          +
          public void setSourceDocs​(java.util.List<java.lang.String> sourceDocs)
          +
          Limits the source of converted "sourceDocs" fields to the specified + priority ordered list of names in an externalDocumentation trait. + +

          This list is case insensitive. By default, this is a list of the + following values: "Source Url", "SourceUrl", "Source", and "Source Code".

          +
          +
          Parameters:
          +
          sourceDocs - Source docs to look for and convert, in order.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          fromNode

          +
          public static CfnConfig fromNode​(Node settings)
          +
          Creates a CfnConfig from a Node value. + +

          This method uses the NodeMapper on the converted input object. + Note that this class can be deserialized using a NodeMapper too since the + NodeMapper will look for a static, public, fromNode method. + +

          This method also serializes unknown properties into the + "extensions" map so that they are accessible to CfnMapper implementations.

          +
          +
          Parameters:
          +
          settings - Input to deserialize.
          +
          Returns:
          +
          Returns the deserialized
          +
          +
          • +
        + + + +
          +
        • +

          setJsonSchemaVersion

          +
          public void setJsonSchemaVersion​(JsonSchemaVersion schemaVersion)
          +
          Description copied from class: JsonSchemaConfig
          +
          Set the JSON schema version to use when converting Smithy shapes into Json Schema.
          +
          +
          Overrides:
          +
          setJsonSchemaVersion in class JsonSchemaConfig
          +
          Parameters:
          +
          schemaVersion - JSON Schema version to use for generated schema
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/CfnException.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/CfnException.html new file mode 100644 index 00000000000..957f9edfeaa --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/CfnException.html @@ -0,0 +1,324 @@ + + + + + +CfnException (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.schema
    +

    Class CfnException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Throwable
        • +
      • +
          +
        • java.lang.Exception
          • +
        • +
            +
          • java.lang.RuntimeException
            • +
          • +
              +
            • software.amazon.smithy.aws.cloudformation.schema.CfnException
              • +
            +
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      public class CfnException
+extends java.lang.RuntimeException
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        CfnException​(java.lang.RuntimeException e) 
        CfnException​(java.lang.String message) 
        CfnException​(java.lang.String message, + java.lang.Throwable previous) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CfnException

          +
          public CfnException​(java.lang.RuntimeException e)
          +
          • +
        + + + +
          +
        • +

          CfnException

          +
          public CfnException​(java.lang.String message)
          +
          • +
        + + + +
          +
        • +

          CfnException

          +
          public CfnException​(java.lang.String message,
+                    java.lang.Throwable previous)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/CfnConverter.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/CfnConverter.html new file mode 100644 index 00000000000..9d376ce5b48 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/CfnConverter.html @@ -0,0 +1,395 @@ + + + + + +CfnConverter (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.schema.fromsmithy
    +

    Class CfnConverter

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.cloudformation.schema.fromsmithy.CfnConverter
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class CfnConverter
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        CfnConverterclassLoader​(java.lang.ClassLoader classLoader) +
        Sets a ClassLoader to use to discover Smithy2CfnExtension + service providers through SPI.
        +
        CfnConverterconfig​(CfnConfig config) +
        Set the CloudFormation configuration settings.
        +
        java.util.List<ResourceSchema>convert​(Model model) +
        Converts the annotated resources in the Smithy model to CloudFormation + Resource Schemas.
        +
        java.util.Map<java.lang.String,​ObjectNode>convertToNodes​(Model model) +
        Converts resource shapes annotated with the @cfnResource trait to + JSON/Node representations of CloudFormation Resource Schemas using the + given Smithy model.
        +
        static CfnConvertercreate() 
        CfnConfiggetConfig() +
        Get the CloudFormation configuration settings.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + + + + + +
          +
        • +

          getConfig

          +
          public CfnConfig getConfig()
          +
          Get the CloudFormation configuration settings.
          +
          +
          Returns:
          +
          Returns the config object.
          +
          +
          • +
        + + + +
          +
        • +

          config

          +
          public CfnConverter config​(CfnConfig config)
          +
          Set the CloudFormation configuration settings.
          +
          +
          Parameters:
          +
          config - Config object to set.
          +
          Returns:
          +
          Returns the converter.
          +
          +
          • +
        + + + +
          +
        • +

          classLoader

          +
          public CfnConverter classLoader​(java.lang.ClassLoader classLoader)
          +
          Sets a ClassLoader to use to discover Smithy2CfnExtension + service providers through SPI. + +

          + The CfnConverter will use its own ClassLoader by default.

          +
          +
          Parameters:
          +
          classLoader - ClassLoader to use.
          +
          Returns:
          +
          Returns the converter.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          convert

          +
          public java.util.List<ResourceSchema> convert​(Model model)
          +
          Converts the annotated resources in the Smithy model to CloudFormation + Resource Schemas.
          +
          +
          Parameters:
          +
          model - Smithy model containing resources to convert.
          +
          Returns:
          +
          Returns the converted resources.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/CfnMapper.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/CfnMapper.html new file mode 100644 index 00000000000..e9686b815cb --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/CfnMapper.html @@ -0,0 +1,350 @@ + + + + + +CfnMapper (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.schema.fromsmithy
    +

    Interface CfnMapper

    +
    +
    +
    +
      +
    • +
      +
      All Known Implementing Classes:
      +
      HandlerPermissionMapper, RequiredMapper
      +
      +
      +
      public interface CfnMapper
      +
      Provides a plugin infrastructure to hook into the Smithy CloudFormation + Resource Schema generation process and map over the result. + +

      The methods of a plugin are invoked by CfnConverter during + Resource Schema generation. There is no need to invoke these manually. + Implementations may choose to leverage configuration options of the + provided context to determine whether or not to enact the plugin.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getOrder

          +
          default byte getOrder()
          +
          Gets the sort order of the plugin from -128 to 127. + +

          Plugins are applied according to this sort order. Lower values + are executed before higher values (for example, -128 comes before 0, + comes before 127). Plugins default to 0, which is the middle point + between the minimum and maximum order values.

          +
          +
          Returns:
          +
          Returns the sort order, defaulting to 0.
          +
          +
          • +
        + + + +
          +
        • +

          before

          +
          default void before​(Context context,
+                    ResourceSchema.Builder builder)
          +
          Updates an ResourceSchema.Builder before converting the model.
          +
          +
          Parameters:
          +
          context - Conversion context.
          +
          builder - ResourceSchema builder to modify.
          +
          +
          • +
        + + + +
          +
        • +

          after

          +
          default ResourceSchema after​(Context context,
+                             ResourceSchema resourceSchema)
          +
          Updates an ResourceSchema.Builder after converting the model.
          +
          +
          Parameters:
          +
          context - Conversion context.
          +
          resourceSchema - ResourceSchema to modify.
          +
          Returns:
          +
          Returns the updated ResourceSchema object.
          +
          +
          • +
        + + + +
          +
        • +

          updateNode

          +
          default ObjectNode updateNode​(Context context,
+                              ResourceSchema resourceSchema,
+                              ObjectNode node)
          +
          Modifies the Node/JSON representation of a ResourceSchema object.
          +
          +
          Parameters:
          +
          context - Conversion context.
          +
          resourceSchema - ResourceSchema being converted to a node.
          +
          node - ResourceSchema object node.
          +
          Returns:
          +
          Returns the updated ObjectNode.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/Context.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/Context.html new file mode 100644 index 00000000000..a4099fb904c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/Context.html @@ -0,0 +1,425 @@ + + + + + +Context (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.schema.fromsmithy
    +

    Class Context

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.cloudformation.schema.fromsmithy.Context
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class Context
+extends java.lang.Object
      +
      Smithy to CloudFormation conversion context object. + +

      One context is used per CloudFormation resource generated.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getModel

          +
          public Model getModel()
          +
          Gets the Smithy model being converted.
          +
          +
          Returns:
          +
          Returns the Smithy model.
          +
          +
          • +
        + + + +
          +
        • +

          getService

          +
          public ServiceShape getService()
          +
          Gets the service shape containing the resource being converted.
          +
          +
          Returns:
          +
          Returns the service shape.
          +
          +
          • +
        + + + +
          +
        • +

          getResource

          +
          public ResourceShape getResource()
          +
          Gets the resource shape being converted.
          +
          +
          Returns:
          +
          Returns the resource shape.
          +
          +
          • +
        + + + +
          +
        • +

          getCfnResource

          +
          public CfnResource getCfnResource()
          +
          Gets the CfnResource index data for this resource.
          +
          +
          Returns:
          +
          Returns the CfnResource index data.
          +
          +
          • +
        + + + +
          +
        • +

          getResourceStructure

          +
          public StructureShape getResourceStructure()
          +
          Gets the structure shape that represents the consolidated properties of the resource.
          +
          +
          Returns:
          +
          Returns the structure shape.
          +
          +
          • +
        + + + +
          +
        • +

          getConfig

          +
          public CfnConfig getConfig()
          +
          Gets the configuration object used for the conversion. + +

          Plugins can query this object for configuration values.

          +
          +
          Returns:
          +
          Returns the configuration object.
          +
          +
          • +
        + + + +
          +
        • +

          getJsonSchemaConverter

          +
          public JsonSchemaConverter getJsonSchemaConverter()
          +
          Gets the JSON schema converter.
          +
          +
          Returns:
          +
          Returns the JSON Schema converter.
          +
          +
          • +
        + + + +
          +
        • +

          getPropertyPointer

          +
          public java.lang.String getPropertyPointer​(java.lang.String propertyName)
          +
          Gets the JSON pointer string to a specific property.
          +
          +
          Parameters:
          +
          propertyName - Property name to build a JSON pointer to.
          +
          Returns:
          +
          Returns the JSON pointer to the property.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/Smithy2Cfn.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/Smithy2Cfn.html new file mode 100644 index 00000000000..83b6f9cb0bb --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/Smithy2Cfn.html @@ -0,0 +1,350 @@ + + + + + +Smithy2Cfn (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.schema.fromsmithy
    +

    Class Smithy2Cfn

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.cloudformation.schema.fromsmithy.Smithy2Cfn
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Smithy2Cfn() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidexecute​(PluginContext context) +
        Executes the plugin, creating any number of artifacts.
        +
        java.lang.StringgetName() +
        Gets the name of the plugin.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Smithy2Cfn

          +
          public Smithy2Cfn()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getName

          +
          public java.lang.String getName()
          +
          Description copied from interface: SmithyBuildPlugin
          +
          Gets the name of the plugin.
          +
          +
          Specified by:
          +
          getName in interface SmithyBuildPlugin
          +
          Returns:
          +
          Returns the name (e.g., "MyPlugin").
          +
          +
          • +
        + + + +
          +
        • +

          execute

          +
          public void execute​(PluginContext context)
          +
          Description copied from interface: SmithyBuildPlugin
          +
          Executes the plugin, creating any number of artifacts.
          +
          +
          Specified by:
          +
          execute in interface SmithyBuildPlugin
          +
          Parameters:
          +
          context - Plugin context for build execution.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/Smithy2CfnExtension.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/Smithy2CfnExtension.html new file mode 100644 index 00000000000..45ce1df1f4c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/Smithy2CfnExtension.html @@ -0,0 +1,288 @@ + + + + + +Smithy2CfnExtension (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.schema.fromsmithy
    +

    Interface Smithy2CfnExtension

    +
    +
    +
    +
      +
    • +
      +
      All Known Implementing Classes:
      +
      CoreExtension
      +
      +
      +
      public interface Smithy2CfnExtension
      +
      An extension mechanism used to influence how CloudFormation resource schemas + are generated from Smithy models. + +

      Implementations of this interface are discovered through Java SPI.

      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Default Methods 
        Modifier and TypeMethodDescription
        default java.util.List<CfnMapper>getCfnMappers() +
        Registers CloudFormation mappers, classes used to modify and extend the + process of converting a Smithy model to CloudFormation resource schemas.
        +
        default java.util.List<JsonSchemaMapper>getJsonSchemaMappers() +
        Registers JsonSchema mappers that are used to modify JsonSchema + definitions created from a Smithy model.
        +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getCfnMappers

          +
          default java.util.List<CfnMapper> getCfnMappers()
          +
          Registers CloudFormation mappers, classes used to modify and extend the + process of converting a Smithy model to CloudFormation resource schemas.
          +
          +
          Returns:
          +
          Returns the mappers to register.
          +
          +
          • +
        + + + +
          +
        • +

          getJsonSchemaMappers

          +
          default java.util.List<JsonSchemaMapper> getJsonSchemaMappers()
          +
          Registers JsonSchema mappers that are used to modify JsonSchema + definitions created from a Smithy model.
          +
          +
          Returns:
          +
          Returns the mappers to register.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/mappers/CoreExtension.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/mappers/CoreExtension.html new file mode 100644 index 00000000000..0cfb86ec841 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/mappers/CoreExtension.html @@ -0,0 +1,329 @@ + + + + + +CoreExtension (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.schema.fromsmithy.mappers
    +

    Class CoreExtension

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.cloudformation.schema.fromsmithy.mappers.CoreExtension
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Smithy2CfnExtension
      +
      +
      +
      public final class CoreExtension
+extends java.lang.Object
+implements Smithy2CfnExtension
      +
      Registers the core Smithy2CloudFormation functionality.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        CoreExtension() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.util.List<CfnMapper>getCfnMappers() +
        Registers CloudFormation mappers, classes used to modify and extend the + process of converting a Smithy model to CloudFormation resource schemas.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          CoreExtension

          +
          public CoreExtension()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getCfnMappers

          +
          public java.util.List<CfnMapper> getCfnMappers()
          +
          Description copied from interface: Smithy2CfnExtension
          +
          Registers CloudFormation mappers, classes used to modify and extend the + process of converting a Smithy model to CloudFormation resource schemas.
          +
          +
          Specified by:
          +
          getCfnMappers in interface Smithy2CfnExtension
          +
          Returns:
          +
          Returns the mappers to register.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/mappers/HandlerPermissionMapper.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/mappers/HandlerPermissionMapper.html new file mode 100644 index 00000000000..b789c441b9e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/mappers/HandlerPermissionMapper.html @@ -0,0 +1,335 @@ + + + + + +HandlerPermissionMapper (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.schema.fromsmithy.mappers
    +

    Class HandlerPermissionMapper

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.cloudformation.schema.fromsmithy.mappers.HandlerPermissionMapper
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      CfnMapper
      +
      +
      +
      public final class HandlerPermissionMapper
+extends java.lang.Object
+implements CfnMapper
      +
      Generates the resource's handler permissions list based on the lifecycle operation + used and any permissions listed in the aws.iam#requiredActions trait.
      +
      +
      See Also:
      +
      handlers Docs
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidbefore​(Context context, + ResourceSchema.Builder resourceSchema) +
        Updates an ResourceSchema.Builder before converting the model.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          HandlerPermissionMapper

          +
          public HandlerPermissionMapper()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          before

          +
          public void before​(Context context,
+                   ResourceSchema.Builder resourceSchema)
          +
          Description copied from interface: CfnMapper
          +
          Updates an ResourceSchema.Builder before converting the model.
          +
          +
          Specified by:
          +
          before in interface CfnMapper
          +
          Parameters:
          +
          context - Conversion context.
          +
          resourceSchema - ResourceSchema builder to modify.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/mappers/RequiredMapper.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/mappers/RequiredMapper.html new file mode 100644 index 00000000000..acf8d4da999 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/mappers/RequiredMapper.html @@ -0,0 +1,335 @@ + + + + + +RequiredMapper (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.schema.fromsmithy.mappers
    +

    Class RequiredMapper

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.cloudformation.schema.fromsmithy.mappers.RequiredMapper
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      CfnMapper
      +
      +
      +
      public final class RequiredMapper
+extends java.lang.Object
+implements CfnMapper
      +
      Generates the resource's required properties list based on the + required operation members that are part of the derived resource.
      +
      +
      See Also:
      +
      required Docs
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        RequiredMapper() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidbefore​(Context context, + ResourceSchema.Builder resourceSchema) +
        Updates an ResourceSchema.Builder before converting the model.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          RequiredMapper

          +
          public RequiredMapper()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          before

          +
          public void before​(Context context,
+                   ResourceSchema.Builder resourceSchema)
          +
          Description copied from interface: CfnMapper
          +
          Updates an ResourceSchema.Builder before converting the model.
          +
          +
          Specified by:
          +
          before in interface CfnMapper
          +
          Parameters:
          +
          context - Conversion context.
          +
          resourceSchema - ResourceSchema builder to modify.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/mappers/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/mappers/package-summary.html new file mode 100644 index 00000000000..f40793bdb5b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/mappers/package-summary.html @@ -0,0 +1,186 @@ + + + + + +software.amazon.smithy.aws.cloudformation.schema.fromsmithy.mappers (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.aws.cloudformation.schema.fromsmithy.mappers

    +
    +
    +
    + + +
    Defines the core functionality to generate CloudFormation Resource Schemas + from Smithy models.
    +
    +
      +
    • + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      CoreExtension +
      Registers the core Smithy2CloudFormation functionality.
      +
      HandlerPermissionMapper +
      Generates the resource's handler permissions list based on the lifecycle operation + used and any permissions listed in the aws.iam#requiredActions trait.
      +
      RequiredMapper +
      Generates the resource's required properties list based on the + required operation members that are part of the derived resource.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/mappers/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/mappers/package-tree.html new file mode 100644 index 00000000000..6f2be43fd86 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/mappers/package-tree.html @@ -0,0 +1,163 @@ + + + + + +software.amazon.smithy.aws.cloudformation.schema.fromsmithy.mappers Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.aws.cloudformation.schema.fromsmithy.mappers

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    +
      +
    • java.lang.Object +
        +
      • software.amazon.smithy.aws.cloudformation.schema.fromsmithy.mappers.CoreExtension (implements software.amazon.smithy.aws.cloudformation.schema.fromsmithy.Smithy2CfnExtension)
        • +
      • software.amazon.smithy.aws.cloudformation.schema.fromsmithy.mappers.HandlerPermissionMapper (implements software.amazon.smithy.aws.cloudformation.schema.fromsmithy.CfnMapper)
        • +
      • software.amazon.smithy.aws.cloudformation.schema.fromsmithy.mappers.RequiredMapper (implements software.amazon.smithy.aws.cloudformation.schema.fromsmithy.CfnMapper)
        • +
      +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/package-summary.html new file mode 100644 index 00000000000..520fa59f514 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/package-summary.html @@ -0,0 +1,205 @@ + + + + + +software.amazon.smithy.aws.cloudformation.schema.fromsmithy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.aws.cloudformation.schema.fromsmithy

    +
    +
    +
    + + +
    Defines tooling and interfaces for generating CloudFormation Resource + Schemas from Smithy models.
    +
    +
      +
    • + + + + + + + + + + + + + + + + +
      Interface Summary 
      InterfaceDescription
      CfnMapper +
      Provides a plugin infrastructure to hook into the Smithy CloudFormation + Resource Schema generation process and map over the result.
      +
      Smithy2CfnExtension +
      An extension mechanism used to influence how CloudFormation resource schemas + are generated from Smithy models.
      +
      +
      • +
    • + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      CfnConverter 
      Context +
      Smithy to CloudFormation conversion context object.
      +
      Smithy2Cfn 
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/package-tree.html new file mode 100644 index 00000000000..5564e275b58 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/fromsmithy/package-tree.html @@ -0,0 +1,170 @@ + + + + + +software.amazon.smithy.aws.cloudformation.schema.fromsmithy Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.aws.cloudformation.schema.fromsmithy

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    +
      +
    • java.lang.Object +
        +
      • software.amazon.smithy.aws.cloudformation.schema.fromsmithy.CfnConverter
        • +
      • software.amazon.smithy.aws.cloudformation.schema.fromsmithy.Context
        • +
      • software.amazon.smithy.aws.cloudformation.schema.fromsmithy.Smithy2Cfn (implements software.amazon.smithy.build.SmithyBuildPlugin)
        • +
      +
      • +
    +
    +
    +

    Interface Hierarchy

    +
      +
    • software.amazon.smithy.aws.cloudformation.schema.fromsmithy.CfnMapper
      • +
    • software.amazon.smithy.aws.cloudformation.schema.fromsmithy.Smithy2CfnExtension
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/Handler.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/Handler.Builder.html new file mode 100644 index 00000000000..cd006231ff6 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/Handler.Builder.html @@ -0,0 +1,327 @@ + + + + + +Handler.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.schema.model
    +

    Class Handler.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.cloudformation.schema.model.Handler.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public Handler build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Specified by:
          +
          build in interface SmithyBuilder<Handler>
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        + + + +
          +
        • +

          permissions

          +
          public Handler.Builder permissions​(java.util.Collection<java.lang.String> permissions)
          +
          • +
        + + + +
          +
        • +

          addPermission

          +
          public Handler.Builder addPermission​(java.lang.String permission)
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/Handler.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/Handler.html new file mode 100644 index 00000000000..d58a96273da --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/Handler.html @@ -0,0 +1,494 @@ + + + + + +Handler (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.schema.model
    +

    Class Handler

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.cloudformation.schema.model.Handler
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static class Handler.Builder 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        static java.lang.StringCREATE 
        static java.lang.StringDELETE 
        static java.lang.StringLIST 
        static java.lang.StringREAD 
        static java.lang.StringUPDATE 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          getPermissions

          +
          public java.util.Set<java.lang.String> getPermissions()
          +
          • +
        + + + +
          +
        • +

          getHandlerNameOrder

          +
          public static java.lang.Integer getHandlerNameOrder​(java.lang.String name)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/Property.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/Property.Builder.html new file mode 100644 index 00000000000..54eaa498582 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/Property.Builder.html @@ -0,0 +1,355 @@ + + + + + +Property.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.schema.model
    +

    Class Property.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.cloudformation.schema.model.Property.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/Property.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/Property.html new file mode 100644 index 00000000000..f97676f2074 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/Property.html @@ -0,0 +1,390 @@ + + + + + +Property (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.schema.model
    +

    Class Property

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.cloudformation.schema.model.Property
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          isInsertionOrder

          +
          public boolean isInsertionOrder()
          +
          • +
        + + + +
          +
        • +

          getDependencies

          +
          public java.util.List<java.lang.String> getDependencies()
          +
          • +
        + + + +
          +
        • +

          getSchema

          +
          public Schema getSchema()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/Remote.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/Remote.Builder.html new file mode 100644 index 00000000000..41721d044cb --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/Remote.Builder.html @@ -0,0 +1,401 @@ + + + + + +Remote.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.schema.model
    +

    Class Remote.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.cloudformation.schema.model.Remote.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public Remote build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Specified by:
          +
          build in interface SmithyBuilder<Remote>
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        + + + +
          +
        • +

          definitions

          +
          public Remote.Builder definitions​(java.util.Map<java.lang.String,​Schema> definitions)
          +
          • +
        + + + +
          +
        • +

          addDefinition

          +
          public Remote.Builder addDefinition​(java.lang.String name,
+                                    Schema definition)
          +
          • +
        + + + +
          +
        • +

          removeDefinition

          +
          public Remote.Builder removeDefinition​(java.lang.String name)
          +
          • +
        + + + + + + + +
          +
        • +

          properties

          +
          public Remote.Builder properties​(java.util.Map<java.lang.String,​Property> properties)
          +
          • +
        + + + + + + + +
          +
        • +

          removeProperty

          +
          public Remote.Builder removeProperty​(java.lang.String name)
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/Remote.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/Remote.html new file mode 100644 index 00000000000..e44b096fa14 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/Remote.html @@ -0,0 +1,376 @@ + + + + + +Remote (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.schema.model
    +

    Class Remote

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.cloudformation.schema.model.Remote
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          toBuilder

          +
          public Remote.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<Remote>
          +
          Returns:
          +
          a builder for type T
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getDefinitions

          +
          public java.util.Map<java.lang.String,​Schema> getDefinitions()
          +
          • +
        + + + +
          +
        • +

          getProperties

          +
          public java.util.Map<java.lang.String,​Property> getProperties()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/ResourceSchema.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/ResourceSchema.Builder.html new file mode 100644 index 00000000000..7fb93b818a0 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/ResourceSchema.Builder.html @@ -0,0 +1,881 @@ + + + + + +ResourceSchema.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.schema.model
    +

    Class ResourceSchema.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.cloudformation.schema.model.ResourceSchema.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/ResourceSchema.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/ResourceSchema.html new file mode 100644 index 00000000000..943ea69496d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/ResourceSchema.html @@ -0,0 +1,558 @@ + + + + + +ResourceSchema (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.schema.model
    +

    Class ResourceSchema

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.cloudformation.schema.model.ResourceSchema
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          getTypeName

          +
          public java.lang.String getTypeName()
          +
          • +
        + + + +
          +
        • +

          getDescription

          +
          public java.lang.String getDescription()
          +
          • +
        + + + +
          +
        • +

          getSourceUrl

          +
          public java.util.Optional<java.lang.String> getSourceUrl()
          +
          • +
        + + + +
          +
        • +

          getDocumentationUrl

          +
          public java.util.Optional<java.lang.String> getDocumentationUrl()
          +
          • +
        + + + +
          +
        • +

          getDefinitions

          +
          public java.util.Map<java.lang.String,​Schema> getDefinitions()
          +
          • +
        + + + +
          +
        • +

          getProperties

          +
          public java.util.Map<java.lang.String,​Property> getProperties()
          +
          • +
        + + + +
          +
        • +

          getReadOnlyProperties

          +
          public java.util.Set<java.lang.String> getReadOnlyProperties()
          +
          • +
        + + + +
          +
        • +

          getWriteOnlyProperties

          +
          public java.util.Set<java.lang.String> getWriteOnlyProperties()
          +
          • +
        + + + +
          +
        • +

          getPrimaryIdentifier

          +
          public java.util.Set<java.lang.String> getPrimaryIdentifier()
          +
          • +
        + + + +
          +
        • +

          getCreateOnlyProperties

          +
          public java.util.Set<java.lang.String> getCreateOnlyProperties()
          +
          • +
        + + + +
          +
        • +

          getDeprecatedProperties

          +
          public java.util.Set<java.lang.String> getDeprecatedProperties()
          +
          • +
        + + + +
          +
        • +

          getAdditionalIdentifiers

          +
          public java.util.List<java.util.List<java.lang.String>> getAdditionalIdentifiers()
          +
          • +
        + + + +
          +
        • +

          getHandlers

          +
          public java.util.Map<java.lang.String,​Handler> getHandlers()
          +
          • +
        + + + +
          +
        • +

          getRemotes

          +
          public java.util.Map<java.lang.String,​Remote> getRemotes()
          +
          • +
        + + + +
          +
        • +

          getTagging

          +
          public Tagging getTagging()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/Tagging.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/Tagging.Builder.html new file mode 100644 index 00000000000..26c8ff844cb --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/Tagging.Builder.html @@ -0,0 +1,395 @@ + + + + + +Tagging.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.schema.model
    +

    Class Tagging.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.cloudformation.schema.model.Tagging.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public Tagging build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Specified by:
          +
          build in interface SmithyBuilder<Tagging>
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        + + + + + + + +
          +
        • +

          tagOnCreate

          +
          public Tagging.Builder tagOnCreate​(boolean tagOnCreate)
          +
          • +
        + + + +
          +
        • +

          tagUpdatable

          +
          public Tagging.Builder tagUpdatable​(boolean tagUpdatable)
          +
          • +
        + + + +
          +
        • +

          cloudFormationSystemTags

          +
          public Tagging.Builder cloudFormationSystemTags​(boolean cloudFormationSystemTags)
          +
          • +
        + + + +
          +
        • +

          tagProperty

          +
          public Tagging.Builder tagProperty​(java.lang.String tagProperty)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/Tagging.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/Tagging.html new file mode 100644 index 00000000000..6186102824b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/Tagging.html @@ -0,0 +1,424 @@ + + + + + +Tagging (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.schema.model
    +

    Class Tagging

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.cloudformation.schema.model.Tagging
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static class Tagging.Builder 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static Tagging.Builderbuilder() 
        booleangetCloudFormationSystemTags() +
        Returns true if the resource supports CloudFormation system tags.
        +
        booleangetTaggable() +
        Returns true if the resource is taggable.
        +
        booleangetTagOnCreate() +
        Returns true if resource tags can be applied on create.
        +
        java.lang.StringgetTagProperty() +
        Returns the name of the tag property.
        +
        booleangetTagUpdatable() +
        Returns true if resource tags can be updated after create.
        +
        Tagging.BuildertoBuilder() +
        Take this object and create a builder that contains all of the + current property values of this object.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + + + + + +
          +
        • +

          getTaggable

          +
          public boolean getTaggable()
          +
          Returns true if the resource is taggable.
          +
          +
          Returns:
          +
          true if the resource is taggable.
          +
          +
          • +
        + + + +
          +
        • +

          getTagOnCreate

          +
          public boolean getTagOnCreate()
          +
          Returns true if resource tags can be applied on create.
          +
          +
          Returns:
          +
          true if resource tags can be applied on create.
          +
          +
          • +
        + + + +
          +
        • +

          getTagUpdatable

          +
          public boolean getTagUpdatable()
          +
          Returns true if resource tags can be updated after create.
          +
          +
          Returns:
          +
          true if resource tags can be updated after create.
          +
          +
          • +
        + + + +
          +
        • +

          getCloudFormationSystemTags

          +
          public boolean getCloudFormationSystemTags()
          +
          Returns true if the resource supports CloudFormation system tags.
          +
          +
          Returns:
          +
          true if the resource supports CloudFormation system tags.
          +
          +
          • +
        + + + +
          +
        • +

          getTagProperty

          +
          public java.lang.String getTagProperty()
          +
          Returns the name of the tag property.
          +
          +
          Returns:
          +
          the name of the tag property.
          +
          +
          • +
        + + + +
          +
        • +

          toBuilder

          +
          public Tagging.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<Tagging>
          +
          Returns:
          +
          a builder for type T
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/package-summary.html new file mode 100644 index 00000000000..18e5fde9527 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/package-summary.html @@ -0,0 +1,215 @@ + + + + + +software.amazon.smithy.aws.cloudformation.schema.model (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.aws.cloudformation.schema.model

    +
    +
    +
    + + +
    Defines data classes for representing CloudFormation Resource Schemas.
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/package-tree.html new file mode 100644 index 00000000000..d801d61a73f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/model/package-tree.html @@ -0,0 +1,170 @@ + + + + + +software.amazon.smithy.aws.cloudformation.schema.model Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.aws.cloudformation.schema.model

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    +
      +
    • java.lang.Object +
        +
      • software.amazon.smithy.aws.cloudformation.schema.model.Handler (implements software.amazon.smithy.model.node.ToNode, software.amazon.smithy.utils.ToSmithyBuilder<T>)
        • +
      • software.amazon.smithy.aws.cloudformation.schema.model.Handler.Builder (implements software.amazon.smithy.utils.SmithyBuilder<T>)
        • +
      • software.amazon.smithy.aws.cloudformation.schema.model.Property (implements software.amazon.smithy.model.node.ToNode, software.amazon.smithy.utils.ToSmithyBuilder<T>)
        • +
      • software.amazon.smithy.aws.cloudformation.schema.model.Property.Builder (implements software.amazon.smithy.utils.SmithyBuilder<T>)
        • +
      • software.amazon.smithy.aws.cloudformation.schema.model.Remote (implements software.amazon.smithy.model.node.ToNode, software.amazon.smithy.utils.ToSmithyBuilder<T>)
        • +
      • software.amazon.smithy.aws.cloudformation.schema.model.Remote.Builder (implements software.amazon.smithy.utils.SmithyBuilder<T>)
        • +
      • software.amazon.smithy.aws.cloudformation.schema.model.ResourceSchema (implements software.amazon.smithy.model.node.ToNode, software.amazon.smithy.utils.ToSmithyBuilder<T>)
        • +
      • software.amazon.smithy.aws.cloudformation.schema.model.ResourceSchema.Builder (implements software.amazon.smithy.utils.SmithyBuilder<T>)
        • +
      • software.amazon.smithy.aws.cloudformation.schema.model.Tagging (implements software.amazon.smithy.utils.ToSmithyBuilder<T>)
        • +
      • software.amazon.smithy.aws.cloudformation.schema.model.Tagging.Builder (implements software.amazon.smithy.utils.SmithyBuilder<T>)
        • +
      +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/package-summary.html new file mode 100644 index 00000000000..2bfabf474f3 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/package-summary.html @@ -0,0 +1,187 @@ + + + + + +software.amazon.smithy.aws.cloudformation.schema (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.aws.cloudformation.schema

    +
    +
    +
    + + +
    Defines core components for generating CloudFormation Resource Schemas + from Smithy models.
    +
    +
      +
    • + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      CfnConfig +
      "cloudformation" smithy-build plugin configuration settings.
      +
      +
      • +
    • + + + + + + + + + + + + +
      Exception Summary 
      ExceptionDescription
      CfnException 
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/package-tree.html new file mode 100644 index 00000000000..e03288c2508 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/schema/package-tree.html @@ -0,0 +1,178 @@ + + + + + +software.amazon.smithy.aws.cloudformation.schema Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.aws.cloudformation.schema

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    +
      +
    • java.lang.Object +
        +
      • software.amazon.smithy.jsonschema.JsonSchemaConfig +
          +
        • software.amazon.smithy.aws.cloudformation.schema.CfnConfig
          • +
        +
        • +
      • java.lang.Throwable (implements java.io.Serializable) +
          +
        • java.lang.Exception +
            +
          • java.lang.RuntimeException +
              +
            • software.amazon.smithy.aws.cloudformation.schema.CfnException
              • +
            +
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnAdditionalIdentifierTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnAdditionalIdentifierTrait.Provider.html new file mode 100644 index 00000000000..23606a477cc --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnAdditionalIdentifierTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +CfnAdditionalIdentifierTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.traits
    +

    Class CfnAdditionalIdentifierTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnAdditionalIdentifierTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnAdditionalIdentifierTrait.html new file mode 100644 index 00000000000..a684badd656 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnAdditionalIdentifierTrait.html @@ -0,0 +1,369 @@ + + + + + +CfnAdditionalIdentifierTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.traits
    +

    Class CfnAdditionalIdentifierTrait

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      FromSourceLocation, ToNode, ToShapeId, Trait
      +
      +
      +
      public final class CfnAdditionalIdentifierTrait
+extends AnnotationTrait
      +
      Indicates that the CloudFormation property generated from this member is an + additional identifier for the resource.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CfnAdditionalIdentifierTrait

          +
          public CfnAdditionalIdentifierTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          CfnAdditionalIdentifierTrait

          +
          public CfnAdditionalIdentifierTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnDefaultValueTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnDefaultValueTrait.Provider.html new file mode 100644 index 00000000000..7d2ca1dc281 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnDefaultValueTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +CfnDefaultValueTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.traits
    +

    Class CfnDefaultValueTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnDefaultValueTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnDefaultValueTrait.html new file mode 100644 index 00000000000..1463787491c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnDefaultValueTrait.html @@ -0,0 +1,369 @@ + + + + + +CfnDefaultValueTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.traits
    +

    Class CfnDefaultValueTrait

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      FromSourceLocation, ToNode, ToShapeId, Trait
      +
      +
      +
      public final class CfnDefaultValueTrait
+extends AnnotationTrait
      +
      Indicates that the CloudFormation property generated from this member has a + default value for this resource.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CfnDefaultValueTrait

          +
          public CfnDefaultValueTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          CfnDefaultValueTrait

          +
          public CfnDefaultValueTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnExcludePropertyTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnExcludePropertyTrait.Provider.html new file mode 100644 index 00000000000..f504a9b079f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnExcludePropertyTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +CfnExcludePropertyTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.traits
    +

    Class CfnExcludePropertyTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnExcludePropertyTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnExcludePropertyTrait.html new file mode 100644 index 00000000000..f896ff18d99 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnExcludePropertyTrait.html @@ -0,0 +1,369 @@ + + + + + +CfnExcludePropertyTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.traits
    +

    Class CfnExcludePropertyTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CfnExcludePropertyTrait

          +
          public CfnExcludePropertyTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          CfnExcludePropertyTrait

          +
          public CfnExcludePropertyTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnMutabilityTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnMutabilityTrait.Provider.html new file mode 100644 index 00000000000..48b8f3ae403 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnMutabilityTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +CfnMutabilityTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.traits
    +

    Class CfnMutabilityTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnMutabilityTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnMutabilityTrait.html new file mode 100644 index 00000000000..46e6cc99c7a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnMutabilityTrait.html @@ -0,0 +1,464 @@ + + + + + +CfnMutabilityTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.traits
    +

    Class CfnMutabilityTrait

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      FromSourceLocation, ToNode, ToShapeId, Trait
      +
      +
      +
      public final class CfnMutabilityTrait
+extends StringTrait
      +
      Indicates an explicit CloudFormation mutability of the structure member + when part of a CloudFormation resource.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CfnMutabilityTrait

          +
          public CfnMutabilityTrait​(java.lang.String value,
+                          SourceLocation sourceLocation)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          isFullyMutable

          +
          public boolean isFullyMutable()
          +
          • +
        + + + +
          +
        • +

          isCreate

          +
          public boolean isCreate()
          +
          • +
        + + + +
          +
        • +

          isCreateAndRead

          +
          public boolean isCreateAndRead()
          +
          • +
        + + + +
          +
        • +

          isRead

          +
          public boolean isRead()
          +
          • +
        + + + +
          +
        • +

          isWrite

          +
          public boolean isWrite()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnMutabilityTraitValidator.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnMutabilityTraitValidator.html new file mode 100644 index 00000000000..3882c0f14bd --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnMutabilityTraitValidator.html @@ -0,0 +1,349 @@ + + + + + +CfnMutabilityTraitValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.traits
    +

    Class CfnMutabilityTraitValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class CfnMutabilityTraitValidator
+extends AbstractValidator
      +
      Validates that members marked as having write-only mutability are not also + marked as additional identifiers for their CloudFormation resource.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CfnMutabilityTraitValidator

          +
          public CfnMutabilityTraitValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnNameTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnNameTrait.Provider.html new file mode 100644 index 00000000000..7f5ba1f8a29 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnNameTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +CfnNameTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.traits
    +

    Class CfnNameTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnNameTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnNameTrait.html new file mode 100644 index 00000000000..f1956966c6c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnNameTrait.html @@ -0,0 +1,381 @@ + + + + + +CfnNameTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.traits
    +

    Class CfnNameTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CfnNameTrait

          +
          public CfnNameTrait​(java.lang.String value,
+                    SourceLocation sourceLocation)
          +
          • +
        + + + +
          +
        • +

          CfnNameTrait

          +
          public CfnNameTrait​(java.lang.String value)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResource.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResource.Builder.html new file mode 100644 index 00000000000..f23816c50b5 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResource.Builder.html @@ -0,0 +1,429 @@ + + + + + +CfnResource.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.traits
    +

    Class CfnResource.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.cloudformation.traits.CfnResource.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResource.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResource.html new file mode 100644 index 00000000000..b219f653958 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResource.html @@ -0,0 +1,522 @@ + + + + + +CfnResource (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.traits
    +

    Class CfnResource

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.cloudformation.traits.CfnResource
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static class CfnResource.Builder 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static CfnResource.Builderbuilder() 
        java.util.List<java.util.Set<java.lang.String>>getAdditionalIdentifiers() +
        Get a list of sets of member shape ids, each set can be used to identify + the CloudFormation resource in addition to its primary identifier(s).
        +
        java.util.Set<java.lang.String>getCreateOnlyProperties() +
        Get create-specifiable-only property definitions of the CloudFormation resource.
        +
        java.util.Set<ShapeId>getExcludedProperties() +
        Get members that have been explicitly excluded from the CloudFormation + resource.
        +
        java.util.Set<java.lang.String>getPrimaryIdentifiers() +
        Gets a set of identifier names that represent the primary way to identify + a CloudFormation resource.
        +
        java.util.Map<java.lang.String,​CfnResourceProperty>getProperties() +
        Get all property definitions of the CloudFormation resource.
        +
        java.util.Optional<CfnResourceProperty>getProperty​(java.lang.String propertyName) +
        Gets the definition of the specified property of the CloudFormation resource.
        +
        java.util.Set<java.lang.String>getReadOnlyProperties() +
        Get read-only property definitions of the CloudFormation resource.
        +
        java.util.Set<java.lang.String>getWriteOnlyProperties() +
        Get write-only property definitions of the CloudFormation resource.
        +
        CfnResource.BuildertoBuilder() +
        Take this object and create a builder that contains all of the + current property values of this object.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + + + + + +
          +
        • +

          getProperties

          +
          public java.util.Map<java.lang.String,​CfnResourceProperty> getProperties()
          +
          Get all property definitions of the CloudFormation resource. + +

          Properties excluded by the cfnExcludedProperty trait are not + returned.

          +
          +
          Returns:
          +
          Returns all members that map to CloudFormation resource + properties.
          +
          See Also:
          +
          getExcludedProperties()
          +
          +
          • +
        + + + +
          +
        • +

          getProperty

          +
          public java.util.Optional<CfnResourceProperty> getProperty​(java.lang.String propertyName)
          +
          Gets the definition of the specified property of the CloudFormation resource. + +

          An empty Optional will be returned if the requested property + has been excluded by the cfnExcludedProperty trait.

          +
          +
          Parameters:
          +
          propertyName - Name of the property to retrieve
          +
          Returns:
          +
          The property definition.
          +
          See Also:
          +
          getExcludedProperties()
          +
          +
          • +
        + + + +
          +
        • +

          getCreateOnlyProperties

          +
          public java.util.Set<java.lang.String> getCreateOnlyProperties()
          +
          Get create-specifiable-only property definitions of the CloudFormation resource. + + These properties can be specified only during resource creation and + can be returned in a read or list request.
          +
          +
          Returns:
          +
          Returns create-only member names that map to CloudFormation resource + properties.
          +
          +
          • +
        + + + +
          +
        • +

          getReadOnlyProperties

          +
          public java.util.Set<java.lang.String> getReadOnlyProperties()
          +
          Get read-only property definitions of the CloudFormation resource. + + These properties can be returned by a read or list request, + but cannot be set by the user.
          +
          +
          Returns:
          +
          Returns read-only member names that map to CloudFormation resource + properties.
          +
          +
          • +
        + + + +
          +
        • +

          getWriteOnlyProperties

          +
          public java.util.Set<java.lang.String> getWriteOnlyProperties()
          +
          Get write-only property definitions of the CloudFormation resource. + + These properties can be specified by the user, but cannot be + returned by a read or list request.
          +
          +
          Returns:
          +
          Returns write-only member names that map to CloudFormation resource + properties.
          +
          +
          • +
        + + + +
          +
        • +

          getExcludedProperties

          +
          public java.util.Set<ShapeId> getExcludedProperties()
          +
          Get members that have been explicitly excluded from the CloudFormation + resource.
          +
          +
          Returns:
          +
          Returns members that have been excluded from a CloudFormation + resource.
          +
          +
          • +
        + + + +
          +
        • +

          getPrimaryIdentifiers

          +
          public java.util.Set<java.lang.String> getPrimaryIdentifiers()
          +
          Gets a set of identifier names that represent the primary way to identify + a CloudFormation resource. This uniquely identifies an individual instance + of the resource type, and can be one or more properties to represent + composite-key identifiers.
          +
          +
          Returns:
          +
          Returns the identifier set primarily used to access a + CloudFormation resource.
          +
          +
          • +
        + + + +
          +
        • +

          getAdditionalIdentifiers

          +
          public java.util.List<java.util.Set<java.lang.String>> getAdditionalIdentifiers()
          +
          Get a list of sets of member shape ids, each set can be used to identify + the CloudFormation resource in addition to its primary identifier(s).
          +
          +
          Returns:
          +
          Returns identifier sets used to access a CloudFormation resource.
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResourceIndex.Mutability.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResourceIndex.Mutability.html new file mode 100644 index 00000000000..40a0f768a9a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResourceIndex.Mutability.html @@ -0,0 +1,423 @@ + + + + + +CfnResourceIndex.Mutability (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.traits
    +

    Enum CfnResourceIndex.Mutability

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        CREATE +
        Applied when a property was derived from a lifecycle operation that + creates a resource or the CfnMutabilityTrait specifying full, + create, or create-and-read mutability.
        +
        READ +
        Applied when a property was derived from a lifecycle operation that + retrieves a resource or the CfnMutabilityTrait specifying full, + read, or create-and-read mutability.
        +
        WRITE +
        Applied when a property was derived from a lifecycle operation that + updates a resource or the CfnMutabilityTrait specifying full + or write mutability.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static CfnResourceIndex.MutabilityvalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static CfnResourceIndex.Mutability[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + +
          +
        • +

          CREATE

          +
          public static final CfnResourceIndex.Mutability CREATE
          +
          Applied when a property was derived from a lifecycle operation that + creates a resource or the CfnMutabilityTrait specifying full, + create, or create-and-read mutability.
          +
          • +
        + + + +
          +
        • +

          READ

          +
          public static final CfnResourceIndex.Mutability READ
          +
          Applied when a property was derived from a lifecycle operation that + retrieves a resource or the CfnMutabilityTrait specifying full, + read, or create-and-read mutability.
          +
          • +
        + + + + +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static CfnResourceIndex.Mutability[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (CfnResourceIndex.Mutability c : CfnResourceIndex.Mutability.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static CfnResourceIndex.Mutability valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResourceIndex.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResourceIndex.html new file mode 100644 index 00000000000..9e3e8e70eae --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResourceIndex.html @@ -0,0 +1,361 @@ + + + + + +CfnResourceIndex (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.traits
    +

    Class CfnResourceIndex

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.cloudformation.traits.CfnResourceIndex
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      KnowledgeIndex
      +
      +
      +
      public final class CfnResourceIndex
+extends java.lang.Object
+implements KnowledgeIndex
      +
      Index of resources to their CloudFormation identifiers and properties. + +

      This index performs no validation that the identifiers and reference + valid shapes.

      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static class CfnResourceIndex.Mutability +
        Mutability options derived through lifecycle operations or traits.
        +
        +
        • +
      +
      + +
      + +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CfnResourceIndex

          +
          public CfnResourceIndex​(Model model)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getResource

          +
          public java.util.Optional<CfnResource> getResource​(ToShapeId resource)
          +
          Gets the definition of the specified CloudFormation resource.
          +
          +
          Parameters:
          +
          resource - ShapeID of a resource
          +
          Returns:
          +
          The resource definition.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResourceProperty.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResourceProperty.Builder.html new file mode 100644 index 00000000000..ecb87941217 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResourceProperty.Builder.html @@ -0,0 +1,395 @@ + + + + + +CfnResourceProperty.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.traits
    +

    Class CfnResourceProperty.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.cloudformation.traits.CfnResourceProperty.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResourceProperty.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResourceProperty.html new file mode 100644 index 00000000000..696f4f4b7d7 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResourceProperty.html @@ -0,0 +1,393 @@ + + + + + +CfnResourceProperty (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.traits
    +

    Class CfnResourceProperty

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.cloudformation.traits.CfnResourceProperty
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getShapeId

          +
          public ShapeId getShapeId()
          +
          Gets the shape ID used to represent this property.
          +
          +
          Returns:
          +
          Returns the shape ID.
          +
          +
          • +
        + + + +
          +
        • +

          hasExplicitMutability

          +
          public boolean hasExplicitMutability()
          +
          Returns true if the property's mutability was configured explicitly + by the use of a trait instead of derived through its lifecycle + bindings within a resource. + +

          Also returns true for identifiers, since their mutability is inherent

          +
          +
          Returns:
          +
          Returns true if the mutability is explicitly defined by a trait or + if property is an identifier
          +
          See Also:
          +
          CfnMutabilityTrait
          +
          +
          • +
        + + + +
          +
        • +

          getMutabilities

          +
          public java.util.Set<CfnResourceIndex.Mutability> getMutabilities()
          +
          Gets all of the CloudFormation-specific property mutability options + associated with this resource property.
          +
          +
          Returns:
          +
          Returns the mutabilities.
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResourcePropertyValidator.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResourcePropertyValidator.html new file mode 100644 index 00000000000..89a8a8d451a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResourcePropertyValidator.html @@ -0,0 +1,348 @@ + + + + + +CfnResourcePropertyValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.traits
    +

    Class CfnResourcePropertyValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class CfnResourcePropertyValidator
+extends AbstractValidator
      +
      Validates that derived CloudFormation properties all have the same target.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CfnResourcePropertyValidator

          +
          public CfnResourcePropertyValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResourceTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResourceTrait.Builder.html new file mode 100644 index 00000000000..dc5ee644291 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResourceTrait.Builder.html @@ -0,0 +1,336 @@ + + + + + +CfnResourceTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.traits
    +

    Class CfnResourceTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResourceTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResourceTrait.Provider.html new file mode 100644 index 00000000000..6b4353d336d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResourceTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +CfnResourceTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.traits
    +

    Class CfnResourceTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResourceTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResourceTrait.html new file mode 100644 index 00000000000..7259d98847d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/CfnResourceTrait.html @@ -0,0 +1,453 @@ + + + + + +CfnResourceTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.cloudformation.traits
    +

    Class CfnResourceTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getName

          +
          public java.util.Optional<java.lang.String> getName()
          +
          Get the AWS CloudFormation resource name.
          +
          +
          Returns:
          +
          Returns the name.
          +
          +
          • +
        + + + +
          +
        • +

          getAdditionalSchemas

          +
          public java.util.List<ShapeId> getAdditionalSchemas()
          +
          Get the Smithy structure shape Ids for additional schema properties.
          +
          +
          Returns:
          +
          Returns the additional schema shape Ids.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          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.
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/package-summary.html new file mode 100644 index 00000000000..a21b0570ff1 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/package-summary.html @@ -0,0 +1,288 @@ + + + + + +software.amazon.smithy.aws.cloudformation.traits (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.aws.cloudformation.traits

    +
    +
    +
    + + +
    Defines traits used for generating CloudFormation Resource Schemas + from Smithy models.
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/package-tree.html new file mode 100644 index 00000000000..fc1d355561c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/cloudformation/traits/package-tree.html @@ -0,0 +1,226 @@ + + + + + +software.amazon.smithy.aws.cloudformation.traits Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.aws.cloudformation.traits

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Enum Hierarchy

    +
      +
    • java.lang.Object +
        +
      • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
        • +
      +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ActionNameTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ActionNameTrait.Provider.html new file mode 100644 index 00000000000..eb2d16b32bd --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ActionNameTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +ActionNameTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class ActionNameTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ActionNameTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ActionNameTrait.html new file mode 100644 index 00000000000..4e0352a4909 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ActionNameTrait.html @@ -0,0 +1,397 @@ + + + + + +ActionNameTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class ActionNameTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          Deprecated.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ActionNameTrait

          +
          public ActionNameTrait​(java.lang.String action)
          +
          Deprecated.
          +
          • +
        + + + +
          +
        • +

          ActionNameTrait

          +
          public ActionNameTrait​(java.lang.String action,
+                       FromSourceLocation sourceLocation)
          +
          Deprecated.
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ActionPermissionDescriptionTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ActionPermissionDescriptionTrait.Provider.html new file mode 100644 index 00000000000..7d0c436b071 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ActionPermissionDescriptionTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +ActionPermissionDescriptionTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class ActionPermissionDescriptionTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ActionPermissionDescriptionTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ActionPermissionDescriptionTrait.html new file mode 100644 index 00000000000..48e7ac60df3 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ActionPermissionDescriptionTrait.html @@ -0,0 +1,397 @@ + + + + + +ActionPermissionDescriptionTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class ActionPermissionDescriptionTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          Deprecated.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ActionPermissionDescriptionTrait

          +
          public ActionPermissionDescriptionTrait​(java.lang.String value)
          +
          Deprecated.
          +
          • +
        + + + +
          +
        • +

          ActionPermissionDescriptionTrait

          +
          public ActionPermissionDescriptionTrait​(java.lang.String value,
+                                        SourceLocation sourceLocation)
          +
          Deprecated.
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ActionResource.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ActionResource.Builder.html new file mode 100644 index 00000000000..275019ead88 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ActionResource.Builder.html @@ -0,0 +1,381 @@ + + + + + +ActionResource.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class ActionResource.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.iam.traits.ActionResource.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ActionResource.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ActionResource.html new file mode 100644 index 00000000000..1abb8018b39 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ActionResource.html @@ -0,0 +1,414 @@ + + + + + +ActionResource (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class ActionResource

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.iam.traits.ActionResource
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getConditionKeys

          +
          public java.util.List<java.lang.String> getConditionKeys()
          +
          Gets the condition keys used for authorizing against this resource.
          +
          +
          Returns:
          +
          the condition keys.
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ActionResources.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ActionResources.Builder.html new file mode 100644 index 00000000000..954c65bc24e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ActionResources.Builder.html @@ -0,0 +1,441 @@ + + + + + +ActionResources.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class ActionResources.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.iam.traits.ActionResources.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ActionResources.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ActionResources.html new file mode 100644 index 00000000000..5d3b922bd22 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ActionResources.html @@ -0,0 +1,425 @@ + + + + + +ActionResources (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class ActionResources

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.iam.traits.ActionResources
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static class ActionResources.Builder 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getRequired

          +
          public java.util.Map<java.lang.String,​ActionResource> getRequired()
          +
          Gets the resources that will always be authorized against for + functionality of the IAM action.
          +
          +
          Returns:
          +
          the required resources.
          +
          +
          • +
        + + + +
          +
        • +

          getOptional

          +
          public java.util.Map<java.lang.String,​ActionResource> getOptional()
          +
          Gets the resources that will be authorized against based on + optional behavior of the IAM action.
          +
          +
          Returns:
          +
          the optional resources.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ConditionKeyDefinition.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ConditionKeyDefinition.Builder.html new file mode 100644 index 00000000000..285fc7a0962 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ConditionKeyDefinition.Builder.html @@ -0,0 +1,381 @@ + + + + + +ConditionKeyDefinition.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class ConditionKeyDefinition.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.iam.traits.ConditionKeyDefinition.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ConditionKeyDefinition.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ConditionKeyDefinition.html new file mode 100644 index 00000000000..3afb5e3f951 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ConditionKeyDefinition.html @@ -0,0 +1,469 @@ + + + + + +ConditionKeyDefinition (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class ConditionKeyDefinition

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.iam.traits.ConditionKeyDefinition
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + +
          +
        • +

          getType

          +
          public java.lang.String getType()
          +
          +
          Returns:
          +
          The IAM policy type of the value that will supplied for this condition key.
          +
          +
          • +
        + + + +
          +
        • +

          getDocumentation

          +
          public java.util.Optional<java.lang.String> getDocumentation()
          +
          +
          Returns:
          +
          A short description of the role of the condition key.
          +
          +
          • +
        + + + +
          +
        • +

          getExternalDocumentation

          +
          public java.util.Optional<java.lang.String> getExternalDocumentation()
          +
          +
          Returns:
          +
          A URL to the documentation page.
          +
          +
          • +
        + + + +
          +
        • +

          getRelativeDocumentation

          +
          public java.util.Optional<java.lang.String> getRelativeDocumentation()
          +
          Get the relative URL path that defines more information about the condition key + within a set of IAM-related documentation.
          +
          +
          Returns:
          +
          A relative URL to the documentation page.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ConditionKeyValueTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ConditionKeyValueTrait.Provider.html new file mode 100644 index 00000000000..7897a181032 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ConditionKeyValueTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +ConditionKeyValueTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class ConditionKeyValueTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ConditionKeyValueTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ConditionKeyValueTrait.html new file mode 100644 index 00000000000..5b445c0c2df --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ConditionKeyValueTrait.html @@ -0,0 +1,381 @@ + + + + + +ConditionKeyValueTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class ConditionKeyValueTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ConditionKeyValueTrait

          +
          public ConditionKeyValueTrait​(java.lang.String conditionKey)
          +
          • +
        + + + +
          +
        • +

          ConditionKeyValueTrait

          +
          public ConditionKeyValueTrait​(java.lang.String conditionKey,
+                              FromSourceLocation sourceLocation)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ConditionKeysIndex.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ConditionKeysIndex.html new file mode 100644 index 00000000000..c52b3aadc7e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ConditionKeysIndex.html @@ -0,0 +1,421 @@ + + + + + +ConditionKeysIndex (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class ConditionKeysIndex

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.iam.traits.ConditionKeysIndex
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      KnowledgeIndex
      +
      +
      +
      public final class ConditionKeysIndex
+extends java.lang.Object
+implements KnowledgeIndex
      +
      Provides an index of condition keys for a service, including any condition + keys inferred from resource identifiers.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ConditionKeysIndex

          +
          public ConditionKeysIndex​(Model model)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getDefinedConditionKeys

          +
          public java.util.Map<java.lang.String,​ConditionKeyDefinition> getDefinedConditionKeys​(ToShapeId service)
          +
          Get all of the explicit and inferred condition keys used in the entire service. + +

          The result does not include global condition keys like "aws:accountId". + Use getConditionKeyNames(software.amazon.smithy.model.shapes.ToShapeId) to find all of the condition keys used + but not necessarily defined for a service.

          +
          +
          Parameters:
          +
          service - Service shape/shapeId to get.
          +
          Returns:
          +
          Returns the conditions keys of the service or an empty map when not found.
          +
          +
          • +
        + + + +
          +
        • +

          getConditionKeyNames

          +
          public java.util.Set<java.lang.String> getConditionKeyNames​(ToShapeId service)
          +
          Get all of the condition key names used in a service.
          +
          +
          Parameters:
          +
          service - Service shape/shapeId use to scope the result.
          +
          Returns:
          +
          Returns the conditions keys of the service or an empty map when not found.
          +
          +
          • +
        + + + +
          +
        • +

          getConditionKeyNames

          +
          public java.util.Set<java.lang.String> getConditionKeyNames​(ToShapeId service,
+                                                            ToShapeId resourceOrOperation)
          +
          Get all of the defined condition keys used in an operation or resource, including + any inferred keys and keys inherited by parent resource bindings.
          +
          +
          Parameters:
          +
          service - Service shape/shapeId use to scope the result.
          +
          resourceOrOperation - Resource or operation shape/shapeId
          +
          Returns:
          +
          Returns the conditions keys of the service or an empty map when not found.
          +
          +
          • +
        + + + +
          +
        • +

          getDefinedConditionKeys

          +
          public java.util.Map<java.lang.String,​ConditionKeyDefinition> getDefinedConditionKeys​(ToShapeId service,
+                                                                                            ToShapeId resourceOrOperation)
          +
          Get all of the defined condition keys used in an operation or resource, including + any inferred keys and keys inherited by parent resource bindings. + +

          The result does not include global condition keys like "aws:accountId". + Use getConditionKeyNames(software.amazon.smithy.model.shapes.ToShapeId) to find all of the condition keys used + but not necessarily defined for a resource or operation.

          +
          +
          Parameters:
          +
          service - Service shape/shapeId use to scope the result.
          +
          resourceOrOperation - Resource or operation shape/shapeId
          +
          Returns:
          +
          Returns the conditions keys of the service or an empty map when not found.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ConditionKeysTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ConditionKeysTrait.Builder.html new file mode 100644 index 00000000000..178a31661d9 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ConditionKeysTrait.Builder.html @@ -0,0 +1,306 @@ + + + + + +ConditionKeysTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class ConditionKeysTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public ConditionKeysTrait build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ConditionKeysTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ConditionKeysTrait.Provider.html new file mode 100644 index 00000000000..373033baa9e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ConditionKeysTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +ConditionKeysTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class ConditionKeysTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ConditionKeysTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ConditionKeysTrait.html new file mode 100644 index 00000000000..f5b55134681 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ConditionKeysTrait.html @@ -0,0 +1,459 @@ + + + + + +ConditionKeysTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class ConditionKeysTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ConditionKeysTrait

          +
          public ConditionKeysTrait​(java.util.List<java.lang.String> keys,
+                          FromSourceLocation sourceLocation)
          +
          • +
        + + + +
          +
        • +

          ConditionKeysTrait

          +
          public ConditionKeysTrait​(java.util.List<java.lang.String> keys)
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ConditionKeysValidator.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ConditionKeysValidator.html new file mode 100644 index 00000000000..6cae9767a03 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ConditionKeysValidator.html @@ -0,0 +1,354 @@ + + + + + +ConditionKeysValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class ConditionKeysValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class ConditionKeysValidator
+extends AbstractValidator
      +
      Ensures that condition keys referenced by operations bound within the + closure of a service are defined either explicitly using the + defineConditionKeys trait or through an inferred resource + identifier condition key. + +

      Condition keys that refer to global "aws:*" keys are allowed to not + be defined on the service.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ConditionKeysValidator

          +
          public ConditionKeysValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/DefineConditionKeysTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/DefineConditionKeysTrait.Builder.html new file mode 100644 index 00000000000..0dc1881b581 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/DefineConditionKeysTrait.Builder.html @@ -0,0 +1,324 @@ + + + + + +DefineConditionKeysTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class DefineConditionKeysTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/DefineConditionKeysTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/DefineConditionKeysTrait.Provider.html new file mode 100644 index 00000000000..7ca5a2f4642 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/DefineConditionKeysTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +DefineConditionKeysTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class DefineConditionKeysTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/DefineConditionKeysTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/DefineConditionKeysTrait.html new file mode 100644 index 00000000000..f8e4f11ab66 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/DefineConditionKeysTrait.html @@ -0,0 +1,455 @@ + + + + + +DefineConditionKeysTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class DefineConditionKeysTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getConditionKeys

          +
          public java.util.Map<java.lang.String,​ConditionKeyDefinition> getConditionKeys()
          +
          Gets all condition keys of the service.
          +
          +
          Returns:
          +
          Returns the immutable map of condition key name to definition.
          +
          +
          • +
        + + + +
          +
        • +

          getConditionKey

          +
          public java.util.Optional<ConditionKeyDefinition> getConditionKey​(java.lang.String name)
          +
          Get a specific condition key by name.
          +
          +
          Parameters:
          +
          name - Name of the condition key to get.
          +
          Returns:
          +
          Returns the optionall found condition key.
          +
          +
          • +
        + + + +
          +
        • +

          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.
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/DisableConditionKeyInferenceTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/DisableConditionKeyInferenceTrait.Provider.html new file mode 100644 index 00000000000..b41da566c4e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/DisableConditionKeyInferenceTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +DisableConditionKeyInferenceTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class DisableConditionKeyInferenceTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/DisableConditionKeyInferenceTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/DisableConditionKeyInferenceTrait.html new file mode 100644 index 00000000000..9b8a81ca3ee --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/DisableConditionKeyInferenceTrait.html @@ -0,0 +1,368 @@ + + + + + +DisableConditionKeyInferenceTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class DisableConditionKeyInferenceTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          DisableConditionKeyInferenceTrait

          +
          public DisableConditionKeyInferenceTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          DisableConditionKeyInferenceTrait

          +
          public DisableConditionKeyInferenceTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/IamActionTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/IamActionTrait.Builder.html new file mode 100644 index 00000000000..6269aa0c2a0 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/IamActionTrait.Builder.html @@ -0,0 +1,462 @@ + + + + + +IamActionTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class IamActionTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/IamActionTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/IamActionTrait.Provider.html new file mode 100644 index 00000000000..43a42cdde27 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/IamActionTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +IamActionTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class IamActionTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/IamActionTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/IamActionTrait.html new file mode 100644 index 00000000000..abd22bc552b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/IamActionTrait.html @@ -0,0 +1,633 @@ + + + + + +IamActionTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class IamActionTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getName

          +
          public java.util.Optional<java.lang.String> getName()
          +
          Get the AWS IAM resource name.
          +
          +
          Returns:
          +
          Returns the name.
          +
          +
          • +
        + + + +
          +
        • +

          resolveActionName

          +
          public static java.lang.String resolveActionName​(OperationShape operation)
          +
          Resolves the IAM action name for the given operation. Uses the following + resolution order: + +
            +
          1. Value of the @iamAction trait's name property
            2. +
          2. Value of the @actionName trait
            3. +
          3. The operation's name
            4. +
          +
          +
          Parameters:
          +
          operation - the operation to resolve a name for.
          +
          Returns:
          +
          The resolved action name.
          +
          +
          • +
        + + + +
          +
        • +

          getDocumentation

          +
          public java.util.Optional<java.lang.String> getDocumentation()
          +
          Gets the description of what granting the user permission to + invoke an operation would entail.
          +
          +
          Returns:
          +
          Returns the documentation.
          +
          +
          • +
        + + + +
          +
        • +

          resolveActionDocumentation

          +
          public static java.lang.String resolveActionDocumentation​(OperationShape operation)
          +
          Resolves the IAM action documentation for the given operation. Uses the following + resolution order: + +
            +
          1. Value of the @iamAction trait's documentation property
            2. +
          2. Value of the @actionPermissionDescription trait
            3. +
          3. Value of the @documentation trait
            4. +
          +
          +
          Parameters:
          +
          operation - the operation to resolve documentation for.
          +
          Returns:
          +
          The resolved action documentation.
          +
          +
          • +
        + + + +
          +
        • +

          getRelativeDocumentation

          +
          public java.util.Optional<java.lang.String> getRelativeDocumentation()
          +
          Gets the relative URL path for the action within a set of + IAM-related documentation.
          +
          +
          Returns:
          +
          Returns the relative URL path to documentation.
          +
          +
          • +
        + + + +
          +
        • +

          getRequiredActions

          +
          public java.util.List<java.lang.String> getRequiredActions()
          +
          Gets other actions that the invoker must be authorized to + perform when executing the targeted operation.
          +
          +
          Returns:
          +
          Returns the list of required actions.
          +
          +
          • +
        + + + +
          +
        • +

          resolveRequiredActions

          +
          public static java.util.List<java.lang.String> resolveRequiredActions​(OperationShape operation)
          +
          Resolves the IAM action required actions for the given operation. Uses the following + resolution order: + +
            +
          1. Value of the @iamAction trait's requiredActions property
            2. +
          2. Value of the @requiredActions trait
            3. +
          3. An empty list.
            4. +
          +
          +
          Parameters:
          +
          operation - the operation to resolve required actions for.
          +
          Returns:
          +
          The resolved required actions.
          +
          +
          • +
        + + + +
          +
        • +

          getResources

          +
          public java.util.Optional<ActionResources> getResources()
          +
          Gets the resources an IAM action can be authorized against.
          +
          +
          Returns:
          +
          Returns the action's resources.
          +
          +
          • +
        + + + +
          +
        • +

          getCreatesResources

          +
          public java.util.List<java.lang.String> getCreatesResources()
          +
          Gets the resources that performing this IAM action will create.
          +
          +
          Returns:
          +
          Returns the resources created by the action.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          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.
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/IamActionValidator.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/IamActionValidator.html new file mode 100644 index 00000000000..b6df5a5dc6e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/IamActionValidator.html @@ -0,0 +1,347 @@ + + + + + +IamActionValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class IamActionValidator

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          IamActionValidator

          +
          public IamActionValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/IamResourceTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/IamResourceTrait.Builder.html new file mode 100644 index 00000000000..8b8f3574c70 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/IamResourceTrait.Builder.html @@ -0,0 +1,336 @@ + + + + + +IamResourceTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class IamResourceTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public IamResourceTrait build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        + + + + + + + +
          +
        • +

          relativeDocumentation

          +
          public IamResourceTrait.Builder relativeDocumentation​(java.lang.String relativeDocumentation)
          +
          • +
        + + + +
          +
        • +

          disableConditionKeyInheritance

          +
          public IamResourceTrait.Builder disableConditionKeyInheritance​(boolean disableConditionKeyInheritance)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/IamResourceTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/IamResourceTrait.Provider.html new file mode 100644 index 00000000000..9c7c5c2d1a7 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/IamResourceTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +IamResourceTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class IamResourceTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/IamResourceTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/IamResourceTrait.html new file mode 100644 index 00000000000..b055a313fc6 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/IamResourceTrait.html @@ -0,0 +1,507 @@ + + + + + +IamResourceTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class IamResourceTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getName

          +
          public java.util.Optional<java.lang.String> getName()
          +
          Get the AWS IAM resource name.
          +
          +
          Returns:
          +
          Returns the name.
          +
          +
          • +
        + + + +
          +
        • +

          resolveResourceName

          +
          public static java.lang.String resolveResourceName​(ResourceShape resource)
          +
          Resolves the IAM resource name for the given resource. Uses the following + resolution order: + +
            +
          1. Value of the @iamResource trait's name property
            2. +
          2. The resource's name
            3. +
          +
          +
          Parameters:
          +
          resource - the resource to resolve a name for.
          +
          Returns:
          +
          The resolved resource name.
          +
          +
          • +
        + + + +
          +
        • +

          getRelativeDocumentation

          +
          public java.util.Optional<java.lang.String> getRelativeDocumentation()
          +
          Get the relative URL path that defines more information about the resource + within a set of IAM-related documentation.
          +
          +
          Returns:
          +
          A relative URL to the documentation page.
          +
          +
          • +
        + + + +
          +
        • +

          isDisableConditionKeyInheritance

          +
          public boolean isDisableConditionKeyInheritance()
          +
          Gets if this IAM resource's condition keys are decoupled from + those of its parent resource(s).
          +
          +
          Returns:
          +
          Returns true if condition key inheritance is disabled.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          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.
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/IamResourceTraitValidator.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/IamResourceTraitValidator.html new file mode 100644 index 00000000000..cc66b3f72ec --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/IamResourceTraitValidator.html @@ -0,0 +1,350 @@ + + + + + +IamResourceTraitValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class IamResourceTraitValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public class IamResourceTraitValidator
+extends AbstractValidator
      +
      Ensures that any resource name defined in the IamResourceTrait is + consistent with the resource name used in any ArnTrait definition + applied to the resource.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          IamResourceTraitValidator

          +
          public IamResourceTraitValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/RequiredActionsTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/RequiredActionsTrait.Builder.html new file mode 100644 index 00000000000..b9a9ddd1d4d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/RequiredActionsTrait.Builder.html @@ -0,0 +1,346 @@ + + + + + +RequiredActionsTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class RequiredActionsTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public RequiredActionsTrait build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/RequiredActionsTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/RequiredActionsTrait.Provider.html new file mode 100644 index 00000000000..e846dd2ec25 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/RequiredActionsTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +RequiredActionsTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class RequiredActionsTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/RequiredActionsTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/RequiredActionsTrait.html new file mode 100644 index 00000000000..82d9a921287 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/RequiredActionsTrait.html @@ -0,0 +1,481 @@ + + + + + +RequiredActionsTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class RequiredActionsTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          Deprecated.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          RequiredActionsTrait

          +
          public RequiredActionsTrait​(java.util.List<java.lang.String> actions,
+                            FromSourceLocation sourceLocation)
          +
          Deprecated.
          +
          • +
        + + + +
          +
        • +

          RequiredActionsTrait

          +
          public RequiredActionsTrait​(java.util.List<java.lang.String> actions)
          +
          Deprecated.
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ServiceResolvedConditionKeysTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ServiceResolvedConditionKeysTrait.Provider.html new file mode 100644 index 00000000000..a0b1d2cdec8 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ServiceResolvedConditionKeysTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +ServiceResolvedConditionKeysTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class ServiceResolvedConditionKeysTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ServiceResolvedConditionKeysTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ServiceResolvedConditionKeysTrait.html new file mode 100644 index 00000000000..3a9527cc0c5 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/ServiceResolvedConditionKeysTrait.html @@ -0,0 +1,388 @@ + + + + + +ServiceResolvedConditionKeysTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class ServiceResolvedConditionKeysTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ServiceResolvedConditionKeysTrait

          +
          public ServiceResolvedConditionKeysTrait​(java.util.List<java.lang.String> conditionKeys)
          +
          • +
        + + + +
          +
        • +

          ServiceResolvedConditionKeysTrait

          +
          public ServiceResolvedConditionKeysTrait​(java.util.List<java.lang.String> conditionKeys,
+                                         FromSourceLocation sourceLocation)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/SupportedPrincipalTypesTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/SupportedPrincipalTypesTrait.Builder.html new file mode 100644 index 00000000000..238b9db5530 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/SupportedPrincipalTypesTrait.Builder.html @@ -0,0 +1,306 @@ + + + + + +SupportedPrincipalTypesTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class SupportedPrincipalTypesTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public SupportedPrincipalTypesTrait build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/SupportedPrincipalTypesTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/SupportedPrincipalTypesTrait.Provider.html new file mode 100644 index 00000000000..57614e1c0be --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/SupportedPrincipalTypesTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +SupportedPrincipalTypesTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class SupportedPrincipalTypesTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/SupportedPrincipalTypesTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/SupportedPrincipalTypesTrait.html new file mode 100644 index 00000000000..bbceb47eda1 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/SupportedPrincipalTypesTrait.html @@ -0,0 +1,458 @@ + + + + + +SupportedPrincipalTypesTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.iam.traits
    +

    Class SupportedPrincipalTypesTrait

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/package-summary.html new file mode 100644 index 00000000000..c7c5b6af299 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/package-summary.html @@ -0,0 +1,344 @@ + + + + + +software.amazon.smithy.aws.iam.traits (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.aws.iam.traits

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/package-tree.html new file mode 100644 index 00000000000..18e26295a35 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/iam/traits/package-tree.html @@ -0,0 +1,242 @@ + + + + + +software.amazon.smithy.aws.iam.traits Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.aws.iam.traits

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/smoketests/model/AwsSmokeTestModel.html b/javadoc/1.47.0/software/amazon/smithy/aws/smoketests/model/AwsSmokeTestModel.html new file mode 100644 index 00000000000..347393b3c40 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/smoketests/model/AwsSmokeTestModel.html @@ -0,0 +1,346 @@ + + + + + +AwsSmokeTestModel (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.smoketests.model
    +

    Class AwsSmokeTestModel

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.smoketests.model.AwsSmokeTestModel
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class AwsSmokeTestModel
+extends java.lang.Object
      +
      Provides methods for interfacing with Java representations of the different + kinds of vendor params shapes used in smoke tests for AWS services.
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/smoketests/model/AwsVendorParams.html b/javadoc/1.47.0/software/amazon/smithy/aws/smoketests/model/AwsVendorParams.html new file mode 100644 index 00000000000..1c6fbc7aa1b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/smoketests/model/AwsVendorParams.html @@ -0,0 +1,281 @@ + + + + + +AwsVendorParams (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.smoketests.model
    +

    Class AwsVendorParams

    +
    +
    + +
    +
      +
    • +
      +
      public final class AwsVendorParams
+extends BaseAwsVendorParams
      +
      Concrete vendor params to apply to AWS services by default.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/smoketests/model/BaseAwsVendorParams.html b/javadoc/1.47.0/software/amazon/smithy/aws/smoketests/model/BaseAwsVendorParams.html new file mode 100644 index 00000000000..364ea218a96 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/smoketests/model/BaseAwsVendorParams.html @@ -0,0 +1,367 @@ + + + + + +BaseAwsVendorParams (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.smoketests.model
    +

    Class BaseAwsVendorParams

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.smoketests.model.BaseAwsVendorParams
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Direct Known Subclasses:
      +
      AwsVendorParams, S3VendorParams
      +
      +
      +
      public abstract class BaseAwsVendorParams
+extends java.lang.Object
      +
      Base vendor params for all AWS services.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.lang.StringgetRegion() 
        java.util.Optional<java.util.List<java.lang.String>>getSigv4aRegionSet() 
        java.util.Optional<java.lang.String>getUri() 
        booleanuseAccountIdRouting() 
        booleanuseDualstack() 
        booleanuseFips() 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + +
          +
        • +

          getRegion

          +
          public java.lang.String getRegion()
          +
          +
          Returns:
          +
          The AWS region to sign the request for and to resolve the default + endpoint with. Defaults to us-west-2.
          +
          +
          • +
        + + + +
          +
        • +

          getSigv4aRegionSet

          +
          public java.util.Optional<java.util.List<java.lang.String>> getSigv4aRegionSet()
          +
          +
          Returns:
          +
          The set of regions to sign a sigv4a request with, if present.
          +
          +
          • +
        + + + +
          +
        • +

          getUri

          +
          public java.util.Optional<java.lang.String> getUri()
          +
          +
          Returns:
          +
          The static endpoint to send the request to, if present.
          +
          +
          • +
        + + + +
          +
        • +

          useFips

          +
          public boolean useFips()
          +
          +
          Returns:
          +
          Whether to resolve a FIPS compliant endpoint or not. Defaults to + false.
          +
          +
          • +
        + + + +
          +
        • +

          useDualstack

          +
          public boolean useDualstack()
          +
          +
          Returns:
          +
          Whether to resolve a dualstack endpoint or not. Defaults to + false.
          +
          +
          • +
        + + + +
          +
        • +

          useAccountIdRouting

          +
          public boolean useAccountIdRouting()
          +
          +
          Returns:
          +
          Whether to use account ID based routing where applicable. + Defaults to true.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/smoketests/model/S3VendorParams.html b/javadoc/1.47.0/software/amazon/smithy/aws/smoketests/model/S3VendorParams.html new file mode 100644 index 00000000000..3fb6502d29f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/smoketests/model/S3VendorParams.html @@ -0,0 +1,399 @@ + + + + + +S3VendorParams (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.smoketests.model
    +

    Class S3VendorParams

    +
    +
    + +
    +
      +
    • +
      +
      public final class S3VendorParams
+extends BaseAwsVendorParams
      +
      Vendor params for S3.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          useAccelerate

          +
          public boolean useAccelerate()
          +
          +
          Returns:
          +
          Whether to resolve an accelerate endpoint or not. Defaults to + false.
          +
          +
          • +
        + + + +
          +
        • +

          useGlobalEndpoint

          +
          public boolean useGlobalEndpoint()
          +
          +
          Returns:
          +
          Whether to use the global endpoint for us-east-1. + Defaults to false.
          +
          +
          • +
        + + + +
          +
        • +

          forcePathStyle

          +
          public boolean forcePathStyle()
          +
          +
          Returns:
          +
          Whether to force path-style addressing. Defaults to false.
          +
          +
          • +
        + + + +
          +
        • +

          useArnRegion

          +
          public boolean useArnRegion()
          +
          +
          Returns:
          +
          Whether to use the region in the bucket ARN to override the set + region. Defaults to true.
          +
          +
          • +
        + + + +
          +
        • +

          useMultiRegionAccessPoints

          +
          public boolean useMultiRegionAccessPoints()
          +
          +
          Returns:
          +
          Whether to use S3's multi-region access points. Defaults to + true.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/smoketests/model/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/aws/smoketests/model/package-summary.html new file mode 100644 index 00000000000..078551f64d0 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/smoketests/model/package-summary.html @@ -0,0 +1,185 @@ + + + + + +software.amazon.smithy.aws.smoketests.model (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.aws.smoketests.model

    +
    +
    +
      +
    • + + + + + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      AwsSmokeTestModel +
      Provides methods for interfacing with Java representations of the different + kinds of vendor params shapes used in smoke tests for AWS services.
      +
      AwsVendorParams +
      Concrete vendor params to apply to AWS services by default.
      +
      BaseAwsVendorParams +
      Base vendor params for all AWS services.
      +
      S3VendorParams +
      Vendor params for S3.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/smoketests/model/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/aws/smoketests/model/package-tree.html new file mode 100644 index 00000000000..26f62cd70e3 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/smoketests/model/package-tree.html @@ -0,0 +1,167 @@ + + + + + +software.amazon.smithy.aws.smoketests.model Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.aws.smoketests.model

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/ArnIndex.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/ArnIndex.html new file mode 100644 index 00000000000..36b8c51ae54 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/ArnIndex.html @@ -0,0 +1,433 @@ + + + + + +ArnIndex (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits
    +

    Class ArnIndex

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.traits.ArnIndex
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      KnowledgeIndex
      +
      +
      +
      public final class ArnIndex
+extends java.lang.Object
+implements KnowledgeIndex
      +
      Resolves and indexes the ARN templates for each resource in a service.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ArnIndex

          +
          public ArnIndex​(Model model)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getServiceArnNamespace

          +
          public java.lang.String getServiceArnNamespace​(ToShapeId serviceId)
          +
          Gets the ARN service namespace of a service shape.
          +
          +
          Parameters:
          +
          serviceId - Service shape to get ARN namespace of.
          +
          Returns:
          +
          Returns the resolved ARN service namespace, defaulting to the + lowercase shape name if not known.
          +
          +
          • +
        + + + +
          +
        • +

          getServiceResourceArns

          +
          public java.util.Map<ShapeId,​ArnTrait> getServiceResourceArns​(ToShapeId service)
          +
          Gets all of the mappings of resources within a service to its + arnTemplate trait.
          +
          +
          Parameters:
          +
          service - Service to retrieve.
          +
          Returns:
          +
          Returns the mapping of resource ID to arnTemplate traits.
          +
          +
          • +
        + + + +
          +
        • +

          getEffectiveOperationArn

          +
          public java.util.Optional<ArnTrait> getEffectiveOperationArn​(ToShapeId service,
+                                                             ToShapeId operation)
          +
          Gets the effective ARN of an operation based on the identifier bindings + of the operation bound to a resource contained within a service. + +

          An operation bound to a resource using a collection binding has an + effective ARN of the parent of the resource. An operation bound to a + resource using an instance binding uses the ARN of the resource as + its effective ARN.

          +
          +
          Parameters:
          +
          service - Service the operation is bound within.
          +
          operation - Operation shape for which to find the effective ARN.
          +
          Returns:
          +
          Returns the optionally found effective ARN.
          +
          +
          • +
        + + + +
          +
        • +

          getFullResourceArnTemplate

          +
          public java.util.Optional<java.lang.String> getFullResourceArnTemplate​(ToShapeId service,
+                                                                       ToShapeId resource)
          +
          Expands the relative ARN of a resource with the service name to form a + full ARN template. + +

          For relative ARNs, the returned template string is in the format of + arn:{AWS::Partition}:service:{AWS::Region}:{AWS::AccountId}:resource + where "service" is the resolved ARN service name of the service and + "resource" is the resource part of the arnTemplate template. + "{AWS::Region}" is added to the template if the arnTemplate "noRegion" + value is not set to true. "{AWS::AccountId}" is added to the template if + the arnTemplate "noAccount" value is not set to true. + +

          For example, if both "noAccount" and "noRegion" are set to true, + the resolved ARN template might look like "arn:{AWS::Partition}:service:::resource". + +

          Absolute ARN templates are returned as-is.

          +
          +
          Parameters:
          +
          service - Service shape ID.
          +
          resource - Resource shape ID.
          +
          Returns:
          +
          Returns the optionally found ARN template for a resource.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/ArnReferenceTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/ArnReferenceTrait.Builder.html new file mode 100644 index 00000000000..f7f04321b68 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/ArnReferenceTrait.Builder.html @@ -0,0 +1,337 @@ + + + + + +ArnReferenceTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits
    +

    Class ArnReferenceTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/ArnReferenceTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/ArnReferenceTrait.Provider.html new file mode 100644 index 00000000000..c85ba318f84 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/ArnReferenceTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +ArnReferenceTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits
    +

    Class ArnReferenceTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/ArnReferenceTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/ArnReferenceTrait.html new file mode 100644 index 00000000000..c8cdb6624a5 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/ArnReferenceTrait.html @@ -0,0 +1,512 @@ + + + + + +ArnReferenceTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits
    +

    Class ArnReferenceTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getType

          +
          public java.util.Optional<java.lang.String> getType()
          +
          Get the AWS CloudFormation type of the ARN.
          +
          +
          Returns:
          +
          Returns the optional type.
          +
          +
          • +
        + + + +
          +
        • +

          getResource

          +
          public java.util.Optional<ShapeId> getResource()
          +
          Get the Smithy resource shape ID of the ARN.
          +
          +
          Returns:
          +
          Returns the optionally present shape ID.
          +
          +
          • +
        + + + +
          +
        • +

          getService

          +
          public java.util.Optional<ShapeId> getService()
          +
          Get the Smithy service shape ID of the ARN.
          +
          +
          Returns:
          +
          Returns the optionally present shape ID.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          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.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object other)
          +
          +
          Overrides:
          +
          equals in class AbstractTrait
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/ArnTemplateValidator.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/ArnTemplateValidator.html new file mode 100644 index 00000000000..f0e07f1fb1e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/ArnTemplateValidator.html @@ -0,0 +1,349 @@ + + + + + +ArnTemplateValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits
    +

    Class ArnTemplateValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class ArnTemplateValidator
+extends AbstractValidator
      +
      Ensures that all arn traits for a service are valid and that their templates + only reference valid resource identifiers.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ArnTemplateValidator

          +
          public ArnTemplateValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/ArnTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/ArnTrait.Builder.html new file mode 100644 index 00000000000..b29d2c37c5b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/ArnTrait.Builder.html @@ -0,0 +1,351 @@ + + + + + +ArnTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits
    +

    Class ArnTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public ArnTrait build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        + + + +
          +
        • +

          template

          +
          public ArnTrait.Builder template​(java.lang.String template)
          +
          • +
        + + + + + + + + + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/ArnTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/ArnTrait.Provider.html new file mode 100644 index 00000000000..60922bec2ee --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/ArnTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +ArnTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits
    +

    Class ArnTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/ArnTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/ArnTrait.html new file mode 100644 index 00000000000..a1225e8b09b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/ArnTrait.html @@ -0,0 +1,544 @@ + + + + + +ArnTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits
    +

    Class ArnTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          isNoAccount

          +
          public boolean isNoAccount()
          +
          +
          Returns:
          +
          Returns the noAccount setting.
          +
          +
          • +
        + + + +
          +
        • +

          isNoRegion

          +
          public boolean isNoRegion()
          +
          +
          Returns:
          +
          Returns the noRegion setting.
          +
          +
          • +
        + + + +
          +
        • +

          isAbsolute

          +
          public boolean isAbsolute()
          +
          +
          Returns:
          +
          Returns whether or not the ARN is absolute.
          +
          +
          • +
        + + + +
          +
        • +

          getTemplate

          +
          public java.lang.String getTemplate()
          +
          +
          Returns:
          +
          Gets the template of the ARN.
          +
          +
          • +
        + + + +
          +
        • +

          getLabels

          +
          public java.util.List<java.lang.String> getLabels()
          +
          +
          Returns:
          +
          Returns the label place holder variable names.
          +
          +
          • +
        + + + +
          +
        • +

          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 ArnTrait.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<ArnTrait>
          +
          Returns:
          +
          a builder for type T
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object other)
          +
          +
          Overrides:
          +
          equals in class AbstractTrait
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/ControlPlaneTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/ControlPlaneTrait.Provider.html new file mode 100644 index 00000000000..0932760cfdd --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/ControlPlaneTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +ControlPlaneTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits
    +

    Class ControlPlaneTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/ControlPlaneTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/ControlPlaneTrait.html new file mode 100644 index 00000000000..e74e89e8f4a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/ControlPlaneTrait.html @@ -0,0 +1,367 @@ + + + + + +ControlPlaneTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits
    +

    Class ControlPlaneTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ControlPlaneTrait

          +
          public ControlPlaneTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          ControlPlaneTrait

          +
          public ControlPlaneTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/DataPlaneTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/DataPlaneTrait.Provider.html new file mode 100644 index 00000000000..e8d3d633d2c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/DataPlaneTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +DataPlaneTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits
    +

    Class DataPlaneTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/DataPlaneTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/DataPlaneTrait.html new file mode 100644 index 00000000000..a95f7f43a08 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/DataPlaneTrait.html @@ -0,0 +1,367 @@ + + + + + +DataPlaneTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits
    +

    Class DataPlaneTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          DataPlaneTrait

          +
          public DataPlaneTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          DataPlaneTrait

          +
          public DataPlaneTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/DataTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/DataTrait.Provider.html new file mode 100644 index 00000000000..59a9ae47d02 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/DataTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +DataTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits
    +

    Class DataTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/DataTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/DataTrait.html new file mode 100644 index 00000000000..fc79a0f70a9 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/DataTrait.html @@ -0,0 +1,368 @@ + + + + + +DataTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits
    +

    Class DataTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          DataTrait

          +
          public DataTrait​(java.lang.String value,
+                 SourceLocation sourceLocation)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/ErrorRenameValidator.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/ErrorRenameValidator.html new file mode 100644 index 00000000000..e738cb53ef2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/ErrorRenameValidator.html @@ -0,0 +1,347 @@ + + + + + +ErrorRenameValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits
    +

    Class ErrorRenameValidator

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ErrorRenameValidator

          +
          public ErrorRenameValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/EventSourceValidator.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/EventSourceValidator.html new file mode 100644 index 00000000000..40d1ba1f1e8 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/EventSourceValidator.html @@ -0,0 +1,350 @@ + + + + + +EventSourceValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits
    +

    Class EventSourceValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class EventSourceValidator
+extends AbstractValidator
      +
      Validates that the aws.api#service/eventSource property matches + aws.api#service/arnNamespace + ".amazonaws.com" and does + not use incorrect formats.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          EventSourceValidator

          +
          public EventSourceValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/HttpChecksumTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/HttpChecksumTrait.Builder.html new file mode 100644 index 00000000000..a571d7d1b23 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/HttpChecksumTrait.Builder.html @@ -0,0 +1,378 @@ + + + + + +HttpChecksumTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits
    +

    Class HttpChecksumTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/HttpChecksumTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/HttpChecksumTrait.Provider.html new file mode 100644 index 00000000000..c91b5988043 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/HttpChecksumTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +HttpChecksumTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits
    +

    Class HttpChecksumTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/HttpChecksumTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/HttpChecksumTrait.html new file mode 100644 index 00000000000..711fed616bb --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/HttpChecksumTrait.html @@ -0,0 +1,638 @@ + + + + + +HttpChecksumTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits
    +

    Class HttpChecksumTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        + + + +
          +
        • +

          CHECKSUM_PREFIX

          +
          public static final java.lang.String CHECKSUM_PREFIX
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        + + + +
          +
        • +

          CHECKSUM_ALGORITHMS

          +
          public static final java.util.List<java.lang.String> CHECKSUM_ALGORITHMS
          +
          • +
        + + + +
          +
        • +

          VALIDATION_MODES

          +
          public static final java.util.List<java.lang.String> VALIDATION_MODES
          +
          • +
        + + + +
          +
        • +

          REQUEST_CHECKSUM_REQUIRED

          +
          public static final java.lang.String REQUEST_CHECKSUM_REQUIRED
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        + + + +
          +
        • +

          REQUEST_ALGORITHM_MEMBER

          +
          public static final java.lang.String REQUEST_ALGORITHM_MEMBER
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        + + + +
          +
        • +

          REQUEST_VALIDATION_MODE_MEMBER

          +
          public static final java.lang.String REQUEST_VALIDATION_MODE_MEMBER
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        + + + +
          +
        • +

          RESPONSE_ALGORITHMS

          +
          public static final java.lang.String RESPONSE_ALGORITHMS
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + +
          +
        • +

          isRequestChecksumRequired

          +
          public boolean isRequestChecksumRequired()
          +
          Returns true if request requires checksum to be present.
          +
          +
          Returns:
          +
          Returns if checksum is required.
          +
          +
          • +
        + + + +
          +
        • +

          getRequestAlgorithmMember

          +
          public java.util.Optional<java.lang.String> getRequestAlgorithmMember()
          +
          Optionally gets name of the input member used to specify which request checksum to send.
          +
          +
          Returns:
          +
          Returns optional input member name.
          +
          +
          • +
        + + + +
          +
        • +

          getResponseAlgorithms

          +
          public java.util.List<java.lang.String> getResponseAlgorithms()
          +
          Gets list of checksum algorithms for which checksum values when present in HTTP response should be validated.
          +
          +
          Returns:
          +
          Returns checksum properties for response.
          +
          +
          • +
        + + + +
          +
        • +

          getRequestValidationModeMember

          +
          public java.util.Optional<java.lang.String> getRequestValidationModeMember()
          +
          Optionally gets name of the input member used to specify opt-in behavior + for response checksum validation.
          +
          +
          Returns:
          +
          Returns optional input member name.
          +
          +
          • +
        + + + +
          +
        • +

          getChecksumLocationName

          +
          public static java.lang.String getChecksumLocationName​(java.lang.String checksumAlgorithm)
          +
          Gets the normalized location name for a checksum algorithm.
          +
          +
          Parameters:
          +
          checksumAlgorithm - The algorithm to get a location name of.
          +
          Returns:
          +
          The normalized location name.
          +
          +
          • +
        + + + +
          +
        • +

          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.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/HttpChecksumTraitValidator.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/HttpChecksumTraitValidator.html new file mode 100644 index 00000000000..8d24b85cef0 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/HttpChecksumTraitValidator.html @@ -0,0 +1,360 @@ + + + + + +HttpChecksumTraitValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits
    +

    Class HttpChecksumTraitValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class HttpChecksumTraitValidator
+extends AbstractValidator
      +
      Validates the HttpChecksum trait. + +
        +
      • Validates that at least one of the request or response checksum + behavior is configured.
        • +
      • Validates that the requestAlgorithmMember and + requestChecksumModeMember properties point to valid input members.
        • +
      • Validates that the requestAlgorithmMember targeted member contains + only supported algorithms.
        • +
      • Validates that the requestChecksumModeMember targeted member contains + only supported modes.
        • +
      • Checks for conflicts with @httpHeader and @httpPrefixHeaders.
        • +
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpChecksumTraitValidator

          +
          public HttpChecksumTraitValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/PlaneIndex.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/PlaneIndex.html new file mode 100644 index 00000000000..fd1de606167 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/PlaneIndex.html @@ -0,0 +1,467 @@ + + + + + +PlaneIndex (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits
    +

    Class PlaneIndex

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.traits.PlaneIndex
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      KnowledgeIndex
      +
      +
      +
      public final class PlaneIndex
+extends java.lang.Object
+implements KnowledgeIndex
      +
      Determines if a service, resource, or operation are considered + part of the data plane or control plane. + +

      The plane is inherited from the top-down and can be overridden + per shape. For example, if a service shape has the + aws.api#controlPlane shape, then every shape within the closure + of the service inherits this property. If a resource shape defines a + aws.api#controlPlane or aws.api#dataPlane trait, then all + shapes within the closure of the resource inherit it. If an operation is + marked with the aws.api#dataPlane trait, it overrides any plane + traits of the service or resource its bound within.

      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        PlaneIndex​(Model model) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        booleanisControlPlane​(ToShapeId service) +
        Checks if the given service shape is part of the control plane.
        +
        booleanisControlPlane​(ToShapeId service, + ToShapeId operationOrResource) +
        Checks if the given shape within a service is part of the control plane.
        +
        booleanisDataPlane​(ToShapeId service) +
        Checks if the given service shape is part of the data plane.
        +
        booleanisDataPlane​(ToShapeId service, + ToShapeId operationOrResource) +
        Checks if the given shape within a service is part of the data plane.
        +
        booleanisPlaneDefined​(ToShapeId service) +
        Checks if the given service shape has defined its plane.
        +
        booleanisPlaneDefined​(ToShapeId service, + ToShapeId operationOrResource) +
        Checks if the given shape within a service has a resolvable plane.
        +
        static PlaneIndexof​(Model model) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          PlaneIndex

          +
          public PlaneIndex​(Model model)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          isControlPlane

          +
          public boolean isControlPlane​(ToShapeId service)
          +
          Checks if the given service shape is part of the control plane.
          +
          +
          Parameters:
          +
          service - Service to check.
          +
          Returns:
          +
          Returns true if the service is part of the control plane.
          +
          +
          • +
        + + + +
          +
        • +

          isControlPlane

          +
          public boolean isControlPlane​(ToShapeId service,
+                              ToShapeId operationOrResource)
          +
          Checks if the given shape within a service is part of the control plane.
          +
          +
          Parameters:
          +
          service - Service to check.
          +
          operationOrResource - Operation or resource within the service to check.
          +
          Returns:
          +
          Returns true if the shape is part of the control plane.
          +
          +
          • +
        + + + +
          +
        • +

          isDataPlane

          +
          public boolean isDataPlane​(ToShapeId service)
          +
          Checks if the given service shape is part of the data plane.
          +
          +
          Parameters:
          +
          service - Service to check.
          +
          Returns:
          +
          Returns true if the service is part of the data plane.
          +
          +
          • +
        + + + +
          +
        • +

          isDataPlane

          +
          public boolean isDataPlane​(ToShapeId service,
+                           ToShapeId operationOrResource)
          +
          Checks if the given shape within a service is part of the data plane.
          +
          +
          Parameters:
          +
          service - Service to check.
          +
          operationOrResource - Operation or resource within the service to check.
          +
          Returns:
          +
          Returns true if the shape is part of the data plane.
          +
          +
          • +
        + + + +
          +
        • +

          isPlaneDefined

          +
          public boolean isPlaneDefined​(ToShapeId service)
          +
          Checks if the given service shape has defined its plane.
          +
          +
          Parameters:
          +
          service - Service to check.
          +
          Returns:
          +
          Returns true if the service has defined its plane.
          +
          +
          • +
        + + + +
          +
        • +

          isPlaneDefined

          +
          public boolean isPlaneDefined​(ToShapeId service,
+                              ToShapeId operationOrResource)
          +
          Checks if the given shape within a service has a resolvable plane.
          +
          +
          Parameters:
          +
          service - Service to check.
          +
          operationOrResource - Operation or resource within the service to check.
          +
          Returns:
          +
          Returns true if the shape has a resolvable plane.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/SdkServiceIdValidator.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/SdkServiceIdValidator.html new file mode 100644 index 00000000000..2dbe5fbefe6 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/SdkServiceIdValidator.html @@ -0,0 +1,403 @@ + + + + + +SdkServiceIdValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits
    +

    Class SdkServiceIdValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class SdkServiceIdValidator
+extends AbstractValidator
      +
      Validates that SDK service IDs are correct and do not match any + prohibited patterns. + +
        +
      • Must match the following regex: ^[a-zA-Z][a-zA-Z0-9]*( [a-zA-Z0-9]+)*$
        • +
      • Must not contain "Amazon", "AWS", or "Aws"
        • +
      • Must not case-insensitively end with "Service", "Client", or "API".
        • +
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          SdkServiceIdValidator

          +
          public SdkServiceIdValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        + + + +
          +
        • +

          isPreviouslyReleasedInvalidServiceId

          +
          public static boolean isPreviouslyReleasedInvalidServiceId​(java.lang.String serviceId)
          +
          Checks if the given value is a previously released but + invalid service ID.
          +
          +
          Parameters:
          +
          serviceId - Service ID value to check.
          +
          Returns:
          +
          Returns true if the service ID is approved but invalid.
          +
          +
          • +
        + + + +
          +
        • +

          validateServiceId

          +
          public static void validateServiceId​(java.lang.String serviceId)
          +
          Validates a service ID value.
          +
          +
          Parameters:
          +
          serviceId - Service ID to validate.
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if the service ID is invalid.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/ServiceTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/ServiceTrait.Builder.html new file mode 100644 index 00000000000..83ad35322e2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/ServiceTrait.Builder.html @@ -0,0 +1,471 @@ + + + + + +ServiceTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits
    +

    Class ServiceTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public ServiceTrait build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        + + + + + + + +
          +
        • +

          cloudFormationName

          +
          public ServiceTrait.Builder cloudFormationName​(java.lang.String cloudFormationName)
          +
          Sets the AWS CloudFormation resource type service name. + +

          Must match the following regex ^[a-z0-9.\-]{1,63}$

          +
          +
          Parameters:
          +
          cloudFormationName - AWS CloudFormation resource type service name.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          arnNamespace

          +
          public ServiceTrait.Builder arnNamespace​(java.lang.String arnNamespace)
          +
          Set the ARN service namespace of the service. + +

          Must match the following regex: ^[A-Z][A-Za-z0-9]+$

          +
          +
          Parameters:
          +
          arnNamespace - ARN service namespace to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          sdkId

          +
          public ServiceTrait.Builder sdkId​(java.lang.String sdkId)
          +
          Set the SDK service ID trait used to control client class names. + +

          Must match the following regex: ^[a-zA-Z][a-zA-Z0-9]*( [a-zA-Z0-9]+)*$

          +
          +
          Parameters:
          +
          sdkId - SDK service ID to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          cloudTrailEventSource

          +
          public ServiceTrait.Builder cloudTrailEventSource​(java.lang.String cloudTrailEventSource)
          +
          Set the CloudTrail event source name of the service.
          +
          +
          Parameters:
          +
          cloudTrailEventSource - CloudTrail event source name of the service.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          docId

          +
          public ServiceTrait.Builder docId​(java.lang.String docId)
          +
          Set the documentation identifier for the service.
          +
          +
          Parameters:
          +
          docId - documentation identifier for the service.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          endpointPrefix

          +
          public ServiceTrait.Builder endpointPrefix​(java.lang.String endpointPrefix)
          +
          Set the endpoint prefix used to construct client endpoints.
          +
          +
          Parameters:
          +
          endpointPrefix - The endpoint prefix of the service.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          abbreviation

          +
          @Deprecated
+public ServiceTrait.Builder abbreviation​(java.lang.String abbreviation)
          +
          Deprecated.
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/ServiceTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/ServiceTrait.Provider.html new file mode 100644 index 00000000000..53adad9a1f3 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/ServiceTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +ServiceTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits
    +

    Class ServiceTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/ServiceTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/ServiceTrait.html new file mode 100644 index 00000000000..2d514198132 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/ServiceTrait.html @@ -0,0 +1,636 @@ + + + + + +ServiceTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits
    +

    Class ServiceTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getArnNamespace

          +
          public java.lang.String getArnNamespace()
          +
          Get the AWS ARN service namespace of the service. + +

          If not set, this value defaults to the name of the service shape + converted to lowercase. This value is combined with resources contained + within the service to form ARNs for resources. Only resources that + explicitly define the 'aws.api#arnTemplate' trait are assigned ARNs, + and their relative ARNs are combined with the service's arnNamespace to + form an ARN.

          +
          +
          Returns:
          +
          Returns the ARN service name (e.g., "route53").
          +
          +
          • +
        + + + +
          +
        • +

          getCloudFormationName

          +
          public java.lang.String getCloudFormationName()
          +
          Get the AWS CloudFormation service name. + +

          When not set, this value defaults to the name of the service shape.

          +
          +
          Returns:
          +
          Returns the optionally present AWS CloudFormation type prefix.
          +
          +
          • +
        + + + +
          +
        • +

          getSdkId

          +
          public java.lang.String getSdkId()
          +
          Get the SDK service ID. + +

          This value is used to generate SDK class names.

          +
          +
          Returns:
          +
          Returns the AWS SDK service ID value.
          +
          +
          • +
        + + + +
          +
        • +

          getCloudTrailEventSource

          +
          public java.lang.String getCloudTrailEventSource()
          +
          Returns the CloudTrail event source name of the service.
          +
          +
          Returns:
          +
          Returns the event source name.
          +
          +
          • +
        + + + +
          +
        • +

          resolveDocId

          +
          public java.lang.String resolveDocId​(ServiceShape serviceShape)
          +
          Resolves the doc id value for the service. + +

          When value on trait is not set, this method defaults to the lower + cased value of the sdkId followed by the service version, separated by + dashes.

          +
          +
          Parameters:
          +
          serviceShape - the shape which this trait targets
          +
          Returns:
          +
          Returns the documentation identifier value for the service name.
          +
          Throws:
          +
          ExpectationNotMetException - if the shape is not the target of this trait.
          +
          +
          • +
        + + + +
          +
        • +

          getDocId

          +
          protected java.util.Optional<java.lang.String> getDocId()
          +
          • +
        + + + +
          +
        • +

          getEndpointPrefix

          +
          public java.lang.String getEndpointPrefix()
          +
          Returns the endpoint prefix for the service. + + This value is not unique across services and it can change at any time. + Therefore it MUST NOT be used to generate class names, namespaces, or + for any other purpose that requires a static, unique identifier. The + sdkId property should be used for those purposes.
          +
          +
          Returns:
          +
          Returns the aws sdk endpoint prefix.
          +
          +
          • +
        + + + +
          +
        • +

          getAbbreviation

          +
          @Deprecated
+public java.util.Optional<java.lang.String> getAbbreviation()
          +
          Deprecated.
          +
          • +
        + + + + + + + +
          +
        • +

          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.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object other)
          +
          +
          Overrides:
          +
          equals in class AbstractTrait
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/CognitoUserPoolsTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/CognitoUserPoolsTrait.Builder.html new file mode 100644 index 00000000000..bfe63bd1c0e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/CognitoUserPoolsTrait.Builder.html @@ -0,0 +1,362 @@ + + + + + +CognitoUserPoolsTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.auth
    +

    Class CognitoUserPoolsTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public CognitoUserPoolsTrait build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        + + + +
          +
        • +

          providerArns

          +
          public CognitoUserPoolsTrait.Builder providerArns​(java.util.List<java.lang.String> providerArns)
          +
          Sets the provider ARNs.
          +
          +
          Parameters:
          +
          providerArns - ARNS to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          addProviderArn

          +
          public CognitoUserPoolsTrait.Builder addProviderArn​(java.lang.String arn)
          +
          Adds a provider ARN.
          +
          +
          Parameters:
          +
          arn - ARN to add.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          clearProviderArns

          +
          public CognitoUserPoolsTrait.Builder clearProviderArns()
          +
          Clears all provider ARNs from the builder.
          +
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/CognitoUserPoolsTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/CognitoUserPoolsTrait.Provider.html new file mode 100644 index 00000000000..c0e382405ed --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/CognitoUserPoolsTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +CognitoUserPoolsTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.auth
    +

    Class CognitoUserPoolsTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/CognitoUserPoolsTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/CognitoUserPoolsTrait.html new file mode 100644 index 00000000000..d5fc200d939 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/CognitoUserPoolsTrait.html @@ -0,0 +1,438 @@ + + + + + +CognitoUserPoolsTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.auth
    +

    Class CognitoUserPoolsTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getProviderArns

          +
          public java.util.List<java.lang.String> getProviderArns()
          +
          Get the list of provider ARNs.
          +
          +
          Returns:
          +
          Returns the ARNs.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          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.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/SigV4ATrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/SigV4ATrait.Builder.html new file mode 100644 index 00000000000..c30df817daa --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/SigV4ATrait.Builder.html @@ -0,0 +1,308 @@ + + + + + +SigV4ATrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.auth
    +

    Class SigV4ATrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public SigV4ATrait build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/SigV4ATrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/SigV4ATrait.Provider.html new file mode 100644 index 00000000000..5aa42a51dad --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/SigV4ATrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +SigV4ATrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.auth
    +

    Class SigV4ATrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/SigV4ATrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/SigV4ATrait.html new file mode 100644 index 00000000000..35859e88438 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/SigV4ATrait.html @@ -0,0 +1,432 @@ + + + + + +SigV4ATrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.auth
    +

    Class SigV4ATrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getName

          +
          public java.lang.String getName()
          +
          Gets the service signing name.
          +
          +
          Returns:
          +
          the service signing name
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          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.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/SigV4Trait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/SigV4Trait.Builder.html new file mode 100644 index 00000000000..a72c124380f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/SigV4Trait.Builder.html @@ -0,0 +1,308 @@ + + + + + +SigV4Trait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.auth
    +

    Class SigV4Trait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          build

          +
          public SigV4Trait build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/SigV4Trait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/SigV4Trait.Provider.html new file mode 100644 index 00000000000..d4c493cd7a7 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/SigV4Trait.Provider.html @@ -0,0 +1,337 @@ + + + + + +SigV4Trait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.auth
    +

    Class SigV4Trait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/SigV4Trait.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/SigV4Trait.html new file mode 100644 index 00000000000..50c42aa03e0 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/SigV4Trait.html @@ -0,0 +1,429 @@ + + + + + +SigV4Trait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.auth
    +

    Class SigV4Trait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getName

          +
          public java.lang.String getName()
          +
          +
          Returns:
          +
          Gets the service signing name.
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          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.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/SigV4TraitsValidator.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/SigV4TraitsValidator.html new file mode 100644 index 00000000000..4d4e9767ee1 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/SigV4TraitsValidator.html @@ -0,0 +1,348 @@ + + + + + +SigV4TraitsValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.auth
    +

    Class SigV4TraitsValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class SigV4TraitsValidator
+extends AbstractValidator
      +
      Validates AWS Service, SigV4, and SigV4A traits.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          SigV4TraitsValidator

          +
          public SigV4TraitsValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/UnsignedPayloadTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/UnsignedPayloadTrait.Provider.html new file mode 100644 index 00000000000..7de8a4d0c1c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/UnsignedPayloadTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +UnsignedPayloadTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.auth
    +

    Class UnsignedPayloadTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/UnsignedPayloadTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/UnsignedPayloadTrait.html new file mode 100644 index 00000000000..de5671d12d5 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/UnsignedPayloadTrait.html @@ -0,0 +1,368 @@ + + + + + +UnsignedPayloadTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.auth
    +

    Class UnsignedPayloadTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          UnsignedPayloadTrait

          +
          public UnsignedPayloadTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          UnsignedPayloadTrait

          +
          public UnsignedPayloadTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/package-summary.html new file mode 100644 index 00000000000..127b074e489 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/package-summary.html @@ -0,0 +1,220 @@ + + + + + +software.amazon.smithy.aws.traits.auth (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.aws.traits.auth

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/package-tree.html new file mode 100644 index 00000000000..0776bdbdcaa --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/auth/package-tree.html @@ -0,0 +1,196 @@ + + + + + +software.amazon.smithy.aws.traits.auth Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.aws.traits.auth

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/CleanClientDiscoveryTraitTransformer.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/CleanClientDiscoveryTraitTransformer.html new file mode 100644 index 00000000000..4f1cd1592ee --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/CleanClientDiscoveryTraitTransformer.html @@ -0,0 +1,328 @@ + + + + + +CleanClientDiscoveryTraitTransformer (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.clientendpointdiscovery
    +

    Class CleanClientDiscoveryTraitTransformer

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.traits.clientendpointdiscovery.CleanClientDiscoveryTraitTransformer
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ModelTransformerPlugin
      +
      +
      +
      public final class CleanClientDiscoveryTraitTransformer
+extends java.lang.Object
+implements ModelTransformerPlugin
      +
      Removes the endpoint discovery trait from a service if the referenced operation or error are removed.
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        ModelonRemove​(ModelTransformer transformer, + java.util.Collection<Shape> shapes, + Model model) +
        The method that is invoked each time shapes are removed from a model.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          CleanClientDiscoveryTraitTransformer

          +
          public CleanClientDiscoveryTraitTransformer()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          onRemove

          +
          public Model onRemove​(ModelTransformer transformer,
+                      java.util.Collection<Shape> shapes,
+                      Model model)
          +
          Description copied from interface: ModelTransformerPlugin
          +
          The method that is invoked each time shapes are removed from a model.
          +
          +
          Specified by:
          +
          onRemove in interface ModelTransformerPlugin
          +
          Parameters:
          +
          transformer - Transformer used to replace/remove shapes from the model.
          +
          shapes - The of shapes that were removed from the model.
          +
          model - Model that has been altered to remove removed.
          +
          Returns:
          +
          Returns a transformed version of the passed in model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientDiscoveredEndpointTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientDiscoveredEndpointTrait.Builder.html new file mode 100644 index 00000000000..5266fe6489e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientDiscoveredEndpointTrait.Builder.html @@ -0,0 +1,309 @@ + + + + + +ClientDiscoveredEndpointTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.clientendpointdiscovery
    +

    Class ClientDiscoveredEndpointTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientDiscoveredEndpointTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientDiscoveredEndpointTrait.Provider.html new file mode 100644 index 00000000000..bd82e448b62 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientDiscoveredEndpointTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +ClientDiscoveredEndpointTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.clientendpointdiscovery
    +

    Class ClientDiscoveredEndpointTrait.Provider

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public ClientDiscoveredEndpointTrait createTrait​(ShapeId target,
+                                                 Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientDiscoveredEndpointTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientDiscoveredEndpointTrait.html new file mode 100644 index 00000000000..e36cbc6df1c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientDiscoveredEndpointTrait.html @@ -0,0 +1,436 @@ + + + + + +ClientDiscoveredEndpointTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.clientendpointdiscovery
    +

    Class ClientDiscoveredEndpointTrait

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientEndpointDiscoveryIdTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientEndpointDiscoveryIdTrait.Provider.html new file mode 100644 index 00000000000..ce14473c1c2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientEndpointDiscoveryIdTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +ClientEndpointDiscoveryIdTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.clientendpointdiscovery
    +

    Class ClientEndpointDiscoveryIdTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientEndpointDiscoveryIdTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientEndpointDiscoveryIdTrait.html new file mode 100644 index 00000000000..bc19fabed06 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientEndpointDiscoveryIdTrait.html @@ -0,0 +1,369 @@ + + + + + +ClientEndpointDiscoveryIdTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.clientendpointdiscovery
    +

    Class ClientEndpointDiscoveryIdTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ClientEndpointDiscoveryIdTrait

          +
          public ClientEndpointDiscoveryIdTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          ClientEndpointDiscoveryIdTrait

          +
          public ClientEndpointDiscoveryIdTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientEndpointDiscoveryIndex.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientEndpointDiscoveryIndex.html new file mode 100644 index 00000000000..5d3a2cf045b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientEndpointDiscoveryIndex.html @@ -0,0 +1,339 @@ + + + + + +ClientEndpointDiscoveryIndex (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.clientendpointdiscovery
    +

    Class ClientEndpointDiscoveryIndex

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.traits.clientendpointdiscovery.ClientEndpointDiscoveryIndex
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      KnowledgeIndex
      +
      +
      +
      public final class ClientEndpointDiscoveryIndex
+extends java.lang.Object
+implements KnowledgeIndex
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientEndpointDiscoveryInfo.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientEndpointDiscoveryInfo.html new file mode 100644 index 00000000000..5d02c907f17 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientEndpointDiscoveryInfo.html @@ -0,0 +1,353 @@ + + + + + +ClientEndpointDiscoveryInfo (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.clientendpointdiscovery
    +

    Class ClientEndpointDiscoveryInfo

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.traits.clientendpointdiscovery.ClientEndpointDiscoveryInfo
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class ClientEndpointDiscoveryInfo
+extends java.lang.Object
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientEndpointDiscoveryTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientEndpointDiscoveryTrait.Builder.html new file mode 100644 index 00000000000..bd1776e2531 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientEndpointDiscoveryTrait.Builder.html @@ -0,0 +1,348 @@ + + + + + +ClientEndpointDiscoveryTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.clientendpointdiscovery
    +

    Class ClientEndpointDiscoveryTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public ClientEndpointDiscoveryTrait build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        + + + +
          +
        • +

          operation

          +
          public ClientEndpointDiscoveryTrait.Builder operation​(ShapeId operation)
          +
          Set the operation used to discover endpoints for the service. + +

          The operation MUST be bound to the service.

          +
          +
          Parameters:
          +
          operation - The ShapeId of the operation used to discover endpoints.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          error

          +
          public ClientEndpointDiscoveryTrait.Builder error​(ShapeId error)
          +
          Set the error shape which indicates to a client that an endpoint + they are using is no longer valid. + +

          This error MUST be bound to every operation bound to the service + which is marked with an ClientDiscoveredEndpointTrait.

          +
          +
          Parameters:
          +
          error - The ShapeId of the invalid endpoint error.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientEndpointDiscoveryTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientEndpointDiscoveryTrait.Provider.html new file mode 100644 index 00000000000..af235281d00 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientEndpointDiscoveryTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +ClientEndpointDiscoveryTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.clientendpointdiscovery
    +

    Class ClientEndpointDiscoveryTrait.Provider

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public ClientEndpointDiscoveryTrait createTrait​(ShapeId target,
+                                                Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientEndpointDiscoveryTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientEndpointDiscoveryTrait.html new file mode 100644 index 00000000000..4dcbd16901e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientEndpointDiscoveryTrait.html @@ -0,0 +1,525 @@ + + + + + +ClientEndpointDiscoveryTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.clientendpointdiscovery
    +

    Class ClientEndpointDiscoveryTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getOperation

          +
          public ShapeId getOperation()
          +
          The operation used to discover endpoints for the service. + +

          The operation MUST be bound to the service.

          +
          +
          Returns:
          +
          The ShapeId of the operation used to discover endpoints.
          +
          +
          • +
        + + + +
          +
        • +

          getOptionalError

          +
          public java.util.Optional<ShapeId> getOptionalError()
          +
          The error shape which indicates to a client that an endpoint they are + using is no longer valid. + +

          This error MUST be bound to every operation bound to the service + which is marked with an ClientDiscoveredEndpointTrait.

          +
          +
          Returns:
          +
          The ShapeId of the invalid endpoint error.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          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.
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientEndpointDiscoveryValidator.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientEndpointDiscoveryValidator.html new file mode 100644 index 00000000000..276d94fa4e6 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/ClientEndpointDiscoveryValidator.html @@ -0,0 +1,347 @@ + + + + + +ClientEndpointDiscoveryValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.clientendpointdiscovery
    +

    Class ClientEndpointDiscoveryValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class ClientEndpointDiscoveryValidator
+extends AbstractValidator
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ClientEndpointDiscoveryValidator

          +
          public ClientEndpointDiscoveryValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/package-summary.html new file mode 100644 index 00000000000..a1896bf7413 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/package-summary.html @@ -0,0 +1,222 @@ + + + + + +software.amazon.smithy.aws.traits.clientendpointdiscovery (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.aws.traits.clientendpointdiscovery

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/package-tree.html new file mode 100644 index 00000000000..ca2f76f8f76 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/clientendpointdiscovery/package-tree.html @@ -0,0 +1,196 @@ + + + + + +software.amazon.smithy.aws.traits.clientendpointdiscovery Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.aws.traits.clientendpointdiscovery

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/customizations/S3UnwrappedXmlOutputTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/customizations/S3UnwrappedXmlOutputTrait.Provider.html new file mode 100644 index 00000000000..2df628d2715 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/customizations/S3UnwrappedXmlOutputTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +S3UnwrappedXmlOutputTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.customizations
    +

    Class S3UnwrappedXmlOutputTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/customizations/S3UnwrappedXmlOutputTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/customizations/S3UnwrappedXmlOutputTrait.html new file mode 100644 index 00000000000..4ef341d93d2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/customizations/S3UnwrappedXmlOutputTrait.html @@ -0,0 +1,367 @@ + + + + + +S3UnwrappedXmlOutputTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.customizations
    +

    Class S3UnwrappedXmlOutputTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          S3UnwrappedXmlOutputTrait

          +
          public S3UnwrappedXmlOutputTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          S3UnwrappedXmlOutputTrait

          +
          public S3UnwrappedXmlOutputTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/customizations/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/customizations/package-summary.html new file mode 100644 index 00000000000..2cda6cd999f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/customizations/package-summary.html @@ -0,0 +1,168 @@ + + + + + +software.amazon.smithy.aws.traits.customizations (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.aws.traits.customizations

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/customizations/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/customizations/package-tree.html new file mode 100644 index 00000000000..39eee259e1a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/customizations/package-tree.html @@ -0,0 +1,174 @@ + + + + + +software.amazon.smithy.aws.traits.customizations Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.aws.traits.customizations

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/package-summary.html new file mode 100644 index 00000000000..65e0f5d309c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/package-summary.html @@ -0,0 +1,292 @@ + + + + + +software.amazon.smithy.aws.traits (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.aws.traits

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/package-tree.html new file mode 100644 index 00000000000..5867535bd5d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/package-tree.html @@ -0,0 +1,217 @@ + + + + + +software.amazon.smithy.aws.traits Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.aws.traits

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsJson1_0Trait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsJson1_0Trait.Builder.html new file mode 100644 index 00000000000..451ced8e282 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsJson1_0Trait.Builder.html @@ -0,0 +1,306 @@ + + + + + +AwsJson1_0Trait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.protocols
    +

    Class AwsJson1_0Trait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public AwsJson1_0Trait build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsJson1_0Trait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsJson1_0Trait.Provider.html new file mode 100644 index 00000000000..1ef593b8676 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsJson1_0Trait.Provider.html @@ -0,0 +1,337 @@ + + + + + +AwsJson1_0Trait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.protocols
    +

    Class AwsJson1_0Trait.Provider

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public AwsJson1_0Trait createTrait​(ShapeId target,
+                                   Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsJson1_0Trait.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsJson1_0Trait.html new file mode 100644 index 00000000000..9ac980bd0a9 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsJson1_0Trait.html @@ -0,0 +1,372 @@ + + + + + +AwsJson1_0Trait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.protocols
    +

    Class AwsJson1_0Trait

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsJson1_1Trait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsJson1_1Trait.Builder.html new file mode 100644 index 00000000000..ee4842cb499 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsJson1_1Trait.Builder.html @@ -0,0 +1,306 @@ + + + + + +AwsJson1_1Trait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.protocols
    +

    Class AwsJson1_1Trait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public AwsJson1_1Trait build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsJson1_1Trait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsJson1_1Trait.Provider.html new file mode 100644 index 00000000000..9c878b91d6d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsJson1_1Trait.Provider.html @@ -0,0 +1,337 @@ + + + + + +AwsJson1_1Trait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.protocols
    +

    Class AwsJson1_1Trait.Provider

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public AwsJson1_1Trait createTrait​(ShapeId target,
+                                   Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsJson1_1Trait.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsJson1_1Trait.html new file mode 100644 index 00000000000..5940bb8f48f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsJson1_1Trait.html @@ -0,0 +1,372 @@ + + + + + +AwsJson1_1Trait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.protocols
    +

    Class AwsJson1_1Trait

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsProtocolTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsProtocolTrait.Builder.html new file mode 100644 index 00000000000..596009df1f4 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsProtocolTrait.Builder.html @@ -0,0 +1,396 @@ + + + + + +AwsProtocolTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.protocols
    +

    Class AwsProtocolTrait.Builder<T extends Trait,​B extends AwsProtocolTrait.Builder>

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Builder() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        BeventStreamHttp​(java.util.List<java.lang.String> eventStreamHttp) +
        Sets the list of supported event stream HTTP protocols.
        +
        BfromNode​(Node node) +
        Updates the builder from a Node.
        +
        Bhttp​(java.util.List<java.lang.String> http) +
        Sets the list of supported HTTP protocols.
        +
        + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          http

          +
          public B http​(java.util.List<java.lang.String> http)
          +
          Sets the list of supported HTTP protocols.
          +
          +
          Parameters:
          +
          http - HTTP protocols to set and replace.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          eventStreamHttp

          +
          public B eventStreamHttp​(java.util.List<java.lang.String> eventStreamHttp)
          +
          Sets the list of supported event stream HTTP protocols.
          +
          +
          Parameters:
          +
          eventStreamHttp - Event stream HTTP protocols to set and replace.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          fromNode

          +
          public B fromNode​(Node node)
          +
          Updates the builder from a Node.
          +
          +
          Parameters:
          +
          node - Node object that must be a valid ObjectNode.
          +
          Returns:
          +
          Returns the updated builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsProtocolTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsProtocolTrait.html new file mode 100644 index 00000000000..84df24fd985 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsProtocolTrait.html @@ -0,0 +1,383 @@ + + + + + +AwsProtocolTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.protocols
    +

    Class AwsProtocolTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getHttp

          +
          public java.util.List<java.lang.String> getHttp()
          +
          Gets the priority ordered list of supported HTTP protocol versions.
          +
          +
          Returns:
          +
          Returns the supported HTTP protocol versions.
          +
          +
          • +
        + + + +
          +
        • +

          getEventStreamHttp

          +
          public java.util.List<java.lang.String> getEventStreamHttp()
          +
          Gets the priority ordered list of supported HTTP protocol versions + that are required when using event streams.
          +
          +
          Returns:
          +
          Returns the supported event stream HTTP protocol versions.
          +
          +
          • +
        + + + +
          +
        • +

          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.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsQueryCompatibleTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsQueryCompatibleTrait.Provider.html new file mode 100644 index 00000000000..b3d32612acd --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsQueryCompatibleTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +AwsQueryCompatibleTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.protocols
    +

    Class AwsQueryCompatibleTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsQueryCompatibleTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsQueryCompatibleTrait.html new file mode 100644 index 00000000000..40b5e023293 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsQueryCompatibleTrait.html @@ -0,0 +1,367 @@ + + + + + +AwsQueryCompatibleTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.protocols
    +

    Class AwsQueryCompatibleTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          AwsQueryCompatibleTrait

          +
          public AwsQueryCompatibleTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          AwsQueryCompatibleTrait

          +
          public AwsQueryCompatibleTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsQueryErrorTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsQueryErrorTrait.Builder.html new file mode 100644 index 00000000000..3f38a4851ca --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsQueryErrorTrait.Builder.html @@ -0,0 +1,363 @@ + + + + + +AwsQueryErrorTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.protocols
    +

    Class AwsQueryErrorTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsQueryErrorTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsQueryErrorTrait.Provider.html new file mode 100644 index 00000000000..f12860d0064 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsQueryErrorTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +AwsQueryErrorTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.protocols
    +

    Class AwsQueryErrorTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsQueryErrorTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsQueryErrorTrait.html new file mode 100644 index 00000000000..7c841cda61e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsQueryErrorTrait.html @@ -0,0 +1,486 @@ + + + + + +AwsQueryErrorTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.protocols
    +

    Class AwsQueryErrorTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getCode

          +
          public java.lang.String getCode()
          +
          • +
        + + + +
          +
        • +

          getHttpResponseCode

          +
          public int getHttpResponseCode()
          +
          • +
        + + + +
          +
        • +

          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.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          builder

          +
          public static AwsQueryErrorTrait.Builder builder()
          +
          +
          Returns:
          +
          Returns a builder to create an awsQueryError trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsQueryTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsQueryTrait.Provider.html new file mode 100644 index 00000000000..4b5bd124358 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsQueryTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +AwsQueryTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.protocols
    +

    Class AwsQueryTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsQueryTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsQueryTrait.html new file mode 100644 index 00000000000..05e74f9f92e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/AwsQueryTrait.html @@ -0,0 +1,371 @@ + + + + + +AwsQueryTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.protocols
    +

    Class AwsQueryTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          AwsQueryTrait

          +
          public AwsQueryTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          AwsQueryTrait

          +
          public AwsQueryTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/Ec2QueryNameTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/Ec2QueryNameTrait.Provider.html new file mode 100644 index 00000000000..65632f519b0 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/Ec2QueryNameTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +Ec2QueryNameTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.protocols
    +

    Class Ec2QueryNameTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/Ec2QueryNameTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/Ec2QueryNameTrait.html new file mode 100644 index 00000000000..df6f334ec44 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/Ec2QueryNameTrait.html @@ -0,0 +1,383 @@ + + + + + +Ec2QueryNameTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.protocols
    +

    Class Ec2QueryNameTrait

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      FromSourceLocation, ToNode, ToShapeId, Trait
      +
      +
      +
      public final class Ec2QueryNameTrait
+extends StringTrait
      +
      Indicates the serialized name of a structure member when that structure is + serialized for the input of an EC2 operation.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Ec2QueryNameTrait

          +
          public Ec2QueryNameTrait​(java.lang.String value,
+                         SourceLocation sourceLocation)
          +
          • +
        + + + +
          +
        • +

          Ec2QueryNameTrait

          +
          public Ec2QueryNameTrait​(java.lang.String value)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/Ec2QueryTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/Ec2QueryTrait.Provider.html new file mode 100644 index 00000000000..f8ce560f44d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/Ec2QueryTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +Ec2QueryTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.protocols
    +

    Class Ec2QueryTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/Ec2QueryTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/Ec2QueryTrait.html new file mode 100644 index 00000000000..3f58cfdc247 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/Ec2QueryTrait.html @@ -0,0 +1,372 @@ + + + + + +Ec2QueryTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.protocols
    +

    Class Ec2QueryTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Ec2QueryTrait

          +
          public Ec2QueryTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          Ec2QueryTrait

          +
          public Ec2QueryTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/ProtocolHttpPayloadValidator.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/ProtocolHttpPayloadValidator.html new file mode 100644 index 00000000000..b55950e22ed --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/ProtocolHttpPayloadValidator.html @@ -0,0 +1,349 @@ + + + + + +ProtocolHttpPayloadValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.protocols
    +

    Class ProtocolHttpPayloadValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class ProtocolHttpPayloadValidator
+extends AbstractValidator
      +
      Ensures that the http payload trait is only bound to structures, unions, + documents, blobs, or strings for AWS protocols.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ProtocolHttpPayloadValidator

          +
          public ProtocolHttpPayloadValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/ProtocolHttpValidator.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/ProtocolHttpValidator.html new file mode 100644 index 00000000000..5c84c1b2f99 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/ProtocolHttpValidator.html @@ -0,0 +1,349 @@ + + + + + +ProtocolHttpValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.protocols
    +

    Class ProtocolHttpValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class ProtocolHttpValidator
+extends AbstractValidator
      +
      Ensures that every entry in eventStreamHttp also appears in + the http property of a protocol trait.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ProtocolHttpValidator

          +
          public ProtocolHttpValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/RestJson1Trait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/RestJson1Trait.Builder.html new file mode 100644 index 00000000000..02a165bf237 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/RestJson1Trait.Builder.html @@ -0,0 +1,306 @@ + + + + + +RestJson1Trait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.protocols
    +

    Class RestJson1Trait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public RestJson1Trait build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/RestJson1Trait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/RestJson1Trait.Provider.html new file mode 100644 index 00000000000..0af95781481 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/RestJson1Trait.Provider.html @@ -0,0 +1,337 @@ + + + + + +RestJson1Trait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.protocols
    +

    Class RestJson1Trait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public RestJson1Trait createTrait​(ShapeId target,
+                                  Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/RestJson1Trait.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/RestJson1Trait.html new file mode 100644 index 00000000000..4bb42a99ba7 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/RestJson1Trait.html @@ -0,0 +1,370 @@ + + + + + +RestJson1Trait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.protocols
    +

    Class RestJson1Trait

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/RestXmlTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/RestXmlTrait.Builder.html new file mode 100644 index 00000000000..2a6eada697a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/RestXmlTrait.Builder.html @@ -0,0 +1,346 @@ + + + + + +RestXmlTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.protocols
    +

    Class RestXmlTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/RestXmlTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/RestXmlTrait.Provider.html new file mode 100644 index 00000000000..4d0ee3421d7 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/RestXmlTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +RestXmlTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.protocols
    +

    Class RestXmlTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public RestXmlTrait createTrait​(ShapeId target,
+                                Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/RestXmlTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/RestXmlTrait.html new file mode 100644 index 00000000000..96ee43e8674 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/RestXmlTrait.html @@ -0,0 +1,414 @@ + + + + + +RestXmlTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.protocols
    +

    Class RestXmlTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          isNoErrorWrapping

          +
          public boolean isNoErrorWrapping()
          +
          +
          Returns:
          +
          Returns the noErrorWrapping setting.
          +
          +
          • +
        + + + +
          +
        • +

          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.
          +
          +
          Overrides:
          +
          createNode in class AwsProtocolTrait
          +
          Returns:
          +
          Returns the trait as a node.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/package-summary.html new file mode 100644 index 00000000000..6fe5a0bba5b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/package-summary.html @@ -0,0 +1,299 @@ + + + + + +software.amazon.smithy.aws.traits.protocols (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.aws.traits.protocols

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/package-tree.html new file mode 100644 index 00000000000..5ca641ad6c4 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/protocols/package-tree.html @@ -0,0 +1,225 @@ + + + + + +software.amazon.smithy.aws.traits.protocols Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.aws.traits.protocols

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/AwsTagIndex.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/AwsTagIndex.html new file mode 100644 index 00000000000..41a3361a07b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/AwsTagIndex.html @@ -0,0 +1,536 @@ + + + + + +AwsTagIndex (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.tagging
    +

    Class AwsTagIndex

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.traits.tagging.AwsTagIndex
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      KnowledgeIndex
      +
      +
      +
      public final class AwsTagIndex
+extends java.lang.Object
+implements KnowledgeIndex
      +
      Index of AWS tagging trait information in a service closure and convenient + access to tag operations by name in service closures.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.util.Optional<ShapeId>getListTagsForResourceOperation​(ShapeId serviceOrResourceId) +
        Gets the ShapeID of the ListTagsForResource operation on the service shape if one is found meeting the criteria.
        +
        java.util.Optional<ShapeId>getTagResourceOperation​(ShapeId serviceOrResourceId) +
        Gets the ShapeID of the TagResource operation on the shape if one is found by name.
        +
        static java.util.Optional<MemberShape>getTagsMember​(Model model, + OperationShape tagResourceOperation) +
        Returns the input member that has a name which matches for tags on a TagResource operation.
        +
        java.util.Optional<ShapeId>getUntagResourceOperation​(ShapeId serviceOrResourceId) +
        Gets the ShapeID of the UntagResource operation on the shape if one is found meeting the criteria.
        +
        booleanisResourceTagOnCreate​(ShapeId resourceId) +
        Checks if the given ShapeID references a resource shape that meets tag on create criteria.
        +
        booleanisResourceTagOnUpdate​(ShapeId resourceId) +
        Checks if the given ShapeID references a resource shape that meets tag on update criteria.
        +
        static AwsTagIndexof​(Model model) 
        booleanserviceHasTagApis​(ShapeId serviceShapeId) +
        Checks if a given ShapeID references a service shape that meets the criteria for having the three + expected service-wide tagging APIs.
        +
        booleanserviceHasValidListTagsForResourceOperation​(ShapeId serviceId) +
        Gets the verification result of whether or not the service has a named ListTagsForResource operation that meets + the expected critiera for ListTagsForResource.
        +
        booleanserviceHasValidTagResourceOperation​(ShapeId serviceId) +
        Gets the verification result of whether or not the service has a named TagResource operation that meets the + expected critiera for TagResource.
        +
        booleanserviceHasValidUntagResourceOperation​(ShapeId serviceId) +
        Gets the verification result of whether or not the service has a named UntagResource operation that meets the + expected critiera for UntagResource.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + + + + + +
          +
        • +

          isResourceTagOnCreate

          +
          public boolean isResourceTagOnCreate​(ShapeId resourceId)
          +
          Checks if the given ShapeID references a resource shape that meets tag on create criteria. + If the given ShapeID does not reference a resource shape, will always return false. + + Tag on create is satisfied when a resource shape has a property representing tags via + the {@see TaggableTrait}, and that property is an input on the resource's create lifecycle + operation.
          +
          +
          Parameters:
          +
          resourceId - ShapeID of the resource to check.
          +
          Returns:
          +
          true iff the resourceId references a resource shape that has tag-on create behavior.
          +
          +
          • +
        + + + +
          +
        • +

          isResourceTagOnUpdate

          +
          public boolean isResourceTagOnUpdate​(ShapeId resourceId)
          +
          Checks if the given ShapeID references a resource shape that meets tag on update criteria. + If the given ShapeID does not reference to a resource shape, will always return false. + + Tag on update is satisfied when a resource shape has a property representing tags via + the {@see TaggableTrait}, and that property is an input on the resource's create lifecycle + operation.
          +
          +
          Parameters:
          +
          resourceId - ShapeID of the resource to check.
          +
          Returns:
          +
          true iff the resourceId references a resource shape that has tag-on update behavior.
          +
          +
          • +
        + + + +
          +
        • +

          serviceHasTagApis

          +
          public boolean serviceHasTagApis​(ShapeId serviceShapeId)
          +
          Checks if a given ShapeID references a service shape that meets the criteria for having the three + expected service-wide tagging APIs.
          +
          +
          Parameters:
          +
          serviceShapeId - ShapeID of the shape to check.
          +
          Returns:
          +
          true iff the serviceShapeId references a service shape that has the necessary tagging APIs.
          +
          +
          • +
        + + + +
          +
        • +

          getTagResourceOperation

          +
          public java.util.Optional<ShapeId> getTagResourceOperation​(ShapeId serviceOrResourceId)
          +
          Gets the ShapeID of the TagResource operation on the shape if one is found by name. + If a resource ID is passed in, it will return the qualifiying service wide TagResource operation ID rather than + the operation ID specified by the tagApi property.
          +
          +
          Parameters:
          +
          serviceOrResourceId - ShapeID of the service shape to retrieve the qualifying TagResource operation for.
          +
          Returns:
          +
          The ShapeID of a qualifying TagResource operation if one is found. Returns an empty optional otherwise.
          +
          +
          • +
        + + + +
          +
        • +

          getUntagResourceOperation

          +
          public java.util.Optional<ShapeId> getUntagResourceOperation​(ShapeId serviceOrResourceId)
          +
          Gets the ShapeID of the UntagResource operation on the shape if one is found meeting the criteria. + If a resource ID is passed in, it will return the qualifiying service wide TagResource operation ID rather than + the operation ID specified by the tagApi property.
          +
          +
          Parameters:
          +
          serviceOrResourceId - ShapeID of the service shape to retrieve the qualifying UntagResource operation for.
          +
          Returns:
          +
          The ShapeID of a qualifying UntagResource operation if one is found. Returns an empty optional + otherwise.
          +
          +
          • +
        + + + +
          +
        • +

          getListTagsForResourceOperation

          +
          public java.util.Optional<ShapeId> getListTagsForResourceOperation​(ShapeId serviceOrResourceId)
          +
          Gets the ShapeID of the ListTagsForResource operation on the service shape if one is found meeting the criteria. + If a resource ID is passed in, it will return the qualifiying service wide TagResource operation ID rather than + the operation ID specified by the tagApi property.
          +
          +
          Parameters:
          +
          serviceOrResourceId - ShapeID of the service shape to retrieve the qualifying ListTagsForResource + operation for.
          +
          Returns:
          +
          The ShapeID of a qualifying ListTagsForResource operation if one is found. Returns an empty optional + otherwise.
          +
          +
          • +
        + + + +
          +
        • +

          serviceHasValidTagResourceOperation

          +
          public boolean serviceHasValidTagResourceOperation​(ShapeId serviceId)
          +
          Gets the verification result of whether or not the service has a named TagResource operation that meets the + expected critiera for TagResource.
          +
          +
          Parameters:
          +
          serviceId - the ShapeID of the service shape the TagResource operation should be bound to.
          +
          Returns:
          +
          True iff the service shape has a service bound operation named 'TagResource' that also satisfies + the criteria for a valid TagResource operation.
          +
          +
          • +
        + + + +
          +
        • +

          serviceHasValidUntagResourceOperation

          +
          public boolean serviceHasValidUntagResourceOperation​(ShapeId serviceId)
          +
          Gets the verification result of whether or not the service has a named UntagResource operation that meets the + expected critiera for UntagResource.
          +
          +
          Parameters:
          +
          serviceId - the ShapeID of the service shape the UntagResource operation should be bound to.
          +
          Returns:
          +
          True iff the service shape has a service bound operation named 'UntagResource' that also satisfies + the criteria for a valid UntagResource operation.
          +
          +
          • +
        + + + +
          +
        • +

          serviceHasValidListTagsForResourceOperation

          +
          public boolean serviceHasValidListTagsForResourceOperation​(ShapeId serviceId)
          +
          Gets the verification result of whether or not the service has a named ListTagsForResource operation that meets + the expected critiera for ListTagsForResource.
          +
          +
          Parameters:
          +
          serviceId - the ShapeID of the service shape the ListTagsForResource operation should be bound to.
          +
          Returns:
          +
          True iff the service shape has a service bound operation named 'ListTagsForResource' that also satisfies + the criteria for a valid ListTagsForResource operation.
          +
          +
          • +
        + + + +
          +
        • +

          getTagsMember

          +
          public static java.util.Optional<MemberShape> getTagsMember​(Model model,
+                                                            OperationShape tagResourceOperation)
          +
          Returns the input member that has a name which matches for tags on a TagResource operation. + + Note: This is more of a utility method needed to expose limited access to an internal method.
          +
          +
          Parameters:
          +
          model - Smithy model to follow member references from the provided operation shape.
          +
          tagResourceOperation - TagResource operation object to scan the input members of.
          +
          Returns:
          +
          the matching input member if present. {@see java.util.Optional.empty()} otherwise.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/ServiceTaggingValidator.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/ServiceTaggingValidator.html new file mode 100644 index 00000000000..bed33664375 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/ServiceTaggingValidator.html @@ -0,0 +1,348 @@ + + + + + +ServiceTaggingValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.tagging
    +

    Class ServiceTaggingValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class ServiceTaggingValidator
+extends AbstractValidator
      +
      Validates service satisfies AWS tagging requirements.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ServiceTaggingValidator

          +
          public ServiceTaggingValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TagEnabledServiceValidator.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TagEnabledServiceValidator.html new file mode 100644 index 00000000000..586077b019c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TagEnabledServiceValidator.html @@ -0,0 +1,348 @@ + + + + + +TagEnabledServiceValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.tagging
    +

    Class TagEnabledServiceValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class TagEnabledServiceValidator
+extends AbstractValidator
      +
      Validates service has at least one taggable resource.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          TagEnabledServiceValidator

          +
          public TagEnabledServiceValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TagEnabledTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TagEnabledTrait.Builder.html new file mode 100644 index 00000000000..e1defded5c5 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TagEnabledTrait.Builder.html @@ -0,0 +1,348 @@ + + + + + +TagEnabledTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.tagging
    +

    Class TagEnabledTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          disableDefaultOperations

          +
          public TagEnabledTrait.Builder disableDefaultOperations​(java.lang.Boolean disableDefaultOperations)
          +
          • +
        + + + +
          +
        • +

          build

          +
          public TagEnabledTrait build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TagEnabledTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TagEnabledTrait.Provider.html new file mode 100644 index 00000000000..714c0b4a3ea --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TagEnabledTrait.Provider.html @@ -0,0 +1,348 @@ + + + + + +TagEnabledTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.tagging
    +

    Class TagEnabledTrait.Provider

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.traits.tagging.TagEnabledTrait.Provider
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      TraitService
      +
      +
      +
      Enclosing class:
      +
      TagEnabledTrait
      +
      +
      +
      public static final class TagEnabledTrait.Provider
+extends java.lang.Object
+implements TraitService
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getShapeId

          +
          public ShapeId getShapeId()
          +
          +
          Specified by:
          +
          getShapeId in interface TraitService
          +
          Returns:
          +
          Gets the shape ID of the trait that this provider created.
          +
          +
          • +
        + + + +
          +
        • +

          createTrait

          +
          public TagEnabledTrait createTrait​(ShapeId target,
+                                   Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Specified by:
          +
          createTrait in interface TraitService
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TagEnabledTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TagEnabledTrait.html new file mode 100644 index 00000000000..e28b4a85655 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TagEnabledTrait.html @@ -0,0 +1,465 @@ + + + + + +TagEnabledTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.tagging
    +

    Class TagEnabledTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          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.
          +
          +
          • +
        + + + +
          +
        • +

          getDisableDefaultOperations

          +
          public boolean getDisableDefaultOperations()
          +
          • +
        + + + + + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TagResourcePropertyNameValidator.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TagResourcePropertyNameValidator.html new file mode 100644 index 00000000000..d0905939fef --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TagResourcePropertyNameValidator.html @@ -0,0 +1,348 @@ + + + + + +TagResourcePropertyNameValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.tagging
    +

    Class TagResourcePropertyNameValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class TagResourcePropertyNameValidator
+extends AbstractValidator
      +
      Validates expected tagging property name used for a taggable resource to encourage consistency.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          TagResourcePropertyNameValidator

          +
          public TagResourcePropertyNameValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TagResourcePropertyTypeValidator.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TagResourcePropertyTypeValidator.html new file mode 100644 index 00000000000..8ea7fb7ef1c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TagResourcePropertyTypeValidator.html @@ -0,0 +1,348 @@ + + + + + +TagResourcePropertyTypeValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.tagging
    +

    Class TagResourcePropertyTypeValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class TagResourcePropertyTypeValidator
+extends AbstractValidator
      +
      Validates tagging property used for a taggable resource to encourage consistency.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          TagResourcePropertyTypeValidator

          +
          public TagResourcePropertyTypeValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TaggableApiConfig.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TaggableApiConfig.Builder.html new file mode 100644 index 00000000000..59fbe24900c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TaggableApiConfig.Builder.html @@ -0,0 +1,326 @@ + + + + + +TaggableApiConfig.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.tagging
    +

    Class TaggableApiConfig.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.traits.tagging.TaggableApiConfig.Builder
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Builder() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        TaggableApiConfigbuild() +
        Creates an immutable object that is created from the properties + that have been set on the builder.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TaggableApiConfig.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TaggableApiConfig.html new file mode 100644 index 00000000000..ce466277989 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TaggableApiConfig.html @@ -0,0 +1,477 @@ + + + + + +TaggableApiConfig (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.tagging
    +

    Class TaggableApiConfig

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.traits.tagging.TaggableApiConfig
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          builder

          +
          public static TaggableApiConfig.Builder builder()
          +
          Creates a builder used to build an TaggableApiConfig.
          +
          +
          Returns:
          +
          Returns the created builder.
          +
          +
          • +
        + + + +
          +
        • +

          getTagApi

          +
          public ShapeId getTagApi()
          +
          Gets the ShapeId of the operation which implements TagResource behavior.
          +
          +
          Returns:
          +
          the ShapeId of the tag operation for the resource
          +
          +
          • +
        + + + +
          +
        • +

          getUntagApi

          +
          public ShapeId getUntagApi()
          +
          Gets the ShapeId of the operation which implements UntagResource behavior.
          +
          +
          Returns:
          +
          the ShapeId of the untag operation for the resource
          +
          +
          • +
        + + + +
          +
        • +

          getListTagsApi

          +
          public ShapeId getListTagsApi()
          +
          Gets the ShapeId of the operation which implements ListTagsForResource + behavior for the resource.
          +
          +
          Returns:
          +
          the ShapeId of the list tags operation for the resource
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TaggableResourceValidator.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TaggableResourceValidator.html new file mode 100644 index 00000000000..d3d8793e47d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TaggableResourceValidator.html @@ -0,0 +1,348 @@ + + + + + +TaggableResourceValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.tagging
    +

    Class TaggableResourceValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class TaggableResourceValidator
+extends AbstractValidator
      +
      Validates that service satisfies the AWS tagging requirements.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          TaggableResourceValidator

          +
          public TaggableResourceValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TaggableTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TaggableTrait.Builder.html new file mode 100644 index 00000000000..0d366b06be7 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TaggableTrait.Builder.html @@ -0,0 +1,376 @@ + + + + + +TaggableTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.tagging
    +

    Class TaggableTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TaggableTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TaggableTrait.Provider.html new file mode 100644 index 00000000000..ef1ff8b0a12 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TaggableTrait.Provider.html @@ -0,0 +1,348 @@ + + + + + +TaggableTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.tagging
    +

    Class TaggableTrait.Provider

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.aws.traits.tagging.TaggableTrait.Provider
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      TraitService
      +
      +
      +
      Enclosing class:
      +
      TaggableTrait
      +
      +
      +
      public static final class TaggableTrait.Provider
+extends java.lang.Object
+implements TraitService
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getShapeId

          +
          public ShapeId getShapeId()
          +
          +
          Specified by:
          +
          getShapeId in interface TraitService
          +
          Returns:
          +
          Gets the shape ID of the trait that this provider created.
          +
          +
          • +
        + + + +
          +
        • +

          createTrait

          +
          public TaggableTrait createTrait​(ShapeId target,
+                                 Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Specified by:
          +
          createTrait in interface TraitService
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TaggableTrait.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TaggableTrait.html new file mode 100644 index 00000000000..ecd7f75cee0 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/TaggableTrait.html @@ -0,0 +1,474 @@ + + + + + +TaggableTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.aws.traits.tagging
    +

    Class TaggableTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getDisableSystemTags

          +
          public boolean getDisableSystemTags()
          +
          Gets a boolean indicating whether or not the service supports the resource carrying system tags.
          +
          +
          Returns:
          +
          Returns true if the service does not support the resource carrying system tags.
          +
          +
          • +
        + + + +
          +
        • +

          getApiConfig

          +
          public java.util.Optional<TaggableApiConfig> getApiConfig()
          +
          Gets the TaggableApiConfig if the resource has its own APIs for tagging.
          +
          +
          Returns:
          +
          the TaggableApiConfig for the resource.
          +
          +
          • +
        + + + +
          +
        • +

          getProperty

          +
          public java.util.Optional<java.lang.String> getProperty()
          +
          Gets the name of the property that represents the tags on the resource, if any.
          +
          +
          Returns:
          +
          the name of the property that represents the tags of the resource.
          +
          +
          • +
        + + + +
          +
        • +

          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.
          +
          +
          • +
        + + + + + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/package-summary.html new file mode 100644 index 00000000000..a3b15f6eb0b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/package-summary.html @@ -0,0 +1,237 @@ + + + + + +software.amazon.smithy.aws.traits.tagging (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.aws.traits.tagging

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/package-tree.html new file mode 100644 index 00000000000..d97d4f8643c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/aws/traits/tagging/package-tree.html @@ -0,0 +1,186 @@ + + + + + +software.amazon.smithy.aws.traits.tagging Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.aws.traits.tagging

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/FileManifest.html b/javadoc/1.47.0/software/amazon/smithy/build/FileManifest.html new file mode 100644 index 00000000000..3ef95bed89c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/FileManifest.html @@ -0,0 +1,759 @@ + + + + + +FileManifest (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build
    +

    Interface FileManifest

    +
    +
    +
    +
      +
    • +
      +
      All Known Implementing Classes:
      +
      MockManifest
      +
      +
      +
      public interface FileManifest
      +
      Creates and tracks the files generated by a SmithyBuildPlugin. + + Mutating FileManifest implementations MUST be thread-safe as they can + be used concurrently across multiple threads when building models.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Abstract Methods Default Methods 
        Modifier and TypeMethodDescription
        default voidaddAllFiles​(FileManifest manifest) +
        Adds the files from another FileManifest into this FileManifest.
        +
        java.nio.file.PathaddFile​(java.nio.file.Path path) +
        Adds a path to the manifest.
        +
        static FileManifestcreate​(java.nio.file.Path basePath) +
        Create a default file manifest for the given base path.
        +
        java.nio.file.PathgetBaseDir() +
        Gets the base directory of the manifest.
        +
        java.util.Set<java.nio.file.Path>getFiles() +
        Gets all of the files in the result.
        +
        default java.util.List<java.nio.file.Path>getFilesIn​(java.lang.String path) +
        Gets the paths to files stored under a prefix.
        +
        default java.util.List<java.nio.file.Path>getFilesIn​(java.nio.file.Path path) +
        Gets the paths to files stored under a prefix.
        +
        default booleanhasFile​(java.lang.String file) +
        Checks if the given file is stored in the manifest.
        +
        default booleanhasFile​(java.nio.file.Path file) +
        Checks if the given file is stored in the manifest.
        +
        default java.nio.file.PathresolvePath​(java.nio.file.Path path) +
        Resolves a path against the base path of the manifest.
        +
        default java.nio.file.PathwriteFile​(java.lang.String path, + java.io.InputStream fileContentsInputStream) +
        Adds a file to the result using the contents of an InputStream.
        +
        default java.nio.file.PathwriteFile​(java.lang.String path, + java.io.Reader fileContentsReader) +
        Adds a file to the result using the contents of a Reader.
        +
        default java.nio.file.PathwriteFile​(java.lang.String path, + java.lang.Class klass, + java.lang.String resource) +
        Adds a file to the result using the contents of a resource loaded by + calling Class.getResourceAsStream(String).
        +
        default java.nio.file.PathwriteFile​(java.lang.String path, + java.lang.String fileContentsText) +
        Adds a UTF-8 encoded file to the result.
        +
        java.nio.file.PathwriteFile​(java.nio.file.Path path, + java.io.InputStream fileContentsInputStream) +
        Adds a file to the result using the contents of an InputStream.
        +
        java.nio.file.PathwriteFile​(java.nio.file.Path path, + java.io.Reader fileContentsReader) +
        Adds a file to the result using the contents of a Reader.
        +
        default java.nio.file.PathwriteFile​(java.nio.file.Path path, + java.lang.Class klass, + java.lang.String resource) +
        Adds a file to the result using the contents of a resource loaded by + calling Class.getResourceAsStream(String).
        +
        default java.nio.file.PathwriteFile​(java.nio.file.Path path, + java.lang.String fileContentsText) +
        Adds a UTF-8 encoded file to the result.
        +
        default java.nio.file.PathwriteJson​(java.lang.String path, + Node node) +
        Adds a Node artifact, converting it automatically to JSON.
        +
        default java.nio.file.PathwriteJson​(java.nio.file.Path path, + Node node) +
        Adds a Node artifact, converting it automatically to JSON.
        +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          create

          +
          static FileManifest create​(java.nio.file.Path basePath)
          +
          Create a default file manifest for the given base path.
          +
          +
          Parameters:
          +
          basePath - Base path where files are written.
          +
          Returns:
          +
          Returns the created manifest.
          +
          +
          • +
        + + + +
          +
        • +

          getBaseDir

          +
          java.nio.file.Path getBaseDir()
          +
          Gets the base directory of the manifest.
          +
          +
          Returns:
          +
          Returns the base directory.
          +
          +
          • +
        + + + +
          +
        • +

          getFiles

          +
          java.util.Set<java.nio.file.Path> getFiles()
          +
          Gets all of the files in the result. + +

          The order of files returned should be stable across calls.

          +
          +
          Returns:
          +
          Returns the files in the manifest.
          +
          +
          • +
        + + + +
          +
        • +

          addFile

          +
          java.nio.file.Path addFile​(java.nio.file.Path path)
          +
          Adds a path to the manifest. + +

          The given path must be relative or within the base directory.

          +
          +
          Parameters:
          +
          path - Path to add.
          +
          Returns:
          +
          Returns the path resolved against any base URL.
          +
          +
          • +
        + + + +
          +
        • +

          addAllFiles

          +
          default void addAllFiles​(FileManifest manifest)
          +
          Adds the files from another FileManifest into this FileManifest.
          +
          +
          Parameters:
          +
          manifest - Other object to merge with.
          +
          +
          • +
        + + + +
          +
        • +

          resolvePath

          +
          default java.nio.file.Path resolvePath​(java.nio.file.Path path)
          +
          Resolves a path against the base path of the manifest.
          +
          +
          Parameters:
          +
          path - Path to resolve against the base URL.
          +
          Returns:
          +
          Returns the resolved, absolute path.
          +
          Throws:
          +
          SmithyBuildException - if the resolved path cannot + falls outside of the base URL of the manifest.
          +
          +
          • +
        + + + +
          +
        • +

          writeFile

          +
          java.nio.file.Path writeFile​(java.nio.file.Path path,
+                             java.io.Reader fileContentsReader)
          +
          Adds a file to the result using the contents of a Reader. + +

          This method will write the contents of a Reader to a file.

          +
          +
          Parameters:
          +
          path - Relative path to the file to create.
          +
          fileContentsReader - Reader to consume and write to the file.
          +
          Returns:
          +
          Returns the resolved path.
          +
          +
          • +
        + + + +
          +
        • +

          writeFile

          +
          java.nio.file.Path writeFile​(java.nio.file.Path path,
+                             java.io.InputStream fileContentsInputStream)
          +
          Adds a file to the result using the contents of an InputStream. + +

          This method will write the contents of an input stream to a file.

          +
          +
          Parameters:
          +
          path - Relative path to the file to create.
          +
          fileContentsInputStream - InputStream to consume and write to the file.
          +
          Returns:
          +
          Returns the resolved path.
          +
          +
          • +
        + + + +
          +
        • +

          writeFile

          +
          default java.nio.file.Path writeFile​(java.nio.file.Path path,
+                                     java.lang.Class klass,
+                                     java.lang.String resource)
          +
          Adds a file to the result using the contents of a resource loaded by + calling Class.getResourceAsStream(String). + +

          This method should be preferred when writing class resources to the manifest + since it handles closing the created InputStream and avoids + tripping up tools like SpotBugs.

          +
          +
          Parameters:
          +
          path - Relative path to the file to create.
          +
          klass - Class to load the resource from.
          +
          resource - Path to the resource to load.
          +
          Returns:
          +
          Returns the resolved path.
          +
          +
          • +
        + + + +
          +
        • +

          writeFile

          +
          default java.nio.file.Path writeFile​(java.lang.String path,
+                                     java.lang.Class klass,
+                                     java.lang.String resource)
          +
          Adds a file to the result using the contents of a resource loaded by + calling Class.getResourceAsStream(String).
          +
          +
          Parameters:
          +
          path - Relative path to the file to create.
          +
          klass - Class to load the resource from.
          +
          resource - Path to the resource to load.
          +
          Returns:
          +
          Returns the resolved path.
          +
          +
          • +
        + + + +
          +
        • +

          writeFile

          +
          default java.nio.file.Path writeFile​(java.nio.file.Path path,
+                                     java.lang.String fileContentsText)
          +
          Adds a UTF-8 encoded file to the result. + +

          This method will write the contents of a string to a file.

          +
          +
          Parameters:
          +
          path - Relative path to the file to create.
          +
          fileContentsText - String value to write to the file.
          +
          Returns:
          +
          Returns the resolved path.
          +
          +
          • +
        + + + +
          +
        • +

          writeFile

          +
          default java.nio.file.Path writeFile​(java.lang.String path,
+                                     java.lang.String fileContentsText)
          +
          Adds a UTF-8 encoded file to the result. + +

          This method will write the contents of a string to a file.

          +
          +
          Parameters:
          +
          path - Relative path to the file to create.
          +
          fileContentsText - String value to write to the file.
          +
          Returns:
          +
          Returns the resolved path.
          +
          +
          • +
        + + + +
          +
        • +

          writeFile

          +
          default java.nio.file.Path writeFile​(java.lang.String path,
+                                     java.io.Reader fileContentsReader)
          +
          Adds a file to the result using the contents of a Reader. + +

          This method will write the contents of a Reader to a file.

          +
          +
          Parameters:
          +
          path - Relative path to the file to create.
          +
          fileContentsReader - Reader to consume and write to the file.
          +
          Returns:
          +
          Returns the resolved path.
          +
          +
          • +
        + + + +
          +
        • +

          writeFile

          +
          default java.nio.file.Path writeFile​(java.lang.String path,
+                                     java.io.InputStream fileContentsInputStream)
          +
          Adds a file to the result using the contents of an InputStream. + +

          This method will write the contents of an input stream to a file.

          +
          +
          Parameters:
          +
          path - Relative path to the file to create.
          +
          fileContentsInputStream - InputStream to consume and write to the file.
          +
          Returns:
          +
          Returns the resolved path.
          +
          +
          • +
        + + + +
          +
        • +

          writeJson

          +
          default java.nio.file.Path writeJson​(java.nio.file.Path path,
+                                     Node node)
          +
          Adds a Node artifact, converting it automatically to JSON.
          +
          +
          Parameters:
          +
          path - Relative path to write to.
          +
          node - Node data to write to JSON.
          +
          Returns:
          +
          Returns the resolved path.
          +
          +
          • +
        + + + +
          +
        • +

          writeJson

          +
          default java.nio.file.Path writeJson​(java.lang.String path,
+                                     Node node)
          +
          Adds a Node artifact, converting it automatically to JSON.
          +
          +
          Parameters:
          +
          path - Relative path to write to.
          +
          node - Node data to write to JSON.
          +
          Returns:
          +
          Returns the resolved path.
          +
          +
          • +
        + + + +
          +
        • +

          hasFile

          +
          default boolean hasFile​(java.nio.file.Path file)
          +
          Checks if the given file is stored in the manifest.
          +
          +
          Parameters:
          +
          file - File to check.
          +
          Returns:
          +
          Return true if the file exists in the manifest.
          +
          +
          • +
        + + + +
          +
        • +

          hasFile

          +
          default boolean hasFile​(java.lang.String file)
          +
          Checks if the given file is stored in the manifest.
          +
          +
          Parameters:
          +
          file - File to check.
          +
          Returns:
          +
          Return true if the file exists in the manifest.
          +
          +
          • +
        + + + +
          +
        • +

          getFilesIn

          +
          default java.util.List<java.nio.file.Path> getFilesIn​(java.nio.file.Path path)
          +
          Gets the paths to files stored under a prefix.
          +
          +
          Parameters:
          +
          path - Path prefix.
          +
          Returns:
          +
          Returns the matching file paths in sorted order.
          +
          +
          • +
        + + + +
          +
        • +

          getFilesIn

          +
          default java.util.List<java.nio.file.Path> getFilesIn​(java.lang.String path)
          +
          Gets the paths to files stored under a prefix.
          +
          +
          Parameters:
          +
          path - Path prefix.
          +
          Returns:
          +
          Returns the matching file paths.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/JsonSubstitutions.html b/javadoc/1.47.0/software/amazon/smithy/build/JsonSubstitutions.html new file mode 100644 index 00000000000..fe76830c23b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/JsonSubstitutions.html @@ -0,0 +1,341 @@ + + + + + +JsonSubstitutions (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build
    +

    Class JsonSubstitutions

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.JsonSubstitutions
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class JsonSubstitutions
+extends java.lang.Object
      +
      Finds string set in a Node object string value and replaces them with a + corresponding Node. + +

      Each key represents a string to search for, and each value represents + what to replace the string with. A value can be any type of Node, allowing + for strings to be changed to objects, arrays, etc. Partial string matches + are not currently supported. + +

      For example, given the following values to replace: + +

      {"FOO": {"bar": "baz"}} + +

      and the following Node value: + +

      {"hello": "FOO", "baz": "do not replace FOO"}, + +

      the resulting Node will become: + +

      {"hello": {"bar: "baz"}, "baz": "do not replace FOO"}. + +

      Notice that "do not replace FOO" was not modified because the entire + string did not literally match the string "FOO".

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          create

          +
          public static JsonSubstitutions create​(ObjectNode node)
          +
          Creates a substitutions instance from an ObjectNode.
          +
          +
          Parameters:
          +
          node - ObjectNode used to create the instance.
          +
          Returns:
          +
          Returns the created JsonSubstitutions.
          +
          +
          • +
        + + + +
          +
        • +

          create

          +
          public static JsonSubstitutions create​(java.util.Map<java.lang.String,​Node> map)
          +
          Creates a substitutions instance from a Map.
          +
          +
          Parameters:
          +
          map - Map used to create the instance.
          +
          Returns:
          +
          Returns the created JsonSubstitutions.
          +
          +
          • +
        + + + +
          +
        • +

          apply

          +
          public Node apply​(Node node)
          +
          Replaces strings in the given node.
          +
          +
          Parameters:
          +
          node - Node to update.
          +
          Returns:
          +
          Returns the updated node.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/MockManifest.StoreMode.html b/javadoc/1.47.0/software/amazon/smithy/build/MockManifest.StoreMode.html new file mode 100644 index 00000000000..81905cc9237 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/MockManifest.StoreMode.html @@ -0,0 +1,387 @@ + + + + + +MockManifest.StoreMode (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build
    +

    Enum MockManifest.StoreMode

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        IN_MEMORY +
        Store all saved files in memory.
        +
        PATH_ONLY +
        Store only the path of each saved file.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static MockManifest.StoreModevalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static MockManifest.StoreMode[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static MockManifest.StoreMode[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (MockManifest.StoreMode c : MockManifest.StoreMode.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static MockManifest.StoreMode valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/MockManifest.html b/javadoc/1.47.0/software/amazon/smithy/build/MockManifest.html new file mode 100644 index 00000000000..9aeca12dacf --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/MockManifest.html @@ -0,0 +1,711 @@ + + + + + +MockManifest (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build
    +

    Class MockManifest

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.MockManifest
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      FileManifest
      +
      +
      +
      public final class MockManifest
+extends java.lang.Object
+implements FileManifest
      +
      A FileManifest that doesn't actually store files on disk. + +

      This manifest is useful for testing SmithyBuildPlugin implementations.

      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static class MockManifest.StoreMode +
        The way in which files are stored.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        MockManifest() +
        Creates a mock manifest that stores files in memory and uses a + base directory of "/".
        +
        MockManifest​(java.nio.file.Path baseDir) +
        Creates a mock manifest that stores files in memory.
        +
        MockManifest​(java.nio.file.Path baseDir, + MockManifest.StoreMode storeMode) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.nio.file.PathaddFile​(java.nio.file.Path path) +
        Adds a path to the manifest.
        +
        byte[]expectFileBytes​(java.lang.String file) +
        Expects that the given file was stored and returns the bytes.
        +
        byte[]expectFileBytes​(java.nio.file.Path file) +
        Expects that the given file was stored and returns the bytes.
        +
        java.lang.StringexpectFileString​(java.lang.String file) +
        Expects that the given file was stored and returns a UTF-8 string.
        +
        java.lang.StringexpectFileString​(java.nio.file.Path file) +
        Expects that the given file was stored and returns a UTF-8 string.
        +
        java.nio.file.PathgetBaseDir() +
        Gets the base directory of the manifest.
        +
        java.util.Optional<byte[]>getFileBytes​(java.lang.String file) +
        Gets the bytes of a stored file.
        +
        java.util.Optional<byte[]>getFileBytes​(java.nio.file.Path file) +
        Gets the bytes of a stored file.
        +
        java.util.Set<java.nio.file.Path>getFiles() +
        Gets all of the files in the result.
        +
        java.util.Optional<java.lang.String>getFileString​(java.lang.String file) +
        Gets the contents of a stored file as a String.
        +
        java.util.Optional<java.lang.String>getFileString​(java.nio.file.Path file) +
        Gets the contents of a stored file as a String.
        +
        java.nio.file.PathwriteFile​(java.nio.file.Path path, + java.io.InputStream fileContentsInputStream) +
        Adds a file to the result using the contents of an InputStream.
        +
        java.nio.file.PathwriteFile​(java.nio.file.Path path, + java.io.Reader fileContentsReader) +
        Adds a file to the result using the contents of a Reader.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          MockManifest

          +
          public MockManifest​(java.nio.file.Path baseDir,
+                    MockManifest.StoreMode storeMode)
          +
          +
          Parameters:
          +
          baseDir - Base directory of the manifest.
          +
          storeMode - How files are stored in the mock.
          +
          +
          • +
        + + + +
          +
        • +

          MockManifest

          +
          public MockManifest​(java.nio.file.Path baseDir)
          +
          Creates a mock manifest that stores files in memory.
          +
          +
          Parameters:
          +
          baseDir - Base directory of the manifest.
          +
          +
          • +
        + + + +
          +
        • +

          MockManifest

          +
          public MockManifest()
          +
          Creates a mock manifest that stores files in memory and uses a + base directory of "/".
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getBaseDir

          +
          public java.nio.file.Path getBaseDir()
          +
          Description copied from interface: FileManifest
          +
          Gets the base directory of the manifest.
          +
          +
          Specified by:
          +
          getBaseDir in interface FileManifest
          +
          Returns:
          +
          Returns the base directory.
          +
          +
          • +
        + + + +
          +
        • +

          getFiles

          +
          public java.util.Set<java.nio.file.Path> getFiles()
          +
          Description copied from interface: FileManifest
          +
          Gets all of the files in the result. + +

          The order of files returned should be stable across calls.

          +
          +
          Specified by:
          +
          getFiles in interface FileManifest
          +
          Returns:
          +
          Returns the files in the manifest.
          +
          +
          • +
        + + + +
          +
        • +

          addFile

          +
          public java.nio.file.Path addFile​(java.nio.file.Path path)
          +
          Description copied from interface: FileManifest
          +
          Adds a path to the manifest. + +

          The given path must be relative or within the base directory.

          +
          +
          Specified by:
          +
          addFile in interface FileManifest
          +
          Parameters:
          +
          path - Path to add.
          +
          Returns:
          +
          Returns the path resolved against any base URL.
          +
          +
          • +
        + + + +
          +
        • +

          writeFile

          +
          public java.nio.file.Path writeFile​(java.nio.file.Path path,
+                                    java.io.Reader fileContentsReader)
          +
          Description copied from interface: FileManifest
          +
          Adds a file to the result using the contents of a Reader. + +

          This method will write the contents of a Reader to a file.

          +
          +
          Specified by:
          +
          writeFile in interface FileManifest
          +
          Parameters:
          +
          path - Relative path to the file to create.
          +
          fileContentsReader - Reader to consume and write to the file.
          +
          Returns:
          +
          Returns the resolved path.
          +
          +
          • +
        + + + +
          +
        • +

          writeFile

          +
          public java.nio.file.Path writeFile​(java.nio.file.Path path,
+                                    java.io.InputStream fileContentsInputStream)
          +
          Description copied from interface: FileManifest
          +
          Adds a file to the result using the contents of an InputStream. + +

          This method will write the contents of an input stream to a file.

          +
          +
          Specified by:
          +
          writeFile in interface FileManifest
          +
          Parameters:
          +
          path - Relative path to the file to create.
          +
          fileContentsInputStream - InputStream to consume and write to the file.
          +
          Returns:
          +
          Returns the resolved path.
          +
          +
          • +
        + + + +
          +
        • +

          getFileString

          +
          public java.util.Optional<java.lang.String> getFileString​(java.nio.file.Path file)
          +
          Gets the contents of a stored file as a String.
          +
          +
          Parameters:
          +
          file - Relative or absolute path to the file to retrieve.
          +
          Returns:
          +
          Returns the optionally found file string.
          +
          Throws:
          +
          SmithyBuildException - if the file cannot be read as UTF-8.
          +
          +
          • +
        + + + +
          +
        • +

          getFileString

          +
          public java.util.Optional<java.lang.String> getFileString​(java.lang.String file)
          +
          Gets the contents of a stored file as a String.
          +
          +
          Parameters:
          +
          file - Relative or absolute path to the file to retrieve.
          +
          Returns:
          +
          Returns the optionally found file string.
          +
          Throws:
          +
          SmithyBuildException - if the file cannot be read as UTF-8.
          +
          +
          • +
        + + + +
          +
        • +

          expectFileString

          +
          public java.lang.String expectFileString​(java.nio.file.Path file)
          +
          Expects that the given file was stored and returns a UTF-8 string.
          +
          +
          Parameters:
          +
          file - File to retrieve.
          +
          Returns:
          +
          Returns the bytes of the file if found.
          +
          Throws:
          +
          java.nio.file.InvalidPathException - if the file cannot be found.
          +
          +
          • +
        + + + +
          +
        • +

          expectFileString

          +
          public java.lang.String expectFileString​(java.lang.String file)
          +
          Expects that the given file was stored and returns a UTF-8 string.
          +
          +
          Parameters:
          +
          file - File to retrieve.
          +
          Returns:
          +
          Returns the bytes of the file if found.
          +
          Throws:
          +
          java.nio.file.InvalidPathException - if the file cannot be found.
          +
          +
          • +
        + + + +
          +
        • +

          getFileBytes

          +
          public java.util.Optional<byte[]> getFileBytes​(java.nio.file.Path file)
          +
          Gets the bytes of a stored file.
          +
          +
          Parameters:
          +
          file - Relative or absolute path to the file to retrieve.
          +
          Returns:
          +
          Returns the optionally found file by.es,
          +
          +
          • +
        + + + +
          +
        • +

          getFileBytes

          +
          public java.util.Optional<byte[]> getFileBytes​(java.lang.String file)
          +
          Gets the bytes of a stored file.
          +
          +
          Parameters:
          +
          file - Relative or absolute path to the file to retrieve.
          +
          Returns:
          +
          Returns the optionally found file by.es,
          +
          +
          • +
        + + + +
          +
        • +

          expectFileBytes

          +
          public byte[] expectFileBytes​(java.nio.file.Path file)
          +
          Expects that the given file was stored and returns the bytes.
          +
          +
          Parameters:
          +
          file - File to retrieve.
          +
          Returns:
          +
          Returns the bytes of the file if found.
          +
          Throws:
          +
          java.nio.file.InvalidPathException - if the file cannot be found.
          +
          +
          • +
        + + + +
          +
        • +

          expectFileBytes

          +
          public byte[] expectFileBytes​(java.lang.String file)
          +
          Expects that the given file was stored and returns the bytes.
          +
          +
          Parameters:
          +
          file - File to retrieve.
          +
          Returns:
          +
          Returns the bytes of the file if found.
          +
          Throws:
          +
          java.nio.file.InvalidPathException - if the file cannot be found.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/PluginContext.Builder.html b/javadoc/1.47.0/software/amazon/smithy/build/PluginContext.Builder.html new file mode 100644 index 00000000000..447cbb3db9c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/PluginContext.Builder.html @@ -0,0 +1,507 @@ + + + + + +PluginContext.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build
    +

    Class PluginContext.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.PluginContext.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public PluginContext build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Specified by:
          +
          build in interface SmithyBuilder<PluginContext>
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        + + + +
          +
        • +

          fileManifest

          +
          public PluginContext.Builder fileManifest​(FileManifest fileManifest)
          +
          Sets the required FileManifest to use + in the plugin.
          +
          +
          Parameters:
          +
          fileManifest - FileManifest to use.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          model

          +
          public PluginContext.Builder model​(Model model)
          +
          Sets the required model that is being built.
          +
          +
          Parameters:
          +
          model - Model to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          projection

          +
          public PluginContext.Builder projection​(java.lang.String name,
+                                        ProjectionConfig projection)
          +
          Sets the projection that the plugin belongs to.
          +
          +
          Parameters:
          +
          name - Name of the projection.
          +
          projection - ProjectionConfig to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          originalModel

          +
          public PluginContext.Builder originalModel​(Model originalModel)
          +
          Sets the model that is being built before it was transformed in + the projection.
          +
          +
          Parameters:
          +
          originalModel - Original Model to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          events

          +
          public PluginContext.Builder events​(java.util.List<ValidationEvent> events)
          +
          Sets the validation events that occurred after projecting the model.
          +
          +
          Parameters:
          +
          events - Validation events to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          settings

          +
          public PluginContext.Builder settings​(ObjectNode settings)
          +
          Sets the settings of the plugin.
          +
          +
          Parameters:
          +
          settings - Settings to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          pluginClassLoader

          +
          public PluginContext.Builder pluginClassLoader​(java.lang.ClassLoader pluginClassLoader)
          +
          Sets a ClassLoader that should be used by build plugins when loading + services.
          +
          +
          Parameters:
          +
          pluginClassLoader - ClassLoader to use in build plugins.
          +
          Returns:
          +
          Retruns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          sources

          +
          public PluginContext.Builder sources​(java.util.Collection<java.nio.file.Path> sources)
          +
          Replaces the path to models that are considered "source" models of the + package being built.
          +
          +
          Parameters:
          +
          sources - Source models to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          artifactName

          +
          public PluginContext.Builder artifactName​(java.lang.String artifactName)
          +
          Set a custom artifact name used to change the output directory of a plugin. + +

          An artifact name is useful when running plugins like "run" or when running a plugin multiple times + in a single projection.

          +
          +
          Parameters:
          +
          artifactName - Custom artifact name to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/PluginContext.html b/javadoc/1.47.0/software/amazon/smithy/build/PluginContext.html new file mode 100644 index 00000000000..fbeaa43a357 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/PluginContext.html @@ -0,0 +1,644 @@ + + + + + +PluginContext (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build
    +

    Class PluginContext

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.PluginContext
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static PluginContext.Builderbuilder() +
        Creates a new PluginContext Builder.
        +
        java.util.Optional<java.lang.String>getArtifactName() +
        Gets the plugin artifact name, if present.
        +
        java.util.List<ValidationEvent>getEvents() +
        Gets the validation events encountered after projecting the model.
        +
        FileManifestgetFileManifest() +
        Gets the FileManifest used to create files in the projection.
        +
        ModelgetModel() +
        Gets the model that was projected.
        +
        ModelgetModelWithoutTraitShapes() +
        Creates a new Model where shapes that define traits or shapes + that are only used as part of a trait definition have been removed.
        +
        java.util.Optional<Model>getOriginalModel() +
        Get the original model before applying the projection.
        +
        java.util.Optional<java.lang.ClassLoader>getPluginClassLoader() +
        Gets the ClassLoader that should be used in build plugins to load + services.
        +
        java.util.Optional<ProjectionConfig>getProjection() 
        java.lang.StringgetProjectionName() +
        Gets the name of the projection being applied.
        +
        ObjectNodegetSettings() +
        Gets the plugin configuration settings.
        +
        java.util.Set<java.nio.file.Path>getSources() +
        Gets the source models, or models that are considered the subject + of the build.
        +
        booleanisSourceMetadata​(java.lang.String metadataKey) +
        Checks if the given metadata key-value pair is either not present + in the old model (thus a new, source metadata), or is present and + the filename of the entry in the original model matches one of + the defined sources.
        +
        booleanisSourceShape​(ToShapeId shape) +
        Checks if the given shape/ID is either not present in the original + model (thus a new, source shape), or is present and the filename of + the shape in the original model matches one of the defined + sources.
        +
        PluginContext.BuildertoBuilder() +
        Take this object and create a builder that contains all of the + current property values of this object.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + +
          +
        • +

          builder

          +
          public static PluginContext.Builder builder()
          +
          Creates a new PluginContext Builder.
          +
          +
          Returns:
          +
          Returns the created builder.
          +
          +
          • +
        + + + +
          +
        • +

          getProjection

          +
          public java.util.Optional<ProjectionConfig> getProjection()
          +
          +
          Returns:
          +
          Get the projection the plugin is optionally attached to.
          +
          +
          • +
        + + + +
          +
        • +

          getProjectionName

          +
          public java.lang.String getProjectionName()
          +
          Gets the name of the projection being applied. + +

          If no projection could be found, "source" is assumed.

          +
          +
          Returns:
          +
          Returns the explicit or assumed projection name.
          +
          +
          • +
        + + + +
          +
        • +

          getArtifactName

          +
          public java.util.Optional<java.lang.String> getArtifactName()
          +
          Gets the plugin artifact name, if present. + +

          An artifact name is given to a plugin by defining the plugin as "bar::foo", where "foo" is the artifact + name and "bar" is the plugin name. An artifact name is useful for cases when a plugin is applied multiple times + in a single projection. The artifact name changes the directory of where the plugin writes files. A plugin + implementation should use the plugin name as the artifact name if no explicit artifact name is provided.

          +
          +
          Returns:
          +
          Returns the optional artifact name.
          +
          +
          • +
        + + + +
          +
        • +

          getModel

          +
          public Model getModel()
          +
          Gets the model that was projected.
          +
          +
          Returns:
          +
          Get the projected model.
          +
          +
          • +
        + + + +
          +
        • +

          getOriginalModel

          +
          public java.util.Optional<Model> getOriginalModel()
          +
          Get the original model before applying the projection.
          +
          +
          Returns:
          +
          The optionally provided original model.
          +
          +
          • +
        + + + +
          +
        • +

          getEvents

          +
          public java.util.List<ValidationEvent> getEvents()
          +
          Gets the validation events encountered after projecting the model.
          +
          +
          Returns:
          +
          Get the validation events that were encountered.
          +
          +
          • +
        + + + +
          +
        • +

          getSettings

          +
          public ObjectNode getSettings()
          +
          Gets the plugin configuration settings.
          +
          +
          Returns:
          +
          Plugins settings object.
          +
          +
          • +
        + + + +
          +
        • +

          getFileManifest

          +
          public FileManifest getFileManifest()
          +
          Gets the FileManifest used to create files in the projection. + +

          All files written by a plugin should either be written using this + manifest or added to the manifest via FileManifest.addFile(java.nio.file.Path).

          +
          +
          Returns:
          +
          Returns the file manifest.
          +
          +
          • +
        + + + +
          +
        • +

          getPluginClassLoader

          +
          public java.util.Optional<java.lang.ClassLoader> getPluginClassLoader()
          +
          Gets the ClassLoader that should be used in build plugins to load + services.
          +
          +
          Returns:
          +
          Returns the optionally set ClassLoader.
          +
          +
          • +
        + + + +
          +
        • +

          getModelWithoutTraitShapes

          +
          public Model getModelWithoutTraitShapes()
          +
          Creates a new Model where shapes that define traits or shapes + that are only used as part of a trait definition have been removed. + +

          This is typically functionality used by code generators when + generating data structures from a model. It's useful because it only + provides shapes that are used to describe data structures rather than + shapes used to describe metadata about the data structures. + +

          Note: this method just calls ModelTransformer.getModelWithoutTraitShapes(software.amazon.smithy.model.Model). + It's added to PluginContext to make it more easily available + to code generators.

          +
          +
          Returns:
          +
          Returns a Model containing matching shapes.
          +
          +
          • +
        + + + +
          +
        • +

          getSources

          +
          public java.util.Set<java.nio.file.Path> getSources()
          +
          Gets the source models, or models that are considered the subject + of the build. + +

          This does not return an exhaustive set of model paths! There are + typically two kinds of models that are added to a build: source + models and discovered models. Discovered models are someone else's + models. Source models are the models owned by the package being built.

          +
          +
          Returns:
          +
          Returns the source models.
          +
          +
          • +
        + + + +
          +
        • +

          isSourceShape

          +
          public boolean isSourceShape​(ToShapeId shape)
          +
          Checks if the given shape/ID is either not present in the original + model (thus a new, source shape), or is present and the filename of + the shape in the original model matches one of the defined + sources.
          +
          +
          Parameters:
          +
          shape - Shape or Shape ID to check.
          +
          Returns:
          +
          Returns true if this shape is considered a source shape.
          +
          +
          • +
        + + + +
          +
        • +

          isSourceMetadata

          +
          public boolean isSourceMetadata​(java.lang.String metadataKey)
          +
          Checks if the given metadata key-value pair is either not present + in the old model (thus a new, source metadata), or is present and + the filename of the entry in the original model matches one of + the defined sources.
          +
          +
          Parameters:
          +
          metadataKey - Metadata key to check.
          +
          Returns:
          +
          Returns true if this metadata is considered a source entry.
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/ProjectionResult.Builder.html b/javadoc/1.47.0/software/amazon/smithy/build/ProjectionResult.Builder.html new file mode 100644 index 00000000000..5398e25d3c9 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/ProjectionResult.Builder.html @@ -0,0 +1,447 @@ + + + + + +ProjectionResult.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build
    +

    Class ProjectionResult.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.ProjectionResult.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          model

          +
          public ProjectionResult.Builder model​(Model model)
          +
          Sets the required model that was projected.
          +
          +
          Parameters:
          +
          model - Model to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          projectionName

          +
          public ProjectionResult.Builder projectionName​(java.lang.String projectionName)
          +
          Sets the required projection name.
          +
          +
          Parameters:
          +
          projectionName - ProjectionConfig name to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          addPluginManifest

          +
          public ProjectionResult.Builder addPluginManifest​(java.lang.String artifactName,
+                                                  FileManifest manifest)
          +
          Adds an artifact result for a plugin. + +

          If no artifact name is configured for a plugin in smithy-build.json (e.g., "plugin::artifact"), the + artifact name defaults to the plugin name.

          +
          +
          Parameters:
          +
          artifactName - Name of the plugin artifact to set.
          +
          manifest - File manifest used by the plugin.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          addEvent

          +
          public ProjectionResult.Builder addEvent​(ValidationEvent event)
          +
          Adds validation events to the result.
          +
          +
          Parameters:
          +
          event - Validation event to add.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          events

          +
          public ProjectionResult.Builder events​(java.util.List<ValidationEvent> events)
          +
          Sets the validation events of the projection.
          +
          +
          Parameters:
          +
          events - Validation events to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/ProjectionResult.html b/javadoc/1.47.0/software/amazon/smithy/build/ProjectionResult.html new file mode 100644 index 00000000000..5557defc0ba --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/ProjectionResult.html @@ -0,0 +1,428 @@ + + + + + +ProjectionResult (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build
    +

    Class ProjectionResult

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.ProjectionResult
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class ProjectionResult
+extends java.lang.Object
      +
      The result of applying a projection to a model.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getProjectionName

          +
          public java.lang.String getProjectionName()
          +
          Gets the name of the projection that was executed.
          +
          +
          Returns:
          +
          Returns the projection name.
          +
          +
          • +
        + + + +
          +
        • +

          getModel

          +
          public Model getModel()
          +
          Gets the result of projecting the model.
          +
          +
          Returns:
          +
          Returns the projected model.
          +
          +
          • +
        + + + +
          +
        • +

          isBroken

          +
          public boolean isBroken()
          +
          Returns true if the projection contains error or danger events.
          +
          +
          Returns:
          +
          Returns true if the projected model is broken.
          +
          +
          • +
        + + + +
          +
        • +

          getEvents

          +
          public java.util.List<ValidationEvent> getEvents()
          +
          Gets the validation events encountered after projecting the model.
          +
          +
          Returns:
          +
          Returns the encountered validation events.
          +
          +
          • +
        + + + +
          +
        • +

          getPluginManifests

          +
          public java.util.Map<java.lang.String,​FileManifest> getPluginManifests()
          +
          Gets the results of each plugin.
          +
          +
          Returns:
          +
          Returns a map of plugin names to their file manifests.
          +
          +
          • +
        + + + +
          +
        • +

          getPluginManifest

          +
          public java.util.Optional<FileManifest> getPluginManifest​(java.lang.String artifactName)
          +
          Gets the result of a specific plugin by plugin artifact name. + +

          If no artifact name is configured for a plugin in smithy-build.json (e.g., "plugin::artifact"), the + artifact name defaults to the plugin name.

          +
          +
          Parameters:
          +
          artifactName - Name of the plugin artifact to retrieve.
          +
          Returns:
          +
          Returns files created by the given plugin or an empty list.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/ProjectionTransformer.html b/javadoc/1.47.0/software/amazon/smithy/build/ProjectionTransformer.html new file mode 100644 index 00000000000..46e452c83bd --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/ProjectionTransformer.html @@ -0,0 +1,385 @@ + + + + + +ProjectionTransformer (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build
    +

    Interface ProjectionTransformer

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getName

          +
          java.lang.String getName()
          +
          Gets the name of the transformer.
          +
          +
          Returns:
          +
          Returns the name (e.g., "traits").
          +
          +
          • +
        + + + +
          +
        • +

          transform

          +
          Model transform​(TransformContext context)
          +
          Transforms the given model using the provided TransformContext.
          +
          +
          Parameters:
          +
          context - Transformation context.
          +
          Returns:
          +
          Returns the created transformer.
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if the arguments are invalid.
          +
          +
          • +
        + + + +
          +
        • +

          getAdditionalProjections

          +
          default java.util.List<java.lang.String> getAdditionalProjections​(TransformContext context)
          +
          Allows the composition of projections by returning additional + projections to run after the current one.
          +
          +
          Parameters:
          +
          context - Transformation context.
          +
          Returns:
          +
          a collection of named projections to run.
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if the arguments are invalid.
          +
          +
          • +
        + + + +
          +
        • +

          createServiceFactory

          +
          static java.util.function.Function<java.lang.String,​java.util.Optional<ProjectionTransformer>> createServiceFactory()
          +
          Creates a ProjectionTransformer factory function using SPI + and the current thread's context class loader.
          +
          +
          Returns:
          +
          Returns the created factory function.
          +
          See Also:
          +
          Thread.getContextClassLoader()
          +
          +
          • +
        + + + +
          +
        • +

          createServiceFactory

          +
          static java.util.function.Function<java.lang.String,​java.util.Optional<ProjectionTransformer>> createServiceFactory​(java.lang.Iterable<ProjectionTransformer> transformers)
          +
          Creates a ProjectionTransformer factory function using + the given transformers.
          +
          +
          Parameters:
          +
          transformers - Transformers used to build a factory function.
          +
          Returns:
          +
          Returns the created factory.
          +
          +
          • +
        + + + +
          +
        • +

          createServiceFactory

          +
          static java.util.function.Function<java.lang.String,​java.util.Optional<ProjectionTransformer>> createServiceFactory​(java.lang.ClassLoader classLoader)
          +
          Creates a ProjectionTransformer factory function using SPI.
          +
          +
          Parameters:
          +
          classLoader - Class loader to use to discover classes.
          +
          Returns:
          +
          Returns the created factory function.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/SmithyBuild.html b/javadoc/1.47.0/software/amazon/smithy/build/SmithyBuild.html new file mode 100644 index 00000000000..11432efe7ef --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/SmithyBuild.html @@ -0,0 +1,942 @@ + + + + + +SmithyBuild (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build
    +

    Class SmithyBuild

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.SmithyBuild
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class SmithyBuild
+extends java.lang.Object
      +
      Runs the projections and plugins found in a SmithyBuildConfig + and writes the artifacts to a FileManifest.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        static java.lang.StringVERSION +
        The version of Smithy build.
        +
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
        Modifier and TypeMethodDescription
        SmithyBuildResultbuild() +
        Builds the model and applies all projections.
        +
        voidbuild​(java.util.function.Consumer<ProjectionResult> resultCallback, + java.util.function.BiConsumer<java.lang.String,​java.lang.Throwable> exceptionCallback) +
        Builds the model and applies all projections, passing each + ProjectionResult to the provided callback as they are + completed and each encountered exception to the provided + exceptionCallback as they are encountered.
        +
        SmithyBuildconfig​(java.nio.file.Path configPath) +
        Sets the required configuration object used to + build the model.
        +
        SmithyBuildconfig​(SmithyBuildConfig config) +
        Sets the required configuration object used to + build the model.
        +
        static SmithyBuildcreate​(java.lang.ClassLoader classLoader) +
        Creates a SmithyBuild implementation that is configured to + discover various Smithy service providers using the given + ClassLoader.
        +
        static SmithyBuildcreate​(java.lang.ClassLoader classLoader, + java.util.function.Supplier<ModelAssembler> modelAssemblerSupplier) +
        Creates a SmithyBuild implementation that is configured to + discover various Smithy service providers using the given + ClassLoader.
        +
        SmithyBuildfileManifestFactory​(java.util.function.Function<java.nio.file.Path,​FileManifest> fileManifestFactory) +
        Sets a factory function that's used to create FileManifest + objects when writing SmithyBuildPlugin artifacts.
        +
        static java.nio.file.PathgetDefaultOutputDirectory() +
        Gets the default directory where smithy-build artifacts are written.
        +
        SmithyBuildimportBasePath​(java.nio.file.Path importBasePath) +
        Deprecated.
        +
        SmithyBuildmodel​(Model model) +
        Sets an optional model to use with the build.
        +
        SmithyBuildmodelAssemblerSupplier​(java.util.function.Supplier<ModelAssembler> modelAssemblerSupplier) +
        Called to create ModelAssembler to load the original + model and to load each projected model.
        +
        SmithyBuildmodelTransformer​(ModelTransformer modelTransformer) +
        Sets a custom ModelTransformer to use when building + projections.
        +
        SmithyBuildoutputDirectory​(java.lang.String outputDirectory) +
        Set a directory where the build artifacts are written.
        +
        SmithyBuildoutputDirectory​(java.nio.file.Path outputDirectory) +
        Set a directory where the build artifacts are written.
        +
        SmithyBuildpluginClassLoader​(java.lang.ClassLoader pluginClassLoader) +
        Sets a ClassLoader that should be used by SmithyBuild plugins when + discovering services.
        +
        SmithyBuildpluginFactory​(java.util.function.Function<java.lang.String,​java.util.Optional<SmithyBuildPlugin>> pluginFactory) +
        Sets a factory function used to create plugins by name.
        +
        SmithyBuildpluginFilter​(java.util.function.Predicate<java.lang.String> pluginFilter) +
        Sets a predicate that accepts the name of a plugin and returns + true if the plugin should be built.
        +
        SmithyBuildprojectionFilter​(java.util.function.Predicate<java.lang.String> projectionFilter) +
        Sets a predicate that accepts the name of a projection and returns + true if the projection should be built.
        +
        SmithyBuildregisterSources​(java.nio.file.Path... pathToSources) +
        Registers the given paths as sources of the model being built.
        +
        SmithyBuildtransformFactory​(java.util.function.Function<java.lang.String,​java.util.Optional<ProjectionTransformer>> transformFactory) +
        Sets a factory function used to create transforms by name.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Field Detail

        + + + +
          +
        • +

          VERSION

          +
          public static final java.lang.String VERSION
          +
          The version of Smithy build.
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          SmithyBuild

          +
          public SmithyBuild()
          +
          • +
        + + + + +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          create

          +
          public static SmithyBuild create​(java.lang.ClassLoader classLoader)
          +
          Creates a SmithyBuild implementation that is configured to + discover various Smithy service providers using the given + ClassLoader.
          +
          +
          Parameters:
          +
          classLoader - ClassLoader used to discover service providers.
          +
          Returns:
          +
          Returns the created SmithyBuild object.
          +
          +
          • +
        + + + +
          +
        • +

          create

          +
          public static SmithyBuild create​(java.lang.ClassLoader classLoader,
+                                 java.util.function.Supplier<ModelAssembler> modelAssemblerSupplier)
          +
          Creates a SmithyBuild implementation that is configured to + discover various Smithy service providers using the given + ClassLoader.
          +
          +
          Parameters:
          +
          classLoader - ClassLoader used to discover service providers.
          +
          modelAssemblerSupplier - Supplier used to create ModelAssemblers in each build.
          +
          Returns:
          +
          Returns the created SmithyBuild object.
          +
          +
          • +
        + + + +
          +
        • +

          getDefaultOutputDirectory

          +
          public static java.nio.file.Path getDefaultOutputDirectory()
          +
          Gets the default directory where smithy-build artifacts are written.
          +
          +
          Returns:
          +
          Returns the build output path.
          +
          +
          • +
        + + + +
          +
        • +

          build

          +
          public SmithyBuildResult build()
          +
          Builds the model and applies all projections. + +

          This method loads all projections, projected models, and their + results into memory so that a SmithyBuildResult can be + returned. See build(Consumer, BiConsumer) for a streaming + approach that uses callbacks and does not load all projections into + memory at once. + +

          Errors are aggregated together into a single + SmithyBuildException that contains an aggregated error + message and each encountered exception is registered to the aggregate + exception through Throwable.addSuppressed(Throwable).

          +
          +
          Returns:
          +
          Returns the result of building the model.
          +
          Throws:
          +
          java.lang.IllegalStateException - if a SmithyBuildConfig is not set.
          +
          SmithyBuildException - if the build fails.
          +
          See Also:
          +
          build(Consumer, BiConsumer)
          +
          +
          • +
        + + + +
          +
        • +

          build

          +
          public void build​(java.util.function.Consumer<ProjectionResult> resultCallback,
+                  java.util.function.BiConsumer<java.lang.String,​java.lang.Throwable> exceptionCallback)
          +
          Builds the model and applies all projections, passing each + ProjectionResult to the provided callback as they are + completed and each encountered exception to the provided + exceptionCallback as they are encountered. + +

          This method differs from build() in that it does not + require every projection and projection result to be loaded into + memory. + +

          The result each projection is placed in the outputDirectory. + A [projection]-build-info.json file is created in the output + directory. A directory is created for each projection using the + projection name, and a file named model.json is place in each directory.

          +
          +
          Parameters:
          +
          resultCallback - A thread-safe callback that receives projection + results as they complete.
          +
          exceptionCallback - A thread-safe callback that receives the name + of each failed projection and the exception that occurred.
          +
          Throws:
          +
          java.lang.IllegalStateException - if a SmithyBuildConfig is not set.
          +
          +
          • +
        + + + +
          +
        • +

          config

          +
          public SmithyBuild config​(SmithyBuildConfig config)
          +
          Sets the required configuration object used to + build the model.
          +
          +
          Parameters:
          +
          config - Configuration to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          config

          +
          public SmithyBuild config​(java.nio.file.Path configPath)
          +
          Sets the required configuration object used to + build the model.
          +
          +
          Parameters:
          +
          configPath - Path to the configuration to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          model

          +
          public SmithyBuild model​(Model model)
          +
          Sets an optional model to use with the build. The provided model is + used alongside any "imports" found in the configuration object.
          +
          +
          Parameters:
          +
          model - Model to build.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          importBasePath

          +
          @Deprecated
+public SmithyBuild importBasePath​(java.nio.file.Path importBasePath)
          +
          Deprecated.
          +
          • +
        + + + +
          +
        • +

          outputDirectory

          +
          public SmithyBuild outputDirectory​(java.nio.file.Path outputDirectory)
          +
          Set a directory where the build artifacts are written. + +

          Calling this method will supersede any outputDirectory + setting returned by SmithyBuildConfig.getOutputDirectory(). + +

          If no output directory is specified here or in the config, then + a default output directory of the current working directory resolved + with ./build/smithy is used.

          +
          +
          Parameters:
          +
          outputDirectory - Directory where artifacts are written.
          +
          Returns:
          +
          Returns the builder.
          +
          See Also:
          +
          SmithyBuildConfig.getOutputDirectory()
          +
          +
          • +
        + + + +
          +
        • +

          outputDirectory

          +
          public SmithyBuild outputDirectory​(java.lang.String outputDirectory)
          +
          Set a directory where the build artifacts are written. + +

          Calling this method will supersede any outputDirectory + setting returned by SmithyBuildConfig.getOutputDirectory(). + +

          If no output directory is specified here or in the config, then + a default output directory of the current working directory + + ./build/smithy is used.

          +
          +
          Parameters:
          +
          outputDirectory - Directory where artifacts are written.
          +
          Returns:
          +
          Returns the builder.
          +
          See Also:
          +
          SmithyBuildConfig.getOutputDirectory()
          +
          +
          • +
        + + + +
          +
        • +

          fileManifestFactory

          +
          public SmithyBuild fileManifestFactory​(java.util.function.Function<java.nio.file.Path,​FileManifest> fileManifestFactory)
          +
          Sets a factory function that's used to create FileManifest + objects when writing SmithyBuildPlugin artifacts. + +

          A default implementation of FileManifest.create(java.nio.file.Path) will be + used if a custom factory is not provided.

          +
          +
          Parameters:
          +
          fileManifestFactory - Factory that accepts a base path and + returns a FileManifest.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          modelAssemblerSupplier

          +
          public SmithyBuild modelAssemblerSupplier​(java.util.function.Supplier<ModelAssembler> modelAssemblerSupplier)
          +
          Called to create ModelAssembler to load the original + model and to load each projected model. + +

          If not provided, the runner will use a default ModelAssembler + implementation that discovers traits, validators, and other + service providers using the class path and module path of + software.smithy.model. + +

          Warning: this supplier can be invoked multiple times to build + a single projection, cache things like service provider factories + when necessary. The same instance of a ModelAssembler MUST NOT + be returned from successive calls to the supplier because assemblers + are created and mutated in different threads.

          +
          +
          Parameters:
          +
          modelAssemblerSupplier - ModelValidator supplier to utilize.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          modelTransformer

          +
          public SmithyBuild modelTransformer​(ModelTransformer modelTransformer)
          +
          Sets a custom ModelTransformer to use when building + projections. + +

          The runner will use a default ModelTransformer if one is not + provided.

          +
          +
          Parameters:
          +
          modelTransformer - Transformer to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          transformFactory

          +
          public SmithyBuild transformFactory​(java.util.function.Function<java.lang.String,​java.util.Optional<ProjectionTransformer>> transformFactory)
          +
          Sets a factory function used to create transforms by name. + +

          A default implementation that utilizes Java SPI to discover + implementations of ProjectionTransformer will be + used if a custom factory is not provided.

          +
          +
          Parameters:
          +
          transformFactory - Factory that accepts a transform name and + returns the optionally found transform.
          +
          Returns:
          +
          Returns the builder.
          +
          See Also:
          +
          ProjectionTransformer.createServiceFactory()
          +
          +
          • +
        + + + + + + + +
          +
        • +

          pluginClassLoader

          +
          public SmithyBuild pluginClassLoader​(java.lang.ClassLoader pluginClassLoader)
          +
          Sets a ClassLoader that should be used by SmithyBuild plugins when + discovering services.
          +
          +
          Parameters:
          +
          pluginClassLoader - ClassLoader plugins discover services with.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          registerSources

          +
          public SmithyBuild registerSources​(java.nio.file.Path... pathToSources)
          +
          Registers the given paths as sources of the model being built. + +

          There are typically two kinds of models that are added to a build: + source models and discovered models. Discovered models are someone + else's models. Source models are the models owned by the package + being built. + +

          Source models are copied into the automatically executed "manifest" + plugin. If no transformations were applied to the sources, then the + source models are copied literally into the manifest directory output. + Otherwise, a modified version of the source models are copied. + +

          When a directory is provided, all of the files in the directory are + treated as sources, and they are relativized to remove the directory. + When a file is provided, the directory that contains that file is used + as a source. All of the relativized files resolved in sources must be + unique across the entire set of files. The sources directories are + essentially flattened into a single directory. + +

          Unsupported model files are ignored and not treated as sources. + This can happen when adding model files from a directory that contains + a mix of model files and non-model files. Filtering models here prevents + unsupported files from appearing in places like JAR manifest files where + they are not allowed.

          +
          +
          Parameters:
          +
          pathToSources - Path to source directories to mark.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          projectionFilter

          +
          public SmithyBuild projectionFilter​(java.util.function.Predicate<java.lang.String> projectionFilter)
          +
          Sets a predicate that accepts the name of a projection and returns + true if the projection should be built.
          +
          +
          Parameters:
          +
          projectionFilter - Predicate that accepts a projection name.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          pluginFilter

          +
          public SmithyBuild pluginFilter​(java.util.function.Predicate<java.lang.String> pluginFilter)
          +
          Sets a predicate that accepts the name of a plugin and returns + true if the plugin should be built.
          +
          +
          Parameters:
          +
          pluginFilter - Predicate that accepts a projection name.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/SmithyBuildException.html b/javadoc/1.47.0/software/amazon/smithy/build/SmithyBuildException.html new file mode 100644 index 00000000000..eb80ed18b81 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/SmithyBuildException.html @@ -0,0 +1,329 @@ + + + + + +SmithyBuildException (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build
    +

    Class SmithyBuildException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Throwable
        • +
      • +
          +
        • java.lang.Exception
          • +
        • +
            +
          • java.lang.RuntimeException
            • +
          • +
              +
            • software.amazon.smithy.build.SmithyBuildException
              • +
            +
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          SmithyBuildException

          +
          public SmithyBuildException​(java.lang.String message)
          +
          • +
        + + + +
          +
        • +

          SmithyBuildException

          +
          public SmithyBuildException​(java.lang.Throwable cause)
          +
          • +
        + + + +
          +
        • +

          SmithyBuildException

          +
          public SmithyBuildException​(java.lang.String message,
+                            java.lang.Throwable previous)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/SmithyBuildPlugin.html b/javadoc/1.47.0/software/amazon/smithy/build/SmithyBuildPlugin.html new file mode 100644 index 00000000000..f2f0dd0f311 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/SmithyBuildPlugin.html @@ -0,0 +1,414 @@ + + + + + +SmithyBuildPlugin (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build
    +

    Interface SmithyBuildPlugin

    +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Abstract Methods Default Methods 
        Modifier and TypeMethodDescription
        static java.util.function.Function<java.lang.String,​java.util.Optional<SmithyBuildPlugin>>createServiceFactory() +
        Creates a SmithyBuildPlugin factory function using SPI and the current + Thread's context class loader.
        +
        static java.util.function.Function<java.lang.String,​java.util.Optional<SmithyBuildPlugin>>createServiceFactory​(java.lang.ClassLoader classLoader) +
        Creates a SmithyBuildPlugin factory function using SPI.
        +
        static java.util.function.Function<java.lang.String,​java.util.Optional<SmithyBuildPlugin>>createServiceFactory​(java.lang.Iterable<SmithyBuildPlugin> plugins) +
        Creates a factory function used that creates SmithyBuildPlugins using + a list of resolved plugins.
        +
        voidexecute​(PluginContext context) +
        Executes the plugin, creating any number of artifacts.
        +
        java.lang.StringgetName() +
        Gets the name of the plugin.
        +
        default booleanisSerial() +
        Plugins can choose whether or not projections they are in can be run in + parallel with other projections.
        +
        default booleanrequiresValidModel() +
        Plugins can choose whether or not to create artifacts based on whether + or not the projection encountered error or unsuppressed danger events.
        +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getName

          +
          java.lang.String getName()
          +
          Gets the name of the plugin.
          +
          +
          Returns:
          +
          Returns the name (e.g., "MyPlugin").
          +
          +
          • +
        + + + +
          +
        • +

          requiresValidModel

          +
          default boolean requiresValidModel()
          +
          Plugins can choose whether or not to create artifacts based on whether + or not the projection encountered error or unsuppressed danger events. + +

          By default plugins require that there are no errors or danger events + for a given projected model.

          +
          +
          Returns:
          +
          Returns true if the plugin should only be called if there are + no error or unsuppressed danger violations for the projection.
          +
          +
          • +
        + + + +
          +
        • +

          isSerial

          +
          default boolean isSerial()
          +
          Plugins can choose whether or not projections they are in can be run in + parallel with other projections. + +

          By default plugins allow parallel execution.

          +
          +
          Returns:
          +
          Returns true if the plugin should be run serially, false if it + can be run in parallel with other plugins.
          +
          +
          • +
        + + + +
          +
        • +

          execute

          +
          void execute​(PluginContext context)
          +
          Executes the plugin, creating any number of artifacts.
          +
          +
          Parameters:
          +
          context - Plugin context for build execution.
          +
          +
          • +
        + + + +
          +
        • +

          createServiceFactory

          +
          static java.util.function.Function<java.lang.String,​java.util.Optional<SmithyBuildPlugin>> createServiceFactory​(java.lang.Iterable<SmithyBuildPlugin> plugins)
          +
          Creates a factory function used that creates SmithyBuildPlugins using + a list of resolved plugins.
          +
          +
          Parameters:
          +
          plugins - Plugins to lookup by name in the factory function.
          +
          Returns:
          +
          Returns the created factory function.
          +
          +
          • +
        + + + +
          +
        • +

          createServiceFactory

          +
          static java.util.function.Function<java.lang.String,​java.util.Optional<SmithyBuildPlugin>> createServiceFactory()
          +
          Creates a SmithyBuildPlugin factory function using SPI and the current + Thread's context class loader.
          +
          +
          Returns:
          +
          Returns the created factory function.
          +
          See Also:
          +
          Thread.getContextClassLoader()
          +
          +
          • +
        + + + +
          +
        • +

          createServiceFactory

          +
          static java.util.function.Function<java.lang.String,​java.util.Optional<SmithyBuildPlugin>> createServiceFactory​(java.lang.ClassLoader classLoader)
          +
          Creates a SmithyBuildPlugin factory function using SPI. + +

          This factory is used in SmithyBuild to create plugins + from configuration names.

          +
          +
          Parameters:
          +
          classLoader - Class loader used to find plugin implementations.
          +
          Returns:
          +
          Returns the created factory function.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/SmithyBuildResult.Builder.html b/javadoc/1.47.0/software/amazon/smithy/build/SmithyBuildResult.Builder.html new file mode 100644 index 00000000000..054513d6120 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/SmithyBuildResult.Builder.html @@ -0,0 +1,312 @@ + + + + + +SmithyBuildResult.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build
    +

    Class SmithyBuildResult.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.SmithyBuildResult.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          addProjectionResult

          +
          public SmithyBuildResult.Builder addProjectionResult​(ProjectionResult result)
          +
          Adds a projection result to the builder. + +

          This method is thread-safe as a synchronized list is updated each + time this is called.

          +
          +
          Parameters:
          +
          result - Result to add.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/SmithyBuildResult.html b/javadoc/1.47.0/software/amazon/smithy/build/SmithyBuildResult.html new file mode 100644 index 00000000000..1130cc94d83 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/SmithyBuildResult.html @@ -0,0 +1,469 @@ + + + + + +SmithyBuildResult (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build
    +

    Class SmithyBuildResult

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.SmithyBuildResult
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class SmithyBuildResult
+extends java.lang.Object
      +
      Encapsulates the result of running SmithyBuild.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static class SmithyBuildResult.Builder +
        Creates a SmithyBuildResult.
        +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          builder

          +
          public static SmithyBuildResult.Builder builder()
          +
          Creates a builder used to build SmithyBuildResult.
          +
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          anyBroken

          +
          public boolean anyBroken()
          +
          Returns true if any projected models contain error or danger events.
          +
          +
          Returns:
          +
          Returns true if any are broken.
          +
          +
          • +
        + + + +
          +
        • +

          allArtifacts

          +
          public java.util.stream.Stream<java.nio.file.Path> allArtifacts()
          +
          Gets all of the artifacts written during the build.
          +
          +
          Returns:
          +
          Returns a stream of paths to artifacts.
          +
          +
          • +
        + + + +
          +
        • +

          allManifests

          +
          public java.util.stream.Stream<FileManifest> allManifests()
          +
          Gets all of the manifests that were used in the build.
          +
          +
          Returns:
          +
          Returns a stream of the manifests.
          +
          +
          • +
        + + + +
          +
        • +

          getProjectionResult

          +
          public java.util.Optional<ProjectionResult> getProjectionResult​(java.lang.String projectionName)
          +
          Gets a projection result by name.
          +
          +
          Parameters:
          +
          projectionName - ProjectionConfig name to get.
          +
          Returns:
          +
          Returns the optionally found result.
          +
          +
          • +
        + + + +
          +
        • +

          getProjectionResults

          +
          public java.util.List<ProjectionResult> getProjectionResults()
          +
          Gets all of the projection results as an unmodifiable list.
          +
          +
          Returns:
          +
          Returns the projection results.
          +
          +
          • +
        + + + +
          +
        • +

          getProjectionResultsMap

          +
          public java.util.Map<java.lang.String,​ProjectionResult> getProjectionResultsMap()
          +
          Gets all of the projection results as a map of projection name to + ProjectionResult.
          +
          +
          Returns:
          +
          Returns the projection results as a map.
          +
          +
          • +
        + + + +
          +
        • +

          size

          +
          public int size()
          +
          Gets the number of projection results in the map.
          +
          +
          Returns:
          +
          Returns the number of results.
          +
          +
          • +
        + + + +
          +
        • +

          isEmpty

          +
          public boolean isEmpty()
          +
          Checks if the results is empty.
          +
          +
          Returns:
          +
          Returns true if there are no results.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/SourcesConflictException.html b/javadoc/1.47.0/software/amazon/smithy/build/SourcesConflictException.html new file mode 100644 index 00000000000..f3e233e0c76 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/SourcesConflictException.html @@ -0,0 +1,302 @@ + + + + + +SourcesConflictException (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build
    +

    Class SourcesConflictException

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      public class SourcesConflictException
+extends SmithyBuildException
      +
      Thrown when sources conflict in the source plugin.
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        SourcesConflictException​(java.lang.String message) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          SourcesConflictException

          +
          public SourcesConflictException​(java.lang.String message)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/TransformContext.Builder.html b/javadoc/1.47.0/software/amazon/smithy/build/TransformContext.Builder.html new file mode 100644 index 00000000000..2e1dcbbc16d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/TransformContext.Builder.html @@ -0,0 +1,384 @@ + + + + + +TransformContext.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build
    +

    Class TransformContext.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.TransformContext.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/TransformContext.html b/javadoc/1.47.0/software/amazon/smithy/build/TransformContext.html new file mode 100644 index 00000000000..a30aec7d2fb --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/TransformContext.html @@ -0,0 +1,488 @@ + + + + + +TransformContext (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build
    +

    Class TransformContext

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.TransformContext
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + +
          +
        • +

          getSettings

          +
          public ObjectNode getSettings()
          +
          Gets the arguments object of the transform.
          +
          +
          Returns:
          +
          Returns the transformer arguments.
          +
          +
          • +
        + + + +
          +
        • +

          getModel

          +
          public Model getModel()
          +
          Gets the model to transform.
          +
          +
          Returns:
          +
          Returns the model to transform.
          +
          +
          • +
        + + + +
          +
        • +

          getOriginalModel

          +
          public java.util.Optional<Model> getOriginalModel()
          +
          Get the original model before applying the projection.
          +
          +
          Returns:
          +
          The optionally provided original model.
          +
          +
          • +
        + + + +
          +
        • +

          getSources

          +
          public java.util.Set<java.nio.file.Path> getSources()
          +
          Gets the source models, or models that are considered the subject + of the build. + +

          This does not return an exhaustive set of model paths! There are + typically two kinds of models that are added to a build: source + models and discovered models. Discovered models are someone else's + models. Source models are the models owned by the package being built.

          +
          +
          Returns:
          +
          Returns the source models.
          +
          +
          • +
        + + + +
          +
        • +

          getProjectionName

          +
          public java.lang.String getProjectionName()
          +
          Gets the name of the projection being applied. + +

          If no projection could be found, "source" is assumed.

          +
          +
          Returns:
          +
          Returns the explicit or assumed projection name.
          +
          +
          • +
        + + + +
          +
        • +

          getTransformer

          +
          public ModelTransformer getTransformer()
          +
          Gets the ModelTransformer that has been configured to aid + in the transformation.
          +
          +
          Returns:
          +
          Returns the model transformer.
          +
          +
          • +
        + + + +
          +
        • +

          getOriginalModelValidationEvents

          +
          public java.util.List<ValidationEvent> getOriginalModelValidationEvents()
          +
          Gets an immutable list of ValidationEvents that were + encountered when loading the source model.
          +
          +
          Returns:
          +
          Returns the encountered validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/UnknownProjectionException.html b/javadoc/1.47.0/software/amazon/smithy/build/UnknownProjectionException.html new file mode 100644 index 00000000000..c755852a060 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/UnknownProjectionException.html @@ -0,0 +1,317 @@ + + + + + +UnknownProjectionException (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build
    +

    Class UnknownProjectionException

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      public class UnknownProjectionException
+extends SmithyBuildException
      +
      Thrown when a projection extends from an unknown projection.
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          UnknownProjectionException

          +
          public UnknownProjectionException​(java.lang.String message)
          +
          • +
        + + + +
          +
        • +

          UnknownProjectionException

          +
          public UnknownProjectionException​(java.lang.String message,
+                                  java.lang.Throwable previous)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/UnknownTransformException.html b/javadoc/1.47.0/software/amazon/smithy/build/UnknownTransformException.html new file mode 100644 index 00000000000..81a79307db8 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/UnknownTransformException.html @@ -0,0 +1,317 @@ + + + + + +UnknownTransformException (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build
    +

    Class UnknownTransformException

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      public class UnknownTransformException
+extends SmithyBuildException
      +
      Thrown when a mapper cannot be found.
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          UnknownTransformException

          +
          public UnknownTransformException​(java.lang.String message)
          +
          • +
        + + + +
          +
        • +

          UnknownTransformException

          +
          public UnknownTransformException​(java.lang.String message,
+                                 java.lang.Throwable previous)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/model/MavenConfig.Builder.html b/javadoc/1.47.0/software/amazon/smithy/build/model/MavenConfig.Builder.html new file mode 100644 index 00000000000..36292b7e0e5 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/model/MavenConfig.Builder.html @@ -0,0 +1,313 @@ + + + + + +MavenConfig.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.model
    +

    Class MavenConfig.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.model.MavenConfig.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/model/MavenConfig.html b/javadoc/1.47.0/software/amazon/smithy/build/model/MavenConfig.html new file mode 100644 index 00000000000..960fdc572ae --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/model/MavenConfig.html @@ -0,0 +1,424 @@ + + + + + +MavenConfig (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.model
    +

    Class MavenConfig

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.model.MavenConfig
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + +
          +
        • +

          getRepositories

          +
          public java.util.Set<MavenRepository> getRepositories()
          +
          Gets the repositories.
          +
          +
          Returns:
          +
          Returns the repositories in an insertion ordered set.
          +
          +
          • +
        + + + +
          +
        • +

          getDependencies

          +
          public java.util.Set<java.lang.String> getDependencies()
          +
          Gets the dependencies.
          +
          +
          Returns:
          +
          Returns the dependencies in an insertion ordered set.
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object obj)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/model/MavenRepository.Builder.html b/javadoc/1.47.0/software/amazon/smithy/build/model/MavenRepository.Builder.html new file mode 100644 index 00000000000..80d5ddf4e8f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/model/MavenRepository.Builder.html @@ -0,0 +1,355 @@ + + + + + +MavenRepository.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.model
    +

    Class MavenRepository.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.model.MavenRepository.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/model/MavenRepository.html b/javadoc/1.47.0/software/amazon/smithy/build/model/MavenRepository.html new file mode 100644 index 00000000000..5315eee8934 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/model/MavenRepository.html @@ -0,0 +1,478 @@ + + + + + +MavenRepository (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.model
    +

    Class MavenRepository

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.model.MavenRepository
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + +
          +
        • +

          getUrl

          +
          public java.lang.String getUrl()
          +
          • +
        + + + +
          +
        • +

          getId

          +
          public java.util.Optional<java.lang.String> getId()
          +
          • +
        + + + +
          +
        • +

          getHttpCredentials

          +
          public java.util.Optional<java.lang.String> getHttpCredentials()
          +
          • +
        + + + +
          +
        • +

          getProxyCredentials

          +
          public java.util.Optional<java.lang.String> getProxyCredentials()
          +
          • +
        + + + +
          +
        • +

          getProxyHost

          +
          public java.util.Optional<java.lang.String> getProxyHost()
          +
          • +
        + + + + + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/model/ProjectionConfig.Builder.html b/javadoc/1.47.0/software/amazon/smithy/build/model/ProjectionConfig.Builder.html new file mode 100644 index 00000000000..b22263d456a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/model/ProjectionConfig.Builder.html @@ -0,0 +1,377 @@ + + + + + +ProjectionConfig.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.model
    +

    Class ProjectionConfig.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.model.ProjectionConfig.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          setAbstract

          +
          public ProjectionConfig.Builder setAbstract​(boolean isAbstract)
          +
          Sets the abstract property of the projection. + +

          Abstract projections do not directly create any artifacts.

          +
          +
          Parameters:
          +
          isAbstract - Set to true to mark as abstract.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          imports

          +
          public ProjectionConfig.Builder imports​(java.util.Collection<java.lang.String> imports)
          +
          Replaces the imports of the projection.
          +
          +
          Parameters:
          +
          imports - Imports to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          transforms

          +
          public ProjectionConfig.Builder transforms​(java.util.Collection<TransformConfig> transforms)
          +
          Replaces the transforms of the projection.
          +
          +
          Parameters:
          +
          transforms - Transform to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          plugins

          +
          public ProjectionConfig.Builder plugins​(java.util.Map<java.lang.String,​ObjectNode> plugins)
          +
          Replaces the plugins of the projection.
          +
          +
          Parameters:
          +
          plugins - Map of plugin name to plugin settings.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/model/ProjectionConfig.html b/javadoc/1.47.0/software/amazon/smithy/build/model/ProjectionConfig.html new file mode 100644 index 00000000000..2807a47e4b3 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/model/ProjectionConfig.html @@ -0,0 +1,410 @@ + + + + + +ProjectionConfig (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.model
    +

    Class ProjectionConfig

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.model.ProjectionConfig
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + + + + + +
          +
        • +

          getTransforms

          +
          public java.util.List<TransformConfig> getTransforms()
          +
          +
          Returns:
          +
          Gets the immutable transforms in the projection.
          +
          +
          • +
        + + + +
          +
        • +

          getPlugins

          +
          public java.util.Map<java.lang.String,​ObjectNode> getPlugins()
          +
          +
          Returns:
          +
          Gets the immutable plugins of the projection.
          +
          +
          • +
        + + + +
          +
        • +

          isAbstract

          +
          public boolean isAbstract()
          +
          +
          Returns:
          +
          Returns true if the projection is abstract.
          +
          +
          • +
        + + + +
          +
        • +

          getImports

          +
          public java.util.List<java.lang.String> getImports()
          +
          Gets the imports configured for the projection.
          +
          +
          Returns:
          +
          Returns the projection-specific imports.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/model/SmithyBuildConfig.Builder.html b/javadoc/1.47.0/software/amazon/smithy/build/model/SmithyBuildConfig.Builder.html new file mode 100644 index 00000000000..bb03156fce5 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/model/SmithyBuildConfig.Builder.html @@ -0,0 +1,521 @@ + + + + + +SmithyBuildConfig.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.model
    +

    Class SmithyBuildConfig.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.model.SmithyBuildConfig.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          version

          +
          public SmithyBuildConfig.Builder version​(java.lang.String version)
          +
          Sets the builder config file version.
          +
          +
          Parameters:
          +
          version - Version to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          load

          +
          public SmithyBuildConfig.Builder load​(java.nio.file.Path config)
          +
          Loads and merges the config file into the builder.
          +
          +
          Parameters:
          +
          config - Config file to load, parse, and merge.
          +
          Returns:
          +
          Returns the updated builder.
          +
          +
          • +
        + + + +
          +
        • +

          merge

          +
          public SmithyBuildConfig.Builder merge​(SmithyBuildConfig config)
          +
          Updates this configuration with the configuration of another file.
          +
          +
          Parameters:
          +
          config - Config to update with.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          outputDirectory

          +
          public SmithyBuildConfig.Builder outputDirectory​(java.lang.String outputDirectory)
          +
          Set a directory where the build artifacts are written.
          +
          +
          Parameters:
          +
          outputDirectory - Directory where artifacts are written.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          imports

          +
          public SmithyBuildConfig.Builder imports​(java.util.Collection<java.lang.String> imports)
          +
          Replaces imports on the config.
          +
          +
          Parameters:
          +
          imports - Imports to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          sources

          +
          public SmithyBuildConfig.Builder sources​(java.util.Collection<java.lang.String> sources)
          +
          Replaces sources on the config.
          +
          +
          Parameters:
          +
          sources - Sources to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          projections

          +
          public SmithyBuildConfig.Builder projections​(java.util.Map<java.lang.String,​ProjectionConfig> projections)
          +
          Replaces projections on the config.
          +
          +
          Parameters:
          +
          projections - Projections to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          plugins

          +
          public SmithyBuildConfig.Builder plugins​(java.util.Map<java.lang.String,​ObjectNode> plugins)
          +
          Replaces plugins on the config.
          +
          +
          Parameters:
          +
          plugins - Plugins to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          ignoreMissingPlugins

          +
          public SmithyBuildConfig.Builder ignoreMissingPlugins​(boolean ignoreMissingPlugins)
          +
          Logs instead of failing when a plugin can't be found by name.
          +
          +
          Parameters:
          +
          ignoreMissingPlugins - Set to true to ignore missing plugins on the classpath.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + + + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/model/SmithyBuildConfig.html b/javadoc/1.47.0/software/amazon/smithy/build/model/SmithyBuildConfig.html new file mode 100644 index 00000000000..a80aab1bd35 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/model/SmithyBuildConfig.html @@ -0,0 +1,606 @@ + + + + + +SmithyBuildConfig (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.model
    +

    Class SmithyBuildConfig

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.model.SmithyBuildConfig
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + +
          +
        • +

          load

          +
          public static SmithyBuildConfig load​(java.nio.file.Path file)
          +
          Loads a SmithyBuildConfig from a JSON file on disk. + +

          The file is expected to contain the following structure: + + { + "version": "1.0", + "sources": ["model"], + "imports": ["foo.json", "baz.json"], + "outputDirectory": "build/output", + "maven" { + "dependencies": ["software.amazon.smithy:smithy-aws-traits:1.26.1"], + "repositories": [ + { + "url": "https://example.com/maven", + "httpCredentials": "${MAVEN_USER}:${MAVEN_PASSWORD}" + } + ] + } + "projections": { + "projection-name": { + "transforms": [ + {"name": "transform-name", "args": ["argument1", "argument2", "..."]}, + {"name": "other-transform"} + }, + "plugins": { + "plugin-name": { + "plugin-config": "value" + }, + "...": {} + } + } + }, + "plugins": { + "plugin-name": { + "plugin-config": "value" + }, + "...": {} + } + } +

          +
          +
          Parameters:
          +
          file - File to load and parse.
          +
          Returns:
          +
          Returns the loaded FileConfig.
          +
          Throws:
          +
          java.lang.RuntimeException - if the file cannot be loaded.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getVersion

          +
          public java.lang.String getVersion()
          +
          Gets the version of Smithy-Build.
          +
          +
          Returns:
          +
          Returns the version.
          +
          +
          • +
        + + + +
          +
        • +

          getImports

          +
          public java.util.List<java.lang.String> getImports()
          +
          Gets the paths to all the models to import. + +

          Paths can point to individual model files or directories. + All models stored in all recursive directories will be imported.

          +
          +
          Returns:
          +
          Gets the list of models to import.
          +
          +
          • +
        + + + +
          +
        • +

          getSources

          +
          public java.util.List<java.lang.String> getSources()
          +
          Gets the paths to all model sources. + +

          Paths can point to individual model files or directories. + All models stored in all recursive directories will be imported. + Each found Smithy model will be considered a source model.

          +
          +
          Returns:
          +
          Gets the list of models to import.
          +
          +
          • +
        + + + +
          +
        • +

          getOutputDirectory

          +
          public java.util.Optional<java.lang.String> getOutputDirectory()
          +
          +
          Returns:
          +
          Gets the optional output directory to store artifacts.
          +
          +
          • +
        + + + +
          +
        • +

          getProjections

          +
          public java.util.Map<java.lang.String,​ProjectionConfig> getProjections()
          +
          Gets all the configured projections.
          +
          +
          Returns:
          +
          Gets the available projections as a map of name to config.
          +
          +
          • +
        + + + +
          +
        • +

          getPlugins

          +
          public java.util.Map<java.lang.String,​ObjectNode> getPlugins()
          +
          Gets the globally configured plugins that are applied to every + projection.
          +
          +
          Returns:
          +
          Gets plugin settings.
          +
          +
          • +
        + + + +
          +
        • +

          isIgnoreMissingPlugins

          +
          public boolean isIgnoreMissingPlugins()
          +
          If a plugin can't be found, Smithy will by default fail the build. + This setting can be set to true to allow the build to progress even + if there is a missing plugin.
          +
          +
          Returns:
          +
          Returns true if missing build plugins are allowed.
          +
          +
          • +
        + + + +
          +
        • +

          getMaven

          +
          public java.util.Optional<MavenConfig> getMaven()
          +
          Gets Maven dependency configuration. + +

          Note that smithy-build does not directly resolve or use dependencies. + It's up to other packages like the Smithy CLI to use a dependency resolver + based on smithy-build.json configuration and call smithy-build with + the appropriate classpath.

          +
          +
          Returns:
          +
          Returns Maven dependency information.
          +
          +
          • +
        + + + +
          +
        • +

          getLastModifiedInMillis

          +
          public long getLastModifiedInMillis()
          +
          Get the last modified time of the configuration file.
          +
          +
          Returns:
          +
          Returns the last modified time in milliseconds since the epoch.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/model/TransformConfig.Builder.html b/javadoc/1.47.0/software/amazon/smithy/build/model/TransformConfig.Builder.html new file mode 100644 index 00000000000..651588fbdf7 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/model/TransformConfig.Builder.html @@ -0,0 +1,337 @@ + + + + + +TransformConfig.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.model
    +

    Class TransformConfig.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.model.TransformConfig.Builder
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          name

          +
          public TransformConfig.Builder name​(java.lang.String name)
          +
          Sets the required name.
          +
          +
          Parameters:
          +
          name - Name of the transform.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          args

          +
          public TransformConfig.Builder args​(Node args)
          +
          Sets the args of the transform. + +

          If an array is provided, the array is automatically converted + to an object with a key named "__args" that contains the array. + This is a backward compatibility shim for older versions of + Smithy Builder that only accepts a list of strings for + projection transforms.

          +
          +
          Parameters:
          +
          args - Arguments to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/model/TransformConfig.html b/javadoc/1.47.0/software/amazon/smithy/build/model/TransformConfig.html new file mode 100644 index 00000000000..1f3a7e559e5 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/model/TransformConfig.html @@ -0,0 +1,338 @@ + + + + + +TransformConfig (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.model
    +

    Class TransformConfig

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.model.TransformConfig
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class TransformConfig
+extends java.lang.Object
      +
      Transform configuration found in a projection.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + +
          +
        • +

          getName

          +
          public java.lang.String getName()
          +
          +
          Returns:
          +
          The name of the projection.
          +
          +
          • +
        + + + +
          +
        • +

          getArgs

          +
          public ObjectNode getArgs()
          +
          +
          Returns:
          +
          Gets the args.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/model/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/build/model/package-summary.html new file mode 100644 index 00000000000..e1754419215 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/model/package-summary.html @@ -0,0 +1,211 @@ + + + + + +software.amazon.smithy.build.model (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.build.model

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/model/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/build/model/package-tree.html new file mode 100644 index 00000000000..aff891224d3 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/model/package-tree.html @@ -0,0 +1,170 @@ + + + + + +software.amazon.smithy.build.model Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.build.model

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/build/package-summary.html new file mode 100644 index 00000000000..494a79042e3 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/package-summary.html @@ -0,0 +1,309 @@ + + + + + +software.amazon.smithy.build (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.build

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/build/package-tree.html new file mode 100644 index 00000000000..d81c60a3918 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/package-tree.html @@ -0,0 +1,212 @@ + + + + + +software.amazon.smithy.build Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.build

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +

    Enum Hierarchy

    +
      +
    • java.lang.Object +
        +
      • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
        • +
      +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/plugins/BuildInfo.html b/javadoc/1.47.0/software/amazon/smithy/build/plugins/BuildInfo.html new file mode 100644 index 00000000000..c631e7b1cde --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/plugins/BuildInfo.html @@ -0,0 +1,647 @@ + + + + + +BuildInfo (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.plugins
    +

    Class BuildInfo

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.plugins.BuildInfo
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class BuildInfo
+extends java.lang.Object
      +
      POJO to represents a smithy-build-info.json file.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          BuildInfo

          +
          public BuildInfo()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getVersion

          +
          public java.lang.String getVersion()
          +
          +
          Returns:
          +
          Gets the version of the build-info file format.
          +
          +
          • +
        + + + +
          +
        • +

          setVersion

          +
          public void setVersion​(java.lang.String version)
          +
          • +
        + + + +
          +
        • +

          getProjectionName

          +
          public java.lang.String getProjectionName()
          +
          +
          Returns:
          +
          Gets the name of the projection used in this build.
          +
          +
          • +
        + + + +
          +
        • +

          setProjectionName

          +
          public void setProjectionName​(java.lang.String projectionName)
          +
          • +
        + + + +
          +
        • +

          getProjection

          +
          public ProjectionConfig getProjection()
          +
          +
          Returns:
          +
          Gets the projection configuration.
          +
          +
          • +
        + + + +
          +
        • +

          setProjection

          +
          public void setProjection​(ProjectionConfig projection)
          +
          • +
        + + + +
          +
        • +

          getValidationEvents

          +
          public java.util.List<ValidationEvent> getValidationEvents()
          +
          +
          Returns:
          +
          Gets the validation events encountered by the projection.
          +
          +
          • +
        + + + +
          +
        • +

          setValidationEvents

          +
          public void setValidationEvents​(java.util.List<ValidationEvent> validationEvents)
          +
          • +
        + + + +
          +
        • +

          getTraitNames

          +
          public java.util.List<ShapeId> getTraitNames()
          +
          +
          Returns:
          +
          Gets the shape ID of every trait used in the projected model.
          +
          +
          • +
        + + + +
          +
        • +

          setTraitNames

          +
          public void setTraitNames​(java.util.List<ShapeId> traitNames)
          +
          • +
        + + + +
          +
        • +

          getTraitDefNames

          +
          public java.util.List<ShapeId> getTraitDefNames()
          +
          +
          Returns:
          +
          Gets the shape ID of every trait shape defined in the projection.
          +
          +
          • +
        + + + +
          +
        • +

          setTraitDefNames

          +
          public void setTraitDefNames​(java.util.List<ShapeId> traitDefNames)
          +
          • +
        + + + +
          +
        • +

          getServiceShapeIds

          +
          public java.util.List<ShapeId> getServiceShapeIds()
          +
          +
          Returns:
          +
          Gets the shape ID of every service in the projection.
          +
          +
          • +
        + + + +
          +
        • +

          setServiceShapeIds

          +
          public void setServiceShapeIds​(java.util.List<ShapeId> serviceShapeIds)
          +
          • +
        + + + +
          +
        • +

          getOperationShapeIds

          +
          public java.util.List<ShapeId> getOperationShapeIds()
          +
          +
          Returns:
          +
          Gets the shape ID of every operation in the projection.
          +
          +
          • +
        + + + +
          +
        • +

          setOperationShapeIds

          +
          public void setOperationShapeIds​(java.util.List<ShapeId> operationShapeIds)
          +
          • +
        + + + +
          +
        • +

          getResourceShapeIds

          +
          public java.util.List<ShapeId> getResourceShapeIds()
          +
          +
          Returns:
          +
          Gets the shape ID of every resource in the projection.
          +
          +
          • +
        + + + +
          +
        • +

          setResourceShapeIds

          +
          public void setResourceShapeIds​(java.util.List<ShapeId> resourceShapeIds)
          +
          • +
        + + + +
          +
        • +

          getMetadata

          +
          public java.util.Map<java.lang.String,​Node> getMetadata()
          +
          +
          Returns:
          +
          Gets the model metadata in the projection.
          +
          +
          • +
        + + + +
          +
        • +

          setMetadata

          +
          public void setMetadata​(java.util.Map<java.lang.String,​Node> metadata)
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/plugins/BuildInfoPlugin.html b/javadoc/1.47.0/software/amazon/smithy/build/plugins/BuildInfoPlugin.html new file mode 100644 index 00000000000..fde6a450c2d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/plugins/BuildInfoPlugin.html @@ -0,0 +1,435 @@ + + + + + +BuildInfoPlugin (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.plugins
    +

    Class BuildInfoPlugin

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.plugins.BuildInfoPlugin
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      SmithyBuildPlugin
      +
      +
      +
      public final class BuildInfoPlugin
+extends java.lang.Object
+implements SmithyBuildPlugin
      +
      Writes a build info file for each projection. This file contains the + projection name, the filters, mappers, and validation events encountered + while building the model. + +

      This plugin is invoked regardless of whether or not the model contains + error or unsuppressed validation events. + +

      This plugin is only invoked if the projection and original model are + configured on the provided PluginContext.

      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        static java.lang.StringBUILD_INFO_PATH 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        BuildInfoPlugin() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidexecute​(PluginContext context) +
        Executes the plugin, creating any number of artifacts.
        +
        java.lang.StringgetName() +
        Gets the name of the plugin.
        +
        booleanrequiresValidModel() +
        Plugins can choose whether or not to create artifacts based on whether + or not the projection encountered error or unsuppressed danger events.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Field Detail

        + + + +
          +
        • +

          BUILD_INFO_PATH

          +
          public static final java.lang.String BUILD_INFO_PATH
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          BuildInfoPlugin

          +
          public BuildInfoPlugin()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getName

          +
          public java.lang.String getName()
          +
          Description copied from interface: SmithyBuildPlugin
          +
          Gets the name of the plugin.
          +
          +
          Specified by:
          +
          getName in interface SmithyBuildPlugin
          +
          Returns:
          +
          Returns the name (e.g., "MyPlugin").
          +
          +
          • +
        + + + +
          +
        • +

          requiresValidModel

          +
          public boolean requiresValidModel()
          +
          Description copied from interface: SmithyBuildPlugin
          +
          Plugins can choose whether or not to create artifacts based on whether + or not the projection encountered error or unsuppressed danger events. + +

          By default plugins require that there are no errors or danger events + for a given projected model.

          +
          +
          Specified by:
          +
          requiresValidModel in interface SmithyBuildPlugin
          +
          Returns:
          +
          Returns true if the plugin should only be called if there are + no error or unsuppressed danger violations for the projection.
          +
          +
          • +
        + + + +
          +
        • +

          execute

          +
          public void execute​(PluginContext context)
          +
          Description copied from interface: SmithyBuildPlugin
          +
          Executes the plugin, creating any number of artifacts.
          +
          +
          Specified by:
          +
          execute in interface SmithyBuildPlugin
          +
          Parameters:
          +
          context - Plugin context for build execution.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/plugins/ConfigurableSmithyBuildPlugin.html b/javadoc/1.47.0/software/amazon/smithy/build/plugins/ConfigurableSmithyBuildPlugin.html new file mode 100644 index 00000000000..79ac74fd63e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/plugins/ConfigurableSmithyBuildPlugin.html @@ -0,0 +1,396 @@ + + + + + +ConfigurableSmithyBuildPlugin (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.plugins
    +

    Class ConfigurableSmithyBuildPlugin<T>

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.plugins.ConfigurableSmithyBuildPlugin<T>
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Type Parameters:
      +
      T - The configuration setting type (e.g., a POJO).
      +
      +
      +
      All Implemented Interfaces:
      +
      SmithyBuildPlugin
      +
      +
      +
      public abstract class ConfigurableSmithyBuildPlugin<T>
+extends java.lang.Object
+implements SmithyBuildPlugin
      +
      An abstract class used to more easily implement a Smithy build plugin + that expects configuration input in a specific type, T. + +

      This class will automatically deserialize the given Node + value in the T and invoke executeWithConfig(PluginContext, Object) + with the deserialized configuration of type T. + +

      If your build plugin requires configuration, then you typically + should just extend this class.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ConfigurableSmithyBuildPlugin

          +
          public ConfigurableSmithyBuildPlugin()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getConfigType

          +
          public abstract java.lang.Class<T> getConfigType()
          +
          Gets the configuration class type. + +

          The referenced configType class must be a public POJO with a + public, zero-arg constructor, getters, and setters. If the POJO has a + public static fromNode method, it will be invoked and is + expected to deserialize the Node. If the POJO has a public static + builder method, it will be invoked, setters will be called + on the builder POJO, and finally the result of calling the + build method is used as the configuration type. Finally, + the deserializer will attempt to create the type and call setters on + it that correspond to property names.

          +
          +
          Returns:
          +
          Returns the configuration class (a POJO with setters/getters).
          +
          +
          • +
        + + + +
          +
        • +

          execute

          +
          public void execute​(PluginContext context)
          +
          Description copied from interface: SmithyBuildPlugin
          +
          Executes the plugin, creating any number of artifacts.
          +
          +
          Specified by:
          +
          execute in interface SmithyBuildPlugin
          +
          Parameters:
          +
          context - Plugin context for build execution.
          +
          +
          • +
        + + + + + +
          +
        • +

          executeWithConfig

          +
          protected abstract void executeWithConfig​(PluginContext context,
+                                          T config)
          +
          Executes the plugin using the deserialized configuration object.
          +
          +
          Parameters:
          +
          context - Plugin context.
          +
          config - Deserialized configuration object.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/plugins/ModelPlugin.html b/javadoc/1.47.0/software/amazon/smithy/build/plugins/ModelPlugin.html new file mode 100644 index 00000000000..f71922e46a7 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/plugins/ModelPlugin.html @@ -0,0 +1,351 @@ + + + + + +ModelPlugin (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.plugins
    +

    Class ModelPlugin

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.plugins.ModelPlugin
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      SmithyBuildPlugin
      +
      +
      +
      public final class ModelPlugin
+extends java.lang.Object
+implements SmithyBuildPlugin
      +
      Writes the projected/filtered SmithyBuild model.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        ModelPlugin() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidexecute​(PluginContext context) +
        Executes the plugin, creating any number of artifacts.
        +
        java.lang.StringgetName() +
        Gets the name of the plugin.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          ModelPlugin

          +
          public ModelPlugin()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getName

          +
          public java.lang.String getName()
          +
          Description copied from interface: SmithyBuildPlugin
          +
          Gets the name of the plugin.
          +
          +
          Specified by:
          +
          getName in interface SmithyBuildPlugin
          +
          Returns:
          +
          Returns the name (e.g., "MyPlugin").
          +
          +
          • +
        + + + +
          +
        • +

          execute

          +
          public void execute​(PluginContext context)
          +
          Description copied from interface: SmithyBuildPlugin
          +
          Executes the plugin, creating any number of artifacts.
          +
          +
          Specified by:
          +
          execute in interface SmithyBuildPlugin
          +
          Parameters:
          +
          context - Plugin context for build execution.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/plugins/NullabilityReportPlugin.html b/javadoc/1.47.0/software/amazon/smithy/build/plugins/NullabilityReportPlugin.html new file mode 100644 index 00000000000..f46ce2963bb --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/plugins/NullabilityReportPlugin.html @@ -0,0 +1,382 @@ + + + + + +NullabilityReportPlugin (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.plugins
    +

    Class NullabilityReportPlugin

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.plugins.NullabilityReportPlugin
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      SmithyBuildPlugin
      +
      +
      +
      public final class NullabilityReportPlugin
+extends java.lang.Object
+implements SmithyBuildPlugin
      +
      Generates a JSON report that contains a mapping of every structure member to + whether the member is considered nullable in v1 and v2 implementations.
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidexecute​(PluginContext context) +
        Executes the plugin, creating any number of artifacts.
        +
        java.lang.StringgetName() +
        Gets the name of the plugin.
        +
        booleanrequiresValidModel() +
        Plugins can choose whether or not to create artifacts based on whether + or not the projection encountered error or unsuppressed danger events.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          NullabilityReportPlugin

          +
          public NullabilityReportPlugin()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getName

          +
          public java.lang.String getName()
          +
          Description copied from interface: SmithyBuildPlugin
          +
          Gets the name of the plugin.
          +
          +
          Specified by:
          +
          getName in interface SmithyBuildPlugin
          +
          Returns:
          +
          Returns the name (e.g., "MyPlugin").
          +
          +
          • +
        + + + +
          +
        • +

          requiresValidModel

          +
          public boolean requiresValidModel()
          +
          Description copied from interface: SmithyBuildPlugin
          +
          Plugins can choose whether or not to create artifacts based on whether + or not the projection encountered error or unsuppressed danger events. + +

          By default plugins require that there are no errors or danger events + for a given projected model.

          +
          +
          Specified by:
          +
          requiresValidModel in interface SmithyBuildPlugin
          +
          Returns:
          +
          Returns true if the plugin should only be called if there are + no error or unsuppressed danger violations for the projection.
          +
          +
          • +
        + + + +
          +
        • +

          execute

          +
          public void execute​(PluginContext context)
          +
          Description copied from interface: SmithyBuildPlugin
          +
          Executes the plugin, creating any number of artifacts.
          +
          +
          Specified by:
          +
          execute in interface SmithyBuildPlugin
          +
          Parameters:
          +
          context - Plugin context for build execution.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/plugins/RunPlugin.Settings.html b/javadoc/1.47.0/software/amazon/smithy/build/plugins/RunPlugin.Settings.html new file mode 100644 index 00000000000..d12d5286842 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/plugins/RunPlugin.Settings.html @@ -0,0 +1,378 @@ + + + + + +RunPlugin.Settings (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.plugins
    +

    Class RunPlugin.Settings

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.plugins.RunPlugin.Settings
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      RunPlugin
      +
      +
      +
      public static final class RunPlugin.Settings
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Settings() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.util.List<java.lang.String>command() 
        voidcommand​(java.util.List<java.lang.String> command) 
        java.util.Map<java.lang.String,​java.lang.String>env() 
        voidenv​(java.util.Map<java.lang.String,​java.lang.String> env) 
        booleansendPrelude() 
        voidsendPrelude​(boolean sendPrelude) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Settings

          +
          public Settings()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          command

          +
          public java.util.List<java.lang.String> command()
          +
          • +
        + + + +
          +
        • +

          command

          +
          public void command​(java.util.List<java.lang.String> command)
          +
          • +
        + + + +
          +
        • +

          sendPrelude

          +
          public boolean sendPrelude()
          +
          • +
        + + + +
          +
        • +

          sendPrelude

          +
          public void sendPrelude​(boolean sendPrelude)
          +
          • +
        + + + +
          +
        • +

          env

          +
          public java.util.Map<java.lang.String,​java.lang.String> env()
          +
          • +
        + + + +
          +
        • +

          env

          +
          public void env​(java.util.Map<java.lang.String,​java.lang.String> env)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/plugins/RunPlugin.html b/javadoc/1.47.0/software/amazon/smithy/build/plugins/RunPlugin.html new file mode 100644 index 00000000000..d593c752b59 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/plugins/RunPlugin.html @@ -0,0 +1,404 @@ + + + + + +RunPlugin (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.plugins
    +

    Class RunPlugin

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.plugins.RunPlugin
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      SmithyBuildPlugin
      +
      +
      +
      public final class RunPlugin
+extends java.lang.Object
+implements SmithyBuildPlugin
      +
      Runs a process-based plugin.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static class RunPlugin.Settings 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        RunPlugin() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidexecute​(PluginContext context) +
        Executes the plugin, creating any number of artifacts.
        +
        java.lang.StringgetName() +
        Gets the name of the plugin.
        +
        booleanrequiresValidModel() +
        Plugins can choose whether or not to create artifacts based on whether + or not the projection encountered error or unsuppressed danger events.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          RunPlugin

          +
          public RunPlugin()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getName

          +
          public java.lang.String getName()
          +
          Description copied from interface: SmithyBuildPlugin
          +
          Gets the name of the plugin.
          +
          +
          Specified by:
          +
          getName in interface SmithyBuildPlugin
          +
          Returns:
          +
          Returns the name (e.g., "MyPlugin").
          +
          +
          • +
        + + + +
          +
        • +

          requiresValidModel

          +
          public boolean requiresValidModel()
          +
          Description copied from interface: SmithyBuildPlugin
          +
          Plugins can choose whether or not to create artifacts based on whether + or not the projection encountered error or unsuppressed danger events. + +

          By default plugins require that there are no errors or danger events + for a given projected model.

          +
          +
          Specified by:
          +
          requiresValidModel in interface SmithyBuildPlugin
          +
          Returns:
          +
          Returns true if the plugin should only be called if there are + no error or unsuppressed danger violations for the projection.
          +
          +
          • +
        + + + +
          +
        • +

          execute

          +
          public void execute​(PluginContext context)
          +
          Description copied from interface: SmithyBuildPlugin
          +
          Executes the plugin, creating any number of artifacts.
          +
          +
          Specified by:
          +
          execute in interface SmithyBuildPlugin
          +
          Parameters:
          +
          context - Plugin context for build execution.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/plugins/SourcesPlugin.html b/javadoc/1.47.0/software/amazon/smithy/build/plugins/SourcesPlugin.html new file mode 100644 index 00000000000..289910b3efc --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/plugins/SourcesPlugin.html @@ -0,0 +1,364 @@ + + + + + +SourcesPlugin (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.plugins
    +

    Class SourcesPlugin

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.plugins.SourcesPlugin
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      SmithyBuildPlugin
      +
      +
      +
      public final class SourcesPlugin
+extends java.lang.Object
+implements SmithyBuildPlugin
      +
      Copies model sources into the sources plugin. + +

      Model sources are model components that were defined in one of the + directories marked as "sources" in the original model or a model + component that is found in the updated model but not the original model. + +

      When a JAR is provided as a source, the models contained within the + JAR are extracted into the sources directory under a directory with the + same name as the JAR without the ".jar" extension; the JAR is not copied + into the sources directory. For example, given a JAR at "/foo/baz.jar" + that contains a "bar.smithy" file, a source will be created named + "baz/bar.smithy". + +

      This plugin can only run if an original model is provided.

      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        SourcesPlugin() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidexecute​(PluginContext context) +
        Executes the plugin, creating any number of artifacts.
        +
        java.lang.StringgetName() +
        Gets the name of the plugin.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          SourcesPlugin

          +
          public SourcesPlugin()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getName

          +
          public java.lang.String getName()
          +
          Description copied from interface: SmithyBuildPlugin
          +
          Gets the name of the plugin.
          +
          +
          Specified by:
          +
          getName in interface SmithyBuildPlugin
          +
          Returns:
          +
          Returns the name (e.g., "MyPlugin").
          +
          +
          • +
        + + + +
          +
        • +

          execute

          +
          public void execute​(PluginContext context)
          +
          Description copied from interface: SmithyBuildPlugin
          +
          Executes the plugin, creating any number of artifacts.
          +
          +
          Specified by:
          +
          execute in interface SmithyBuildPlugin
          +
          Parameters:
          +
          context - Plugin context for build execution.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/plugins/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/build/plugins/package-summary.html new file mode 100644 index 00000000000..efd6689702e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/plugins/package-summary.html @@ -0,0 +1,208 @@ + + + + + +software.amazon.smithy.build.plugins (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.build.plugins

    +
    +
    +
      +
    • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      BuildInfo +
      POJO to represents a smithy-build-info.json file.
      +
      BuildInfoPlugin +
      Writes a build info file for each projection.
      +
      ConfigurableSmithyBuildPlugin<T> +
      An abstract class used to more easily implement a Smithy build plugin + that expects configuration input in a specific type, T.
      +
      ModelPlugin +
      Writes the projected/filtered SmithyBuild model.
      +
      NullabilityReportPlugin +
      Generates a JSON report that contains a mapping of every structure member to + whether the member is considered nullable in v1 and v2 implementations.
      +
      RunPlugin +
      Runs a process-based plugin.
      +
      RunPlugin.Settings 
      SourcesPlugin +
      Copies model sources into the sources plugin.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/plugins/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/build/plugins/package-tree.html new file mode 100644 index 00000000000..ad6fda6fc43 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/plugins/package-tree.html @@ -0,0 +1,168 @@ + + + + + +software.amazon.smithy.build.plugins Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.build.plugins

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/processor/SmithyAnnotationProcessor.html b/javadoc/1.47.0/software/amazon/smithy/build/processor/SmithyAnnotationProcessor.html new file mode 100644 index 00000000000..5cc419707cc --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/processor/SmithyAnnotationProcessor.html @@ -0,0 +1,471 @@ + + + + + +SmithyAnnotationProcessor (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.processor
    +

    Class SmithyAnnotationProcessor<A extends java.lang.annotation.Annotation>

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • javax.annotation.processing.AbstractProcessor
        • +
      • +
          +
        • software.amazon.smithy.build.processor.SmithyAnnotationProcessor<A>
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Type Parameters:
      +
      A - Annotation to execute the processor for. This annotation should + target the PACKAGE ElementType and + should be applied in the package-info.java file of a package.
      +
      +
      +
      All Implemented Interfaces:
      +
      javax.annotation.processing.Processor
      +
      +
      +
      public abstract class SmithyAnnotationProcessor<A extends java.lang.annotation.Annotation>
+extends javax.annotation.processing.AbstractProcessor
      +
      Base implementation of a Smithy annotation processor. + +

      This implementation can be extended to create an Annotation processor for + a Smithy build plugin that generates Java code. The processor will execute + a single build plugin and write any generated Java code created + by the plugin to the correct output path. + +

      Smithy models on the classpath of extending annotation processors are automatically + discovered and any java artifacts generated by this plugin are written to standard locations. + Generated resource files are written to the class output while all other generated Java + classes are written to the source output. Plugin artifacts that are not java files or + resource files under META-INF/ are ignored. + +

      Extending classes must specify the name of the build plugin they will execute using + getPluginName(). This plugin must be discoverable on the annotation processor classpath. + The plugin is then executed using the data from the annotation as the plugin configuration. + +

      For example, if your plugin has the following configuration node in a `smithy-build.json` file: + 

      +     "myPlugin" : {
+         "packageName" = "myPackage.namespace",
+         "listOfTags" = ["a", "b", "c"]
+     }
+
      + Then you would define an annotation like the following: + 
      + {@code
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Summary

        +
          +
        • + + +

          Fields inherited from class javax.annotation.processing.AbstractProcessor

          +processingEnv
          • +
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods Concrete Methods 
        Modifier and TypeMethodDescription
        protected abstract ObjectNodecreatePluginNode​(A annotation, + java.lang.String packageName) +
        Maps annotation data to a plugin configuration node.
        +
        protected abstract java.lang.Class<A>getAnnotationClass() +
        Annotation class for the processor.
        +
        protected abstract java.lang.StringgetPluginName() +
        Name of the Smithy build plugin to execute with this annotation processor.
        +
        voidinit​(javax.annotation.processing.ProcessingEnvironment processingEnv) 
        booleanprocess​(java.util.Set<? extends javax.lang.model.element.TypeElement> annotations, + javax.annotation.processing.RoundEnvironment roundEnv) 
        +
          +
        • + + +

          Methods inherited from class javax.annotation.processing.AbstractProcessor

          +getCompletions, getSupportedAnnotationTypes, getSupportedOptions, getSupportedSourceVersion, isInitialized
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          SmithyAnnotationProcessor

          +
          public SmithyAnnotationProcessor()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          init

          +
          public void init​(javax.annotation.processing.ProcessingEnvironment processingEnv)
          +
          +
          Specified by:
          +
          init in interface javax.annotation.processing.Processor
          +
          Overrides:
          +
          init in class javax.annotation.processing.AbstractProcessor
          +
          +
          • +
        + + + +
          +
        • +

          process

          +
          public boolean process​(java.util.Set<? extends javax.lang.model.element.TypeElement> annotations,
+                       javax.annotation.processing.RoundEnvironment roundEnv)
          +
          +
          Specified by:
          +
          process in interface javax.annotation.processing.Processor
          +
          Specified by:
          +
          process in class javax.annotation.processing.AbstractProcessor
          +
          +
          • +
        + + + +
          +
        • +

          getPluginName

          +
          protected abstract java.lang.String getPluginName()
          +
          Name of the Smithy build plugin to execute with this annotation processor.
          +
          +
          Returns:
          +
          name of plugin to run.
          +
          +
          • +
        + + + +
          +
        • +

          getAnnotationClass

          +
          protected abstract java.lang.Class<A> getAnnotationClass()
          +
          Annotation class for the processor. +

          + Each implementation of SmithyProcessor should have a specific package-scoped annotation + used for configuration. createPluginNode(Annotation, String) maps this annotation to the + configuration node for the plugin specified by getPluginName().

          +
          +
          Returns:
          +
          class of the annotation used by this processor
          +
          +
          • +
        + + + + + +
          +
        • +

          createPluginNode

          +
          protected abstract ObjectNode createPluginNode​(A annotation,
+                                               java.lang.String packageName)
          +
          Maps annotation data to a plugin configuration node.
          +
          +
          Parameters:
          +
          annotation - instance of generator annotation to use to create the build config.
          +
          Returns:
          +
          ObjectNode to use as plugin configuration node.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/processor/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/build/processor/package-summary.html new file mode 100644 index 00000000000..27565472f6b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/processor/package-summary.html @@ -0,0 +1,166 @@ + + + + + +software.amazon.smithy.build.processor (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.build.processor

    +
    +
    +
      +
    • + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      SmithyAnnotationProcessor<A extends java.lang.annotation.Annotation> +
      Base implementation of a Smithy annotation processor.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/processor/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/build/processor/package-tree.html new file mode 100644 index 00000000000..100ebd4a23a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/processor/package-tree.html @@ -0,0 +1,165 @@ + + + + + +software.amazon.smithy.build.processor Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.build.processor

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    +
      +
    • java.lang.Object +
        +
      • javax.annotation.processing.AbstractProcessor (implements javax.annotation.processing.Processor) + +
        • +
      +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/Apply.Config.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/Apply.Config.html new file mode 100644 index 00000000000..dfe4273ed4a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/Apply.Config.html @@ -0,0 +1,337 @@ + + + + + +Apply.Config (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class Apply.Config

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.transforms.Apply.Config
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      Apply
      +
      +
      +
      public static final class Apply.Config
+extends java.lang.Object
      +
      apply configuration.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Config() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.util.List<java.lang.String>getProjections() +
        Gets the ordered list of projections to apply by name.
        +
        voidsetProjections​(java.util.List<java.lang.String> projections) +
        Sets the ordered list of projection names to apply.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Config

          +
          public Config()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getProjections

          +
          public java.util.List<java.lang.String> getProjections()
          +
          Gets the ordered list of projections to apply by name.
          +
          +
          Returns:
          +
          Returns the projection names to apply.
          +
          +
          • +
        + + + +
          +
        • +

          setProjections

          +
          public void setProjections​(java.util.List<java.lang.String> projections)
          +
          Sets the ordered list of projection names to apply.
          +
          +
          Parameters:
          +
          projections - Projection names to apply.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/Apply.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/Apply.html new file mode 100644 index 00000000000..c1738f608ef --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/Apply.html @@ -0,0 +1,489 @@ + + + + + +Apply (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class Apply

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Apply

          +
          public Apply()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getConfigType

          +
          public java.lang.Class<Apply.Config> getConfigType()
          +
          Description copied from class: ConfigurableProjectionTransformer
          +
          Gets the configuration class type. + +

          The referenced configType class must be a public POJO with a + public, zero-arg constructor, getters, and setters. If the POJO has a + public static fromNode method, it will be invoked and is + expected to deserialize the Node. If the POJO has a public static + builder method, it will be invoked, setters will be called + on the builder POJO, and finally the result of calling the + build method is used as the configuration type. Finally, + the deserializer will attempt to create the type and call setters on + the instantiated object that correspond to property names (either named + "set" + property name, or just property name).

          +
          +
          Specified by:
          +
          getConfigType in class ConfigurableProjectionTransformer<Apply.Config>
          +
          Returns:
          +
          Returns the configuration class (a POJO with setters/getters).
          +
          +
          • +
        + + + +
          +
        • +

          getName

          +
          public java.lang.String getName()
          +
          Description copied from interface: ProjectionTransformer
          +
          Gets the name of the transformer.
          +
          +
          Returns:
          +
          Returns the name (e.g., "traits").
          +
          +
          • +
        + + + + + + + + + + + + + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/ChangeStringEnumsToEnumShapes.Config.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ChangeStringEnumsToEnumShapes.Config.html new file mode 100644 index 00000000000..bfd97fd8bde --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ChangeStringEnumsToEnumShapes.Config.html @@ -0,0 +1,327 @@ + + + + + +ChangeStringEnumsToEnumShapes.Config (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class ChangeStringEnumsToEnumShapes.Config

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.transforms.ChangeStringEnumsToEnumShapes.Config
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      ChangeStringEnumsToEnumShapes
      +
      +
      +
      public static final class ChangeStringEnumsToEnumShapes.Config
+extends java.lang.Object
      +
      changeStringEnumsToEnumShapes configuration settings.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Config() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Config

          +
          public Config()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setSynthesizeNames

          +
          public void setSynthesizeNames​(boolean synthesizeNames)
          +
          +
          Parameters:
          +
          synthesizeNames - Whether enums without names should have names synthesized if possible.
          +
          +
          • +
        + + + +
          +
        • +

          getSynthesizeNames

          +
          public boolean getSynthesizeNames()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/ChangeStringEnumsToEnumShapes.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ChangeStringEnumsToEnumShapes.html new file mode 100644 index 00000000000..a807d35e958 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ChangeStringEnumsToEnumShapes.html @@ -0,0 +1,419 @@ + + + + + +ChangeStringEnumsToEnumShapes (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class ChangeStringEnumsToEnumShapes

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ChangeStringEnumsToEnumShapes

          +
          public ChangeStringEnumsToEnumShapes()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/ChangeTypes.Config.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ChangeTypes.Config.html new file mode 100644 index 00000000000..3b90326e8e2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ChangeTypes.Config.html @@ -0,0 +1,365 @@ + + + + + +ChangeTypes.Config (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class ChangeTypes.Config

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.transforms.ChangeTypes.Config
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      ChangeTypes
      +
      +
      +
      public static final class ChangeTypes.Config
+extends java.lang.Object
      +
      flattenNamespaces configuration settings.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Config() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Config

          +
          public Config()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setShapeTypes

          +
          public void setShapeTypes​(java.util.Map<ShapeId,​ShapeType> shapeTypes)
          +
          Sets the map of shape IDs to shape types to set.
          +
          +
          Parameters:
          +
          shapeTypes - Map of shape ID to shape type.
          +
          +
          • +
        + + + +
          +
        • +

          getShapeTypes

          +
          public java.util.Map<ShapeId,​ShapeType> getShapeTypes()
          +
          • +
        + + + +
          +
        • +

          setSynthesizeEnumNames

          +
          public void setSynthesizeEnumNames​(boolean synthesizeEnumNames)
          +
          Sets whether to synthesize names for enums that don't already have them.
          +
          +
          Parameters:
          +
          synthesizeEnumNames - Whether to synthesize enum names.
          +
          +
          • +
        + + + +
          +
        • +

          getSynthesizeEnumNames

          +
          public boolean getSynthesizeEnumNames()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/ChangeTypes.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ChangeTypes.html new file mode 100644 index 00000000000..24654dd0f89 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ChangeTypes.html @@ -0,0 +1,418 @@ + + + + + +ChangeTypes (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class ChangeTypes

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ChangeTypes

          +
          public ChangeTypes()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getConfigType

          +
          public java.lang.Class<ChangeTypes.Config> getConfigType()
          +
          Description copied from class: ConfigurableProjectionTransformer
          +
          Gets the configuration class type. + +

          The referenced configType class must be a public POJO with a + public, zero-arg constructor, getters, and setters. If the POJO has a + public static fromNode method, it will be invoked and is + expected to deserialize the Node. If the POJO has a public static + builder method, it will be invoked, setters will be called + on the builder POJO, and finally the result of calling the + build method is used as the configuration type. Finally, + the deserializer will attempt to create the type and call setters on + the instantiated object that correspond to property names (either named + "set" + property name, or just property name).

          +
          +
          Specified by:
          +
          getConfigType in class ConfigurableProjectionTransformer<ChangeTypes.Config>
          +
          Returns:
          +
          Returns the configuration class (a POJO with setters/getters).
          +
          +
          • +
        + + + +
          +
        • +

          getName

          +
          public java.lang.String getName()
          +
          Description copied from interface: ProjectionTransformer
          +
          Gets the name of the transformer.
          +
          +
          Returns:
          +
          Returns the name (e.g., "traits").
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/ConfigurableProjectionTransformer.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ConfigurableProjectionTransformer.html new file mode 100644 index 00000000000..20096291f24 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ConfigurableProjectionTransformer.html @@ -0,0 +1,457 @@ + + + + + +ConfigurableProjectionTransformer (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class ConfigurableProjectionTransformer<T>

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.transforms.ConfigurableProjectionTransformer<T>
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ConfigurableProjectionTransformer

          +
          public ConfigurableProjectionTransformer()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getConfigType

          +
          public abstract java.lang.Class<T> getConfigType()
          +
          Gets the configuration class type. + +

          The referenced configType class must be a public POJO with a + public, zero-arg constructor, getters, and setters. If the POJO has a + public static fromNode method, it will be invoked and is + expected to deserialize the Node. If the POJO has a public static + builder method, it will be invoked, setters will be called + on the builder POJO, and finally the result of calling the + build method is used as the configuration type. Finally, + the deserializer will attempt to create the type and call setters on + the instantiated object that correspond to property names (either named + "set" + property name, or just property name).

          +
          +
          Returns:
          +
          Returns the configuration class (a POJO with setters/getters).
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getAdditionalProjections

          +
          public java.util.List<java.lang.String> getAdditionalProjections​(TransformContext context)
          +
          Description copied from interface: ProjectionTransformer
          +
          Allows the composition of projections by returning additional + projections to run after the current one.
          +
          +
          Specified by:
          +
          getAdditionalProjections in interface ProjectionTransformer
          +
          Parameters:
          +
          context - Transformation context.
          +
          Returns:
          +
          a collection of named projections to run.
          +
          +
          • +
        + + + + + +
          +
        • +

          transformWithConfig

          +
          protected abstract Model transformWithConfig​(TransformContext context,
+                                             T config)
          +
          Executes the transform using the deserialized configuration object.
          +
          +
          Parameters:
          +
          context - Transform context.
          +
          config - Deserialized configuration object.
          +
          Returns:
          +
          Returns the transformed model.
          +
          +
          • +
        + + + +
          +
        • +

          getAdditionalProjectionsFunction

          +
          protected java.util.Optional<java.util.function.BiFunction<TransformContext,​T,​java.util.List<java.lang.String>>> getAdditionalProjectionsFunction()
          +
          +
          Returns:
          +
          an Optional of either a BiFunction that returns the additional + projections to run after this one, or empty to indicate this + projection will never compose other ones.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeMetadata.Config.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeMetadata.Config.html new file mode 100644 index 00000000000..201e7c82019 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeMetadata.Config.html @@ -0,0 +1,334 @@ + + + + + +ExcludeMetadata.Config (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class ExcludeMetadata.Config

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.transforms.ExcludeMetadata.Config
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      ExcludeMetadata
      +
      +
      +
      public static final class ExcludeMetadata.Config
+extends java.lang.Object
      +
      excludeMetadata configuration settings.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Config() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.util.Set<java.lang.String>getKeys() 
        voidsetKeys​(java.util.Set<java.lang.String> keys) +
        Sets the list of keys to remove from metadata.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Config

          +
          public Config()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getKeys

          +
          public java.util.Set<java.lang.String> getKeys()
          +
          +
          Returns:
          +
          the list of keys to remove from metadata.
          +
          +
          • +
        + + + +
          +
        • +

          setKeys

          +
          public void setKeys​(java.util.Set<java.lang.String> keys)
          +
          Sets the list of keys to remove from metadata.
          +
          +
          Parameters:
          +
          keys - Metadata keys to remove.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeMetadata.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeMetadata.html new file mode 100644 index 00000000000..0dc71b76e95 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeMetadata.html @@ -0,0 +1,477 @@ + + + + + +ExcludeMetadata (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class ExcludeMetadata

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeShapesBySelector.Config.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeShapesBySelector.Config.html new file mode 100644 index 00000000000..b95607efea5 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeShapesBySelector.Config.html @@ -0,0 +1,337 @@ + + + + + +ExcludeShapesBySelector.Config (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class ExcludeShapesBySelector.Config

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.transforms.ExcludeShapesBySelector.Config
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      ExcludeShapesBySelector
      +
      +
      +
      public static final class ExcludeShapesBySelector.Config
+extends java.lang.Object
      +
      excludeShapesBySelector configuration.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Config() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        SelectorgetSelector() +
        Gets the selector used to filter the shapes.
        +
        voidsetSelector​(Selector selector) +
        Sets the selector used to filter the shapes.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Config

          +
          public Config()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getSelector

          +
          public Selector getSelector()
          +
          Gets the selector used to filter the shapes.
          +
          +
          Returns:
          +
          The selector used to filter the shapes.
          +
          +
          • +
        + + + +
          +
        • +

          setSelector

          +
          public void setSelector​(Selector selector)
          +
          Sets the selector used to filter the shapes.
          +
          +
          Parameters:
          +
          selector - The selector used to filter the shapes.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeShapesBySelector.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeShapesBySelector.html new file mode 100644 index 00000000000..d7d3b914474 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeShapesBySelector.html @@ -0,0 +1,420 @@ + + + + + +ExcludeShapesBySelector (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class ExcludeShapesBySelector

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ExcludeShapesBySelector

          +
          public ExcludeShapesBySelector()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getConfigType

          +
          public java.lang.Class<ExcludeShapesBySelector.Config> getConfigType()
          +
          Description copied from class: ConfigurableProjectionTransformer
          +
          Gets the configuration class type. + +

          The referenced configType class must be a public POJO with a + public, zero-arg constructor, getters, and setters. If the POJO has a + public static fromNode method, it will be invoked and is + expected to deserialize the Node. If the POJO has a public static + builder method, it will be invoked, setters will be called + on the builder POJO, and finally the result of calling the + build method is used as the configuration type. Finally, + the deserializer will attempt to create the type and call setters on + the instantiated object that correspond to property names (either named + "set" + property name, or just property name).

          +
          +
          Specified by:
          +
          getConfigType in class ConfigurableProjectionTransformer<ExcludeShapesBySelector.Config>
          +
          Returns:
          +
          Returns the configuration class (a POJO with setters/getters).
          +
          +
          • +
        + + + +
          +
        • +

          getName

          +
          public java.lang.String getName()
          +
          Description copied from interface: ProjectionTransformer
          +
          Gets the name of the transformer.
          +
          +
          Returns:
          +
          Returns the name (e.g., "traits").
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeShapesByTag.Config.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeShapesByTag.Config.html new file mode 100644 index 00000000000..685d83e5209 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeShapesByTag.Config.html @@ -0,0 +1,337 @@ + + + + + +ExcludeShapesByTag.Config (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class ExcludeShapesByTag.Config

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.transforms.ExcludeShapesByTag.Config
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      ExcludeShapesByTag
      +
      +
      +
      public static final class ExcludeShapesByTag.Config
+extends java.lang.Object
      +
      excludeShapesByTag configuration.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Config() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.util.Set<java.lang.String>getTags() +
        Gets the set of tags that causes shapes to be removed.
        +
        voidsetTags​(java.util.Set<java.lang.String> tags) +
        Sets the set of tags that causes shapes to be removed.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Config

          +
          public Config()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getTags

          +
          public java.util.Set<java.lang.String> getTags()
          +
          Gets the set of tags that causes shapes to be removed.
          +
          +
          Returns:
          +
          Returns the removal tags.
          +
          +
          • +
        + + + +
          +
        • +

          setTags

          +
          public void setTags​(java.util.Set<java.lang.String> tags)
          +
          Sets the set of tags that causes shapes to be removed.
          +
          +
          Parameters:
          +
          tags - Tags that cause shapes to be removed.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeShapesByTag.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeShapesByTag.html new file mode 100644 index 00000000000..f6ee6aee897 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeShapesByTag.html @@ -0,0 +1,479 @@ + + + + + +ExcludeShapesByTag (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class ExcludeShapesByTag

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ProjectionTransformer
      +
      +
      +
      public final class ExcludeShapesByTag
+extends ConfigurableProjectionTransformer<T>
      +
      excludeShapesByTag removes shapes if they are tagged with one or more + of the given arguments. + +

      Prelude shapes are not removed by this transformer.

      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeShapesByTrait.Config.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeShapesByTrait.Config.html new file mode 100644 index 00000000000..7638a403535 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeShapesByTrait.Config.html @@ -0,0 +1,338 @@ + + + + + +ExcludeShapesByTrait.Config (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class ExcludeShapesByTrait.Config

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.transforms.ExcludeShapesByTrait.Config
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      ExcludeShapesByTrait
      +
      +
      +
      public static final class ExcludeShapesByTrait.Config
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Config() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.util.Set<java.lang.String>getTraits() +
        Gets the shape IDs of the traits to filter shapes by.
        +
        voidsetTraits​(java.util.Set<java.lang.String> traits) +
        Sets the shape IDs of the traits to filter shapes by.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Config

          +
          public Config()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getTraits

          +
          public java.util.Set<java.lang.String> getTraits()
          +
          Gets the shape IDs of the traits to filter shapes by. + +

          Relative shape IDs are assumed to be in the smithy.api namespace.

          +
          +
          Returns:
          +
          Returns the trait shape IDs.
          +
          +
          • +
        + + + +
          +
        • +

          setTraits

          +
          public void setTraits​(java.util.Set<java.lang.String> traits)
          +
          Sets the shape IDs of the traits to filter shapes by.
          +
          +
          Parameters:
          +
          traits - The shape IDs of the traits that if present causes a shape to be removed.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeShapesByTrait.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeShapesByTrait.html new file mode 100644 index 00000000000..e7eadd6a969 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeShapesByTrait.html @@ -0,0 +1,416 @@ + + + + + +ExcludeShapesByTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class ExcludeShapesByTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ExcludeShapesByTrait

          +
          public ExcludeShapesByTrait()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getName

          +
          public java.lang.String getName()
          +
          Description copied from interface: ProjectionTransformer
          +
          Gets the name of the transformer.
          +
          +
          Returns:
          +
          Returns the name (e.g., "traits").
          +
          +
          • +
        + + + +
          +
        • +

          getConfigType

          +
          public java.lang.Class<ExcludeShapesByTrait.Config> getConfigType()
          +
          Description copied from class: ConfigurableProjectionTransformer
          +
          Gets the configuration class type. + +

          The referenced configType class must be a public POJO with a + public, zero-arg constructor, getters, and setters. If the POJO has a + public static fromNode method, it will be invoked and is + expected to deserialize the Node. If the POJO has a public static + builder method, it will be invoked, setters will be called + on the builder POJO, and finally the result of calling the + build method is used as the configuration type. Finally, + the deserializer will attempt to create the type and call setters on + the instantiated object that correspond to property names (either named + "set" + property name, or just property name).

          +
          +
          Specified by:
          +
          getConfigType in class ConfigurableProjectionTransformer<ExcludeShapesByTrait.Config>
          +
          Returns:
          +
          Returns the configuration class (a POJO with setters/getters).
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeTags.Config.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeTags.Config.html new file mode 100644 index 00000000000..405b245483d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeTags.Config.html @@ -0,0 +1,337 @@ + + + + + +ExcludeTags.Config (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class ExcludeTags.Config

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.transforms.ExcludeTags.Config
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      ExcludeTags
      +
      +
      +
      public static final class ExcludeTags.Config
+extends java.lang.Object
      +
      excludeTags configuration.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Config() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.util.Set<java.lang.String>getTags() +
        Gets the set of tags that are removed from the model.
        +
        voidsetTags​(java.util.Set<java.lang.String> tags) +
        Sets the set of tags that are removed from the model.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Config

          +
          public Config()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getTags

          +
          public java.util.Set<java.lang.String> getTags()
          +
          Gets the set of tags that are removed from the model.
          +
          +
          Returns:
          +
          Returns the tags to remove.
          +
          +
          • +
        + + + +
          +
        • +

          setTags

          +
          public void setTags​(java.util.Set<java.lang.String> tags)
          +
          Sets the set of tags that are removed from the model.
          +
          +
          Parameters:
          +
          tags - The tags to remove from the model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeTags.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeTags.html new file mode 100644 index 00000000000..6e2263a4863 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeTags.html @@ -0,0 +1,477 @@ + + + + + +ExcludeTags (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class ExcludeTags

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeTraits.Config.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeTraits.Config.html new file mode 100644 index 00000000000..3ae9c83b30b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeTraits.Config.html @@ -0,0 +1,341 @@ + + + + + +ExcludeTraits.Config (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class ExcludeTraits.Config

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.transforms.ExcludeTraits.Config
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      ExcludeTraits
      +
      +
      +
      public static final class ExcludeTraits.Config
+extends java.lang.Object
      +
      excludeTraits configuration settings.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Config() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.util.Set<java.lang.String>getTraits() +
        Gets the list of trait shape IDs/namespaces to exclude.
        +
        voidsetTraits​(java.util.Set<java.lang.String> traits) +
        Sets the list of trait shape IDs/namespaces to exclude.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Config

          +
          public Config()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getTraits

          +
          public java.util.Set<java.lang.String> getTraits()
          +
          Gets the list of trait shape IDs/namespaces to exclude.
          +
          +
          Returns:
          +
          shape IDs to exclude.
          +
          +
          • +
        + + + +
          +
        • +

          setTraits

          +
          public void setTraits​(java.util.Set<java.lang.String> traits)
          +
          Sets the list of trait shape IDs/namespaces to exclude. + +

          Relative shape IDs are considered traits in the prelude + namespace, smithy.api. Strings ending in "#" are + used to exclude traits from an entire namespace.

          +
          +
          Parameters:
          +
          traits - Traits to exclude.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeTraits.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeTraits.html new file mode 100644 index 00000000000..d8e65fbc153 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeTraits.html @@ -0,0 +1,482 @@ + + + + + +ExcludeTraits (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class ExcludeTraits

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ProjectionTransformer
      +
      +
      +
      public final class ExcludeTraits
+extends ConfigurableProjectionTransformer<T>
      +
      excludeTraits removes trait definitions and traits from + shapes when a trait name matches any of the values given in + traits. + +

      Arguments that end with "#" exclude the traits of an entire + namespace. Trait shape IDs that are relative are assumed to be + part of the smithy.api prelude namespace.

      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeTraitsByTag.Config.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeTraitsByTag.Config.html new file mode 100644 index 00000000000..26dd16fb202 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeTraitsByTag.Config.html @@ -0,0 +1,334 @@ + + + + + +ExcludeTraitsByTag.Config (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class ExcludeTraitsByTag.Config

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.transforms.ExcludeTraitsByTag.Config
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      ExcludeTraitsByTag
      +
      +
      +
      public static final class ExcludeTraitsByTag.Config
+extends java.lang.Object
      +
      excludeTraitsByTag configuration settings.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Config() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.util.Set<java.lang.String>getTags() 
        voidsetTags​(java.util.Set<java.lang.String> tags) +
        Sets the list of tags that, if present, cause the trait to be removed.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Config

          +
          public Config()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getTags

          +
          public java.util.Set<java.lang.String> getTags()
          +
          +
          Returns:
          +
          the list of tags that, if present, cause the trait to be removed.
          +
          +
          • +
        + + + +
          +
        • +

          setTags

          +
          public void setTags​(java.util.Set<java.lang.String> tags)
          +
          Sets the list of tags that, if present, cause the trait to be removed.
          +
          +
          Parameters:
          +
          tags - Tags to set.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeTraitsByTag.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeTraitsByTag.html new file mode 100644 index 00000000000..91aa7943aa1 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/ExcludeTraitsByTag.html @@ -0,0 +1,480 @@ + + + + + +ExcludeTraitsByTag (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class ExcludeTraitsByTag

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ProjectionTransformer
      +
      +
      +
      public final class ExcludeTraitsByTag
+extends ConfigurableProjectionTransformer<T>
      +
      excludeTraitsByTag removes traits and trait definitions + from a model if the trait definition contains any of the provided + tags. + +

      This transformer will not remove prelude trait definitions.

      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/FilterSuppressions.Config.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/FilterSuppressions.Config.html new file mode 100644 index 00000000000..3ee6fcb0250 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/FilterSuppressions.Config.html @@ -0,0 +1,577 @@ + + + + + +FilterSuppressions.Config (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class FilterSuppressions.Config

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.transforms.FilterSuppressions.Config
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      FilterSuppressions
      +
      +
      +
      public static final class FilterSuppressions.Config
+extends java.lang.Object
      +
      filterSuppressions configuration settings.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Config() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.util.Set<java.lang.String>getEventIdAllowList() +
        Gets a list of allowed event IDs.
        +
        java.util.Set<java.lang.String>getEventIdDenyList() +
        Gets a list of denied event IDs.
        +
        java.util.Set<java.lang.String>getNamespaceAllowList() +
        Gets the metadata suppression namespace allow list.
        +
        java.util.Set<java.lang.String>getNamespaceDenyList() +
        Gets the metadata suppression namespace deny list.
        +
        booleangetRemoveReasons() +
        Gets whether suppression reasons are removed.
        +
        booleangetRemoveUnused() +
        Gets whether unused suppressions are removed.
        +
        voidsetEventIdAllowList​(java.util.Set<java.lang.String> eventIdAllowList) +
        Sets a list of event IDs that can be referred to in suppressions.
        +
        voidsetEventIdDenyList​(java.util.Set<java.lang.String> eventIdDenyList) +
        Sets a list of event IDs that cannot be referred to in suppressions.
        +
        voidsetNamespaceAllowList​(java.util.Set<java.lang.String> namespaceAllowList) +
        Sets a list of namespaces that can be referred to in metadata suppressions.
        +
        voidsetNamespaceDenyList​(java.util.Set<java.lang.String> namespaceDenyList) +
        Sets a list of namespaces that cannot be referred to in metadata suppressions.
        +
        voidsetRemoveReasons​(boolean removeReasons) +
        Set to true to remove the reason property from metadata suppressions.
        +
        voidsetRemoveUnused​(boolean removeUnused) +
        Set to true to remove suppressions that have no effect.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Config

          +
          public Config()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getRemoveUnused

          +
          public boolean getRemoveUnused()
          +
          Gets whether unused suppressions are removed.
          +
          +
          Returns:
          +
          Returns true if unused suppressions are removed.
          +
          +
          • +
        + + + +
          +
        • +

          setRemoveUnused

          +
          public void setRemoveUnused​(boolean removeUnused)
          +
          Set to true to remove suppressions that have no effect. + +

          If a validation event ID is never emitted, then suppress traits + will be updated to no longer refer to the ID and removed if they no longer + refer to any event. Metadata suppressions are also removed if they have no + effect.

          +
          +
          Parameters:
          +
          removeUnused - Set to true to remove unused suppressions.
          +
          +
          • +
        + + + +
          +
        • +

          getRemoveReasons

          +
          public boolean getRemoveReasons()
          +
          Gets whether suppression reasons are removed.
          +
          +
          Returns:
          +
          Returns true if suppression reasons are removed.
          +
          +
          • +
        + + + +
          +
        • +

          setRemoveReasons

          +
          public void setRemoveReasons​(boolean removeReasons)
          +
          Set to true to remove the reason property from metadata suppressions. + +

          The reason for a suppression could reveal internal or sensitive information. + Removing the "reason" from metadata suppressions is an extra step teams can + take to ensure they do not leak internal information when publishing models + outside of their organization.

          +
          +
          Parameters:
          +
          removeReasons - Set to true to remove reasons.
          +
          +
          • +
        + + + +
          +
        • +

          getEventIdAllowList

          +
          public java.util.Set<java.lang.String> getEventIdAllowList()
          +
          Gets a list of allowed event IDs.
          +
          +
          Returns:
          +
          Returns the allow list of event IDs.
          +
          +
          • +
        + + + +
          +
        • +

          setEventIdAllowList

          +
          public void setEventIdAllowList​(java.util.Set<java.lang.String> eventIdAllowList)
          +
          Sets a list of event IDs that can be referred to in suppressions. + +

          Suppressions that refer to any other event ID will be updated to + no longer refer to them, or removed if they no longer refer to any events. + +

          This setting cannot be used in tandem with eventIdDenyList.

          +
          +
          Parameters:
          +
          eventIdAllowList - IDs to allow.
          +
          +
          • +
        + + + +
          +
        • +

          getEventIdDenyList

          +
          public java.util.Set<java.lang.String> getEventIdDenyList()
          +
          Gets a list of denied event IDs.
          +
          +
          Returns:
          +
          Gets the event ID deny list.
          +
          +
          • +
        + + + +
          +
        • +

          setEventIdDenyList

          +
          public void setEventIdDenyList​(java.util.Set<java.lang.String> eventIdDenyList)
          +
          Sets a list of event IDs that cannot be referred to in suppressions. + +

          Suppressions that refer to any of these event IDs will be updated to + no longer refer to them, or removed if they no longer refer to any events. + +

          This setting cannot be used in tandem with eventIdAllowList.

          +
          +
          Parameters:
          +
          eventIdDenyList - IDs to deny.
          +
          +
          • +
        + + + +
          +
        • +

          getNamespaceAllowList

          +
          public java.util.Set<java.lang.String> getNamespaceAllowList()
          +
          Gets the metadata suppression namespace allow list.
          +
          +
          Returns:
          +
          The metadata suppression namespace allow list.
          +
          +
          • +
        + + + +
          +
        • +

          setNamespaceAllowList

          +
          public void setNamespaceAllowList​(java.util.Set<java.lang.String> namespaceAllowList)
          +
          Sets a list of namespaces that can be referred to in metadata suppressions. + +

          Metadata suppressions that refer to namespaces outside of this list, + including "*", will be removed. + +

          This setting cannot be used in tandem with namespaceDenyList.

          +
          +
          Parameters:
          +
          namespaceAllowList - Namespaces to allow.
          +
          +
          • +
        + + + +
          +
        • +

          getNamespaceDenyList

          +
          public java.util.Set<java.lang.String> getNamespaceDenyList()
          +
          Gets the metadata suppression namespace deny list.
          +
          +
          Returns:
          +
          The metadata suppression namespace deny list.
          +
          +
          • +
        + + + +
          +
        • +

          setNamespaceDenyList

          +
          public void setNamespaceDenyList​(java.util.Set<java.lang.String> namespaceDenyList)
          +
          Sets a list of namespaces that cannot be referred to in metadata suppressions. + +

          Metadata suppressions that refer to namespaces in this list, + including "*", will be removed. + +

          This setting cannot be used in tandem with namespaceAllowList.

          +
          +
          Parameters:
          +
          namespaceDenyList - Namespaces to deny.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/FilterSuppressions.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/FilterSuppressions.html new file mode 100644 index 00000000000..2fa129188c6 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/FilterSuppressions.html @@ -0,0 +1,418 @@ + + + + + +FilterSuppressions (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class FilterSuppressions

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          FilterSuppressions

          +
          public FilterSuppressions()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getConfigType

          +
          public java.lang.Class<FilterSuppressions.Config> getConfigType()
          +
          Description copied from class: ConfigurableProjectionTransformer
          +
          Gets the configuration class type. + +

          The referenced configType class must be a public POJO with a + public, zero-arg constructor, getters, and setters. If the POJO has a + public static fromNode method, it will be invoked and is + expected to deserialize the Node. If the POJO has a public static + builder method, it will be invoked, setters will be called + on the builder POJO, and finally the result of calling the + build method is used as the configuration type. Finally, + the deserializer will attempt to create the type and call setters on + the instantiated object that correspond to property names (either named + "set" + property name, or just property name).

          +
          +
          Specified by:
          +
          getConfigType in class ConfigurableProjectionTransformer<FilterSuppressions.Config>
          +
          Returns:
          +
          Returns the configuration class (a POJO with setters/getters).
          +
          +
          • +
        + + + +
          +
        • +

          getName

          +
          public java.lang.String getName()
          +
          Description copied from interface: ProjectionTransformer
          +
          Gets the name of the transformer.
          +
          +
          Returns:
          +
          Returns the name (e.g., "traits").
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/FlattenNamespaces.Config.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/FlattenNamespaces.Config.html new file mode 100644 index 00000000000..fe93cb17bdf --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/FlattenNamespaces.Config.html @@ -0,0 +1,425 @@ + + + + + +FlattenNamespaces.Config (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class FlattenNamespaces.Config

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.transforms.FlattenNamespaces.Config
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      FlattenNamespaces
      +
      +
      +
      public static final class FlattenNamespaces.Config
+extends java.lang.Object
      +
      flattenNamespaces configuration settings.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Config() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.util.Set<java.lang.String>getIncludeTagged() +
        Gets the set of tags that are retained in the model.
        +
        java.lang.StringgetNamespace() +
        Gets the target namespace that existing namespaces will be flattened + into.
        +
        ShapeIdgetService() 
        voidsetIncludeTagged​(java.util.Set<java.lang.String> tags) +
        Sets the set of tags that are retained in the model.
        +
        voidsetNamespace​(java.lang.String namespace) +
        Sets the target namespace that existing namespaces will be flattened + into.
        +
        voidsetService​(ShapeId service) +
        Sets the service ShapeId that will be flattened into the target + namespace.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Config

          +
          public Config()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setNamespace

          +
          public void setNamespace​(java.lang.String namespace)
          +
          Sets the target namespace that existing namespaces will be flattened + into.
          +
          +
          Parameters:
          +
          namespace - The target namespace to use in the model.
          +
          +
          • +
        + + + +
          +
        • +

          getNamespace

          +
          public java.lang.String getNamespace()
          +
          Gets the target namespace that existing namespaces will be flattened + into.
          +
          +
          Returns:
          +
          the target namespace to be used in the model.
          +
          +
          • +
        + + + +
          +
        • +

          setService

          +
          public void setService​(ShapeId service)
          +
          Sets the service ShapeId that will be flattened into the target + namespace.
          +
          +
          Parameters:
          +
          service - The ID of the service.
          +
          +
          • +
        + + + +
          +
        • +

          getService

          +
          public ShapeId getService()
          +
          +
          Returns:
          +
          Gets the service shape ID of the service that will have + its shape namespaces updated.
          +
          +
          • +
        + + + +
          +
        • +

          setIncludeTagged

          +
          public void setIncludeTagged​(java.util.Set<java.lang.String> tags)
          +
          Sets the set of tags that are retained in the model.
          +
          +
          Parameters:
          +
          tags - The tags to retain in the model.
          +
          +
          • +
        + + + +
          +
        • +

          getIncludeTagged

          +
          public java.util.Set<java.lang.String> getIncludeTagged()
          +
          Gets the set of tags that are retained in the model.
          +
          +
          Returns:
          +
          Returns the tags to retain.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/FlattenNamespaces.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/FlattenNamespaces.html new file mode 100644 index 00000000000..6db2b5cbf4d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/FlattenNamespaces.html @@ -0,0 +1,424 @@ + + + + + +FlattenNamespaces (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class FlattenNamespaces

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ProjectionTransformer
      +
      +
      +
      public final class FlattenNamespaces
+extends ConfigurableProjectionTransformer<FlattenNamespaces.Config>
      +
      flattenNamespaces updates a model by flattening the namespaces of + shapes connected to a service into a single, target namespace. When + configuring the transformer, a service and target namespace must be + specified. Optionally, tags can be specified for including any additional + shapes that should be flattened into the target namespace. Any shape + from outside the service closure that is included via the application of a + tag will not be included if it conflicts with a shape in the service closure.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          FlattenNamespaces

          +
          public FlattenNamespaces()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getConfigType

          +
          public java.lang.Class<FlattenNamespaces.Config> getConfigType()
          +
          Description copied from class: ConfigurableProjectionTransformer
          +
          Gets the configuration class type. + +

          The referenced configType class must be a public POJO with a + public, zero-arg constructor, getters, and setters. If the POJO has a + public static fromNode method, it will be invoked and is + expected to deserialize the Node. If the POJO has a public static + builder method, it will be invoked, setters will be called + on the builder POJO, and finally the result of calling the + build method is used as the configuration type. Finally, + the deserializer will attempt to create the type and call setters on + the instantiated object that correspond to property names (either named + "set" + property name, or just property name).

          +
          +
          Specified by:
          +
          getConfigType in class ConfigurableProjectionTransformer<FlattenNamespaces.Config>
          +
          Returns:
          +
          Returns the configuration class (a POJO with setters/getters).
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getName

          +
          public java.lang.String getName()
          +
          Description copied from interface: ProjectionTransformer
          +
          Gets the name of the transformer.
          +
          +
          Returns:
          +
          Returns the name (e.g., "traits").
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeMetadata.Config.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeMetadata.Config.html new file mode 100644 index 00000000000..e473cbbf8d5 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeMetadata.Config.html @@ -0,0 +1,334 @@ + + + + + +IncludeMetadata.Config (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class IncludeMetadata.Config

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.transforms.IncludeMetadata.Config
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      IncludeMetadata
      +
      +
      +
      public static final class IncludeMetadata.Config
+extends java.lang.Object
      +
      includeMetadata configuration settings.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Config() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.util.Set<java.lang.String>getKeys() 
        voidsetKeys​(java.util.Set<java.lang.String> keys) +
        Sets the list of keys to keep in metadata.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Config

          +
          public Config()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getKeys

          +
          public java.util.Set<java.lang.String> getKeys()
          +
          +
          Returns:
          +
          the list of keys to keep in metadata.
          +
          +
          • +
        + + + +
          +
        • +

          setKeys

          +
          public void setKeys​(java.util.Set<java.lang.String> keys)
          +
          Sets the list of keys to keep in metadata.
          +
          +
          Parameters:
          +
          keys - Metadata keys to keep.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeMetadata.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeMetadata.html new file mode 100644 index 00000000000..3c98b92042c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeMetadata.html @@ -0,0 +1,477 @@ + + + + + +IncludeMetadata (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class IncludeMetadata

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeNamespaces.Config.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeNamespaces.Config.html new file mode 100644 index 00000000000..1f789441249 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeNamespaces.Config.html @@ -0,0 +1,334 @@ + + + + + +IncludeNamespaces.Config (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class IncludeNamespaces.Config

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.transforms.IncludeNamespaces.Config
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      IncludeNamespaces
      +
      +
      +
      public static final class IncludeNamespaces.Config
+extends java.lang.Object
      +
      includeNamespaces configuration.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Config() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.util.Set<java.lang.String>getNamespaces() 
        voidsetNamespaces​(java.util.Set<java.lang.String> namespaces) +
        Sets the list of namespaces to include.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Config

          +
          public Config()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getNamespaces

          +
          public java.util.Set<java.lang.String> getNamespaces()
          +
          +
          Returns:
          +
          Gets the list of namespaces to include.
          +
          +
          • +
        + + + +
          +
        • +

          setNamespaces

          +
          public void setNamespaces​(java.util.Set<java.lang.String> namespaces)
          +
          Sets the list of namespaces to include.
          +
          +
          Parameters:
          +
          namespaces - Namespaces to include.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeNamespaces.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeNamespaces.html new file mode 100644 index 00000000000..139d0d21e1a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeNamespaces.html @@ -0,0 +1,479 @@ + + + + + +IncludeNamespaces (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class IncludeNamespaces

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ProjectionTransformer
      +
      +
      +
      public final class IncludeNamespaces
+extends ConfigurableProjectionTransformer<T>
      +
      includeNamespaces filters out shapes and trait definitions + that are not part of one of the given namespaces. + +

      Note that this does not filter out prelude shapes or namespaces.

      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeServices.Config.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeServices.Config.html new file mode 100644 index 00000000000..403875a2492 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeServices.Config.html @@ -0,0 +1,334 @@ + + + + + +IncludeServices.Config (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class IncludeServices.Config

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.transforms.IncludeServices.Config
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      IncludeServices
      +
      +
      +
      public static final class IncludeServices.Config
+extends java.lang.Object
      +
      includeServices configuration.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Config() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.util.Set<ShapeId>getServices() 
        voidsetServices​(java.util.Set<ShapeId> services) +
        Sets the list of service shapes IDs to include.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Config

          +
          public Config()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getServices

          +
          public java.util.Set<ShapeId> getServices()
          +
          +
          Returns:
          +
          Gets the list of service shapes IDs to include.
          +
          +
          • +
        + + + +
          +
        • +

          setServices

          +
          public void setServices​(java.util.Set<ShapeId> services)
          +
          Sets the list of service shapes IDs to include.
          +
          +
          Parameters:
          +
          services - Services to include by shape ID.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeServices.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeServices.html new file mode 100644 index 00000000000..7ae6fe9aab1 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeServices.html @@ -0,0 +1,478 @@ + + + + + +IncludeServices (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class IncludeServices

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ProjectionTransformer
      +
      +
      +
      public final class IncludeServices
+extends ConfigurableProjectionTransformer<T>
      +
      includeServices filters out service shapes that are not + included in the list of shape IDs contained in the + services property.
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeShapesBySelector.Config.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeShapesBySelector.Config.html new file mode 100644 index 00000000000..63dd7e59636 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeShapesBySelector.Config.html @@ -0,0 +1,337 @@ + + + + + +IncludeShapesBySelector.Config (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class IncludeShapesBySelector.Config

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.transforms.IncludeShapesBySelector.Config
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      IncludeShapesBySelector
      +
      +
      +
      public static final class IncludeShapesBySelector.Config
+extends java.lang.Object
      +
      includeShapesBySelector configuration.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Config() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        SelectorgetSelector() +
        Gets the selector used to filter the shapes.
        +
        voidsetSelector​(Selector selector) +
        Sets the selector used to filter the shapes.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Config

          +
          public Config()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getSelector

          +
          public Selector getSelector()
          +
          Gets the selector used to filter the shapes.
          +
          +
          Returns:
          +
          The selector used to filter the shapes.
          +
          +
          • +
        + + + +
          +
        • +

          setSelector

          +
          public void setSelector​(Selector selector)
          +
          Sets the selector used to filter the shapes.
          +
          +
          Parameters:
          +
          selector - The selector used to filter the shapes.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeShapesBySelector.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeShapesBySelector.html new file mode 100644 index 00000000000..c0a6d316568 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeShapesBySelector.html @@ -0,0 +1,420 @@ + + + + + +IncludeShapesBySelector (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class IncludeShapesBySelector

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          IncludeShapesBySelector

          +
          public IncludeShapesBySelector()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getConfigType

          +
          public java.lang.Class<IncludeShapesBySelector.Config> getConfigType()
          +
          Description copied from class: ConfigurableProjectionTransformer
          +
          Gets the configuration class type. + +

          The referenced configType class must be a public POJO with a + public, zero-arg constructor, getters, and setters. If the POJO has a + public static fromNode method, it will be invoked and is + expected to deserialize the Node. If the POJO has a public static + builder method, it will be invoked, setters will be called + on the builder POJO, and finally the result of calling the + build method is used as the configuration type. Finally, + the deserializer will attempt to create the type and call setters on + the instantiated object that correspond to property names (either named + "set" + property name, or just property name).

          +
          +
          Specified by:
          +
          getConfigType in class ConfigurableProjectionTransformer<IncludeShapesBySelector.Config>
          +
          Returns:
          +
          Returns the configuration class (a POJO with setters/getters).
          +
          +
          • +
        + + + +
          +
        • +

          getName

          +
          public java.lang.String getName()
          +
          Description copied from interface: ProjectionTransformer
          +
          Gets the name of the transformer.
          +
          +
          Returns:
          +
          Returns the name (e.g., "traits").
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeShapesByTag.Config.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeShapesByTag.Config.html new file mode 100644 index 00000000000..4f9bef39d64 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeShapesByTag.Config.html @@ -0,0 +1,337 @@ + + + + + +IncludeShapesByTag.Config (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class IncludeShapesByTag.Config

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.transforms.IncludeShapesByTag.Config
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      IncludeShapesByTag
      +
      +
      +
      public static final class IncludeShapesByTag.Config
+extends java.lang.Object
      +
      includeShapesByTag configuration.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Config() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.util.Set<java.lang.String>getTags() +
        Gets the set of tags that cause shapes to be included.
        +
        voidsetTags​(java.util.Set<java.lang.String> tags) +
        Sets the set of tags that cause shapes to be included.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Config

          +
          public Config()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getTags

          +
          public java.util.Set<java.lang.String> getTags()
          +
          Gets the set of tags that cause shapes to be included.
          +
          +
          Returns:
          +
          Returns the inclusion tags.
          +
          +
          • +
        + + + +
          +
        • +

          setTags

          +
          public void setTags​(java.util.Set<java.lang.String> tags)
          +
          Sets the set of tags that cause shapes to be included.
          +
          +
          Parameters:
          +
          tags - Tags that cause shapes to be included.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeShapesByTag.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeShapesByTag.html new file mode 100644 index 00000000000..961933cc3e5 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeShapesByTag.html @@ -0,0 +1,480 @@ + + + + + +IncludeShapesByTag (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class IncludeShapesByTag

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ProjectionTransformer
      +
      +
      +
      public final class IncludeShapesByTag
+extends ConfigurableProjectionTransformer<T>
      +
      includeShapesByTag removes shapes and trait definitions + that are not tagged with at least one of the tags provided + in the tags argument. + +

      Prelude shapes are not removed by this transformer.

      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeTags.Config.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeTags.Config.html new file mode 100644 index 00000000000..61769141709 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeTags.Config.html @@ -0,0 +1,337 @@ + + + + + +IncludeTags.Config (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class IncludeTags.Config

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.transforms.IncludeTags.Config
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      IncludeTags
      +
      +
      +
      public static final class IncludeTags.Config
+extends java.lang.Object
      +
      includeTags configuration.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Config() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.util.Set<java.lang.String>getTags() +
        Gets the set of tags that are retained in the model.
        +
        voidsetTags​(java.util.Set<java.lang.String> tags) +
        Sets the set of tags that are retained in the model.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Config

          +
          public Config()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getTags

          +
          public java.util.Set<java.lang.String> getTags()
          +
          Gets the set of tags that are retained in the model.
          +
          +
          Returns:
          +
          Returns the tags to retain.
          +
          +
          • +
        + + + +
          +
        • +

          setTags

          +
          public void setTags​(java.util.Set<java.lang.String> tags)
          +
          Sets the set of tags that are retained in the model.
          +
          +
          Parameters:
          +
          tags - The tags to retain in the model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeTags.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeTags.html new file mode 100644 index 00000000000..324578c63a7 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeTags.html @@ -0,0 +1,478 @@ + + + + + +IncludeTags (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class IncludeTags

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeTraits.Config.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeTraits.Config.html new file mode 100644 index 00000000000..4729fbc50ca --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeTraits.Config.html @@ -0,0 +1,341 @@ + + + + + +IncludeTraits.Config (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class IncludeTraits.Config

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.transforms.IncludeTraits.Config
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      IncludeTraits
      +
      +
      +
      public static final class IncludeTraits.Config
+extends java.lang.Object
      +
      includeTraits configuration settings.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Config() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.util.Set<java.lang.String>getTraits() +
        Gets the list of trait shape IDs to include.
        +
        voidsetTraits​(java.util.Set<java.lang.String> traits) +
        Sets the list of trait shape IDs to include.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Config

          +
          public Config()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getTraits

          +
          public java.util.Set<java.lang.String> getTraits()
          +
          Gets the list of trait shape IDs to include.
          +
          +
          Returns:
          +
          shape IDs to include.
          +
          +
          • +
        + + + +
          +
        • +

          setTraits

          +
          public void setTraits​(java.util.Set<java.lang.String> traits)
          +
          Sets the list of trait shape IDs to include. + +

          End an argument with "#" to include the traits from an entire + namespace. Trait shape IDs that are relative are assumed to be + part of the smithy.api prelude namespace.

          +
          +
          Parameters:
          +
          traits - Traits to include.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeTraits.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeTraits.html new file mode 100644 index 00000000000..55c9779c40c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeTraits.html @@ -0,0 +1,482 @@ + + + + + +IncludeTraits (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class IncludeTraits

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ProjectionTransformer
      +
      +
      +
      public final class IncludeTraits
+extends ConfigurableProjectionTransformer<T>
      +
      includeTraits removes trait definitions when a trait name + does not match one of the provided traits shape IDs. Any + instance of the trait is also removed from the model. + +

      End an argument with "#" to include the traits from an entire + namespace. Trait shape IDs that are relative are assumed to be part + of the smithy.api prelude namespace.

      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeTraitsByTag.Config.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeTraitsByTag.Config.html new file mode 100644 index 00000000000..cc12998997f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeTraitsByTag.Config.html @@ -0,0 +1,336 @@ + + + + + +IncludeTraitsByTag.Config (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class IncludeTraitsByTag.Config

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.transforms.IncludeTraitsByTag.Config
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      IncludeTraitsByTag
      +
      +
      +
      public static final class IncludeTraitsByTag.Config
+extends java.lang.Object
      +
      includeTraitsByTag configuration settings.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Config() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.util.Set<java.lang.String>getTags() 
        voidsetTags​(java.util.Set<java.lang.String> tags) +
        Sets the list of tags that must be present for a trait to be included + in the filtered model.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Config

          +
          public Config()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getTags

          +
          public java.util.Set<java.lang.String> getTags()
          +
          +
          Returns:
          +
          the list of tags that must be present for a trait to be kept.
          +
          +
          • +
        + + + +
          +
        • +

          setTags

          +
          public void setTags​(java.util.Set<java.lang.String> tags)
          +
          Sets the list of tags that must be present for a trait to be included + in the filtered model.
          +
          +
          Parameters:
          +
          tags - Tags to set.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeTraitsByTag.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeTraitsByTag.html new file mode 100644 index 00000000000..ed5750ccc8d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/IncludeTraitsByTag.html @@ -0,0 +1,479 @@ + + + + + +IncludeTraitsByTag (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class IncludeTraitsByTag

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ProjectionTransformer
      +
      +
      +
      public final class IncludeTraitsByTag
+extends ConfigurableProjectionTransformer<T>
      +
      includeTraitsByTag removes trait definitions from a model if + the definition does not contain at least one of the provided tags. + +

      This transformer does not remove prelude traits.

      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/RemoveTraitDefinitions.Config.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/RemoveTraitDefinitions.Config.html new file mode 100644 index 00000000000..c5ca7dcba0a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/RemoveTraitDefinitions.Config.html @@ -0,0 +1,342 @@ + + + + + +RemoveTraitDefinitions.Config (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class RemoveTraitDefinitions.Config

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.transforms.RemoveTraitDefinitions.Config
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      RemoveTraitDefinitions
      +
      +
      +
      public static final class RemoveTraitDefinitions.Config
+extends java.lang.Object
      +
      removeTraitShapes configuration settings.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Config() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.util.Set<java.lang.String>getExportTagged() +
        Gets the set of tags that are used to export trait definitions.
        +
        voidsetExportTagged​(java.util.Set<java.lang.String> exportByTags) +
        You can export trait definitions by applying specific tags + to the trait definition and adding the list of export tags as an + argument to the transformer.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Config

          +
          public Config()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setExportTagged

          +
          public void setExportTagged​(java.util.Set<java.lang.String> exportByTags)
          +
          You can export trait definitions by applying specific tags + to the trait definition and adding the list of export tags as an + argument to the transformer.
          +
          +
          Parameters:
          +
          exportByTags - Tags that cause trait definitions to be + exported.
          +
          +
          • +
        + + + +
          +
        • +

          getExportTagged

          +
          public java.util.Set<java.lang.String> getExportTagged()
          +
          Gets the set of tags that are used to export trait definitions.
          +
          +
          Returns:
          +
          the tags that are used to export trait definitions.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/RemoveTraitDefinitions.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/RemoveTraitDefinitions.html new file mode 100644 index 00000000000..b985431ca70 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/RemoveTraitDefinitions.html @@ -0,0 +1,422 @@ + + + + + +RemoveTraitDefinitions (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class RemoveTraitDefinitions

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          RemoveTraitDefinitions

          +
          public RemoveTraitDefinitions()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getConfigType

          +
          public java.lang.Class<RemoveTraitDefinitions.Config> getConfigType()
          +
          Description copied from class: ConfigurableProjectionTransformer
          +
          Gets the configuration class type. + +

          The referenced configType class must be a public POJO with a + public, zero-arg constructor, getters, and setters. If the POJO has a + public static fromNode method, it will be invoked and is + expected to deserialize the Node. If the POJO has a public static + builder method, it will be invoked, setters will be called + on the builder POJO, and finally the result of calling the + build method is used as the configuration type. Finally, + the deserializer will attempt to create the type and call setters on + the instantiated object that correspond to property names (either named + "set" + property name, or just property name).

          +
          +
          Specified by:
          +
          getConfigType in class ConfigurableProjectionTransformer<RemoveTraitDefinitions.Config>
          +
          Returns:
          +
          Returns the configuration class (a POJO with setters/getters).
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getName

          +
          public java.lang.String getName()
          +
          Description copied from interface: ProjectionTransformer
          +
          Gets the name of the transformer.
          +
          +
          Returns:
          +
          Returns the name (e.g., "traits").
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/RemoveUnusedShapes.Config.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/RemoveUnusedShapes.Config.html new file mode 100644 index 00000000000..4b1475ea28b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/RemoveUnusedShapes.Config.html @@ -0,0 +1,341 @@ + + + + + +RemoveUnusedShapes.Config (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class RemoveUnusedShapes.Config

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.transforms.RemoveUnusedShapes.Config
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      RemoveUnusedShapes
      +
      +
      +
      public static final class RemoveUnusedShapes.Config
+extends java.lang.Object
      +
      removeUnusedShapes configuration settings.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Config() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.util.Set<java.lang.String>getExportTagged() +
        Gets the set of tags that are used to export shapes.
        +
        voidsetExportTagged​(java.util.Set<java.lang.String> exportByTags) +
        You can export shapes that are not connected to any service + shape by applying specific tags to the shape and adding the list of + export tags as an argument to the transformer.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Config

          +
          public Config()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setExportTagged

          +
          public void setExportTagged​(java.util.Set<java.lang.String> exportByTags)
          +
          You can export shapes that are not connected to any service + shape by applying specific tags to the shape and adding the list of + export tags as an argument to the transformer.
          +
          +
          Parameters:
          +
          exportByTags - Tags that cause shapes to be exported.
          +
          +
          • +
        + + + +
          +
        • +

          getExportTagged

          +
          public java.util.Set<java.lang.String> getExportTagged()
          +
          Gets the set of tags that are used to export shapes.
          +
          +
          Returns:
          +
          the tags that are used to export shapes.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/RemoveUnusedShapes.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/RemoveUnusedShapes.html new file mode 100644 index 00000000000..ee03958c4ab --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/RemoveUnusedShapes.html @@ -0,0 +1,494 @@ + + + + + +RemoveUnusedShapes (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class RemoveUnusedShapes

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ProjectionTransformer
      +
      +
      +
      public final class RemoveUnusedShapes
+extends ConfigurableProjectionTransformer<T>
      +
      removeUnusedShapes removes shapes from the model that are not + connected to any service shape. + +

      Shapes from the prelude *are* removed if they are not referenced as + part of a model.

      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/RenameShapes.Config.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/RenameShapes.Config.html new file mode 100644 index 00000000000..655b1803549 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/RenameShapes.Config.html @@ -0,0 +1,339 @@ + + + + + +RenameShapes.Config (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class RenameShapes.Config

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.build.transforms.RenameShapes.Config
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      RenameShapes
      +
      +
      +
      public static final class RenameShapes.Config
+extends java.lang.Object
      +
      renameShapes configuration settings.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Config() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.util.Map<java.lang.String,​java.lang.String>getRenamed() +
        Gets the map of shape ids to be renamed.
        +
        voidsetRenamed​(java.util.Map<java.lang.String,​java.lang.String> renamed) +
        Sets the map of `from` shape ids to the `to` shape id values that they shapes + will be renamed to.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Config

          +
          public Config()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setRenamed

          +
          public void setRenamed​(java.util.Map<java.lang.String,​java.lang.String> renamed)
          +
          Sets the map of `from` shape ids to the `to` shape id values that they shapes + will be renamed to.
          +
          +
          Parameters:
          +
          renamed - The map of shapes to rename.
          +
          +
          • +
        + + + +
          +
        • +

          getRenamed

          +
          public java.util.Map<java.lang.String,​java.lang.String> getRenamed()
          +
          Gets the map of shape ids to be renamed.
          +
          +
          Returns:
          +
          The map of shapes to rename.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/RenameShapes.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/RenameShapes.html new file mode 100644 index 00000000000..da03cdf4a6d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/RenameShapes.html @@ -0,0 +1,422 @@ + + + + + +RenameShapes (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.build.transforms
    +

    Class RenameShapes

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ProjectionTransformer
      +
      +
      +
      public final class RenameShapes
+extends ConfigurableProjectionTransformer<RenameShapes.Config>
      +
      renameShapes updates a model by renaming shapes. When + configuring the transformer, a `renamed` property must be set as a + map with the keys as the `from` shape ids that will be renamed `to` + the shape id values. Any references to a renamed shape will also be + updated.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          RenameShapes

          +
          public RenameShapes()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getConfigType

          +
          public java.lang.Class<RenameShapes.Config> getConfigType()
          +
          Description copied from class: ConfigurableProjectionTransformer
          +
          Gets the configuration class type. + +

          The referenced configType class must be a public POJO with a + public, zero-arg constructor, getters, and setters. If the POJO has a + public static fromNode method, it will be invoked and is + expected to deserialize the Node. If the POJO has a public static + builder method, it will be invoked, setters will be called + on the builder POJO, and finally the result of calling the + build method is used as the configuration type. Finally, + the deserializer will attempt to create the type and call setters on + the instantiated object that correspond to property names (either named + "set" + property name, or just property name).

          +
          +
          Specified by:
          +
          getConfigType in class ConfigurableProjectionTransformer<RenameShapes.Config>
          +
          Returns:
          +
          Returns the configuration class (a POJO with setters/getters).
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getName

          +
          public java.lang.String getName()
          +
          Description copied from interface: ProjectionTransformer
          +
          Gets the name of the transformer.
          +
          +
          Returns:
          +
          Returns the name (e.g., "traits").
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/package-summary.html new file mode 100644 index 00000000000..d93484eb83e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/package-summary.html @@ -0,0 +1,463 @@ + + + + + +software.amazon.smithy.build.transforms (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.build.transforms

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/build/transforms/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/build/transforms/package-tree.html new file mode 100644 index 00000000000..a778d1503c9 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/build/transforms/package-tree.html @@ -0,0 +1,210 @@ + + + + + +software.amazon.smithy.build.transforms Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.build.transforms

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/cli/AnsiColorFormatter.html b/javadoc/1.47.0/software/amazon/smithy/cli/AnsiColorFormatter.html new file mode 100644 index 00000000000..fbba230624f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/cli/AnsiColorFormatter.html @@ -0,0 +1,431 @@ + + + + + +AnsiColorFormatter (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.cli
    +

    Enum AnsiColorFormatter

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Enum<AnsiColorFormatter>
        • +
      • +
          +
        • software.amazon.smithy.cli.AnsiColorFormatter
          • +
        +
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        AUTO +
        Writes using ANSI colors if it detects that the environment supports color.
        +
        FORCE_COLOR +
        Writes with ANSI colors.
        +
        NO_COLOR +
        Does not write any color.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static AnsiColorFormatterdetect() +
        Detects if ANSI colors are supported and returns the appropriate Ansi enum variant.
        +
        static AnsiColorFormattervalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static AnsiColorFormatter[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        + +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + +
          +
        • +

          NO_COLOR

          +
          public static final AnsiColorFormatter NO_COLOR
          +
          Does not write any color.
          +
          • +
        + + + +
          +
        • +

          FORCE_COLOR

          +
          public static final AnsiColorFormatter FORCE_COLOR
          +
          Writes with ANSI colors.
          +
          • +
        + + + +
          +
        • +

          AUTO

          +
          public static final AnsiColorFormatter AUTO
          +
          Writes using ANSI colors if it detects that the environment supports color.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static AnsiColorFormatter[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (AnsiColorFormatter c : AnsiColorFormatter.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static AnsiColorFormatter valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          detect

          +
          public static AnsiColorFormatter detect()
          +
          Detects if ANSI colors are supported and returns the appropriate Ansi enum variant. + +

          This method differs from using the AUTO variant directly because it will + detect any changes to the environment that might enable or disable colors.

          +
          +
          Returns:
          +
          Returns the detected ANSI color enum variant.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/cli/ArgumentReceiver.html b/javadoc/1.47.0/software/amazon/smithy/cli/ArgumentReceiver.html new file mode 100644 index 00000000000..3632ff5a41b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/cli/ArgumentReceiver.html @@ -0,0 +1,321 @@ + + + + + +ArgumentReceiver (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.cli
    +

    Interface ArgumentReceiver

    +
    +
    +
    +
      +
    • +
      +
      All Known Implementing Classes:
      +
      StandardOptions
      +
      +
      +
      public interface ArgumentReceiver
      +
      A command line argument receiver. + +

      All non-positional arguments of a Command need a + corresponding receiver to accept it through either + testOption(String) or testParameter(String). + If any receiver rejects a non-positional argument, the CLI will + exit with an error.

      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Default Methods 
        Modifier and TypeMethodDescription
        default voidregisterHelp​(HelpPrinter printer) +
        Registers help information to the given HelpPrinter.
        +
        default booleantestOption​(java.lang.String name) +
        Test if the given value-less option is accepted by the receiver.
        +
        default java.util.function.Consumer<java.lang.String>testParameter​(java.lang.String name) +
        Test if the given parameter that requires a value is accepted by the receiver.
        +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          testOption

          +
          default boolean testOption​(java.lang.String name)
          +
          Test if the given value-less option is accepted by the receiver. + +

          If the option is accepted, the receiver should store a stateful + value to indicate the option was received, and the CLI will skip + the argument for further processing.

          +
          +
          Parameters:
          +
          name - Name of the option to test.
          +
          Returns:
          +
          Returns true if accepted.
          +
          +
          • +
        + + + +
          +
        • +

          testParameter

          +
          default java.util.function.Consumer<java.lang.String> testParameter​(java.lang.String name)
          +
          Test if the given parameter that requires a value is accepted by the receiver. + +

          If the parameter is accepted, the receiver returns a Consumer that + receives the expected value, and it should store a stateful value to allow + the value to be later recalled. The CLI will skip the argument for further + processing.

          +
          +
          Parameters:
          +
          name - Name of the parameter to test.
          +
          Returns:
          +
          Returns a consumer if accepted or null if rejected.
          +
          +
          • +
        + + + +
          +
        • +

          registerHelp

          +
          default void registerHelp​(HelpPrinter printer)
          +
          Registers help information to the given HelpPrinter.
          +
          +
          Parameters:
          +
          printer - Printer to modify.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/cli/Arguments.html b/javadoc/1.47.0/software/amazon/smithy/cli/Arguments.html new file mode 100644 index 00000000000..e38e062582d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/cli/Arguments.html @@ -0,0 +1,466 @@ + + + + + +Arguments (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.cli
    +

    Interface Arguments

    +
    +
    +
    +
      +
    • +
      +
      public interface Arguments
      +
      Command line arguments list to evaluate. + +

      Arguments are parsed on demand. To finalize parsing arguments and force validation of remaining arguments, + call getPositional(). Note that because arguments are parsed on demand and whole set of arguments isn't + known before getPositional() is called.

      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Abstract Methods 
        Modifier and TypeMethodDescription
        voidaddReceiver​(ArgumentReceiver receiver) +
        Adds an argument receiver to the argument list.
        +
        java.util.List<java.lang.String>getPositional() +
        Gets the positional arguments.
        +
        <T extends ArgumentReceiver>
        T        		getReceiver​(java.lang.Class<T> type) +
        Get a receiver by class.
        +
        java.lang.Iterable<ArgumentReceiver>getReceivers() +
        Get the argument receivers registered with the Arguments list.
        +
        booleanhasNext() +
        Checks if any arguments are remaining.
        +
        booleanhasReceiver​(java.lang.Class<? extends ArgumentReceiver> receiverClass) +
        Check if this class contains a receiver.
        +
        static Argumentsof​(java.lang.String[] args) 
        java.lang.Stringpeek() +
        Peeks at the next value in the argument list without shifting it.
        +
        java.lang.Stringshift() +
        Shifts off the next value in the argument list or returns null.
        +
        java.lang.StringshiftFor​(java.lang.String parameter) +
        Expects an argument value for a parameter by name.
        +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          of

          +
          static Arguments of​(java.lang.String[] args)
          +
          • +
        + + + +
          +
        • +

          addReceiver

          +
          void addReceiver​(ArgumentReceiver receiver)
          +
          Adds an argument receiver to the argument list.
          +
          +
          Parameters:
          +
          receiver - Receiver to add.
          +
          +
          • +
        + + + +
          +
        • +

          hasReceiver

          +
          boolean hasReceiver​(java.lang.Class<? extends ArgumentReceiver> receiverClass)
          +
          Check if this class contains a receiver.
          +
          +
          Parameters:
          +
          receiverClass - Class of receiver to detect.
          +
          Returns:
          +
          Returns true if found.
          +
          +
          • +
        + + + +
          +
        • +

          getReceiver

          +
          <T extends ArgumentReceiver> T getReceiver​(java.lang.Class<T> type)
          +
          Get a receiver by class.
          +
          +
          Type Parameters:
          +
          T - Type of receiver to get.
          +
          Parameters:
          +
          type - Type of receiver to get.
          +
          Returns:
          +
          Returns the found receiver.
          +
          Throws:
          +
          java.lang.NullPointerException - if not found.
          +
          +
          • +
        + + + +
          +
        • +

          getReceivers

          +
          java.lang.Iterable<ArgumentReceiver> getReceivers()
          +
          Get the argument receivers registered with the Arguments list.
          +
          +
          Returns:
          +
          Returns the receivers.
          +
          +
          • +
        + + + +
          +
        • +

          hasNext

          +
          boolean hasNext()
          +
          Checks if any arguments are remaining.
          +
          +
          Returns:
          +
          Returns true if there are more arguments.
          +
          +
          • +
        + + + +
          +
        • +

          peek

          +
          java.lang.String peek()
          +
          Peeks at the next value in the argument list without shifting it. + +

          Note that arguments consumed by a ArgumentReceiver are never peeked.

          +
          +
          Returns:
          +
          Returns the next argument or null if no further arguments are present.
          +
          +
          • +
        + + + +
          +
        • +

          shift

          +
          java.lang.String shift()
          +
          Shifts off the next value in the argument list or returns null.
          +
          +
          Returns:
          +
          Returns the next value or null.
          +
          +
          • +
        + + + +
          +
        • +

          shiftFor

          +
          java.lang.String shiftFor​(java.lang.String parameter)
          +
          Expects an argument value for a parameter by name.
          +
          +
          Parameters:
          +
          parameter - Name of the parameter to get the value of.
          +
          Returns:
          +
          Returns the value of the parameter.
          +
          Throws:
          +
          CliError - if the parameter is not present.
          +
          +
          • +
        + + + +
          +
        • +

          getPositional

          +
          java.util.List<java.lang.String> getPositional()
          +
          Gets the positional arguments. + +

          Expects that all remaining arguments are positional, and returns them. + +

          If an argument is "--", then it's skipped and remaining arguments are considered positional. If any + argument is encountered that isn't valid for a registered Receiver, then an error is raised. Otherwise, all + remaining arguments are returned in a list. + +

          Subscribers for different receivers are called when this method is first called.

          +
          +
          Returns:
          +
          Returns remaining arguments.
          +
          Throws:
          +
          CliError - if the next argument starts with "--" but isn't "--".
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/cli/BuildParameterBuilder.ClassPathTagMatcher.html b/javadoc/1.47.0/software/amazon/smithy/cli/BuildParameterBuilder.ClassPathTagMatcher.html new file mode 100644 index 00000000000..c868a4d8a88 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/cli/BuildParameterBuilder.ClassPathTagMatcher.html @@ -0,0 +1,269 @@ + + + + + +BuildParameterBuilder.ClassPathTagMatcher (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.cli
    +

    Interface BuildParameterBuilder.ClassPathTagMatcher

    +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethodDescription
        java.util.Set<java.lang.String>findJarsWithMatchingTags​(java.util.Set<java.lang.String> classpath, + java.util.Set<java.lang.String> tagsToFind) +
        Finds all JARs that contain any of the given set of tags.
        +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          findJarsWithMatchingTags

          +
          java.util.Set<java.lang.String> findJarsWithMatchingTags​(java.util.Set<java.lang.String> classpath,
+                                                         java.util.Set<java.lang.String> tagsToFind)
          +
          Finds all JARs that contain any of the given set of tags.
          +
          +
          Parameters:
          +
          classpath - Set of paths to JARs to search.
          +
          tagsToFind - Tags to search for in the classpath.
          +
          Returns:
          +
          Returns the matching JARs in the classpath.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/cli/BuildParameterBuilder.JarFileClassPathTagMatcher.html b/javadoc/1.47.0/software/amazon/smithy/cli/BuildParameterBuilder.JarFileClassPathTagMatcher.html new file mode 100644 index 00000000000..bbc82089a70 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/cli/BuildParameterBuilder.JarFileClassPathTagMatcher.html @@ -0,0 +1,330 @@ + + + + + +BuildParameterBuilder.JarFileClassPathTagMatcher (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.cli
    +

    Class BuildParameterBuilder.JarFileClassPathTagMatcher

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.cli.BuildParameterBuilder.JarFileClassPathTagMatcher
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.util.Set<java.lang.String>findJarsWithMatchingTags​(java.util.Set<java.lang.String> classpath, + java.util.Set<java.lang.String> tagsToFind) +
        Finds all JARs that contain any of the given set of tags.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          JarFileClassPathTagMatcher

          +
          public JarFileClassPathTagMatcher()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          findJarsWithMatchingTags

          +
          public java.util.Set<java.lang.String> findJarsWithMatchingTags​(java.util.Set<java.lang.String> classpath,
+                                                                java.util.Set<java.lang.String> tagsToFind)
          +
          Description copied from interface: BuildParameterBuilder.ClassPathTagMatcher
          +
          Finds all JARs that contain any of the given set of tags.
          +
          +
          Specified by:
          +
          findJarsWithMatchingTags in interface BuildParameterBuilder.ClassPathTagMatcher
          +
          Parameters:
          +
          classpath - Set of paths to JARs to search.
          +
          tagsToFind - Tags to search for in the classpath.
          +
          Returns:
          +
          Returns the matching JARs in the classpath.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/cli/BuildParameterBuilder.Result.html b/javadoc/1.47.0/software/amazon/smithy/cli/BuildParameterBuilder.Result.html new file mode 100644 index 00000000000..d2da01831e6 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/cli/BuildParameterBuilder.Result.html @@ -0,0 +1,337 @@ + + + + + +BuildParameterBuilder.Result (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.cli
    +

    Class BuildParameterBuilder.Result

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.cli.BuildParameterBuilder.Result
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      BuildParameterBuilder
      +
      +
      +
      public static final class BuildParameterBuilder.Result
+extends java.lang.Object
      +
      Result class used to build source and projection JARs.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        java.util.List<java.lang.String>args +
        Smithy Build command line arguments.
        +
        java.lang.Stringclasspath +
        Smithy build classpath string.
        +
        java.lang.StringdiscoveryClasspath +
        Smithy build discovery classpath string.
        +
        java.util.Set<java.lang.String>sources +
        The set of source models, including computed sources used in the argument list.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Field Detail

        + + + +
          +
        • +

          args

          +
          public final java.util.List<java.lang.String> args
          +
          Smithy Build command line arguments. + +

          This value can be explicitly mutated as needed.

          +
          • +
        + + + +
          +
        • +

          sources

          +
          public final java.util.Set<java.lang.String> sources
          +
          The set of source models, including computed sources used in the argument list. + +

          This value can be explicitly mutated as needed.

          +
          • +
        + + + +
          +
        • +

          classpath

          +
          public final java.lang.String classpath
          +
          Smithy build classpath string. + +

          This is the classpath that should be used when invoking the CLI. + The value is a colon (:) separate string.

          +
          • +
        + + + +
          +
        • +

          discoveryClasspath

          +
          public final java.lang.String discoveryClasspath
          +
          Smithy build discovery classpath string. + +

          This is the classpath that is also specified in the arguments list and + is used for model discovery. The value is a colon (:) separate string.

          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/cli/BuildParameterBuilder.html b/javadoc/1.47.0/software/amazon/smithy/cli/BuildParameterBuilder.html new file mode 100644 index 00000000000..ab6822f2633 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/cli/BuildParameterBuilder.html @@ -0,0 +1,762 @@ + + + + + +BuildParameterBuilder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.cli
    +

    Class BuildParameterBuilder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.cli.BuildParameterBuilder
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class BuildParameterBuilder
+extends java.lang.Object
      +
      This builder can be used to build up a Smithy CLI command to + run `smithy build`. + +

      This builder will take into account the "lib" and "build" classpaths + that points to JAR files when determining which JARs are added as sources + and which JARs are added as part of model discovery. This is determined + based on the value provided for projectionSource. + +

      If projectionSource is not set or set to "source", then classes + will be loaded using the lib and build classpath. However, models are + discovered only using the lib classpath, ensuring that consumers of the + generated JAR can find the required models using only the declared + dependencies of this package. + +

      If projectionSource is not set to something other than + "source", then we build the model and discover models using only the build + classpath. This provides a layer of isolation between the sources that + created a projection from the downstream consumers of the projected model. + projectionSourceTags can be provided to find JARs in the build + classpath that have a META-INF/MANIFEST.MF "Smithy-Tags" value that matches + one or more of the provided tags. This is used to select which models from + your dependencies should be considered "sources" so that they show up in + the JAR you're projecting.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          BuildParameterBuilder

          +
          public BuildParameterBuilder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          projectionSource

          +
          public BuildParameterBuilder projectionSource​(java.lang.String projectionSource)
          +
          Sets the name of the projection being built as a source. + +

          This means that the given projection is used to populate + a build artifact (for example, a JAR being built by Gradle).

          +
          +
          Parameters:
          +
          projectionSource - Projection name.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          sources

          +
          public BuildParameterBuilder sources​(java.util.Collection<java.lang.String> sources)
          +
          Adds a collection of "source" model files.
          +
          +
          Parameters:
          +
          sources - Sources to add.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          addSourcesIfExists

          +
          public BuildParameterBuilder addSourcesIfExists​(java.util.Collection<java.lang.String> sources)
          +
          Adds a collection of "source" model files only if they exist.
          +
          +
          Parameters:
          +
          sources - Sources to add.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          buildClasspath

          +
          public BuildParameterBuilder buildClasspath​(java.lang.String buildClasspath)
          +
          Sets the build classpath.
          +
          +
          Parameters:
          +
          buildClasspath - Classpath to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          libClasspath

          +
          public BuildParameterBuilder libClasspath​(java.lang.String libClasspath)
          +
          Sets the lib classpath.
          +
          +
          Parameters:
          +
          libClasspath - Classpath to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          projectionSourceTags

          +
          public BuildParameterBuilder projectionSourceTags​(java.lang.String projectionSourceTags)
          +
          Sets the tags to find in the build classpath when projecting a JAR. + +

          Tags can only be provided if projectionSource has been set to + something other than "source".

          +
          +
          Parameters:
          +
          projectionSourceTags - Comma separated list of projection tags.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          projectionSourceTags

          +
          public BuildParameterBuilder projectionSourceTags​(java.util.Collection<java.lang.String> projectionSourceTags)
          +
          Sets the tags to find in the build classpath when projecting a JAR. + +

          Tags can only be provided if projectionSource has been set to + something other than "source".

          +
          +
          Parameters:
          +
          projectionSourceTags - Projection tags.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          tagMatcher

          +
          public BuildParameterBuilder tagMatcher​(BuildParameterBuilder.ClassPathTagMatcher tagMatcher)
          +
          Sets the implementation used to find JARs with the given tags. + +

          A default implementation that loads JARs is automatically used if + an explicit implementation is not specified. You probably only need + to provide a custom implementation for testing.

          +
          +
          Parameters:
          +
          tagMatcher - Tag matching implementation.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          addConfig

          +
          public BuildParameterBuilder addConfig​(java.lang.String pathToConfig)
          +
          Adds a configuration file to the builder.
          +
          +
          Parameters:
          +
          pathToConfig - Path to the configuration file.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          addConfigIfExists

          +
          public BuildParameterBuilder addConfigIfExists​(java.lang.String pathToConfig)
          +
          Adds a configuration file to the builder only if it exists. + +

          This method is ignored if the file is null, empty, or does + not exist.

          +
          +
          Parameters:
          +
          pathToConfig - Path to the configuration file.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          output

          +
          public BuildParameterBuilder output​(java.lang.String output)
          +
          Sets the optional output directory.
          +
          +
          Parameters:
          +
          output - Optional output directory to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          projection

          +
          public BuildParameterBuilder projection​(java.lang.String projection)
          +
          Ensures that only the given projection is built. All other + projections are skipped. + +

          This is not the same as calling projectionSource.

          +
          +
          Parameters:
          +
          projection - Projection to build, excluding others.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          plugin

          +
          public BuildParameterBuilder plugin​(java.lang.String plugin)
          +
          Ensures that only the given plugin is built in each projection. + All other plugins are skipped.
          +
          +
          Parameters:
          +
          plugin - Plugin to build, excluding others.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          discover

          +
          public BuildParameterBuilder discover​(boolean discover)
          +
          Enables model discovery.
          +
          +
          Parameters:
          +
          discover - Set to true to enable model discovery.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          allowUnknownTraits

          +
          public BuildParameterBuilder allowUnknownTraits​(boolean allowUnknownTraits)
          +
          Ignores unknown traits when building models.
          +
          +
          Parameters:
          +
          allowUnknownTraits - Set to true to allow unknown traits.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          addExtraArgs

          +
          public BuildParameterBuilder addExtraArgs​(java.lang.String... args)
          +
          Adds extra arguments to the CLI arguments before positional arguments.
          +
          +
          Parameters:
          +
          args - Arguments to add.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          build

          +
          public BuildParameterBuilder.Result build()
          +
          Computes the result object that is used when running smithy build.
          +
          +
          Returns:
          +
          Returns the computed result.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/cli/Cli.html b/javadoc/1.47.0/software/amazon/smithy/cli/Cli.html new file mode 100644 index 00000000000..8d1f389ccfd --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/cli/Cli.html @@ -0,0 +1,374 @@ + + + + + +Cli (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.cli
    +

    Class Cli

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.cli.Cli
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class Cli
+extends java.lang.Object
      +
      This class provides a basic CLI abstraction. + +

      Why are we not using a library for this? Because parsing command line + options isn't difficult, we don't need to take a dependency, this code + uses no reflection to improve startup time. We can control exactly what + CLI features are supported in case we want to migrate to a library or + event a different language.

      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Cli​(Command command, + java.lang.ClassLoader classLoader) +
        Creates a new CLI with the given name.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidcolorFormatter​(ColorFormatter colorFormatter) 
        intrun​(java.lang.String[] args) +
        Execute the command line using the given arguments.
        +
        voidstderr​(CliPrinter stderrPrinter) 
        voidstdout​(CliPrinter stdoutPrinter) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Cli

          +
          public Cli​(Command command,
+           java.lang.ClassLoader classLoader)
          +
          Creates a new CLI with the given name.
          +
          +
          Parameters:
          +
          command - CLI command to run.
          +
          classLoader - ClassLoader to use when invoking commands.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          run

          +
          public int run​(java.lang.String[] args)
          +
          Execute the command line using the given arguments.
          +
          +
          Parameters:
          +
          args - Arguments to parse.
          +
          Returns:
          +
          Returns the exit code.
          +
          Throws:
          +
          CliError - on error.
          +
          +
          • +
        + + + +
          +
        • +

          colorFormatter

          +
          public void colorFormatter​(ColorFormatter colorFormatter)
          +
          • +
        + + + +
          +
        • +

          stdout

          +
          public void stdout​(CliPrinter stdoutPrinter)
          +
          • +
        + + + +
          +
        • +

          stderr

          +
          public void stderr​(CliPrinter stderrPrinter)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/cli/CliError.html b/javadoc/1.47.0/software/amazon/smithy/cli/CliError.html new file mode 100644 index 00000000000..e548def8b1c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/cli/CliError.html @@ -0,0 +1,438 @@ + + + + + +CliError (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.cli
    +

    Class CliError

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Throwable
        • +
      • +
          +
        • java.lang.Exception
          • +
        • +
            +
          • java.lang.RuntimeException
            • +
          • +
              +
            • software.amazon.smithy.cli.CliError
              • +
            +
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      public final class CliError
+extends java.lang.RuntimeException
      +
      Throw this exception to cause the CLI to exit with a message and code.
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        intcode 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        CliError​(java.lang.String message) +
        Exits the CLI with a message and an error code of 1.
        +
        CliError​(java.lang.String message, + int code) 
        CliError​(java.lang.String message, + int code, + java.lang.Throwable previous) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static CliErrorwrap​(java.lang.Throwable e) +
        Wraps the given exception in a CliError (no wrapping is performed + if the given exception is an instance of CliError).
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          code

          +
          public final int code
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CliError

          +
          public CliError​(java.lang.String message)
          +
          Exits the CLI with a message and an error code of 1.
          +
          +
          Parameters:
          +
          message - Message to output.
          +
          +
          • +
        + + + +
          +
        • +

          CliError

          +
          public CliError​(java.lang.String message,
+                int code)
          +
          +
          Parameters:
          +
          message - Message to use in the exception.
          +
          code - Exit code to set.
          +
          +
          • +
        + + + +
          +
        • +

          CliError

          +
          public CliError​(java.lang.String message,
+                int code,
+                java.lang.Throwable previous)
          +
          +
          Parameters:
          +
          message - Message to use in the exception.
          +
          code - Exit code to set.
          +
          previous - Previous exception.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          wrap

          +
          public static CliError wrap​(java.lang.Throwable e)
          +
          Wraps the given exception in a CliError (no wrapping is performed + if the given exception is an instance of CliError).
          +
          +
          Parameters:
          +
          e - Exception to wrap.
          +
          Returns:
          +
          Returns the wrapped exception.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/cli/CliPrinter.html b/javadoc/1.47.0/software/amazon/smithy/cli/CliPrinter.html new file mode 100644 index 00000000000..3576fb9a651 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/cli/CliPrinter.html @@ -0,0 +1,363 @@ + + + + + +CliPrinter (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.cli
    +

    Interface CliPrinter

    +
    +
    +
    +
      +
    • +
      +
      All Superinterfaces:
      +
      java.lang.Appendable, java.io.Flushable
      +
      +
      +
      public interface CliPrinter
+extends java.lang.Appendable, java.io.Flushable
      +
      Handles text output of the CLI.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          append

          +
          CliPrinter append​(char c)
          +
          +
          Specified by:
          +
          append in interface java.lang.Appendable
          +
          +
          • +
        + + + +
          +
        • +

          append

          +
          default CliPrinter append​(java.lang.CharSequence csq)
          +
          +
          Specified by:
          +
          append in interface java.lang.Appendable
          +
          +
          • +
        + + + +
          +
        • +

          append

          +
          CliPrinter append​(java.lang.CharSequence csq,
+                  int start,
+                  int end)
          +
          +
          Specified by:
          +
          append in interface java.lang.Appendable
          +
          +
          • +
        + + + +
          +
        • +

          println

          +
          default CliPrinter println​(java.lang.String text)
          +
          Prints text to the writer and appends a new line.
          +
          +
          Parameters:
          +
          text - Text to print.
          +
          +
          • +
        + + + +
          +
        • +

          flush

          +
          default void flush()
          +
          Flushes any buffers in the printer.
          +
          +
          Specified by:
          +
          flush in interface java.io.Flushable
          +
          +
          • +
        + + + +
          +
        • +

          fromOutputStream

          +
          static CliPrinter fromOutputStream​(java.io.OutputStream stream)
          +
          Create a new CliPrinter from an OutputStream.
          +
          +
          Parameters:
          +
          stream - OutputStream to write to.
          +
          Returns:
          +
          Returns the created CliPrinter.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/cli/ColorBuffer.html b/javadoc/1.47.0/software/amazon/smithy/cli/ColorBuffer.html new file mode 100644 index 00000000000..46ab1c8a513 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/cli/ColorBuffer.html @@ -0,0 +1,502 @@ + + + + + +ColorBuffer (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.cli
    +

    Class ColorBuffer

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.cli.ColorBuffer
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.lang.Appendable, java.lang.AutoCloseable
      +
      +
      +
      public final class ColorBuffer
+extends java.lang.Object
+implements java.lang.Appendable, java.lang.AutoCloseable
      +
      An Appendable that supports color provided by a ColorFormatter. + +

      A ColorBuffer is not thread-safe and is meant to write short contiguous output text that will + eventually be written to other things like a CliPrinter. + +

      When wrapping a CliPrinter, ensure you use close() to write to the printer. Alternatively, + wrap the buffer in a try-with-resources block.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          of

          +
          public static ColorBuffer of​(ColorFormatter colors,
+                             java.lang.Appendable sink)
          +
          Create a new ColorBuffer that directly writes to the given sink. + +

          No additional buffering is used when buffering over an Appendable. Each call to write to the + buffer will write to the appendable.

          +
          +
          Parameters:
          +
          colors - ColorFormatter used to provide colors and style.
          +
          sink - Where to write.
          +
          Returns:
          +
          Returns the created buffer.
          +
          +
          • +
        + + + +
          +
        • +

          of

          +
          public static ColorBuffer of​(ColorFormatter colors,
+                             CliPrinter sink)
          +
          Create a new ColorBuffer that stores all output to an internal buffer and only writes to the given + CliPrinter when close() is called.
          +
          +
          Parameters:
          +
          colors - ColorFormatter used to provide colors and style.
          +
          sink - Where to write.
          +
          Returns:
          +
          Returns the created buffer.
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          append

          +
          public ColorBuffer append​(java.lang.CharSequence csq)
          +
          +
          Specified by:
          +
          append in interface java.lang.Appendable
          +
          +
          • +
        + + + +
          +
        • +

          append

          +
          public ColorBuffer append​(java.lang.CharSequence csq,
+                          int start,
+                          int end)
          +
          +
          Specified by:
          +
          append in interface java.lang.Appendable
          +
          +
          • +
        + + + +
          +
        • +

          append

          +
          public ColorBuffer append​(char c)
          +
          +
          Specified by:
          +
          append in interface java.lang.Appendable
          +
          +
          • +
        + + + +
          +
        • +

          print

          +
          public ColorBuffer print​(java.lang.String text,
+                         Style... styles)
          +
          Writes styled text to the builder using the CliPrinter's color settings.
          +
          +
          Parameters:
          +
          text - Text to write.
          +
          styles - Styles to apply to the text.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          println

          +
          public ColorBuffer println​(java.lang.String text,
+                           Style... styles)
          +
          Prints a line of styled text to the buffer.
          +
          +
          Parameters:
          +
          text - Text to print.
          +
          styles - Styles to apply.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          println

          +
          public ColorBuffer println()
          +
          Writes a system-dependent new line.
          +
          +
          Returns:
          +
          Returns the buffer.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          close

          +
          public void close()
          +
          +
          Specified by:
          +
          close in interface java.lang.AutoCloseable
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/cli/ColorFormatter.html b/javadoc/1.47.0/software/amazon/smithy/cli/ColorFormatter.html new file mode 100644 index 00000000000..4a077f5296c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/cli/ColorFormatter.html @@ -0,0 +1,371 @@ + + + + + +ColorFormatter (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.cli
    +

    Interface ColorFormatter

    +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods Default Methods 
        Modifier and TypeMethodDescription
        voidendStyle​(java.lang.Appendable appendable) 
        booleanisColorEnabled() 
        default voidprintln​(java.lang.Appendable appendable, + java.lang.String text, + Style... styles) +
        Print a styled line of text to the given appendable.
        +
        voidstartStyle​(java.lang.Appendable appendable, + Style... style) 
        default voidstyle​(java.lang.Appendable appendable, + java.lang.String text, + Style... styles) +
        Styles text using the given styles and writes it to an Appendable.
        +
        default java.lang.Stringstyle​(java.lang.String text, + Style... styles) +
        Styles text using the given styles.
        +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          style

          +
          default java.lang.String style​(java.lang.String text,
+                               Style... styles)
          +
          Styles text using the given styles.
          +
          +
          Parameters:
          +
          text - Text to style.
          +
          styles - Styles to apply.
          +
          Returns:
          +
          Returns the styled text.
          +
          +
          • +
        + + + +
          +
        • +

          style

          +
          default void style​(java.lang.Appendable appendable,
+                   java.lang.String text,
+                   Style... styles)
          +
          Styles text using the given styles and writes it to an Appendable.
          +
          +
          Parameters:
          +
          appendable - Where to write styled text.
          +
          text - Text to write.
          +
          styles - Styles to apply.
          +
          +
          • +
        + + + +
          +
        • +

          println

          +
          default void println​(java.lang.Appendable appendable,
+                     java.lang.String text,
+                     Style... styles)
          +
          Print a styled line of text to the given appendable.
          +
          +
          Parameters:
          +
          appendable - Where to write.
          +
          text - Text to write.
          +
          styles - Styles to apply.
          +
          +
          • +
        + + + +
          +
        • +

          isColorEnabled

          +
          boolean isColorEnabled()
          +
          +
          Returns:
          +
          Returns true if this formatter supports color output.
          +
          +
          • +
        + + + +
          +
        • +

          startStyle

          +
          void startStyle​(java.lang.Appendable appendable,
+                Style... style)
          +
          • +
        + + + +
          +
        • +

          endStyle

          +
          void endStyle​(java.lang.Appendable appendable)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/cli/ColorTheme.html b/javadoc/1.47.0/software/amazon/smithy/cli/ColorTheme.html new file mode 100644 index 00000000000..5dcac729a81 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/cli/ColorTheme.html @@ -0,0 +1,549 @@ + + + + + +ColorTheme (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.cli
    +

    Class ColorTheme

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.cli.ColorTheme
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class ColorTheme
+extends java.lang.Object
      +
      Standardizes on colors across commands.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          EM_UNDERLINE

          +
          public static final Style EM_UNDERLINE
          +
          • +
        + + + +
          +
        • +

          DEPRECATED

          +
          public static final Style DEPRECATED
          +
          • +
        + + + +
          +
        • +

          MUTED

          +
          public static final Style MUTED
          +
          • +
        + + + +
          +
        • +

          EVENT_SHAPE_ID

          +
          public static final Style EVENT_SHAPE_ID
          +
          • +
        + + + +
          +
        • +

          LITERAL

          +
          public static final Style LITERAL
          +
          • +
        + + + +
          +
        • +

          ERROR_TITLE

          +
          public static final Style ERROR_TITLE
          +
          • +
        + + + +
          +
        • +

          ERROR

          +
          public static final Style ERROR
          +
          • +
        + + + +
          +
        • +

          DANGER_TITLE

          +
          public static final Style DANGER_TITLE
          +
          • +
        + + + +
          +
        • +

          DANGER

          +
          public static final Style DANGER
          +
          • +
        + + + +
          +
        • +

          WARNING_TITLE

          +
          public static final Style WARNING_TITLE
          +
          • +
        + + + +
          +
        • +

          WARNING

          +
          public static final Style WARNING
          +
          • +
        + + + +
          +
        • +

          NOTE_TITLE

          +
          public static final Style NOTE_TITLE
          +
          • +
        + + + +
          +
        • +

          NOTE

          +
          public static final Style NOTE
          +
          • +
        + + + +
          +
        • +

          SUPPRESSED_TITLE

          +
          public static final Style SUPPRESSED_TITLE
          +
          • +
        + + + +
          +
        • +

          SUPPRESSED

          +
          public static final Style SUPPRESSED
          +
          • +
        + + + +
          +
        • +

          SUCCESS

          +
          public static final Style SUCCESS
          +
          • +
        + + + +
          +
        • +

          DIFF_TITLE

          +
          public static final Style DIFF_TITLE
          +
          • +
        + + + +
          +
        • +

          DIFF_EVENT_TITLE

          +
          public static final Style DIFF_EVENT_TITLE
          +
          • +
        + + + +
          +
        • +

          HINT_TITLE

          +
          public static final Style HINT_TITLE
          +
          • +
        + + + +
          +
        • +

          TEMPLATE_TITLE

          +
          public static final Style TEMPLATE_TITLE
          +
          • +
        + + + +
          +
        • +

          TEMPLATE_LIST_BORDER

          +
          public static final Style TEMPLATE_LIST_BORDER
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/cli/Command.Env.html b/javadoc/1.47.0/software/amazon/smithy/cli/Command.Env.html new file mode 100644 index 00000000000..ba7065ab6db --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/cli/Command.Env.html @@ -0,0 +1,385 @@ + + + + + +Command.Env (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.cli
    +

    Class Command.Env

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.cli.Command.Env
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing interface:
      +
      Command
      +
      +
      +
      public static final class Command.Env
+extends java.lang.Object
      +
      Environment settings for the command.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + + + + + +
          +
        • +

          classLoader

          +
          public java.lang.ClassLoader classLoader()
          +
          • +
        + + + +
          +
        • +

          flush

          +
          public void flush()
          +
          • +
        + + + +
          +
        • +

          withClassLoader

          +
          public Command.Env withClassLoader​(java.lang.ClassLoader classLoader)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/cli/Command.html b/javadoc/1.47.0/software/amazon/smithy/cli/Command.html new file mode 100644 index 00000000000..1d7c5b260df --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/cli/Command.html @@ -0,0 +1,355 @@ + + + + + +Command (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.cli
    +

    Interface Command

    +
    +
    +
    +
      +
    • +
      +
      All Known Implementing Classes:
      +
      SmithyCommand
      +
      +
      +
      public interface Command
      +
      Represents a CLI command.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeInterfaceDescription
        static class Command.Env +
        Environment settings for the command.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods Default Methods 
        Modifier and TypeMethodDescription
        intexecute​(Arguments arguments, + Command.Env env) +
        Executes the command using the provided arguments.
        +
        java.lang.StringgetName() +
        Gets the name of the command.
        +
        java.lang.StringgetSummary() +
        Gets a short summary of the command that's shown in the main help.
        +
        default booleanisHidden() +
        Return true to hide this command from help output.
        +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getName

          +
          java.lang.String getName()
          +
          Gets the name of the command. + +

          The returned name should contain no spaces or special characters.

          +
          +
          Returns:
          +
          Returns the command name.
          +
          +
          • +
        + + + +
          +
        • +

          isHidden

          +
          default boolean isHidden()
          +
          Return true to hide this command from help output.
          +
          +
          Returns:
          +
          Return true if this is a hidden command.
          +
          +
          • +
        + + + +
          +
        • +

          getSummary

          +
          java.lang.String getSummary()
          +
          Gets a short summary of the command that's shown in the main help.
          +
          +
          Returns:
          +
          Returns the short help description.
          +
          +
          • +
        + + + +
          +
        • +

          execute

          +
          int execute​(Arguments arguments,
+            Command.Env env)
          +
          Executes the command using the provided arguments.
          +
          +
          Parameters:
          +
          arguments - CLI arguments.
          +
          env - CLI environment settings like stdout, stderr, etc.
          +
          Returns:
          +
          Returns the exit code.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/cli/EnvironmentVariable.html b/javadoc/1.47.0/software/amazon/smithy/cli/EnvironmentVariable.html new file mode 100644 index 00000000000..43d00d4af38 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/cli/EnvironmentVariable.html @@ -0,0 +1,638 @@ + + + + + +EnvironmentVariable (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.cli
    +

    Enum EnvironmentVariable

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Enum<EnvironmentVariable>
        • +
      • +
          +
        • software.amazon.smithy.cli.EnvironmentVariable
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable, java.lang.Comparable<EnvironmentVariable>
      +
      +
      +
      public enum EnvironmentVariable
+extends java.lang.Enum<EnvironmentVariable>
      +
      Environment variables used by the Smithy CLI.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        FORCE_COLOR +
        If set to any value, force enables the support of ANSI colors in the output.
        +
        NO_COLOR +
        If set to any value, disable ANSI colors in the output.
        +
        SMITHY_DEPENDENCY_MODE +
        Configures if and how the Smithy CLI handles dependencies declared in smithy-build.json files.
        +
        SMITHY_MAVEN_CACHE +
        A custom location for the Maven local repository cache.
        +
        SMITHY_MAVEN_REPOS +
        A pipe-delimited list of Maven repositories to use.
        +
        SMITHY_PROXY_CREDENTIALS +
        Used to determine a proxy credentials to use for Maven dependency resolution through + a proxy.
        +
        SMITHY_PROXY_HOST +
        Used to determine a proxy host to use for Maven dependency resolution.
        +
        SMITHY_VERSION +
        The current version of the CLI.
        +
        TERM +
        Used to detect if ANSI colors are supported.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidclear() +
        Clears the system property for the variable.
        +
        java.lang.Stringget() +
        Gets the system property or the environment variable for the property, in that order.
        +
        static java.lang.StringgetByName​(java.lang.String name) +
        Gets a system property or environment variable by name, in that order.
        +
        booleanisSet() +
        Returns true if the system property or environment variables is set.
        +
        voidset​(java.lang.String value) +
        Sets a system property for the environment variable.
        +
        static EnvironmentVariablevalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static EnvironmentVariable[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + +
          +
        • +

          SMITHY_MAVEN_CACHE

          +
          public static final EnvironmentVariable SMITHY_MAVEN_CACHE
          +
          A custom location for the Maven local repository cache. + +

          Example: ~/.m2/repository

          +
          • +
        + + + +
          +
        • +

          SMITHY_MAVEN_REPOS

          +
          public static final EnvironmentVariable SMITHY_MAVEN_REPOS
          +
          A pipe-delimited list of Maven repositories to use. + +

          Example: https://example.com/repo1|https://example.com/repo2

          +
          • +
        + + + +
          +
        • +

          SMITHY_DEPENDENCY_MODE

          +
          public static final EnvironmentVariable SMITHY_DEPENDENCY_MODE
          +
          Configures if and how the Smithy CLI handles dependencies declared in smithy-build.json files. + +
            +
          • ignore: ignore dependencies and assume that they are provided by the caller of the CLI.
            • +
          • forbid: forbids dependencies from being declared and will fail the CLI if dependencies are declared.
            • +
          • standard: the assumed default, will automatically resolve dependencies using Apache Maven.
            • +
          + +

          If the CLI detects that Gradle is calling the CLI, dependency resolution is disabled and defaults to + ignore. You can explicitly enable dependency resolution by setting SMITHY_DEPENDENCY_MODE to + standard.

          +
          • +
        + + + +
          +
        • +

          SMITHY_VERSION

          +
          public static final EnvironmentVariable SMITHY_VERSION
          +
          The current version of the CLI. This is set automatically by the CLI.
          +
          • +
        + + + +
          +
        • +

          NO_COLOR

          +
          public static final EnvironmentVariable NO_COLOR
          +
          If set to any value, disable ANSI colors in the output.
          +
          • +
        + + + +
          +
        • +

          FORCE_COLOR

          +
          public static final EnvironmentVariable FORCE_COLOR
          +
          If set to any value, force enables the support of ANSI colors in the output.
          +
          • +
        + + + +
          +
        • +

          TERM

          +
          public static final EnvironmentVariable TERM
          +
          Used to detect if ANSI colors are supported. + +
            +
          • If set to "dumb" colors are disabled.
            • +
          • If not set and the operating system is detected as Windows, colors are disabled.
            • +
          +
          • +
        + + + +
          +
        • +

          SMITHY_PROXY_HOST

          +
          public static final EnvironmentVariable SMITHY_PROXY_HOST
          +
          Used to determine a proxy host to use for Maven dependency resolution. + +

          Set the host, protocol, and port information with a valid url. + 

          + export SMITHY_PROXY_HOST=protocol://host:port
+
          + NOTE: this setting will be used for all repositories + defined in the smithy-build maven configuration unless a repo-specific + configuration is provided.
          +
          • +
        + + + +
          +
        • +

          SMITHY_PROXY_CREDENTIALS

          +
          public static final EnvironmentVariable SMITHY_PROXY_CREDENTIALS
          +
          Used to determine a proxy credentials to use for Maven dependency resolution through + a proxy. + +

          Use this setting in conjunction with the SMITHY_PROXY_HOST variable to configure + proxy settings for dependency resolution. + +

          Set both the username and password information as a ":" separated string. + 

          + export SMITHY_PROXY_CREDENTIALS=user:pass
+
          + NOTE: this setting will be used for all repositories + defined in the smithy-build maven configuration unless a repo-specific + configuration is provided.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static EnvironmentVariable[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (EnvironmentVariable c : EnvironmentVariable.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static EnvironmentVariable valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getByName

          +
          public static java.lang.String getByName​(java.lang.String name)
          +
          Gets a system property or environment variable by name, in that order.
          +
          +
          Parameters:
          +
          name - Variable to get.
          +
          Returns:
          +
          Returns the found system property or environment variable or null.
          +
          +
          • +
        + + + +
          +
        • +

          isSet

          +
          public boolean isSet()
          +
          Returns true if the system property or environment variables is set.
          +
          +
          Returns:
          +
          Returns true if set.
          +
          +
          • +
        + + + +
          +
        • +

          get

          +
          public java.lang.String get()
          +
          Gets the system property or the environment variable for the property, in that order.
          +
          +
          Returns:
          +
          Returns the found system property or environment variable or null.
          +
          +
          • +
        + + + +
          +
        • +

          set

          +
          public void set​(java.lang.String value)
          +
          Sets a system property for the environment variable.
          +
          +
          Parameters:
          +
          value - Value to set.
          +
          +
          • +
        + + + +
          +
        • +

          clear

          +
          public void clear()
          +
          Clears the system property for the variable.
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/cli/HelpPrinter.html b/javadoc/1.47.0/software/amazon/smithy/cli/HelpPrinter.html new file mode 100644 index 00000000000..b10f2ebcb4e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/cli/HelpPrinter.html @@ -0,0 +1,494 @@ + + + + + +HelpPrinter (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.cli
    +

    Class HelpPrinter

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.cli.HelpPrinter
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class HelpPrinter
+extends java.lang.Object
      +
      Generates and prints structured help output.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        HelpPrinter​(java.lang.String name) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        HelpPrinterdocumentation​(java.lang.String documentation) +
        Defines the optional long-form documentation that comes after long argument + descriptions.
        +
        static HelpPrinterfromArguments​(java.lang.String name, + Arguments arguments) +
        Create a HelpPrinter that registers help options and parameters defined in the + given arguments.
        +
        HelpPrintermaxWidth​(int maxWidth) 
        HelpPrinteroption​(java.lang.String longName, + java.lang.String shortName, + java.lang.String description) +
        Adds an option that takes no argument value.
        +
        HelpPrinterparam​(java.lang.String longName, + java.lang.String shortName, + java.lang.String exampleValue, + java.lang.String description) +
        Adds a parameter that requires an argument value.
        +
        HelpPrinterpositional​(java.lang.String name, + java.lang.String description) +
        Defines a positional argument.
        +
        voidprint​(ColorFormatter colors, + CliPrinter printer) +
        Prints the generated help to the given printer.
        +
        HelpPrintersummary​(java.lang.String summary) +
        Defines the summary text of the command that comes after the short argument + description and before the long argument descriptions.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          HelpPrinter

          +
          public HelpPrinter​(java.lang.String name)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          maxWidth

          +
          public HelpPrinter maxWidth​(int maxWidth)
          +
          • +
        + + + +
          +
        • +

          fromArguments

          +
          public static HelpPrinter fromArguments​(java.lang.String name,
+                                        Arguments arguments)
          +
          Create a HelpPrinter that registers help options and parameters defined in the + given arguments.
          +
          +
          Parameters:
          +
          name - Name of the command.
          +
          arguments - Arguments to extract params from.
          +
          Returns:
          +
          Returns the created HelpPrinter.
          +
          +
          • +
        + + + +
          +
        • +

          summary

          +
          public HelpPrinter summary​(java.lang.String summary)
          +
          Defines the summary text of the command that comes after the short argument + description and before the long argument descriptions.
          +
          +
          Parameters:
          +
          summary - Summary text to display.
          +
          Returns:
          +
          Returns the printer.
          +
          +
          • +
        + + + +
          +
        • +

          documentation

          +
          public HelpPrinter documentation​(java.lang.String documentation)
          +
          Defines the optional long-form documentation that comes after long argument + descriptions.
          +
          +
          Parameters:
          +
          documentation - Documentation to display.
          +
          Returns:
          +
          Returns the printer.
          +
          +
          • +
        + + + +
          +
        • +

          option

          +
          public HelpPrinter option​(java.lang.String longName,
+                          java.lang.String shortName,
+                          java.lang.String description)
          +
          Adds an option that takes no argument value.
          +
          +
          Parameters:
          +
          longName - Nullable argument long form (e.g., "--foo").
          +
          shortName - Nullable argument short form (e.g., null).
          +
          description - Description description of the argument.
          +
          Returns:
          +
          Returns the printer.
          +
          +
          • +
        + + + +
          +
        • +

          param

          +
          public HelpPrinter param​(java.lang.String longName,
+                         java.lang.String shortName,
+                         java.lang.String exampleValue,
+                         java.lang.String description)
          +
          Adds a parameter that requires an argument value.
          +
          +
          Parameters:
          +
          longName - Nullable argument long form (e.g., "--foo").
          +
          shortName - Nullable argument short form (e.g., null).
          +
          exampleValue - Example value of the parameter (e.g., "FOO").
          +
          description - Description description of the argument.
          +
          Returns:
          +
          Returns the printer.
          +
          +
          • +
        + + + +
          +
        • +

          positional

          +
          public HelpPrinter positional​(java.lang.String name,
+                              java.lang.String description)
          +
          Defines a positional argument.
          +
          +
          Parameters:
          +
          name - Name of the positional argument (e.g., <MODEL...>)
          +
          description - Description of the argument.
          +
          Returns:
          +
          Returns the printer.
          +
          +
          • +
        + + + +
          +
        • +

          print

          +
          public void print​(ColorFormatter colors,
+                  CliPrinter printer)
          +
          Prints the generated help to the given printer.
          +
          +
          Parameters:
          +
          colors - Color formatter.
          +
          printer - CliPrinter to write to.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/cli/SmithyCli.html b/javadoc/1.47.0/software/amazon/smithy/cli/SmithyCli.html new file mode 100644 index 00000000000..57e0ef27c50 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/cli/SmithyCli.html @@ -0,0 +1,430 @@ + + + + + +SmithyCli (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.cli
    +

    Class SmithyCli

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.cli.SmithyCli
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class SmithyCli
+extends java.lang.Object
      +
      Entry point of the Smithy CLI.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        SmithyCliclassLoader​(java.lang.ClassLoader classLoader) +
        Sets a custom class loader to use when executing commands.
        +
        static SmithyClicreate() +
        Creates a new instance of the CLI.
        +
        ClicreateCli() +
        Creates a runnable CLI.
        +
        SmithyClidependencyResolverFactory​(DependencyResolver.Factory dependencyResolverFactory) +
        Sets a custom dependency resolver factory to use when resolving dependencies.
        +
        static java.lang.StringgetVersion() +
        Get the Smithy CLI version of the running CLI.
        +
        static voidmain​(java.lang.String... args) +
        Executes the CLI.
        +
        intrun​(java.lang.String... args) +
        Runs the CLI.
        +
        intrun​(java.util.List<java.lang.String> args) +
        Runs the CLI using a list of arguments.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + +
          +
        • +

          create

          +
          public static SmithyCli create()
          +
          Creates a new instance of the CLI.
          +
          +
          Returns:
          +
          Returns the CLI instance.
          +
          +
          • +
        + + + +
          +
        • +

          main

          +
          public static void main​(java.lang.String... args)
          +
          Executes the CLI.
          +
          +
          Parameters:
          +
          args - Arguments to parse and execute.
          +
          +
          • +
        + + + +
          +
        • +

          classLoader

          +
          public SmithyCli classLoader​(java.lang.ClassLoader classLoader)
          +
          Sets a custom class loader to use when executing commands.
          +
          +
          Parameters:
          +
          classLoader - Class loader used to find models, traits, etc.
          +
          Returns:
          +
          Returns the CLI.
          +
          +
          • +
        + + + +
          +
        • +

          dependencyResolverFactory

          +
          public SmithyCli dependencyResolverFactory​(DependencyResolver.Factory dependencyResolverFactory)
          +
          Sets a custom dependency resolver factory to use when resolving dependencies. + +

          Note that the CLI will automatically handle caching the resolved classpath and ensuring that + resolved dependencies are consistent with the versions of JARs used by the CLI.

          +
          +
          Parameters:
          +
          dependencyResolverFactory - Factory to use when resolving dependencies.
          +
          Returns:
          +
          Returns the CLI.
          +
          +
          • +
        + + + +
          +
        • +

          run

          +
          public int run​(java.util.List<java.lang.String> args)
          +
          Runs the CLI using a list of arguments.
          +
          +
          Parameters:
          +
          args - Arguments to parse and execute.
          +
          Returns:
          +
          Returns the exit code.
          +
          +
          • +
        + + + +
          +
        • +

          run

          +
          public int run​(java.lang.String... args)
          +
          Runs the CLI.
          +
          +
          Parameters:
          +
          args - Arguments to parse and execute.
          +
          Returns:
          +
          Returns the exit code.
          +
          +
          • +
        + + + +
          +
        • +

          createCli

          +
          public Cli createCli()
          +
          Creates a runnable CLI.
          +
          +
          Returns:
          +
          Returns the created CLI.
          +
          +
          • +
        + + + +
          +
        • +

          getVersion

          +
          public static java.lang.String getVersion()
          +
          Get the Smithy CLI version of the running CLI.
          +
          +
          Returns:
          +
          Returns the CLI version (e.g., "1.26.0").
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/cli/StandardOptions.html b/javadoc/1.47.0/software/amazon/smithy/cli/StandardOptions.html new file mode 100644 index 00000000000..cb9b17e8d8c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/cli/StandardOptions.html @@ -0,0 +1,637 @@ + + + + + +StandardOptions (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.cli
    +

    Class StandardOptions

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.cli.StandardOptions
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ArgumentReceiver
      +
      +
      +
      public final class StandardOptions
+extends java.lang.Object
+implements ArgumentReceiver
      +
      Options available to all commands.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        static java.lang.StringDEBUG 
        static java.lang.StringFORCE_COLOR 
        static java.lang.StringHELP 
        static java.lang.StringHELP_SHORT 
        static java.lang.StringLOGGING 
        static java.lang.StringNO_COLOR 
        static java.lang.StringQUIET 
        static java.lang.StringSTACKTRACE 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        StandardOptions() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        AnsiColorFormattercolorSetting() 
        booleandebug() 
        booleanhelp() 
        java.util.logging.Levellogging() 
        booleanquiet() 
        voidregisterHelp​(HelpPrinter printer) +
        Registers help information to the given HelpPrinter.
        +
        booleanstackTrace() 
        booleantestOption​(java.lang.String name) +
        Test if the given value-less option is accepted by the receiver.
        +
        java.util.function.Consumer<java.lang.String>testParameter​(java.lang.String name) +
        Test if the given parameter that requires a value is accepted by the receiver.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          StandardOptions

          +
          public StandardOptions()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          testOption

          +
          public boolean testOption​(java.lang.String name)
          +
          Description copied from interface: ArgumentReceiver
          +
          Test if the given value-less option is accepted by the receiver. + +

          If the option is accepted, the receiver should store a stateful + value to indicate the option was received, and the CLI will skip + the argument for further processing.

          +
          +
          Specified by:
          +
          testOption in interface ArgumentReceiver
          +
          Parameters:
          +
          name - Name of the option to test.
          +
          Returns:
          +
          Returns true if accepted.
          +
          +
          • +
        + + + +
          +
        • +

          testParameter

          +
          public java.util.function.Consumer<java.lang.String> testParameter​(java.lang.String name)
          +
          Description copied from interface: ArgumentReceiver
          +
          Test if the given parameter that requires a value is accepted by the receiver. + +

          If the parameter is accepted, the receiver returns a Consumer that + receives the expected value, and it should store a stateful value to allow + the value to be later recalled. The CLI will skip the argument for further + processing.

          +
          +
          Specified by:
          +
          testParameter in interface ArgumentReceiver
          +
          Parameters:
          +
          name - Name of the parameter to test.
          +
          Returns:
          +
          Returns a consumer if accepted or null if rejected.
          +
          +
          • +
        + + + +
          +
        • +

          help

          +
          public boolean help()
          +
          • +
        + + + +
          +
        • +

          logging

          +
          public java.util.logging.Level logging()
          +
          • +
        + + + +
          +
        • +

          quiet

          +
          public boolean quiet()
          +
          • +
        + + + +
          +
        • +

          debug

          +
          public boolean debug()
          +
          • +
        + + + +
          +
        • +

          stackTrace

          +
          public boolean stackTrace()
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/cli/Style.Constant.html b/javadoc/1.47.0/software/amazon/smithy/cli/Style.Constant.html new file mode 100644 index 00000000000..d61357f9667 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/cli/Style.Constant.html @@ -0,0 +1,351 @@ + + + + + +Style.Constant (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.cli
    +

    Class Style.Constant

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.cli.Style.Constant
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Style
      +
      +
      +
      Enclosing interface:
      +
      Style
      +
      +
      +
      public static final class Style.Constant
+extends java.lang.Object
+implements Style
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Constant

          +
          public Constant​(java.lang.String ansiColorCode)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getAnsiColorCode

          +
          public java.lang.String getAnsiColorCode()
          +
          +
          Specified by:
          +
          getAnsiColorCode in interface Style
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/cli/Style.Multi.html b/javadoc/1.47.0/software/amazon/smithy/cli/Style.Multi.html new file mode 100644 index 00000000000..83fd77acf38 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/cli/Style.Multi.html @@ -0,0 +1,351 @@ + + + + + +Style.Multi (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.cli
    +

    Class Style.Multi

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.cli.Style.Multi
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Style
      +
      +
      +
      Enclosing interface:
      +
      Style
      +
      +
      +
      public static final class Style.Multi
+extends java.lang.Object
+implements Style
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Multi

          +
          public Multi​(Style... styles)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getAnsiColorCode

          +
          public java.lang.String getAnsiColorCode()
          +
          +
          Specified by:
          +
          getAnsiColorCode in interface Style
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/cli/Style.html b/javadoc/1.47.0/software/amazon/smithy/cli/Style.html new file mode 100644 index 00000000000..8c032b3c13c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/cli/Style.html @@ -0,0 +1,831 @@ + + + + + +Style (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.cli
    +

    Interface Style

    +
    +
    +
    +
      +
    • +
      +
      All Known Implementing Classes:
      +
      Style.Constant, Style.Multi
      +
      +
      +
      public interface Style
      +
      Colors and styles for use with AnsiColorFormatter or CliPrinter. + +

      ANSI codes returned by this interface should not include the opening \033[, the final ;m when + opening styles, or the closing . These escapes are added automatically when multiple styles are + applied.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          BOLD

          +
          static final Style BOLD
          +
          • +
        + + + +
          +
        • +

          FAINT

          +
          static final Style FAINT
          +
          • +
        + + + +
          +
        • +

          ITALIC

          +
          static final Style ITALIC
          +
          • +
        + + + +
          +
        • +

          UNDERLINE

          +
          static final Style UNDERLINE
          +
          • +
        + + + +
          +
        • +

          BLACK

          +
          static final Style BLACK
          +
          • +
        + + + +
          +
        • +

          RED

          +
          static final Style RED
          +
          • +
        + + + +
          +
        • +

          GREEN

          +
          static final Style GREEN
          +
          • +
        + + + +
          +
        • +

          YELLOW

          +
          static final Style YELLOW
          +
          • +
        + + + +
          +
        • +

          BLUE

          +
          static final Style BLUE
          +
          • +
        + + + +
          +
        • +

          MAGENTA

          +
          static final Style MAGENTA
          +
          • +
        + + + +
          +
        • +

          CYAN

          +
          static final Style CYAN
          +
          • +
        + + + +
          +
        • +

          WHITE

          +
          static final Style WHITE
          +
          • +
        + + + +
          +
        • +

          BRIGHT_BLACK

          +
          static final Style BRIGHT_BLACK
          +
          • +
        + + + +
          +
        • +

          BRIGHT_RED

          +
          static final Style BRIGHT_RED
          +
          • +
        + + + +
          +
        • +

          BRIGHT_GREEN

          +
          static final Style BRIGHT_GREEN
          +
          • +
        + + + +
          +
        • +

          BRIGHT_YELLOW

          +
          static final Style BRIGHT_YELLOW
          +
          • +
        + + + +
          +
        • +

          BRIGHT_BLUE

          +
          static final Style BRIGHT_BLUE
          +
          • +
        + + + +
          +
        • +

          BRIGHT_MAGENTA

          +
          static final Style BRIGHT_MAGENTA
          +
          • +
        + + + +
          +
        • +

          BRIGHT_CYAN

          +
          static final Style BRIGHT_CYAN
          +
          • +
        + + + +
          +
        • +

          BRIGHT_WHITE

          +
          static final Style BRIGHT_WHITE
          +
          • +
        + + + +
          +
        • +

          BG_BLACK

          +
          static final Style BG_BLACK
          +
          • +
        + + + +
          +
        • +

          BG_RED

          +
          static final Style BG_RED
          +
          • +
        + + + +
          +
        • +

          BG_GREEN

          +
          static final Style BG_GREEN
          +
          • +
        + + + +
          +
        • +

          BG_YELLOW

          +
          static final Style BG_YELLOW
          +
          • +
        + + + +
          +
        • +

          BG_BLUE

          +
          static final Style BG_BLUE
          +
          • +
        + + + +
          +
        • +

          BG_MAGENTA

          +
          static final Style BG_MAGENTA
          +
          • +
        + + + +
          +
        • +

          BG_CYAN

          +
          static final Style BG_CYAN
          +
          • +
        + + + +
          +
        • +

          BG_WHITE

          +
          static final Style BG_WHITE
          +
          • +
        + + + +
          +
        • +

          BG_BRIGHT_BLACK

          +
          static final Style BG_BRIGHT_BLACK
          +
          • +
        + + + +
          +
        • +

          BG_BRIGHT_RED

          +
          static final Style BG_BRIGHT_RED
          +
          • +
        + + + +
          +
        • +

          BG_BRIGHT_GREEN

          +
          static final Style BG_BRIGHT_GREEN
          +
          • +
        + + + +
          +
        • +

          BG_BRIGHT_YELLOW

          +
          static final Style BG_BRIGHT_YELLOW
          +
          • +
        + + + +
          +
        • +

          BG_BRIGHT_BLUE

          +
          static final Style BG_BRIGHT_BLUE
          +
          • +
        + + + +
          +
        • +

          BG_BRIGHT_MAGENTA

          +
          static final Style BG_BRIGHT_MAGENTA
          +
          • +
        + + + +
          +
        • +

          BG_BRIGHT_CYAN

          +
          static final Style BG_BRIGHT_CYAN
          +
          • +
        + + + +
          +
        • +

          BG_BRIGHT_WHITE

          +
          static final Style BG_BRIGHT_WHITE
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getAnsiColorCode

          +
          java.lang.String getAnsiColorCode()
          +
          • +
        + + + +
          +
        • +

          of

          +
          static Style of​(Style... styles)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/cli/commands/SmithyCommand.html b/javadoc/1.47.0/software/amazon/smithy/cli/commands/SmithyCommand.html new file mode 100644 index 00000000000..c2d05034d62 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/cli/commands/SmithyCommand.html @@ -0,0 +1,398 @@ + + + + + +SmithyCommand (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.cli.commands
    +

    Class SmithyCommand

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.cli.commands.SmithyCommand
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Command
      +
      +
      +
      public final class SmithyCommand
+extends java.lang.Object
+implements Command
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        intexecute​(Arguments arguments, + Command.Env env) +
        Executes the command using the provided arguments.
        +
        java.lang.StringgetName() +
        Gets the name of the command.
        +
        java.lang.StringgetSummary() +
        Gets a short summary of the command that's shown in the main help.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + +
          +
        • +

          getName

          +
          public java.lang.String getName()
          +
          Description copied from interface: Command
          +
          Gets the name of the command. + +

          The returned name should contain no spaces or special characters.

          +
          +
          Specified by:
          +
          getName in interface Command
          +
          Returns:
          +
          Returns the command name.
          +
          +
          • +
        + + + +
          +
        • +

          getSummary

          +
          public java.lang.String getSummary()
          +
          Description copied from interface: Command
          +
          Gets a short summary of the command that's shown in the main help.
          +
          +
          Specified by:
          +
          getSummary in interface Command
          +
          Returns:
          +
          Returns the short help description.
          +
          +
          • +
        + + + +
          +
        • +

          execute

          +
          public int execute​(Arguments arguments,
+                   Command.Env env)
          +
          Description copied from interface: Command
          +
          Executes the command using the provided arguments.
          +
          +
          Specified by:
          +
          execute in interface Command
          +
          Parameters:
          +
          arguments - CLI arguments.
          +
          env - CLI environment settings like stdout, stderr, etc.
          +
          Returns:
          +
          Returns the exit code.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/cli/commands/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/cli/commands/package-summary.html new file mode 100644 index 00000000000..8542ee6bcef --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/cli/commands/package-summary.html @@ -0,0 +1,164 @@ + + + + + +software.amazon.smithy.cli.commands (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.cli.commands

    +
    +
    +
      +
    • + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      SmithyCommand 
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/cli/commands/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/cli/commands/package-tree.html new file mode 100644 index 00000000000..2cf374598f5 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/cli/commands/package-tree.html @@ -0,0 +1,161 @@ + + + + + +software.amazon.smithy.cli.commands Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.cli.commands

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    +
      +
    • java.lang.Object +
        +
      • software.amazon.smithy.cli.commands.SmithyCommand (implements software.amazon.smithy.cli.Command)
        • +
      +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/cli/dependencies/DependencyResolver.Factory.html b/javadoc/1.47.0/software/amazon/smithy/cli/dependencies/DependencyResolver.Factory.html new file mode 100644 index 00000000000..2644cd855bd --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/cli/dependencies/DependencyResolver.Factory.html @@ -0,0 +1,271 @@ + + + + + +DependencyResolver.Factory (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.cli.dependencies
    +

    Interface DependencyResolver.Factory

    +
    +
    +
    +
      +
    • +
      +
      Enclosing interface:
      +
      DependencyResolver
      +
      +
      +
      Functional Interface:
      +
      This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
      +
      +
      +
      @FunctionalInterface
+public static interface DependencyResolver.Factory
      +
      Responsible for creating a DependencyResolver for the CLI, + optionally based on configuration.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          create

          +
          DependencyResolver create​(SmithyBuildConfig config,
+                          Command.Env env)
          +
          Creates a DependencyResolver.
          +
          +
          Parameters:
          +
          config - smithy-build.json configuration that can be used to configure the resolver.
          +
          env - Command environment, including stderr and stdout printers.
          +
          Returns:
          +
          Returns the created resolver.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/cli/dependencies/DependencyResolver.html b/javadoc/1.47.0/software/amazon/smithy/cli/dependencies/DependencyResolver.html new file mode 100644 index 00000000000..95835f39b7f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/cli/dependencies/DependencyResolver.html @@ -0,0 +1,339 @@ + + + + + +DependencyResolver (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.cli.dependencies
    +

    Interface DependencyResolver

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          addRepository

          +
          void addRepository​(MavenRepository repository)
          +
          Add a Maven repository.
          +
          +
          Parameters:
          +
          repository - Repository to add.
          +
          Throws:
          +
          DependencyResolverException - When the repository is invalid.
          +
          +
          • +
        + + + +
          +
        • +

          addDependency

          +
          void addDependency​(java.lang.String coordinates)
          +
          Add a dependency. + +

          Coordinates must be given a group ID, artifact ID, and version in the form + of "groupId:artifactId:version". Coordinates support Maven dependency ranges. + Coordinates do not support LATEST, SNAPSHOT, latest-release, latest.*, or + Gradle style "+" syntax.

          +
          +
          Parameters:
          +
          coordinates - Dependency coordinates to add.
          +
          Throws:
          +
          DependencyResolverException - When the dependency is invalid.
          +
          +
          • +
        + + + +
          +
        • +

          resolve

          +
          java.util.List<ResolvedArtifact> resolve()
          +
          Resolves artifacts for the configured dependencies.
          +
          +
          Returns:
          +
          Returns the resolved artifacts, including file on disk and coordinates.
          +
          Throws:
          +
          DependencyResolverException - If dependency resolution fails.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/cli/dependencies/DependencyResolverException.html b/javadoc/1.47.0/software/amazon/smithy/cli/dependencies/DependencyResolverException.html new file mode 100644 index 00000000000..684f7bc0ba2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/cli/dependencies/DependencyResolverException.html @@ -0,0 +1,325 @@ + + + + + +DependencyResolverException (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.cli.dependencies
    +

    Class DependencyResolverException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Throwable
        • +
      • +
          +
        • java.lang.Exception
          • +
        • +
            +
          • java.lang.RuntimeException
            • +
          • +
              +
            • software.amazon.smithy.cli.dependencies.DependencyResolverException
              • +
            +
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      public final class DependencyResolverException
+extends java.lang.RuntimeException
      +
      Exception encountered while attempting to resolve dependencies.
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          DependencyResolverException

          +
          public DependencyResolverException​(java.lang.String message)
          +
          • +
        + + + +
          +
        • +

          DependencyResolverException

          +
          public DependencyResolverException​(java.lang.Throwable previous)
          +
          • +
        + + + +
          +
        • +

          DependencyResolverException

          +
          public DependencyResolverException​(java.lang.String message,
+                                   java.lang.Throwable previous)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/cli/dependencies/FileCacheResolver.html b/javadoc/1.47.0/software/amazon/smithy/cli/dependencies/FileCacheResolver.html new file mode 100644 index 00000000000..bfb94b554fd --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/cli/dependencies/FileCacheResolver.html @@ -0,0 +1,402 @@ + + + + + +FileCacheResolver (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.cli.dependencies
    +

    Class FileCacheResolver

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.cli.dependencies.FileCacheResolver
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      DependencyResolver
      +
      +
      +
      public final class FileCacheResolver
+extends java.lang.Object
+implements DependencyResolver
      +
      A resolver that loads and caches resolved artifacts to a JSON file if + the cache is fresh and resolved artifacts haven't been updated after a + given reference point in time.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          FileCacheResolver

          +
          public FileCacheResolver​(java.io.File location,
+                         long referenceTimeInMillis,
+                         DependencyResolver delegate)
          +
          +
          Parameters:
          +
          location - The location to the cache.
          +
          referenceTimeInMillis - Invalidate cache items if this time is newer than the cache item time.
          +
          delegate - Resolver to delegate to when dependencies aren't cached.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          addDependency

          +
          public void addDependency​(java.lang.String coordinates)
          +
          Description copied from interface: DependencyResolver
          +
          Add a dependency. + +

          Coordinates must be given a group ID, artifact ID, and version in the form + of "groupId:artifactId:version". Coordinates support Maven dependency ranges. + Coordinates do not support LATEST, SNAPSHOT, latest-release, latest.*, or + Gradle style "+" syntax.

          +
          +
          Specified by:
          +
          addDependency in interface DependencyResolver
          +
          Parameters:
          +
          coordinates - Dependency coordinates to add.
          +
          +
          • +
        + + + +
          +
        • +

          resolve

          +
          public java.util.List<ResolvedArtifact> resolve()
          +
          Description copied from interface: DependencyResolver
          +
          Resolves artifacts for the configured dependencies.
          +
          +
          Specified by:
          +
          resolve in interface DependencyResolver
          +
          Returns:
          +
          Returns the resolved artifacts, including file on disk and coordinates.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/cli/dependencies/FilterCliVersionResolver.html b/javadoc/1.47.0/software/amazon/smithy/cli/dependencies/FilterCliVersionResolver.html new file mode 100644 index 00000000000..868604ecc05 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/cli/dependencies/FilterCliVersionResolver.html @@ -0,0 +1,400 @@ + + + + + +FilterCliVersionResolver (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.cli.dependencies
    +

    Class FilterCliVersionResolver

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.cli.dependencies.FilterCliVersionResolver
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      DependencyResolver
      +
      +
      +
      public final class FilterCliVersionResolver
+extends java.lang.Object
+implements DependencyResolver
      +
      Removes Smithy CLI dependencies that conflict with the JARs used by the CLI. + +

      This makes creating a dedicated ClassLoader simpler because Smithy dependencies are provided by the parent + class loader when running the CLI.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          FilterCliVersionResolver

          +
          public FilterCliVersionResolver​(java.lang.String version,
+                                DependencyResolver delegate)
          +
          +
          Parameters:
          +
          version - Version of the Smithy CLI.
          +
          delegate - Resolver to resolve dependencies and filter.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          addDependency

          +
          public void addDependency​(java.lang.String coordinates)
          +
          Description copied from interface: DependencyResolver
          +
          Add a dependency. + +

          Coordinates must be given a group ID, artifact ID, and version in the form + of "groupId:artifactId:version". Coordinates support Maven dependency ranges. + Coordinates do not support LATEST, SNAPSHOT, latest-release, latest.*, or + Gradle style "+" syntax.

          +
          +
          Specified by:
          +
          addDependency in interface DependencyResolver
          +
          Parameters:
          +
          coordinates - Dependency coordinates to add.
          +
          +
          • +
        + + + +
          +
        • +

          resolve

          +
          public java.util.List<ResolvedArtifact> resolve()
          +
          Description copied from interface: DependencyResolver
          +
          Resolves artifacts for the configured dependencies.
          +
          +
          Specified by:
          +
          resolve in interface DependencyResolver
          +
          Returns:
          +
          Returns the resolved artifacts, including file on disk and coordinates.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/cli/dependencies/MavenDependencyResolver.html b/javadoc/1.47.0/software/amazon/smithy/cli/dependencies/MavenDependencyResolver.html new file mode 100644 index 00000000000..077b3f88baf --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/cli/dependencies/MavenDependencyResolver.html @@ -0,0 +1,407 @@ + + + + + +MavenDependencyResolver (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.cli.dependencies
    +

    Class MavenDependencyResolver

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.cli.dependencies.MavenDependencyResolver
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      DependencyResolver
      +
      +
      +
      public final class MavenDependencyResolver
+extends java.lang.Object
+implements DependencyResolver
      +
      Resolves Maven dependencies for the Smithy CLI using Maven resolvers.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          MavenDependencyResolver

          +
          public MavenDependencyResolver()
          +
          • +
        + + + +
          +
        • +

          MavenDependencyResolver

          +
          public MavenDependencyResolver​(java.lang.String cacheLocation)
          +
          +
          Parameters:
          +
          cacheLocation - Maven local cache location.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          addDependency

          +
          public void addDependency​(java.lang.String coordinates)
          +
          Description copied from interface: DependencyResolver
          +
          Add a dependency. + +

          Coordinates must be given a group ID, artifact ID, and version in the form + of "groupId:artifactId:version". Coordinates support Maven dependency ranges. + Coordinates do not support LATEST, SNAPSHOT, latest-release, latest.*, or + Gradle style "+" syntax.

          +
          +
          Specified by:
          +
          addDependency in interface DependencyResolver
          +
          Parameters:
          +
          coordinates - Dependency coordinates to add.
          +
          +
          • +
        + + + +
          +
        • +

          resolve

          +
          public java.util.List<ResolvedArtifact> resolve()
          +
          Description copied from interface: DependencyResolver
          +
          Resolves artifacts for the configured dependencies.
          +
          +
          Specified by:
          +
          resolve in interface DependencyResolver
          +
          Returns:
          +
          Returns the resolved artifacts, including file on disk and coordinates.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/cli/dependencies/ResolvedArtifact.html b/javadoc/1.47.0/software/amazon/smithy/cli/dependencies/ResolvedArtifact.html new file mode 100644 index 00000000000..d076954c603 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/cli/dependencies/ResolvedArtifact.html @@ -0,0 +1,567 @@ + + + + + +ResolvedArtifact (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.cli.dependencies
    +

    Class ResolvedArtifact

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.cli.dependencies.ResolvedArtifact
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ToNode
      +
      +
      +
      public final class ResolvedArtifact
+extends java.lang.Object
+implements ToNode
      +
      An artifact resolved from a repository that provides the path on disk where the artifact + was downloaded, and the coordinates of the artifact.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        ResolvedArtifact​(java.nio.file.Path path, + java.lang.String groupId, + java.lang.String artifactId, + java.lang.String version) 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ResolvedArtifact

          +
          public ResolvedArtifact​(java.nio.file.Path path,
+                        java.lang.String groupId,
+                        java.lang.String artifactId,
+                        java.lang.String version)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          fromCoordinates

          +
          public static ResolvedArtifact fromCoordinates​(java.nio.file.Path location,
+                                               java.lang.String coordinates)
          +
          Creates a resolved artifact from a file path and Maven coordinates string.
          +
          +
          Parameters:
          +
          location - Location of the artifact.
          +
          coordinates - Maven coordinates (e.g., group:artifact:version).
          +
          Returns:
          +
          Returns the created artifact.
          +
          Throws:
          +
          DependencyResolverException - if the provided coordinates are invalid.
          +
          +
          • +
        + + + +
          +
        • +

          fromCoordinateNode

          +
          public static ResolvedArtifact fromCoordinateNode​(java.lang.String coordinates,
+                                                  Node node)
          +
          Creates a resolved artifact from a Maven coordinates string and Node.
          +
          +
          Parameters:
          +
          coordinates - Maven coordinates (e.g., group:artifact:version).
          +
          node - Node containing the resolved artifact data.
          +
          Returns:
          +
          Returns the created artifact
          +
          +
          • +
        + + + +
          +
        • +

          getPath

          +
          public java.nio.file.Path getPath()
          +
          Get the path to the artifact on disk.
          +
          +
          Returns:
          +
          Returns the location of the downloaded artifact.
          +
          +
          • +
        + + + +
          +
        • +

          getCoordinates

          +
          public java.lang.String getCoordinates()
          +
          Get the resolved coordinates (e.g., group:artifact:version).
          +
          +
          Returns:
          +
          Returns the resolved coordinates.
          +
          +
          • +
        + + + +
          +
        • +

          getGroupId

          +
          public java.lang.String getGroupId()
          +
          +
          Returns:
          +
          Get the group ID of the artifact.
          +
          +
          • +
        + + + +
          +
        • +

          getArtifactId

          +
          public java.lang.String getArtifactId()
          +
          +
          Returns:
          +
          Get the artifact ID of the artifact.
          +
          +
          • +
        + + + +
          +
        • +

          getVersion

          +
          public java.lang.String getVersion()
          +
          +
          Returns:
          +
          Get the version of the artifact.
          +
          +
          • +
        + + + +
          +
        • +

          getShaSum

          +
          public java.lang.String getShaSum()
          +
          +
          Returns:
          +
          Get the sha1 digest of the artifact.
          +
          +
          • +
        + + + +
          +
        • +

          getLastModified

          +
          public long getLastModified()
          +
          +
          Returns:
          +
          Get the last time the artifact was modified.
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/cli/dependencies/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/cli/dependencies/package-summary.html new file mode 100644 index 00000000000..d01e9b42f20 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/cli/dependencies/package-summary.html @@ -0,0 +1,228 @@ + + + + + +software.amazon.smithy.cli.dependencies (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.cli.dependencies

    +
    +
    +
      +
    • + + + + + + + + + + + + + + + + +
      Interface Summary 
      InterfaceDescription
      DependencyResolver +
      Resolves Maven dependencies for the Smithy CLI.
      +
      DependencyResolver.Factory +
      Responsible for creating a DependencyResolver for the CLI, + optionally based on configuration.
      +
      +
      • +
    • + + + + + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      FileCacheResolver +
      A resolver that loads and caches resolved artifacts to a JSON file if + the cache is fresh and resolved artifacts haven't been updated after a + given reference point in time.
      +
      FilterCliVersionResolver +
      Removes Smithy CLI dependencies that conflict with the JARs used by the CLI.
      +
      MavenDependencyResolver +
      Resolves Maven dependencies for the Smithy CLI using Maven resolvers.
      +
      ResolvedArtifact +
      An artifact resolved from a repository that provides the path on disk where the artifact + was downloaded, and the coordinates of the artifact.
      +
      +
      • +
    • + + + + + + + + + + + + +
      Exception Summary 
      ExceptionDescription
      DependencyResolverException +
      Exception encountered while attempting to resolve dependencies.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/cli/dependencies/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/cli/dependencies/package-tree.html new file mode 100644 index 00000000000..10ae2cf3f90 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/cli/dependencies/package-tree.html @@ -0,0 +1,184 @@ + + + + + +software.amazon.smithy.cli.dependencies Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.cli.dependencies

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/cli/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/cli/package-summary.html new file mode 100644 index 00000000000..83900eccdb3 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/cli/package-summary.html @@ -0,0 +1,330 @@ + + + + + +software.amazon.smithy.cli (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.cli

    +
    +
    +
    + + +
    Everything in this package should be considered an implementation detail; + the only stable interface of the Smithy CLI is passing in a list of + arguments from the command line.
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/cli/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/cli/package-tree.html new file mode 100644 index 00000000000..b8d03199236 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/cli/package-tree.html @@ -0,0 +1,221 @@ + + + + + +software.amazon.smithy.cli Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.cli

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +

    Enum Hierarchy

    +
      +
    • java.lang.Object + +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/CodegenContext.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/CodegenContext.html new file mode 100644 index 00000000000..8963a00413c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/CodegenContext.html @@ -0,0 +1,362 @@ + + + + + +CodegenContext (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core
    +

    Interface CodegenContext<S,​W extends SymbolWriter<W,​?>,​I extends SmithyIntegration<S,​W,​?>>

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          model

          +
          Model model()
          +
          +
          Returns:
          +
          Gets the model being code generated.
          +
          +
          • +
        + + + +
          +
        • +

          settings

          +
          S settings()
          +
          +
          Returns:
          +
          Gets code generation settings.
          +
          +
          • +
        + + + +
          +
        • +

          symbolProvider

          +
          SymbolProvider symbolProvider()
          +
          +
          Returns:
          +
          Gets the SymbolProvider used for code generation.
          +
          +
          • +
        + + + +
          +
        • +

          fileManifest

          +
          FileManifest fileManifest()
          +
          +
          Returns:
          +
          Gets the FileManifest being written to for code generation.
          +
          +
          • +
        + + + +
          +
        • +

          writerDelegator

          +
          WriterDelegator<W> writerDelegator()
          +
          Get the WriterDelegator used for generating code. + +

          Generates might need other delegators for specific purposes, and it's fine to + add more methods for those specific purposes. If an implementation uses a specific + subclass of a WriterDelegator, implementations can override this method to return + a more specific WriterDelegator type.

          +
          +
          Returns:
          +
          Returns the writer delegator used by the generator.
          +
          +
          • +
        + + + +
          +
        • +

          integrations

          +
          java.util.List<I> integrations()
          +
          +
          Returns:
          +
          Gets the SmithyIntegrations used for code generation.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/CodegenException.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/CodegenException.html new file mode 100644 index 00000000000..9c6bdc20bba --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/CodegenException.html @@ -0,0 +1,330 @@ + + + + + +CodegenException (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core
    +

    Class CodegenException

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      public class CodegenException
+extends SmithyBuildException
      +
      Thrown when an error occurs during code generation.
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        CodegenException​(java.lang.String message) 
        CodegenException​(java.lang.String message, + java.lang.Throwable cause) 
        CodegenException​(java.lang.Throwable cause) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CodegenException

          +
          public CodegenException​(java.lang.String message)
          +
          • +
        + + + +
          +
        • +

          CodegenException

          +
          public CodegenException​(java.lang.Throwable cause)
          +
          • +
        + + + +
          +
        • +

          CodegenException

          +
          public CodegenException​(java.lang.String message,
+                        java.lang.Throwable cause)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/DependencyTracker.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/DependencyTracker.html new file mode 100644 index 00000000000..73e28f732d1 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/DependencyTracker.html @@ -0,0 +1,617 @@ + + + + + +DependencyTracker (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core
    +

    Class DependencyTracker

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.codegen.core.DependencyTracker
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      SymbolDependencyContainer
      +
      +
      +
      public final class DependencyTracker
+extends java.lang.Object
+implements SymbolDependencyContainer
      +
      A container for all known dependencies of a generator. + +

      A DependencyTracker can include predefined dependencies loaded from a + file (for example to track versions of runtime dependencies used in the + generator), or dependencies that are accumulated dynamically as code is + generated. + +

      Notes: +

        +
      • Multiple packages of the same name and type can be added to tracker. + There's no de-duplication.
        • +
      • Note that this class is mutable and not synchronized.
        • +
      + +

      Loading from JSON

      + +

      Dependencies can be loaded from a JSON file to more easily track + dependencies used at runtime by generated code. This feature can also + be used to generate the dependencies tracked by the generated from from + other dependency graph formats like lockfiles. + +

      The JSON file has the following format: + + 

      + 
+ {
+     "version": "1.0",
+     "dependencies": [
+         {
+             "packageName": "string",
+             "version": "string",
+             "dependencyType": "string",
+             "properties": {
+                 "x": true,
+                 "y": [10],
+                 "z": "string"
+             }
+         }
+     ]
+ }
+ 
+
      + +
        +
      • "version" (string, required): Must be set to "1.0".
        • +
      • "dependencies" is a list of dependency objects that contain the following + properties: +
          +
        • "packageName" (string, required): The required name of the package.
          • +
        • "version" (string, required): The required dependency version.
          • +
        • "dependencyType" (string): The optional type of dependency. This value + is dependent on the package manager of the target environment.
          • +
        • "properties" (map of string to any value): Properties to assign to + the symbol. These properties can be any JSON value type other than null. + List values are converted to a List, map values are converted to + a Map, boolean values to Java's boolean, numeric values to an + appropriate Number type, and string values to String.
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        DependencyTracker() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidaddDependencies​(SymbolDependencyContainer container) +
        Adds dependencies from a SymbolDependencyContainer.
        +
        voidaddDependenciesFromJson​(java.net.URL jsonFile) +
        Loads predefined dependencies from a JSON file (for example, to track + known dependencies used by generated code at runtime).
        +
        voidaddDependency​(java.lang.String packageName, + java.lang.String version, + java.lang.String dependencyType) +
        Adds a dependency.
        +
        voidaddDependency​(SymbolDependency dependency) +
        Adds a dependency.
        +
        SymbolDependencygetByName​(java.lang.String name) +
        Gets the first found dependency by name.
        +
        SymbolDependencygetByName​(java.lang.String name, + java.lang.String dependencyType) +
        Gets the first found dependency by name and dependency type.
        +
        java.util.List<SymbolDependency>getByProperty​(java.lang.String property) +
        Gets a list of matching dependencies that contain a property named + property.
        +
        java.util.List<SymbolDependency>getByProperty​(java.lang.String property, + java.lang.Object value) +
        Gets a list of matching dependencies that contain a property named + property with a value of value.
        +
        java.util.List<SymbolDependency>getByType​(java.lang.String dependencyType) +
        Gets a list of matching dependencies that have a dependency type + matching dependencyType.
        +
        java.util.List<SymbolDependency>getDependencies() +
        Gets the list of dependencies that this object introduces.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          DependencyTracker

          +
          public DependencyTracker()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getDependencies

          +
          public java.util.List<SymbolDependency> getDependencies()
          +
          Description copied from interface: SymbolDependencyContainer
          +
          Gets the list of dependencies that this object introduces. + +

          A dependency is a dependency on another package that a Symbol + or type requires. It is quite different from a reference since a + reference only refers to a symbol; a reference provides no context + as to whether or not a dependency is required or the dependency's + coordinates.

          +
          +
          Specified by:
          +
          getDependencies in interface SymbolDependencyContainer
          +
          Returns:
          +
          Returns the dependencies.
          +
          +
          • +
        + + + +
          +
        • +

          getByName

          +
          public SymbolDependency getByName​(java.lang.String name)
          +
          Gets the first found dependency by name.
          +
          +
          Parameters:
          +
          name - Package name of the dependency to get.
          +
          Returns:
          +
          Returns the dependency.
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if the dependency cannot be found.
          +
          +
          • +
        + + + +
          +
        • +

          getByName

          +
          public SymbolDependency getByName​(java.lang.String name,
+                                  java.lang.String dependencyType)
          +
          Gets the first found dependency by name and dependency type.
          +
          +
          Parameters:
          +
          name - Package name of the dependency to get.
          +
          dependencyType - The dependency type of package to find.
          +
          Returns:
          +
          Returns the dependency.
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if the dependency cannot be found.
          +
          +
          • +
        + + + +
          +
        • +

          getByType

          +
          public java.util.List<SymbolDependency> getByType​(java.lang.String dependencyType)
          +
          Gets a list of matching dependencies that have a dependency type + matching dependencyType.
          +
          +
          Parameters:
          +
          dependencyType - Dependency type to find.
          +
          Returns:
          +
          Returns the matching dependencies.
          +
          +
          • +
        + + + +
          +
        • +

          getByProperty

          +
          public java.util.List<SymbolDependency> getByProperty​(java.lang.String property)
          +
          Gets a list of matching dependencies that contain a property named + property.
          +
          +
          Parameters:
          +
          property - Property to find.
          +
          Returns:
          +
          Returns the matching dependencies.
          +
          +
          • +
        + + + +
          +
        • +

          getByProperty

          +
          public java.util.List<SymbolDependency> getByProperty​(java.lang.String property,
+                                                      java.lang.Object value)
          +
          Gets a list of matching dependencies that contain a property named + property with a value of value.
          +
          +
          Parameters:
          +
          property - Property to find.
          +
          value - Value to match.
          +
          Returns:
          +
          Returns the matching dependencies.
          +
          +
          • +
        + + + +
          +
        • +

          addDependency

          +
          public void addDependency​(SymbolDependency dependency)
          +
          Adds a dependency.
          +
          +
          Parameters:
          +
          dependency - Dependency to add.
          +
          +
          • +
        + + + +
          +
        • +

          addDependency

          +
          public void addDependency​(java.lang.String packageName,
+                          java.lang.String version,
+                          java.lang.String dependencyType)
          +
          Adds a dependency.
          +
          +
          Parameters:
          +
          packageName - Name of the dependency.
          +
          version - Version of the dependency.
          +
          dependencyType - Type of dependency (e.g., "dev", "test", "runtime", etc). + This value wholly depends on the type of dependency graph + being generated.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          addDependenciesFromJson

          +
          public void addDependenciesFromJson​(java.net.URL jsonFile)
          +
          Loads predefined dependencies from a JSON file (for example, to track + known dependencies used by generated code at runtime). + + 
          + 
+ DependencyTracker tracker = new DependencyTracker();
+ tracker.addDependenciesFromJson(getClass().getResource("some-file.json"));
+ 
+
          +
          +
          Parameters:
          +
          jsonFile - URL location of the JSON file.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/ImportContainer.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/ImportContainer.html new file mode 100644 index 00000000000..999a9dbf364 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/ImportContainer.html @@ -0,0 +1,329 @@ + + + + + +ImportContainer (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core
    +

    Interface ImportContainer

    +
    +
    +
    +
      +
    • +
      +
      public interface ImportContainer
      +
      Contains the imports associated with a specific file. + +

      The only required method is importSymbol(software.amazon.smithy.codegen.core.Symbol, java.lang.String), but implementations + are expected to also override toString() so that it contains the + formatted imports that can be written as code to a file. Other methods + can, and should, be added to make working with language specific imports + easier too.

      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods Default Methods 
        Modifier and TypeMethodDescription
        default voidimportSymbol​(Symbol symbol) +
        Adds an import for the given symbol if and only if the "namespace" of the + provided Symbol differs from the "namespace" associated with the + ImportContainer.
        +
        voidimportSymbol​(Symbol symbol, + java.lang.String alias) +
        Adds an import for the given symbol if and only if the "namespace" of the + provided Symbol differs from the "namespace" associated with the + ImportContainer.
        +
        java.lang.StringtoString() +
        Implementations must implement a custom toString method that + converts the collected imports to code that can be written to a + CodeWriter.
        +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          importSymbol

          +
          void importSymbol​(Symbol symbol,
+                  java.lang.String alias)
          +
          Adds an import for the given symbol if and only if the "namespace" of the + provided Symbol differs from the "namespace" associated with the + ImportContainer. + +

          "namespace" in this context can mean whatever it needs to mean for the + target programming language. In some languages, it might mean the path to + a file. In others, it might mean a proper namespace string. It's up to + subclasses to both track a current "namespace" and implement this method + in a way that makes sense.

          +
          +
          Parameters:
          +
          symbol - Symbol to import if it's in another namespace.
          +
          alias - Alias to import the symbol as.
          +
          +
          • +
        + + + +
          +
        • +

          importSymbol

          +
          default void importSymbol​(Symbol symbol)
          +
          Adds an import for the given symbol if and only if the "namespace" of the + provided Symbol differs from the "namespace" associated with the + ImportContainer.
          +
          +
          Parameters:
          +
          symbol - The symbol to import.
          +
          See Also:
          +
          importSymbol(Symbol, String)
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          java.lang.String toString()
          +
          Implementations must implement a custom toString method that + converts the collected imports to code that can be written to a + CodeWriter.
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          Returns:
          +
          Returns the collected imports as a string.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/MappedReservedWords.Builder.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/MappedReservedWords.Builder.html new file mode 100644 index 00000000000..b6880905aad --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/MappedReservedWords.Builder.html @@ -0,0 +1,342 @@ + + + + + +MappedReservedWords.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core
    +

    Class MappedReservedWords.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.codegen.core.MappedReservedWords.Builder
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        ReservedWordsbuild() +
        Builds the reserved words.
        +
        MappedReservedWords.Builderput​(java.lang.String reservedWord, + java.lang.String conversion) +
        Add a new reserved words.
        +
        MappedReservedWords.BuilderputCaseInsensitive​(java.lang.String reservedWord, + java.lang.String conversion) +
        Add a new case-insensitive reserved word that converts the given + reserved word to the given conversion string.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + +
          +
        • +

          put

          +
          public MappedReservedWords.Builder put​(java.lang.String reservedWord,
+                                       java.lang.String conversion)
          +
          Add a new reserved words.
          +
          +
          Parameters:
          +
          reservedWord - Reserved word to convert.
          +
          conversion - Word to convert to.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          putCaseInsensitive

          +
          public MappedReservedWords.Builder putCaseInsensitive​(java.lang.String reservedWord,
+                                                      java.lang.String conversion)
          +
          Add a new case-insensitive reserved word that converts the given + reserved word to the given conversion string. + +

          Note that the conversion string is used literally. The casing + of the original word has no effect on the conversion. Use + ReservedWordsBuilder for a case-insensitive reserved words + implementation that can take casing into account.

          +
          +
          Parameters:
          +
          reservedWord - Case-insensitive reserved word to convert.
          +
          conversion - Word to convert to.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/MappedReservedWords.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/MappedReservedWords.html new file mode 100644 index 00000000000..b2260bf5c9f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/MappedReservedWords.html @@ -0,0 +1,428 @@ + + + + + +MappedReservedWords (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core
    +

    Class MappedReservedWords

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.codegen.core.MappedReservedWords
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ReservedWords
      +
      +
      +
      public final class MappedReservedWords
+extends java.lang.Object
+implements ReservedWords
      +
      A reserved words implementation that maps known words to other words. + +

      The following example shows how to use this class to make reserved + words safe for the targeted code: + + 

      + 
+ ReservedWords reserved = MappedReservedWords.builder()
+         .put("exception", "apiException")
+         .put("void", "void_")
+         .build();
+ String safeWord = reserved.escape("exception");
+ System.out.println(safeWord); // outputs "apiException"
+ 
+
      + +

      The detection of reserved words can be made case-insensitive such + that "bar", "BAR", "Bar", etc., can be detected as reserved words. + + 

      + 
+ ReservedWords reserved = MappedReservedWords.builder()
+         .put("foo", "Hi")
+         .putCaseInsensitive("bar", "bam")
+         .build();
+
+ assert(reserved.escape("foo").equals("Hi"));
+ assert(reserved.escape("Foo").equals("Foo"));
+ assert(reserved.escape("BAR").equals("bam"));
+ 
+
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        MappedReservedWords​(java.util.Map<java.lang.String,​java.lang.String> mappings, + java.util.Map<java.lang.String,​java.lang.String> caseInsensitiveMappings) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static MappedReservedWords.Builderbuilder() 
        java.lang.Stringescape​(java.lang.String word) +
        Escapes a reserved word.
        +
        booleanisReserved​(java.lang.String word) +
        Checks if the given word is reserved.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          MappedReservedWords

          +
          public MappedReservedWords​(java.util.Map<java.lang.String,​java.lang.String> mappings,
+                           java.util.Map<java.lang.String,​java.lang.String> caseInsensitiveMappings)
          +
          +
          Parameters:
          +
          mappings - Map of reserved word to replacement words.
          +
          caseInsensitiveMappings - Map of case-insensitive reserved word to replacement words.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          escape

          +
          public java.lang.String escape​(java.lang.String word)
          +
          Description copied from interface: ReservedWords
          +
          Escapes a reserved word.
          +
          +
          Specified by:
          +
          escape in interface ReservedWords
          +
          Parameters:
          +
          word - Word to escape.
          +
          Returns:
          +
          Returns the converted value.
          +
          +
          • +
        + + + +
          +
        • +

          isReserved

          +
          public boolean isReserved​(java.lang.String word)
          +
          Description copied from interface: ReservedWords
          +
          Checks if the given word is reserved.
          +
          +
          Specified by:
          +
          isReserved in interface ReservedWords
          +
          Parameters:
          +
          word - Word to check.
          +
          Returns:
          +
          Returns true if the word is reserved.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/ReservedWordSymbolProvider.Builder.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/ReservedWordSymbolProvider.Builder.html new file mode 100644 index 00000000000..06ebe3cdf08 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/ReservedWordSymbolProvider.Builder.html @@ -0,0 +1,517 @@ + + + + + +ReservedWordSymbolProvider.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core
    +

    Class ReservedWordSymbolProvider.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.codegen.core.ReservedWordSymbolProvider.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public SymbolProvider build()
          +
          Builds a SymbolProvider implementation that wraps another + symbol provider and escapes its results. + +

          This might not always be the right solution. For example, + symbol providers often need to recursively resolve symbols to + create shapes like arrays and maps. In these cases, delegating + would be awkward or impossible since the symbol provider being + wrapped would also need access to the wrapper. In cases like this, + use buildEscaper() and pass that into the SymbolProvider + directly.

          +
          +
          Returns:
          +
          Returns the built SymbolProvider that delegates to another.
          +
          +
          • +
        + + + +
          +
        • +

          buildEscaper

          +
          public ReservedWordSymbolProvider.Escaper buildEscaper()
          +
          Builds a SymbolProvider.Escaper that is used to manually + escape Symbols and member names.
          +
          +
          Returns:
          +
          Returns the built escaper.
          +
          +
          • +
        + + + +
          +
        • +

          symbolProvider

          +
          public ReservedWordSymbolProvider.Builder symbolProvider​(SymbolProvider delegate)
          +
          Sets the delegate symbol provider. + +

          This is only required when calling build() to build + a SymbolProvider that delegates to another provider.

          +
          +
          Parameters:
          +
          delegate - Symbol provider to delegate to.
          +
          Returns:
          +
          Returns the builder
          +
          +
          • +
        + + + +
          +
        • +

          filenameReservedWords

          +
          public ReservedWordSymbolProvider.Builder filenameReservedWords​(ReservedWords filenameReservedWords)
          +
          Sets the reserved word implementation for file names. + +

          If not provided, file names are not passed through a reserved + words implementation after calling the delegate.

          +
          +
          Parameters:
          +
          filenameReservedWords - Reserved word implementation for namespaces.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          namespaceReservedWords

          +
          public ReservedWordSymbolProvider.Builder namespaceReservedWords​(ReservedWords namespaceReservedWords)
          +
          Sets the reserved word implementation for namespace names. + +

          If not provided, namespace names are not passed through a reserved + words implementation after calling the delegate.

          +
          +
          Parameters:
          +
          namespaceReservedWords - Reserved word implementation for namespaces.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          nameReservedWords

          +
          public ReservedWordSymbolProvider.Builder nameReservedWords​(ReservedWords nameReservedWords)
          +
          Sets the reserved word implementation for names (structures names, + class names, etc.). + +

          If not provided, names are not passed through a reserved words + implementation after calling the delegate.

          +
          +
          Parameters:
          +
          nameReservedWords - Reserved word implementation for containers.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          memberReservedWords

          +
          public ReservedWordSymbolProvider.Builder memberReservedWords​(ReservedWords memberReservedWords)
          +
          Sets the reserved word implementation for members. + +

          If not provided, member names are not passed through a reserved + words implementation after calling the delegate.

          +
          +
          Parameters:
          +
          memberReservedWords - Reserved word implementation for members.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          escapePredicate

          +
          public ReservedWordSymbolProvider.Builder escapePredicate​(java.util.function.BiPredicate<Shape,​Symbol> escapePredicate)
          +
          Sets a predicate that is used to control when a shape + symbol + combination should be checked if it's a reserved word. + +

          The predicate is invoked when toSymbol is called. It + is used to disable/enable escaping reserved words based on the + shape and symbol. The given predicate accepts the Shape + and the Symbol that was created for the shape and returns + true if reserved word checks should be made or false if reserved + word checks should not be made. For example, some code generators + only escape words that have namespaces to differentiate between + language built-ins and user-defined types. + +

          By default, all symbols are checked for reserved words.

          +
          +
          Parameters:
          +
          escapePredicate - Predicate that returns true if escaping should be checked.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/ReservedWordSymbolProvider.Escaper.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/ReservedWordSymbolProvider.Escaper.html new file mode 100644 index 00000000000..c5f19234978 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/ReservedWordSymbolProvider.Escaper.html @@ -0,0 +1,306 @@ + + + + + +ReservedWordSymbolProvider.Escaper (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core
    +

    Class ReservedWordSymbolProvider.Escaper

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.codegen.core.ReservedWordSymbolProvider.Escaper
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      ReservedWordSymbolProvider
      +
      +
      +
      public static final class ReservedWordSymbolProvider.Escaper
+extends java.lang.Object
      +
      Uses to manually escape Symbols and member names.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.lang.StringescapeMemberName​(java.lang.String memberName) +
        Escapes the given member name if needed.
        +
        SymbolescapeSymbol​(Shape shape, + Symbol symbol) +
        Escapes the given symbol using the reserved words implementations + registered for each component.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + +
          +
        • +

          escapeSymbol

          +
          public Symbol escapeSymbol​(Shape shape,
+                           Symbol symbol)
          +
          Escapes the given symbol using the reserved words implementations + registered for each component.
          +
          +
          Parameters:
          +
          shape - Shape being turned into a Symbol.
          +
          symbol - Symbol to escape.
          +
          Returns:
          +
          Returns the escaped Symbol.
          +
          +
          • +
        + + + +
          +
        • +

          escapeMemberName

          +
          public java.lang.String escapeMemberName​(java.lang.String memberName)
          +
          Escapes the given member name if needed.
          +
          +
          Parameters:
          +
          memberName - Member name to escape.
          +
          Returns:
          +
          Returns the possibly escaped member name.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/ReservedWordSymbolProvider.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/ReservedWordSymbolProvider.html new file mode 100644 index 00000000000..43f82746807 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/ReservedWordSymbolProvider.html @@ -0,0 +1,404 @@ + + + + + +ReservedWordSymbolProvider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core
    +

    Class ReservedWordSymbolProvider

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.codegen.core.ReservedWordSymbolProvider
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      SymbolProvider
      +
      +
      +
      public final class ReservedWordSymbolProvider
+extends java.lang.Object
+implements SymbolProvider
      +
      Decorates a SymbolProvider by passing values through context + specific ReservedWords implementations. + +

      A specific ReservedWords implementation can be registered + for each kind of symbol provided by the delegated SymbolProvider. + For example, reserved words can be created that are specific to + class names. + +

      This motivation behind this class is to allow more general purpose + implementations of SymbolProvider and ReservedWords to + be composed. + +

      A warning is logged each time a symbol is renamed by a reserved words + implementation. + +

      SymbolProvider implementations that need to recursively call themselves + in a way that requires recursive symbols to be escaped will need to + manually make calls into ReservedWordSymbolProvider.Escaper and + cannot be decorated by an instance of ReservedWordSymbolProvider. + For example, this is the case if a list of strings needs to be turned + into something like "Array[%s]" where "%s" is the symbol name of the + targeted member.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          builder

          +
          public static ReservedWordSymbolProvider.Builder builder()
          +
          Builder to create a ReservedWordSymbolProvider instance.
          +
          +
          Returns:
          +
          Returns a new builder.
          +
          +
          • +
        + + + +
          +
        • +

          toSymbol

          +
          public Symbol toSymbol​(Shape shape)
          +
          Description copied from interface: SymbolProvider
          +
          Gets the symbol to define for the given shape. + +

          A "symbol" represents the qualified name of a type in a target + programming language. + +

            +
          • When given a structure, union, resource, or service shape, + this method should provide the namespace and name of the type to + generate.
            • +
          • When given a simple type like a string, number, or timestamp, + this method should return the language-specific type of the + shape.
            • +
          • When given a member shape, this method should return the + language specific type to use as the target of the member.
            • +
          • When given a list, set, or map, this method should return the + language specific type to use for the shape (e.g., a map shape for + a Python code generator might return "dict".
            • +
          +
          +
          Specified by:
          +
          toSymbol in interface SymbolProvider
          +
          Parameters:
          +
          shape - Shape to get the class name of.
          +
          Returns:
          +
          Returns the generated class name.
          +
          +
          • +
        + + + +
          +
        • +

          toMemberName

          +
          public java.lang.String toMemberName​(MemberShape shape)
          +
          Description copied from interface: SymbolProvider
          +
          Converts a member shape to a member/property name of a containing + data structure. + +

          The default implementation will return the member name of + the provided shape ID and should be overridden if necessary.

          +
          +
          Specified by:
          +
          toMemberName in interface SymbolProvider
          +
          Parameters:
          +
          shape - Shape to convert.
          +
          Returns:
          +
          Returns the converted member name.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/ReservedWords.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/ReservedWords.html new file mode 100644 index 00000000000..1c798720368 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/ReservedWords.html @@ -0,0 +1,355 @@ + + + + + +ReservedWords (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core
    +

    Interface ReservedWords

    +
    +
    +
    +
      +
    • +
      +
      All Known Implementing Classes:
      +
      MappedReservedWords
      +
      +
      +
      public interface ReservedWords
      +
      Determines what is reserved and escapes reserved words.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Abstract Methods 
        Modifier and TypeMethodDescription
        static ReservedWordscompose​(ReservedWords... delegates) +
        Composes multiple instance of ReservedWords into a + single implementation that delegates to them one after the + other.
        +
        java.lang.Stringescape​(java.lang.String word) +
        Escapes a reserved word.
        +
        static ReservedWordsidentity() +
        Creates a reserved word implementation that does not modify words.
        +
        booleanisReserved​(java.lang.String word) +
        Checks if the given word is reserved.
        +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          escape

          +
          java.lang.String escape​(java.lang.String word)
          +
          Escapes a reserved word.
          +
          +
          Parameters:
          +
          word - Word to escape.
          +
          Returns:
          +
          Returns the converted value.
          +
          +
          • +
        + + + +
          +
        • +

          isReserved

          +
          boolean isReserved​(java.lang.String word)
          +
          Checks if the given word is reserved.
          +
          +
          Parameters:
          +
          word - Word to check.
          +
          Returns:
          +
          Returns true if the word is reserved.
          +
          +
          • +
        + + + +
          +
        • +

          identity

          +
          static ReservedWords identity()
          +
          Creates a reserved word implementation that does not modify words. + + 
          + 
+ ReservedWords reserved = ReservedWords.identity();
+ reserved.isReserved("foo"); // always returns false for anything.
+ 
+
          +
          +
          Returns:
          +
          Returns the identity implementation.
          +
          +
          • +
        + + + +
          +
        • +

          compose

          +
          static ReservedWords compose​(ReservedWords... delegates)
          +
          Composes multiple instance of ReservedWords into a + single implementation that delegates to them one after the + other. + +

          Each reserved words implementation is invoked one after + the other until one of them returns true for + isReserved(java.lang.String). + + 

          + 
+ ReservedWords a = MappedReservedWords.builder().put("void", "_void").build();
+ ReservedWords b = MappedReservedWords.builder().put("foo", "_foo").build();
+ ReservedWords composed = ReservedWords.compose(a, b);
+ String safeWordA = composed.escape("void");
+ String safeWordB = composed.escape("foo");
+ System.out.println(safeWordA + " " + safeWordB); // outputs "_void _foo"
+ 
+
          +
          +
          Parameters:
          +
          delegates - ReservedWords instances to delegate to.
          +
          Returns:
          +
          Returns the created ReservedWords instance.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/ReservedWordsBuilder.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/ReservedWordsBuilder.html new file mode 100644 index 00000000000..003c5c76cfd --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/ReservedWordsBuilder.html @@ -0,0 +1,452 @@ + + + + + +ReservedWordsBuilder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core
    +

    Class ReservedWordsBuilder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.codegen.core.ReservedWordsBuilder
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class ReservedWordsBuilder
+extends java.lang.Object
      +
      Builds a ReservedWords implementation from explicit + mappings and from line-delimited files that contain reserved words.
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        ReservedWordsbuild() +
        Builds the reserved words.
        +
        ReservedWordsBuilderloadCaseInsensitiveWords​(java.net.URL location) +
        Load a list of case-insensitive, line-delimited reserved words from a file.
        +
        ReservedWordsBuilderloadCaseInsensitiveWords​(java.net.URL location, + java.util.function.Function<java.lang.String,​java.lang.String> escaper) +
        Load a list of case-insensitive, line-delimited reserved words from a file.
        +
        ReservedWordsBuilderloadWords​(java.net.URL location) +
        Load a list of case-sensitive, line-delimited reserved words from a file.
        +
        ReservedWordsBuilderloadWords​(java.net.URL location, + java.util.function.Function<java.lang.String,​java.lang.String> escaper) +
        Load a list of case-sensitive, line-delimited reserved words from a file.
        +
        ReservedWordsBuilderput​(java.lang.String reservedWord, + java.lang.String conversion) +
        Add a new reserved words.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          ReservedWordsBuilder

          +
          public ReservedWordsBuilder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public ReservedWords build()
          +
          Builds the reserved words.
          +
          +
          Returns:
          +
          Returns the created reserved words implementation.
          +
          +
          • +
        + + + +
          +
        • +

          put

          +
          public ReservedWordsBuilder put​(java.lang.String reservedWord,
+                                java.lang.String conversion)
          +
          Add a new reserved words.
          +
          +
          Parameters:
          +
          reservedWord - Reserved word to convert.
          +
          conversion - Word to convert to.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          loadWords

          +
          public ReservedWordsBuilder loadWords​(java.net.URL location)
          +
          Load a list of case-sensitive, line-delimited reserved words from a file. + +

          This method will escape words by prefixing them with "_". Use + loadWords(URL, Function) to customize how words are escaped. + +

          Blank lines and lines that start with # are ignored.

          +
          +
          Parameters:
          +
          location - URL of the file to load.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          loadWords

          +
          public ReservedWordsBuilder loadWords​(java.net.URL location,
+                                      java.util.function.Function<java.lang.String,​java.lang.String> escaper)
          +
          Load a list of case-sensitive, line-delimited reserved words from a file. + +

          Blank lines and lines that start with # are ignored.

          +
          +
          Parameters:
          +
          location - URL of the file to load.
          +
          escaper - Function used to escape reserved words.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          loadCaseInsensitiveWords

          +
          public ReservedWordsBuilder loadCaseInsensitiveWords​(java.net.URL location)
          +
          Load a list of case-insensitive, line-delimited reserved words from a file. + +

          This method will escape words by prefixing them with "_". Use + loadCaseInsensitiveWords(URL, Function) to customize how words + are escaped. + +

          Blank lines and lines that start with # are ignored.

          +
          +
          Parameters:
          +
          location - URL of the file to load.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          loadCaseInsensitiveWords

          +
          public ReservedWordsBuilder loadCaseInsensitiveWords​(java.net.URL location,
+                                                     java.util.function.Function<java.lang.String,​java.lang.String> escaper)
          +
          Load a list of case-insensitive, line-delimited reserved words from a file. + +

          Blank lines and lines that start with # are ignored.

          +
          +
          Parameters:
          +
          location - URL of the file to load.
          +
          escaper - Function used to escape reserved words.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/ShapeGenerationOrder.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/ShapeGenerationOrder.html new file mode 100644 index 00000000000..dd3e186f9d2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/ShapeGenerationOrder.html @@ -0,0 +1,401 @@ + + + + + +ShapeGenerationOrder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core
    +

    Enum ShapeGenerationOrder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Enum<ShapeGenerationOrder>
        • +
      • +
          +
        • software.amazon.smithy.codegen.core.ShapeGenerationOrder
          • +
        +
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        ALPHABETICAL +
        Shapes ordered alphabetically by their names.
        +
        NONE +
        Shapes without order.
        +
        TOPOLOGICAL +
        Shapes ordered in reverse-topological order.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static ShapeGenerationOrdervalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static ShapeGenerationOrder[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static ShapeGenerationOrder[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (ShapeGenerationOrder c : ShapeGenerationOrder.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static ShapeGenerationOrder valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/SmithyIntegration.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/SmithyIntegration.html new file mode 100644 index 00000000000..c719f25d75c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/SmithyIntegration.html @@ -0,0 +1,581 @@ + + + + + +SmithyIntegration (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core
    +

    Interface SmithyIntegration<S,​W extends SymbolWriter<W,​?>,​C extends CodegenContext<S,​W,​?>>

    +
    +
    +
    +
      +
    • +
      +
      Type Parameters:
      +
      S - The settings object used to configure the generator.
      +
      W - The type of AbstractCodeWriter used by the generator.
      +
      C - The CodegenContext value used by the generator.
      +
      +
      +
      All Known Subinterfaces:
      +
      TraitCodegenIntegration
      +
      +
      +
      All Known Implementing Classes:
      +
      CoreIntegration, IdRefDecoratorIntegration, JavaDocIntegration, UniqueItemDecoratorIntegration
      +
      +
      +
      public interface SmithyIntegration<S,​W extends SymbolWriter<W,​?>,​C extends CodegenContext<S,​W,​?>>
      +
      This interface provides the base concept of an "Integration" to + Smithy code generators. + +

      This class provides the bare minimum that most Smithy code generators + can implement as a tool to customize generators. Code generators are + expected to extend this interface to add various hooks to their generator + (e.g., register protocol generators, register auth scheme integrations, + attach middleware, intercept and augment CodeWriter sections, etc). + +

      This interface is currently unstable as more requirements + may be added in the future.

      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Default Methods 
        Modifier and TypeMethodDescription
        default voidconfigure​(S settings, + ObjectNode integrationSettings) +
        Configures the integration.
        +
        default voidcustomize​(C codegenContext) +
        Allows generators to write additional files, perform additional tasks, and + interact directly with a FileManifest used to write files to the plugin's + output.
        +
        default SymbolProviderdecorateSymbolProvider​(Model model, + S settings, + SymbolProvider symbolProvider) +
        Updates the SymbolProvider used when generating code.
        +
        default java.util.List<? extends CodeInterceptor<? extends CodeSection,​W>>interceptors​(C codegenContext) +
        Gets a list of CodeInterceptors to register with the AbstractCodeWriters + created by the code generator.
        +
        default java.lang.Stringname() +
        Gets the name of the integration.
        +
        default ModelpreprocessModel​(Model model, + S settings) +
        Preprocess the model before code generation.
        +
        default bytepriority() +
        Gets the priority ordering relative to the topologically ordered integration graph + determined by runBefore() and runAfter().
        +
        default java.util.List<java.lang.String>runAfter() +
        Gets the name of the integrations that this integration must come after.
        +
        default java.util.List<java.lang.String>runBefore() +
        Gets the names of integrations that this integration must come before.
        +
        static <I extends SmithyIntegration<?,​?,​?>>
        java.util.List<I>        		sort​(java.lang.Iterable<I> integrations) +
        Topologically sorts a list of integrations based on priority, + runBefore, and runAfter, and integration names.
        +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          name

          +
          default java.lang.String name()
          +
          Gets the name of the integration. + +

          This name is referred to when ordering the graph of integrations. The + name defaults to the canonical class name if not overridden.

          +
          +
          Returns:
          +
          Returns the integration name.
          +
          +
          • +
        + + + +
          +
        • +

          priority

          +
          default byte priority()
          +
          Gets the priority ordering relative to the topologically ordered integration graph + determined by runBefore() and runAfter(). + +

          Higher numbers come before lower numbers. + +

          When ordering, implementations must not allow cycles, and no two integrations + may have the same name.

          +
          +
          Returns:
          +
          Returns the priority order.
          +
          +
          • +
        + + + + + +
          +
        • +

          configure

          +
          default void configure​(S settings,
+                       ObjectNode integrationSettings)
          +
          Configures the integration. + +

          This provides access to both the parsed settings for the generator and + an unparsed ObjectNode containing settings for this particular + integration. + +

          The following smithy-build.json file contains an example of how + this configuration will be set. + + 

          
+ {
+     "version": "1.0",
+     "projections": {
+         "codegen-projection": {
+             "plugins": {
+                 "code-generator": {
+                     "service": "com.example#DocumentedService",
+                     "integrations": {
+                         "my-integration": {
+                             "example-setting": "foo"
+                         }
+                     }
+                 }
+             }
+         }
+     }
+ }
+
          + +

          In this example, an integration whose name() is my-integration + Would receive the extra settings from the key of the same name within the + integrations node. + +

          Integrations SHOULD use modeled traits as much as possible to drive + configuration. This is intended for configuration that doesn't make sense + as a trait, such as configuring a documentation theme.

          +
          +
          Parameters:
          +
          settings - Settings used to generate code.
          +
          integrationSettings - Settings used to configure integrations.
          +
          +
          • +
        + + + +
          +
        • +

          runBefore

          +
          default java.util.List<java.lang.String> runBefore()
          +
          Gets the names of integrations that this integration must come before. + +

          Dependencies are soft. Dependencies on integration names that cannot be found + log a warning and are ignored.

          +
          +
          Returns:
          +
          Returns the integration names this must come before.
          +
          +
          • +
        + + + +
          +
        • +

          runAfter

          +
          default java.util.List<java.lang.String> runAfter()
          +
          Gets the name of the integrations that this integration must come after. + +

          Dependencies are soft. Dependencies on integration names that cannot be found + log a warning and are ignored.

          +
          +
          Returns:
          +
          Returns the integration names this must come after.
          +
          +
          • +
        + + + + + +
          +
        • +

          preprocessModel

          +
          default Model preprocessModel​(Model model,
+                              S settings)
          +
          Preprocess the model before code generation. + +

          This can be used to remove unsupported features, remove traits + from shapes (e.g., make members optional), etc. + +

          By default, this method will return the given model as-is.

          +
          +
          Parameters:
          +
          model - Model being generated.
          +
          settings - Settings used to generate code.
          +
          Returns:
          +
          Returns the updated model.
          +
          +
          • +
        + + + + + +
          +
        • +

          decorateSymbolProvider

          +
          default SymbolProvider decorateSymbolProvider​(Model model,
+                                              S settings,
+                                              SymbolProvider symbolProvider)
          +
          Updates the SymbolProvider used when generating code. + +

          This can be used to customize the names of shapes, the package + that code is generated into, add dependencies, add imports, etc. + +

          By default, this method will return the given symbolProvider + as-is. + +

          This integration method should be called only after preprocessModel(software.amazon.smithy.model.Model, S).

          +
          +
          Parameters:
          +
          model - Model being generated.
          +
          settings - Settings used to generate.
          +
          symbolProvider - The original SymbolProvider.
          +
          Returns:
          +
          The decorated SymbolProvider.
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          customize

          +
          default void customize​(C codegenContext)
          +
          Allows generators to write additional files, perform additional tasks, and + interact directly with a FileManifest used to write files to the plugin's + output. + +

          This method should generally be invoked at the end of the code generation process.

          +
          +
          Parameters:
          +
          codegenContext - Code generation context that can be queried when writing additional files.
          +
          +
          • +
        + + + +
          +
        • +

          sort

          +
          static <I extends SmithyIntegration<?,​?,​?>> java.util.List<I> sort​(java.lang.Iterable<I> integrations)
          +
          Topologically sorts a list of integrations based on priority, + runBefore, and runAfter, and integration names.
          +
          +
          Type Parameters:
          +
          I - The type of integration to sort.
          +
          Parameters:
          +
          integrations - Integrations to sort.
          +
          Returns:
          +
          Returns the sorted integrations.
          +
          Throws:
          +
          java.lang.IllegalArgumentException - If a cycle is found between integrations.
          +
          java.lang.IllegalArgumentException - If multiple integrations share the same name.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/Symbol.Builder.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/Symbol.Builder.html new file mode 100644 index 00000000000..ab261bd9ea0 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/Symbol.Builder.html @@ -0,0 +1,698 @@ + + + + + +Symbol.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core
    +

    Class Symbol.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.codegen.core.Symbol.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public Symbol build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Specified by:
          +
          build in interface SmithyBuilder<Symbol>
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        + + + +
          +
        • +

          name

          +
          public Symbol.Builder name​(java.lang.String name)
          +
          Sets the unqualified name of the symbol.
          +
          +
          Parameters:
          +
          name - Name to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          namespace

          +
          public Symbol.Builder namespace​(java.lang.String namespace,
+                                java.lang.String namespaceDelimiter)
          +
          Sets the namespace and namespace delimiter of the symbol.
          +
          +
          Parameters:
          +
          namespace - Namespace to set.
          +
          namespaceDelimiter - Namespace delimiter to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          definitionFile

          +
          public Symbol.Builder definitionFile​(java.lang.String definitionFile)
          +
          Sets the filename of where this symbol is defined. + +

          This value defaults to the value provided for declarationFile + if not present. One of a definitionFile or a declarationFile + must be provided for every Symbol.

          +
          +
          Parameters:
          +
          definitionFile - Filename of where the symbol is defined.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          declarationFile

          +
          public Symbol.Builder declarationFile​(java.lang.String declarationFile)
          +
          Sets the filename of where this symbol is declared. + +

          This value defaults to the value provided for definitionFile + if not present. One of a definitionFile or a declarationFile + must be provided for every Symbol.

          +
          +
          Parameters:
          +
          declarationFile - Filename of where the symbol is declared.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          references

          +
          public Symbol.Builder references​(java.util.List<SymbolReference> references)
          +
          Replaces the symbol references to the symbol.
          +
          +
          Parameters:
          +
          references - References to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          addReference

          +
          public Symbol.Builder addReference​(Symbol reference)
          +
          Add a symbol reference to indicate that this symbol points to + or contains references to other symbols.
          +
          +
          Parameters:
          +
          reference - Symbol that is referenced.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          addReference

          +
          public Symbol.Builder addReference​(SymbolReference reference)
          +
          Add a symbol reference to indicate that this symbol points to + or contains references to other symbols.
          +
          +
          Parameters:
          +
          reference - Symbol reference to add.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          dependencies

          +
          public Symbol.Builder dependencies​(java.util.List<SymbolDependency> dependencies)
          +
          Replaces the symbol dependencies of the symbol.
          +
          +
          Parameters:
          +
          dependencies - Dependencies to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          dependencies

          +
          public Symbol.Builder dependencies​(SymbolDependencyContainer container)
          +
          Replaces the symbol dependencies of the symbol.
          +
          +
          Parameters:
          +
          container - Dependencies to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          addDependency

          +
          public Symbol.Builder addDependency​(SymbolDependencyContainer dependency)
          +
          Add a symbol dependency.
          +
          +
          Parameters:
          +
          dependency - Symbol dependency to add.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          addDependency

          +
          public Symbol.Builder addDependency​(java.lang.String packageName,
+                                    java.lang.String version)
          +
          Add a symbol dependency.
          +
          +
          Parameters:
          +
          packageName - Name of the package to depend on.
          +
          version - Version to depend on.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          addDependency

          +
          public Symbol.Builder addDependency​(java.lang.String dependencyType,
+                                    java.lang.String packageName,
+                                    java.lang.String version)
          +
          Add a symbol dependency.
          +
          +
          Parameters:
          +
          dependencyType - Type of dependency.
          +
          packageName - Name of the package to depend on.
          +
          version - Version to depend on.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          putProperty

          +
          public T putProperty​(java.lang.String key,
+                     java.lang.Object value)
          +
          Sets a specific custom property.
          +
          +
          Parameters:
          +
          key - Key to set.
          +
          value - Value to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          removeProperty

          +
          public T removeProperty​(java.lang.String key)
          +
          Removes a specific custom property.
          +
          +
          Parameters:
          +
          key - Key to remove.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          properties

          +
          public T properties​(java.util.Map<java.lang.String,​java.lang.Object> properties)
          +
          Replaces all of the custom properties.
          +
          +
          Parameters:
          +
          properties - Custom properties to replace with.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/Symbol.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/Symbol.html new file mode 100644 index 00000000000..2fd8fc0a9c6 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/Symbol.html @@ -0,0 +1,897 @@ + + + + + +Symbol (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core
    +

    Class Symbol

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.codegen.core.Symbol
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      SymbolContainer, SymbolDependencyContainer, ToSmithyBuilder<Symbol>
      +
      +
      +
      public final class Symbol
+extends java.lang.Object
+implements SymbolContainer, SymbolDependencyContainer, ToSmithyBuilder<Symbol>
      +
      A "symbol" is created by a SymbolProvider, and represents the + qualified name of a type in a target programming language. + +

      A symbol contains an optional namespace, optional namespace + delimiter, name, a map of additional properties, a declaration file + the determines where the symbol is declared, and a definition file that + determines where a symbol is defined. + +

      A namespace can be used when the target language supports namespaces. + The provided namespace can be in whatever format is useful to the target + language. A namespace delimiter is injected between the namespace and the + name when creating the fully-qualified symbol name. The "name" is the + unqualified name of the symbol (e.g., "str", or "MyShape"). + +

      Additional properties can be included when it's useful to provide + more information about a symbol. For example, it might be useful to + identify the name of a dependency that needs to be pulled in through a + package manager when a symbol is used. + +

      The following example shows how a Java type could be made into a symbol: + + 

      + 
+ Class<Symbol> klass = Symbol.class;
+ Symbol symbol = Symbol.builder()
+         .namespace(klass.getPackage().toString(), ".")
+         .name(klass.getSimpleName())
+         .build();
+ System.out.println(symbol);
+ // ^ outputs "software.amazon.smithy.codegen.Symbol"
+ System.out.println(symbol.relativize("software.amazon.smithy.codegen");
+ // ^ outputs "Symbol"
+ 
+
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static class Symbol.Builder +
        Builds a Symbol.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static Symbol.Builderbuilder() +
        Creates a new Symbol builder.
        +
        booleanequals​(java.lang.Object o) 
        java.lang.ObjectexpectProperty​(java.lang.String name) +
        Gets a specific additional property or throws if missing.
        +
        <T> TexpectProperty​(java.lang.String name, + java.lang.Class<T> type) +
        Gets a specific additional property or throws if missing or if the + property is not an instance of the given type.
        +
        java.lang.StringgetDeclarationFile() +
        Gets the location/filename in which the symbol is declared.
        +
        java.lang.StringgetDefinitionFile() +
        Gets the location/filename in which the symbol is defined.
        +
        java.util.List<SymbolDependency>getDependencies() +
        Gets the list of dependencies that this object introduces.
        +
        java.lang.StringgetFullName() +
        Gets the full name of the symbol.
        +
        java.lang.StringgetName() +
        Gets the unqualified name of the symbol, that is, a name without + namespace.
        +
        java.lang.StringgetNamespace() +
        Provides the namespace of the symbol or "" if empty.
        +
        java.lang.StringgetNamespaceDelimiter() +
        Provides the namespace delimiter of the symbol or "" if empty.
        +
        java.util.Map<java.lang.String,​java.lang.Object>getProperties() +
        Gets the additional properties of the object.
        +
        java.util.Optional<java.lang.Object>getProperty​(java.lang.String name) +
        Gets a specific property if present.
        +
        <T> java.util.Optional<T>getProperty​(java.lang.String name, + java.lang.Class<T> type) +
        Gets an additional property of a specific type.
        +
        java.util.List<SymbolReference>getReferences() +
        Gets the list of symbols that are referenced by this symbol.
        +
        java.util.List<Symbol>getSymbols() +
        Returns any Symbol objects contained in the object.
        +
        inthashCode() 
        java.lang.Stringrelativize​(java.lang.String namespace) +
        Creates a relativized Symbol for the given namespace.
        +
        Symbol.BuildertoBuilder() +
        Take this object and create a builder that contains all of the + current property values of this object.
        +
        SymbolReferencetoReference​(java.lang.String alias, + SymbolReference.Option... options) +
        Converts the symbol to a SymbolReference using the given alias.
        +
        SymboltoReferencedSymbol​(java.lang.String alias) +
        Converts the symbol to a Symbol that refers to this Symbol + using a SymbolReference.
        +
        Symbol.BuildertoReferencedSymbolBuilder​(java.lang.String alias) +
        Converts the symbol to a Symbol.Builder that refers to this + Symbol using a SymbolReference via an alias.
        +
        java.lang.StringtoString() 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          builder

          +
          public static Symbol.Builder builder()
          +
          Creates a new Symbol builder.
          +
          +
          Returns:
          +
          Returns the created symbol builder.
          +
          +
          • +
        + + + +
          +
        • +

          getNamespace

          +
          public java.lang.String getNamespace()
          +
          Provides the namespace of the symbol or "" if empty.
          +
          +
          Returns:
          +
          Returns the optional namespace.
          +
          +
          • +
        + + + +
          +
        • +

          getNamespaceDelimiter

          +
          public java.lang.String getNamespaceDelimiter()
          +
          Provides the namespace delimiter of the symbol or "" if empty. + +

          This delimiter is injected between the namespace and name + when creating the full name.

          +
          +
          Returns:
          +
          Returns the optional namespace.
          +
          +
          • +
        + + + +
          +
        • +

          getName

          +
          public java.lang.String getName()
          +
          Gets the unqualified name of the symbol, that is, a name without + namespace.
          +
          +
          Returns:
          +
          Returns the name of the symbol.
          +
          +
          • +
        + + + +
          +
        • +

          getDeclarationFile

          +
          public java.lang.String getDeclarationFile()
          +
          Gets the location/filename in which the symbol is declared. + +

          Code generators should write the generated code for this + symbol's declaration in a file with the same name that is + returned from this method. Not all languages separate a symbol's + definition from its declaration. This method is useful for things + like C and C++ header files. + +

          This method returns an empty string if no value was provided + in the builder.

          +
          +
          Returns:
          +
          The name of the file the symbol is declared.
          +
          +
          • +
        + + + +
          +
        • +

          getDefinitionFile

          +
          public java.lang.String getDefinitionFile()
          +
          Gets the location/filename in which the symbol is defined. + +

          Code generators should write the generated code for a + symbol in a file with the same name that is returned from this + method. + +

          This method returns an empty string if no value was provided + for either the declaration file or the definition file.

          +
          +
          Returns:
          +
          The name of the file the symbol is defined.
          +
          +
          • +
        + + + +
          +
        • +

          getFullName

          +
          public java.lang.String getFullName()
          +
          Gets the full name of the symbol. + +

          The full name is the concatenation of the namespace, + the namespace delimiter, and the name.

          +
          +
          Returns:
          +
          Returns the fully qualified name of the symbol.
          +
          +
          • +
        + + + +
          +
        • +

          relativize

          +
          public java.lang.String relativize​(java.lang.String namespace)
          +
          Creates a relativized Symbol for the given namespace. + +

          If this symbol is in the same namespace as the provided namespace, + then only the symbol name is returned. Otherwise, the fully-qualified + symbol is returned.

          +
          +
          Parameters:
          +
          namespace - Namespace to relativize against.
          +
          Returns:
          +
          Returns the relativized symbol.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          toReferencedSymbol

          +
          public Symbol toReferencedSymbol​(java.lang.String alias)
          +
          Converts the symbol to a Symbol that refers to this Symbol + using a SymbolReference. This makes it easier to refer to a + type using an alias but still through a Symbol to be compatible with + SymbolProvider. + +

          The following example creates a Symbol that is referred to as + "__Document" in code, but is an alias of "foo.Document". + + 

          
+ Symbol aliasedSymbol = Symbol.builder()
+         .name("Document")
+         .namespace("foo", ".")
+         .build()
+         .toReferenceSymbol("__Document");
+
          + +

          When used with a SymbolWriter, the writer should add an + import on "foo.Document" and alias it to "__Document". + +

          The created symbol uses an empty namespace (""). If this is not + compatible with specific ImportContainers to understand that + the aliased symbol itself needs no imports, then you can augment the + symbol with other metadata by instead using toReferencedSymbolBuilder(String). + +

          Note that this does not work with every programming language. + For example, Java does not support aliasing whereas TypeScript does.

          +
          +
          Parameters:
          +
          alias - Alias to use to refer to the symbol.
          +
          Returns:
          +
          Returns the created Symbol.
          +
          See Also:
          +
          toReferencedSymbolBuilder(String)
          +
          +
          • +
        + + + +
          +
        • +

          toReferencedSymbolBuilder

          +
          public Symbol.Builder toReferencedSymbolBuilder​(java.lang.String alias)
          +
          Converts the symbol to a Symbol.Builder that refers to this + Symbol using a SymbolReference via an alias. This makes it + easier to refer to type using an alias but still use a Symbol to be + compatible with SymbolProviders.
          +
          +
          Parameters:
          +
          alias - Alias to use to refer to the symbol.
          +
          Returns:
          +
          Returns a SymbolBuilder that is prepared with the symbol and alias.
          +
          See Also:
          +
          toReferencedSymbol(String)
          +
          +
          • +
        + + + +
          +
        • +

          getReferences

          +
          public java.util.List<SymbolReference> getReferences()
          +
          Gets the list of symbols that are referenced by this symbol.
          +
          +
          Returns:
          +
          Returns the Symbol references.
          +
          +
          • +
        + + + +
          +
        • +

          getDependencies

          +
          public java.util.List<SymbolDependency> getDependencies()
          +
          Description copied from interface: SymbolDependencyContainer
          +
          Gets the list of dependencies that this object introduces. + +

          A dependency is a dependency on another package that a Symbol + or type requires. It is quite different from a reference since a + reference only refers to a symbol; a reference provides no context + as to whether or not a dependency is required or the dependency's + coordinates.

          +
          +
          Specified by:
          +
          getDependencies in interface SymbolDependencyContainer
          +
          Returns:
          +
          Returns the dependencies.
          +
          +
          • +
        + + + +
          +
        • +

          getSymbols

          +
          public java.util.List<Symbol> getSymbols()
          +
          Description copied from interface: SymbolContainer
          +
          Returns any Symbol objects contained in the object.
          +
          +
          Specified by:
          +
          getSymbols in interface SymbolContainer
          +
          Returns:
          +
          Returns a collection of Symbols.
          +
          +
          • +
        + + + +
          +
        • +

          toBuilder

          +
          public Symbol.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<Symbol>
          +
          Returns:
          +
          a builder for type T
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          • +
        + + + +
          +
        • +

          getProperties

          +
          public java.util.Map<java.lang.String,​java.lang.Object> getProperties()
          +
          Gets the additional properties of the object.
          +
          +
          Returns:
          +
          Returns a map of additional property strings.
          +
          +
          • +
        + + + +
          +
        • +

          getProperty

          +
          public java.util.Optional<java.lang.Object> getProperty​(java.lang.String name)
          +
          Gets a specific property if present.
          +
          +
          Parameters:
          +
          name - Property to retrieve.
          +
          Returns:
          +
          Returns the optionally found property.
          +
          +
          • +
        + + + +
          +
        • +

          getProperty

          +
          public <T> java.util.Optional<T> getProperty​(java.lang.String name,
+                                             java.lang.Class<T> type)
          +
          Gets an additional property of a specific type.
          +
          +
          Type Parameters:
          +
          T - Type of value to expect.
          +
          Parameters:
          +
          name - Name of the property to get.
          +
          type - Type of value to expect.
          +
          Returns:
          +
          Returns a map of additional property strings.
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if the value is not of the given type.
          +
          +
          • +
        + + + +
          +
        • +

          expectProperty

          +
          public java.lang.Object expectProperty​(java.lang.String name)
          +
          Gets a specific additional property or throws if missing.
          +
          +
          Parameters:
          +
          name - Property to retrieve.
          +
          Returns:
          +
          Returns the found property.
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if the property is not present.
          +
          +
          • +
        + + + +
          +
        • +

          expectProperty

          +
          public <T> T expectProperty​(java.lang.String name,
+                            java.lang.Class<T> type)
          +
          Gets a specific additional property or throws if missing or if the + property is not an instance of the given type.
          +
          +
          Type Parameters:
          +
          T - Type of value to expect.
          +
          Parameters:
          +
          name - Property to retrieve.
          +
          type - Type of value to expect.
          +
          Returns:
          +
          Returns the found property.
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if the property is not present.
          +
          java.lang.IllegalArgumentException - if the value is not of the given type.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolContainer.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolContainer.html new file mode 100644 index 00000000000..b9905b8a278 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolContainer.html @@ -0,0 +1,260 @@ + + + + + +SymbolContainer (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core
    +

    Interface SymbolContainer

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getSymbols

          +
          java.util.List<Symbol> getSymbols()
          +
          Returns any Symbol objects contained in the object.
          +
          +
          Returns:
          +
          Returns a collection of Symbols.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolDependency.Builder.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolDependency.Builder.html new file mode 100644 index 00000000000..42b610a51da --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolDependency.Builder.html @@ -0,0 +1,429 @@ + + + + + +SymbolDependency.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core
    +

    Class SymbolDependency.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.codegen.core.SymbolDependency.Builder
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        SymbolDependencybuild() +
        Creates an immutable object that is created from the properties + that have been set on the builder.
        +
        SymbolDependency.BuilderdependencyType​(java.lang.String dependencyType) +
        Sets the type of dependency (for example, "dev", "optional", etc).
        +
        SymbolDependency.BuilderpackageName​(java.lang.String packageName) +
        Sets the package name of the dependency.
        +
        Tproperties​(java.util.Map<java.lang.String,​java.lang.Object> properties) +
        Replaces all of the custom properties.
        +
        TputProperty​(java.lang.String key, + java.lang.Object value) +
        Sets a specific custom property.
        +
        TremoveProperty​(java.lang.String key) +
        Removes a specific custom property.
        +
        SymbolDependency.Builderversion​(java.lang.String version) +
        Sets the version string of the dependency.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + + + + + +
          +
        • +

          dependencyType

          +
          public SymbolDependency.Builder dependencyType​(java.lang.String dependencyType)
          +
          Sets the type of dependency (for example, "dev", "optional", etc). + +

          Defaults to an empty string if not explicitly set.

          +
          +
          Parameters:
          +
          dependencyType - Dependency type to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          packageName

          +
          public SymbolDependency.Builder packageName​(java.lang.String packageName)
          +
          Sets the package name of the dependency.
          +
          +
          Parameters:
          +
          packageName - Package name to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          version

          +
          public SymbolDependency.Builder version​(java.lang.String version)
          +
          Sets the version string of the dependency.
          +
          +
          Parameters:
          +
          version - Opaque version string to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          putProperty

          +
          public T putProperty​(java.lang.String key,
+                     java.lang.Object value)
          +
          Sets a specific custom property.
          +
          +
          Parameters:
          +
          key - Key to set.
          +
          value - Value to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          removeProperty

          +
          public T removeProperty​(java.lang.String key)
          +
          Removes a specific custom property.
          +
          +
          Parameters:
          +
          key - Key to remove.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          properties

          +
          public T properties​(java.util.Map<java.lang.String,​java.lang.Object> properties)
          +
          Replaces all of the custom properties.
          +
          +
          Parameters:
          +
          properties - Custom properties to replace with.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolDependency.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolDependency.html new file mode 100644 index 00000000000..079c67ad173 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolDependency.html @@ -0,0 +1,735 @@ + + + + + +SymbolDependency (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core
    +

    Class SymbolDependency

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.codegen.core.SymbolDependency
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.lang.Comparable<SymbolDependency>, SymbolDependencyContainer, ToSmithyBuilder<SymbolDependency>
      +
      +
      +
      public final class SymbolDependency
+extends java.lang.Object
+implements SymbolDependencyContainer, ToSmithyBuilder<SymbolDependency>, java.lang.Comparable<SymbolDependency>
      +
      Represents a dependency that is introduced by a Symbol. + +

      SymbolProvider implementations sometimes need to refer to + Symbol values that require a dependency to be brought in when + generating code. A dependency can be associated with the Symbol to + specify the relationship of a Symbol to a dependency. + +

      This dependency class was designed to be as generic as possible while + still allowing for some extension points through typed properties. + If a feature you need is missing (for example, specifying a GitHub + repository), use TypedPropertiesBag.Builder.putProperty(java.lang.String, java.lang.Object) to add a + property on the dependency that can be understood by you code generator. + +

      It's up to code generators to make sense of the values provided in a + dependency and to aggregate them in a meaningful way. This class uses a + package + version combination to define the coordinates of a dependency. + Some dependency managers like Maven use a group + package + version + combination. In cases like this, it is recommended to specify the + package of the symbol as the group + package name (e.g., + "software.amazon.smithy.model:0.9.3" becomes a package of + "software.amazon.smithy.model" and a version of "0.9.3"). + +

      The dependencyType of a dependency is application and + target-specific. When omitted, it defaults to an empty string (""). An + arbitrary string value can be provided and should refer to something that + makes sense for the target language. For illustrative purposed only: + a code generator that targets JavaScript and NPM could set the + dependencyType of a dependency to "devDependencies" to add the + dependency to the "devDependencies" property of a generated package.json. + +

      version is also an opaque values that is target-specific and + can even be specific to a dependencyType. For example, PHP's + Composer provides a section named "suggest" that is a map of package names + to a description of the suggestion. A SymbolDependency that is + meant to define a "suggest" entry for a composer.json file could set the + dependencyType to "suggest", the packageName to the name + of the suggested package, and version to the description of the + suggestion.

      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static class SymbolDependency.Builder +
        Builds a SymbolDependency.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static SymbolDependency.Builderbuilder() 
        intcompareTo​(SymbolDependency other) +
        Dependencies can be sorted based on the natural sort order of + the dependencyType, packageName, and finally the version.
        +
        booleanequals​(java.lang.Object o) 
        java.lang.ObjectexpectProperty​(java.lang.String name) +
        Gets a specific additional property or throws if missing.
        +
        <T> TexpectProperty​(java.lang.String name, + java.lang.Class<T> type) +
        Gets a specific additional property or throws if missing or if the + property is not an instance of the given type.
        +
        static java.util.Map<java.lang.String,​java.util.Map<java.lang.String,​SymbolDependency>>gatherDependencies​(java.util.stream.Stream<SymbolDependency> symbolStream) +
        Gets a mapping of all dependencies used by the provided symbols.
        +
        static java.util.Map<java.lang.String,​java.util.Map<java.lang.String,​SymbolDependency>>gatherDependencies​(java.util.stream.Stream<SymbolDependency> symbolStream, + java.util.function.BinaryOperator<SymbolDependency> versionMergeFunction) +
        Gets a mapping of all dependencies used by the provided symbols.
        +
        java.util.List<SymbolDependency>getDependencies() +
        Gets the list of dependencies that this object introduces.
        +
        java.lang.StringgetDependencyType() +
        Gets the type of dependency (for example, "dev", "optional", etc).
        +
        java.lang.StringgetPackageName() +
        Gets the package name referenced by the dependency.
        +
        java.util.Map<java.lang.String,​java.lang.Object>getProperties() +
        Gets the additional properties of the object.
        +
        java.util.Optional<java.lang.Object>getProperty​(java.lang.String name) +
        Gets a specific property if present.
        +
        <T> java.util.Optional<T>getProperty​(java.lang.String name, + java.lang.Class<T> type) +
        Gets an additional property of a specific type.
        +
        java.lang.StringgetVersion() +
        Gets the version string of the dependency.
        +
        inthashCode() 
        SymbolDependency.BuildertoBuilder() +
        Take this object and create a builder that contains all of the + current property values of this object.
        +
        java.lang.StringtoString() 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          gatherDependencies

          +
          public static java.util.Map<java.lang.String,​java.util.Map<java.lang.String,​SymbolDependency>> gatherDependencies​(java.util.stream.Stream<SymbolDependency> symbolStream)
          +
          Gets a mapping of all dependencies used by the provided symbols. + +

          Given a stream of symbols, the dependencies of the symbol are gathered into + a map of the dependencyType to a map of a package name to package version. + +

          By default, when two versions conflict, an exception is thrown. In the + case the a conflict is possible or it is necessary to detect incompatibilities, + use gatherDependencies(Stream, BinaryOperator) and provide a + custom version merge function.

          +
          +
          Parameters:
          +
          symbolStream - Stream of symbols to compute from.
          +
          Returns:
          +
          Returns a map of dependency types to a map of package to version.
          +
          Throws:
          +
          CodegenException - when two package versions conflict.
          +
          +
          • +
        + + + +
          +
        • +

          gatherDependencies

          +
          public static java.util.Map<java.lang.String,​java.util.Map<java.lang.String,​SymbolDependency>> gatherDependencies​(java.util.stream.Stream<SymbolDependency> symbolStream,
+                                                                                                                              java.util.function.BinaryOperator<SymbolDependency> versionMergeFunction)
          +
          Gets a mapping of all dependencies used by the provided symbols. + +

          Given a stream of symbols, the dependencies of the symbol are gathered into + a map of the dependencyType to a map of a package name to package version. + Dependencies are sorted while they are collected, meaning that newer versions + of a conflicting dependency typically take precedence over older versions. + However, this is not always true with a natural sort order + (e.g., 0.9 and 0.10). + +

          versionMergeFunction is invoked each time a package import version + of a package conflicts with another version of the same package for the + same dependency type. The function accepts the dependency type, the package + name, the previous version that was registered, the new conflicting version, + and is expected to return the version that should be used or can throw in + the case of an incompatible conflict. It is a target-specific concern to + determine if two version are compatible or to find an acceptable compromise + between the two versions.

          +
          +
          Parameters:
          +
          symbolStream - Stream of symbols to compute from.
          +
          versionMergeFunction - Function that determines which two conflicting versions wins.
          +
          Returns:
          +
          Returns a map of dependency types to a map of package to version.
          +
          +
          • +
        + + + +
          +
        • +

          getDependencyType

          +
          public java.lang.String getDependencyType()
          +
          Gets the type of dependency (for example, "dev", "optional", etc). + +

          This value defaults to an empty string if not explicitly set.

          +
          +
          Returns:
          +
          Returns the dependency type.
          +
          +
          • +
        + + + +
          +
        • +

          getPackageName

          +
          public java.lang.String getPackageName()
          +
          Gets the package name referenced by the dependency.
          +
          +
          Returns:
          +
          Returns the package name.
          +
          +
          • +
        + + + +
          +
        • +

          getVersion

          +
          public java.lang.String getVersion()
          +
          Gets the version string of the dependency.
          +
          +
          Returns:
          +
          Returns the version.
          +
          +
          • +
        + + + +
          +
        • +

          getDependencies

          +
          public java.util.List<SymbolDependency> getDependencies()
          +
          Description copied from interface: SymbolDependencyContainer
          +
          Gets the list of dependencies that this object introduces. + +

          A dependency is a dependency on another package that a Symbol + or type requires. It is quite different from a reference since a + reference only refers to a symbol; a reference provides no context + as to whether or not a dependency is required or the dependency's + coordinates.

          +
          +
          Specified by:
          +
          getDependencies in interface SymbolDependencyContainer
          +
          Returns:
          +
          Returns the dependencies.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          • +
        + + + +
          +
        • +

          compareTo

          +
          public int compareTo​(SymbolDependency other)
          +
          Dependencies can be sorted based on the natural sort order of + the dependencyType, packageName, and finally the version. + +
          +
          +
          Specified by:
          +
          compareTo in interface java.lang.Comparable<SymbolDependency>
          +
          +
          • +
        + + + +
          +
        • +

          getProperties

          +
          public java.util.Map<java.lang.String,​java.lang.Object> getProperties()
          +
          Gets the additional properties of the object.
          +
          +
          Returns:
          +
          Returns a map of additional property strings.
          +
          +
          • +
        + + + +
          +
        • +

          getProperty

          +
          public java.util.Optional<java.lang.Object> getProperty​(java.lang.String name)
          +
          Gets a specific property if present.
          +
          +
          Parameters:
          +
          name - Property to retrieve.
          +
          Returns:
          +
          Returns the optionally found property.
          +
          +
          • +
        + + + +
          +
        • +

          getProperty

          +
          public <T> java.util.Optional<T> getProperty​(java.lang.String name,
+                                             java.lang.Class<T> type)
          +
          Gets an additional property of a specific type.
          +
          +
          Type Parameters:
          +
          T - Type of value to expect.
          +
          Parameters:
          +
          name - Name of the property to get.
          +
          type - Type of value to expect.
          +
          Returns:
          +
          Returns a map of additional property strings.
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if the value is not of the given type.
          +
          +
          • +
        + + + +
          +
        • +

          expectProperty

          +
          public java.lang.Object expectProperty​(java.lang.String name)
          +
          Gets a specific additional property or throws if missing.
          +
          +
          Parameters:
          +
          name - Property to retrieve.
          +
          Returns:
          +
          Returns the found property.
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if the property is not present.
          +
          +
          • +
        + + + +
          +
        • +

          expectProperty

          +
          public <T> T expectProperty​(java.lang.String name,
+                            java.lang.Class<T> type)
          +
          Gets a specific additional property or throws if missing or if the + property is not an instance of the given type.
          +
          +
          Type Parameters:
          +
          T - Type of value to expect.
          +
          Parameters:
          +
          name - Property to retrieve.
          +
          type - Type of value to expect.
          +
          Returns:
          +
          Returns the found property.
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if the property is not present.
          +
          java.lang.IllegalArgumentException - if the value is not of the given type.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolDependencyContainer.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolDependencyContainer.html new file mode 100644 index 00000000000..cecde7da814 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolDependencyContainer.html @@ -0,0 +1,266 @@ + + + + + +SymbolDependencyContainer (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core
    +

    Interface SymbolDependencyContainer

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getDependencies

          +
          java.util.List<SymbolDependency> getDependencies()
          +
          Gets the list of dependencies that this object introduces. + +

          A dependency is a dependency on another package that a Symbol + or type requires. It is quite different from a reference since a + reference only refers to a symbol; a reference provides no context + as to whether or not a dependency is required or the dependency's + coordinates.

          +
          +
          Returns:
          +
          Returns the dependencies.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolProvider.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolProvider.html new file mode 100644 index 00000000000..0a3affb659e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolProvider.html @@ -0,0 +1,352 @@ + + + + + +SymbolProvider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core
    +

    Interface SymbolProvider

    +
    +
    +
    +
      +
    • +
      +
      All Known Implementing Classes:
      +
      ReservedWordSymbolProvider, TracingSymbolProvider
      +
      +
      +
      public interface SymbolProvider
      +
      Provides Symbol objects for shapes. + +

      Implementations of this interface are used to determine what file a + shape is defined within, what namespace/module/package a shape is defined + in, converts shapes to class/struct/interface names, converts shapes to + function/method names, converts shapes to member/property names, and + creates variable names from strings. + +

      Method names MUST account for reserved words and the syntax constraints + of the target language. This typically means that implementations will + leverage one or more internal instances of ReservedWords.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          toSymbol

          +
          Symbol toSymbol​(Shape shape)
          +
          Gets the symbol to define for the given shape. + +

          A "symbol" represents the qualified name of a type in a target + programming language. + +

            +
          • When given a structure, union, resource, or service shape, + this method should provide the namespace and name of the type to + generate.
            • +
          • When given a simple type like a string, number, or timestamp, + this method should return the language-specific type of the + shape.
            • +
          • When given a member shape, this method should return the + language specific type to use as the target of the member.
            • +
          • When given a list, set, or map, this method should return the + language specific type to use for the shape (e.g., a map shape for + a Python code generator might return "dict".
            • +
          +
          +
          Parameters:
          +
          shape - Shape to get the class name of.
          +
          Returns:
          +
          Returns the generated class name.
          +
          +
          • +
        + + + +
          +
        • +

          toMemberName

          +
          default java.lang.String toMemberName​(MemberShape shape)
          +
          Converts a member shape to a member/property name of a containing + data structure. + +

          The default implementation will return the member name of + the provided shape ID and should be overridden if necessary.

          +
          +
          Parameters:
          +
          shape - Shape to convert.
          +
          Returns:
          +
          Returns the converted member name.
          +
          +
          • +
        + + + +
          +
        • +

          cache

          +
          static SymbolProvider cache​(SymbolProvider delegate)
          +
          Decorates a SymbolProvider with a cache and returns the + decorated SymbolProvider. + +

          The results of calling toSymbol and toMemberName + on delegate are cached using a thread-safe cache. + + 

          + 
+ SymbolProvider delegate = createComplexProvider(myModel);
+ SymbolProvider cachingProvider = SymbolProvider.cache(delegate);
+ 
+
          +
          +
          Parameters:
          +
          delegate - Symbol provider to wrap and cache its results.
          +
          Returns:
          +
          Returns the wrapped SymbolProvider.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolReference.Builder.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolReference.Builder.html new file mode 100644 index 00000000000..e5ba48a6a0b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolReference.Builder.html @@ -0,0 +1,454 @@ + + + + + +SymbolReference.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core
    +

    Class SymbolReference.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.codegen.core.SymbolReference.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          symbol

          +
          public SymbolReference.Builder symbol​(Symbol symbol)
          +
          Sets the Symbol referenced by the SymbolReference.
          +
          +
          Parameters:
          +
          symbol - Symbol to reference.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          options

          +
          public SymbolReference.Builder options​(java.util.Set<SymbolReference.Option> options)
          +
          Replaces the Set of Options to the SymbolReference.
          +
          +
          Parameters:
          +
          options - Options to add.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          options

          +
          public SymbolReference.Builder options​(SymbolReference.Option... options)
          +
          Replaces the array of Options in the SymbolReference.
          +
          +
          Parameters:
          +
          options - Options to add.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          alias

          +
          public SymbolReference.Builder alias​(java.lang.String alias)
          +
          Adds an alias to the SymbolReference. + +

          An alias is used in some programming languages to change the + way a symbol is referenced in a source file. Aliases are often used + for de-conflicting symbols.

          +
          +
          Parameters:
          +
          alias - Alias to assign the symbol.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          putProperty

          +
          public T putProperty​(java.lang.String key,
+                     java.lang.Object value)
          +
          Sets a specific custom property.
          +
          +
          Parameters:
          +
          key - Key to set.
          +
          value - Value to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          removeProperty

          +
          public T removeProperty​(java.lang.String key)
          +
          Removes a specific custom property.
          +
          +
          Parameters:
          +
          key - Key to remove.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          properties

          +
          public T properties​(java.util.Map<java.lang.String,​java.lang.Object> properties)
          +
          Replaces all of the custom properties.
          +
          +
          Parameters:
          +
          properties - Custom properties to replace with.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolReference.ContextOption.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolReference.ContextOption.html new file mode 100644 index 00000000000..941ffc2664c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolReference.ContextOption.html @@ -0,0 +1,393 @@ + + + + + +SymbolReference.ContextOption (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core
    +

    Enum SymbolReference.ContextOption

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable, java.lang.Comparable<SymbolReference.ContextOption>, SymbolReference.Option
      +
      +
      +
      Enclosing class:
      +
      SymbolReference
      +
      +
      +
      public static enum SymbolReference.ContextOption
+extends java.lang.Enum<SymbolReference.ContextOption>
+implements SymbolReference.Option
      +
      Options used to control the context of when the symbol reference is needed. + +

      These context options are used to define the context in which one symbol + refers to another. For example, if a reference is only needed when the symbol + is defined and not needed when the symbol is used, then code generators can + automatically add the necessary imports for each circumstance.

      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        DECLARE +
        Indicates that the referenced symbol is needed when declaring the symbol.
        +
        USE +
        Indicates that the referenced symbol is needed when importing/using the symbol.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static SymbolReference.ContextOptionvalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static SymbolReference.ContextOption[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static SymbolReference.ContextOption[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (SymbolReference.ContextOption c : SymbolReference.ContextOption.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static SymbolReference.ContextOption valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolReference.Option.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolReference.Option.html new file mode 100644 index 00000000000..a728e93433e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolReference.Option.html @@ -0,0 +1,197 @@ + + + + + +SymbolReference.Option (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core
    +

    Interface SymbolReference.Option

    +
    +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolReference.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolReference.html new file mode 100644 index 00000000000..93210b78acc --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolReference.html @@ -0,0 +1,750 @@ + + + + + +SymbolReference (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core
    +

    Class SymbolReference

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.codegen.core.SymbolReference
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static class SymbolReference.Builder +
        Builds a SymbolReference.
        +
        static class SymbolReference.ContextOption +
        Options used to control the context of when the symbol reference is needed.
        +
        static interface SymbolReference.Option +
        Top-level interface for all SymbolReference options.
        +
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static SymbolReference.Builderbuilder() 
        booleanequals​(java.lang.Object o) 
        java.lang.ObjectexpectProperty​(java.lang.String name) +
        Gets a specific additional property or throws if missing.
        +
        <T> TexpectProperty​(java.lang.String name, + java.lang.Class<T> type) +
        Gets a specific additional property or throws if missing or if the + property is not an instance of the given type.
        +
        java.lang.StringgetAlias() +
        Gets the alias to use when referring to the Symbol.
        +
        java.util.List<SymbolDependency>getDependencies() +
        Gets the list of dependencies that this object introduces.
        +
        java.util.Set<SymbolReference.Option>getOptions() +
        Gets all of the reference options.
        +
        java.util.Map<java.lang.String,​java.lang.Object>getProperties() +
        Gets the additional properties of the object.
        +
        java.util.Optional<java.lang.Object>getProperty​(java.lang.String name) +
        Gets a specific property if present.
        +
        <T> java.util.Optional<T>getProperty​(java.lang.String name, + java.lang.Class<T> type) +
        Gets an additional property of a specific type.
        +
        SymbolgetSymbol() +
        Gets the referenced symbol.
        +
        java.util.List<Symbol>getSymbols() +
        Returns any Symbol objects contained in the object.
        +
        inthashCode() 
        booleanhasOption​(SymbolReference.Option option) +
        Checks if the given option is set on the symbol.
        +
        SymbolReference.BuildertoBuilder() +
        Take this object and create a builder that contains all of the + current property values of this object.
        +
        java.lang.StringtoString() 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          SymbolReference

          +
          public SymbolReference​(Symbol symbol,
+                       SymbolReference.Option... options)
          +
          +
          Parameters:
          +
          symbol - Symbol that is referenced.
          +
          options - Options to store with the reference.
          +
          +
          • +
        + + + +
          +
        • +

          SymbolReference

          +
          public SymbolReference​(Symbol symbol,
+                       java.util.Map<java.lang.String,​java.lang.Object> properties,
+                       SymbolReference.Option... options)
          +
          +
          Parameters:
          +
          symbol - Symbol that is referenced.
          +
          properties - Bag of reference properties.
          +
          options - Options to store with the reference.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getSymbol

          +
          public Symbol getSymbol()
          +
          Gets the referenced symbol.
          +
          +
          Returns:
          +
          Returns the symbol.
          +
          +
          • +
        + + + +
          +
        • +

          getAlias

          +
          public java.lang.String getAlias()
          +
          Gets the alias to use when referring to the Symbol. + +

          The value of getSymbol().getName() is returned if no + alias was explicitly configured on the reference. + +

          An alias is used in some programming languages to change the + way a symbol is referenced in a source file. Aliases are often used + for de-conflicting symbols.

          +
          +
          Returns:
          +
          Returns the alias.
          +
          +
          • +
        + + + +
          +
        • +

          getOptions

          +
          public java.util.Set<SymbolReference.Option> getOptions()
          +
          Gets all of the reference options.
          +
          +
          Returns:
          +
          Returns the options set.
          +
          +
          • +
        + + + +
          +
        • +

          hasOption

          +
          public boolean hasOption​(SymbolReference.Option option)
          +
          Checks if the given option is set on the symbol.
          +
          +
          Parameters:
          +
          option - Option to check.
          +
          Returns:
          +
          Returns true if this option is set.
          +
          +
          • +
        + + + +
          +
        • +

          getSymbols

          +
          public java.util.List<Symbol> getSymbols()
          +
          Description copied from interface: SymbolContainer
          +
          Returns any Symbol objects contained in the object.
          +
          +
          Specified by:
          +
          getSymbols in interface SymbolContainer
          +
          Returns:
          +
          Returns a collection of Symbols.
          +
          +
          • +
        + + + +
          +
        • +

          getDependencies

          +
          public java.util.List<SymbolDependency> getDependencies()
          +
          Description copied from interface: SymbolDependencyContainer
          +
          Gets the list of dependencies that this object introduces. + +

          A dependency is a dependency on another package that a Symbol + or type requires. It is quite different from a reference since a + reference only refers to a symbol; a reference provides no context + as to whether or not a dependency is required or the dependency's + coordinates.

          +
          +
          Specified by:
          +
          getDependencies in interface SymbolDependencyContainer
          +
          Returns:
          +
          Returns the dependencies.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          getProperties

          +
          public java.util.Map<java.lang.String,​java.lang.Object> getProperties()
          +
          Gets the additional properties of the object.
          +
          +
          Returns:
          +
          Returns a map of additional property strings.
          +
          +
          • +
        + + + +
          +
        • +

          getProperty

          +
          public java.util.Optional<java.lang.Object> getProperty​(java.lang.String name)
          +
          Gets a specific property if present.
          +
          +
          Parameters:
          +
          name - Property to retrieve.
          +
          Returns:
          +
          Returns the optionally found property.
          +
          +
          • +
        + + + +
          +
        • +

          getProperty

          +
          public <T> java.util.Optional<T> getProperty​(java.lang.String name,
+                                             java.lang.Class<T> type)
          +
          Gets an additional property of a specific type.
          +
          +
          Type Parameters:
          +
          T - Type of value to expect.
          +
          Parameters:
          +
          name - Name of the property to get.
          +
          type - Type of value to expect.
          +
          Returns:
          +
          Returns a map of additional property strings.
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if the value is not of the given type.
          +
          +
          • +
        + + + +
          +
        • +

          expectProperty

          +
          public java.lang.Object expectProperty​(java.lang.String name)
          +
          Gets a specific additional property or throws if missing.
          +
          +
          Parameters:
          +
          name - Property to retrieve.
          +
          Returns:
          +
          Returns the found property.
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if the property is not present.
          +
          +
          • +
        + + + +
          +
        • +

          expectProperty

          +
          public <T> T expectProperty​(java.lang.String name,
+                            java.lang.Class<T> type)
          +
          Gets a specific additional property or throws if missing or if the + property is not an instance of the given type.
          +
          +
          Type Parameters:
          +
          T - Type of value to expect.
          +
          Parameters:
          +
          name - Property to retrieve.
          +
          type - Type of value to expect.
          +
          Returns:
          +
          Returns the found property.
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if the property is not present.
          +
          java.lang.IllegalArgumentException - if the value is not of the given type.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolWriter.Factory.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolWriter.Factory.html new file mode 100644 index 00000000000..2f508e043b8 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolWriter.Factory.html @@ -0,0 +1,308 @@ + + + + + +SymbolWriter.Factory (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core
    +

    Interface SymbolWriter.Factory<W extends SymbolWriter<W,​? extends ImportContainer>>

    +
    +
    +
    +
      +
    • +
      +
      Type Parameters:
      +
      W - Type of SymbolWriter to create.
      +
      +
      +
      All Superinterfaces:
      +
      java.util.function.BiFunction<java.lang.String,​java.lang.String,​W>
      +
      +
      +
      Enclosing class:
      +
      SymbolWriter<W extends SymbolWriter<W,​I>,​I extends ImportContainer>
      +
      +
      +
      Functional Interface:
      +
      This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
      +
      +
      +
      @FunctionalInterface
+public static interface SymbolWriter.Factory<W extends SymbolWriter<W,​? extends ImportContainer>>
+extends java.util.function.BiFunction<java.lang.String,​java.lang.String,​W>
      +
      Factory used to create a SymbolWriter. + +

      The following example shows how to implement a basic Factory. + + 

      
+ public final class MyWriterFactory implements SymbolWriter.Factory<MyWriter> {
+     \@Override
+     public MyWriter apply(String filename, String namespace) {
+         return new MyWriter(namespace);
+     }
+ }
+
      + +

      Because this class is a FunctionalInterface, it can be implemented + using a lambda expression: + + 

      
+ SymbolWriter.Factory<MyWriter> = (filename, namespace) -> new MyWriter(namespace);
+
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethodDescription
        Wapply​(java.lang.String filename, + java.lang.String namespace) +
        Creates a SymbolWriter of type W for the given + filename and namespace.
        +
        +
          +
        • + + +

          Methods inherited from interface java.util.function.BiFunction

          +andThen
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          apply

          +
          W apply​(java.lang.String filename,
+        java.lang.String namespace)
          +
          Creates a SymbolWriter of type W for the given + filename and namespace.
          +
          +
          Specified by:
          +
          apply in interface java.util.function.BiFunction<java.lang.String,​java.lang.String,​W extends SymbolWriter<W,​? extends ImportContainer>>
          +
          Parameters:
          +
          filename - Non-null filename of the writer being created.
          +
          namespace - Non-null namespace associated with the file (possibly empty string).
          +
          Returns:
          +
          Returns the created writer of type W.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolWriter.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolWriter.html new file mode 100644 index 00000000000..7735c64f7c0 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/SymbolWriter.html @@ -0,0 +1,616 @@ + + + + + +SymbolWriter (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core
    +

    Class SymbolWriter<W extends SymbolWriter<W,​I>,​I extends ImportContainer>

    +
    +
    + +
    +
      +
    • +
      +
      Type Parameters:
      +
      W - The concrete type, used to provide a fluent interface.
      +
      I - The import container used by the writer to manage imports.
      +
      +
      +
      All Implemented Interfaces:
      +
      SymbolDependencyContainer
      +
      +
      +
      Direct Known Subclasses:
      +
      TraitCodegenWriter
      +
      +
      +
      public abstract class SymbolWriter<W extends SymbolWriter<W,​I>,​I extends ImportContainer>
+extends AbstractCodeWriter<W>
+implements SymbolDependencyContainer
      +
      A SymbolWriter is a specialized AbstractCodeWriter that makes it + easier to implement code generation that utilizes Symbols and + SymbolDependency values. + +

      A SymbolWriter is expected to be subclassed, and the + subclass is expected to implement language-specific functionality + like writing documentation comments, tracking "imports", and adding + any other kinds of helpful functionality for generating source code + for a programming language. + +

      The following example shows how a subclass of SymbolWriter + should be created. SymbolWriters are expected to define a recursive + type signature (notice that MyWriter is a generic parametric + type in its own type definition). + + 

      
+ public final class MyWriter extends SymbolWriter<MyWriter, MyImportContainer> {
+     public MyWriter(String namespace) {
+         super(new MyImportContainer(namespace));
+     }
+
+     \@Override
+     public String toString() {
+         return getImportContainer().toString() + "\n\n" + super.toString();
+     }
+
+     public MyWriter someCustomMethod() {
+         // You can implement custom methods that are specific to whatever
+         // language you're implementing a generator for.
+         return this;
+     }
+ }
+
      + + +

      Formatting symbols with "T"

      + +

      SymbolWriter registers a default formatter for "T" that writes + Symbols and SymbolReferences. Imports needed by these types + are automatically registered with addUseImports(software.amazon.smithy.codegen.core.SymbolContainer) for a Symbol + and addImport(software.amazon.smithy.codegen.core.Symbol, java.lang.String, software.amazon.smithy.codegen.core.SymbolReference.ContextOption...) for a SymbolReference. Programming languages + that have a concept of namespaces can use setRelativizeSymbols(java.lang.String) to + the namespace of the SymbolWriter, and then the default symbol formatter + will relativize symbols against that namespace using Symbol.relativize(java.lang.String) + when writing the symbol as a string.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + + + +
          +
        • +

          SymbolWriter

          +
          public SymbolWriter​(I importContainer)
          +
          +
          Parameters:
          +
          importContainer - Container used to persist and filter imports based on package names.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setRelativizeSymbols

          +
          public W setRelativizeSymbols​(java.lang.String relativizeSymbols)
          +
          Sets a string used to relativize Symbols formatted using the default W + implementation used by SymbolWriter in the current state. + +

          In many programming languages, when referring to types in the same namespace as + the current scope of a SymbolWriter, the symbols written in that scope don't need + to be fully-qualified. They can just reference the unqualified type name. By setting + a value for relativizeSymbols, if the result of Symbol.getNamespace() + is equal to relativizeSymbols, then the unqualified name of the symbol is + written to the SymbolWriter when the default implementation of W + is written. Symbols that refer to types in other namespaces will write the fully + qualified type. + +

          Note: This method may have no effect if a programming language + does not use namespaces or concepts like namespaces or if W has been + overridden with another implementation.

          +
          +
          Parameters:
          +
          relativizeSymbols - The package name, namespace, etc to relativize symbols with.
          +
          Returns:
          +
          Returns the SymbolWriter.
          +
          +
          • +
        + + + +
          +
        • +

          getImportContainer

          +
          public final I getImportContainer()
          +
          Gets the import container associated with the writer. + +

          The AbstractCodeWriter.toString() method of the SymbolWriter should + be overridden so that it includes the import container's contents in + the output as appropriate.

          +
          +
          Returns:
          +
          Returns the import container.
          +
          +
          • +
        + + + +
          +
        • +

          getDependencies

          +
          public final java.util.List<SymbolDependency> getDependencies()
          +
          Description copied from interface: SymbolDependencyContainer
          +
          Gets the list of dependencies that this object introduces. + +

          A dependency is a dependency on another package that a Symbol + or type requires. It is quite different from a reference since a + reference only refers to a symbol; a reference provides no context + as to whether or not a dependency is required or the dependency's + coordinates.

          +
          +
          Specified by:
          +
          getDependencies in interface SymbolDependencyContainer
          +
          Returns:
          +
          Returns the dependencies.
          +
          +
          • +
        + + + +
          +
        • +

          addDependency

          +
          public final W addDependency​(SymbolDependencyContainer dependencies)
          +
          Adds one or more dependencies to the generated code (represented as + a SymbolDependency). + +

          Tracking dependencies on a SymbolWriter allows dependencies + to be automatically aggregated and collected in order to generate + configuration files for dependency management tools (e.g., npm, + maven, etc).

          +
          +
          Parameters:
          +
          dependencies - Dependency to add.
          +
          Returns:
          +
          Returns the writer.
          +
          +
          • +
        + + + +
          +
        • +

          addUseImports

          +
          public W addUseImports​(SymbolContainer container)
          +
          Imports one or more USE symbols using the name of the symbol + (e.g., SymbolReference.ContextOption.USE references). + +

          USE references are only necessary when referring to a symbol, not + declaring the symbol. For example, when referring to a + List<Foo>, the USE references would be both the List + type and Foo type. + +

          This method may be overridden as needed.

          +
          +
          Parameters:
          +
          container - Symbols to add.
          +
          Returns:
          +
          Returns the writer.
          +
          +
          • +
        + + + + + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/TopologicalIndex.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/TopologicalIndex.html new file mode 100644 index 00000000000..d9cbed5d16e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/TopologicalIndex.html @@ -0,0 +1,440 @@ + + + + + +TopologicalIndex (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core
    +

    Class TopologicalIndex

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.codegen.core.TopologicalIndex
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      KnowledgeIndex
      +
      +
      +
      public final class TopologicalIndex
+extends java.lang.Object
+implements KnowledgeIndex
      +
      Creates a reverse-topological ordering of shapes. + +

      This kind of reverse topological ordering is useful for languages + like C++ that need to define shapes before they can be referenced. + Only non-recursive shapes are reverse-topologically ordered using + getOrderedShapes(). However, recursive shapes are queryable + through getRecursiveShapes(). When this returned Set is + iterated, recursive shapes are ordered by their degree of recursion (the + number of edges across all recursive closures), and then by shape ID + when multiple shapes have the same degree of recursion. + +

      The recursion closures of a shape can be queried using + getRecursiveClosure(ToShapeId). This method returns a list of + paths from the shape back to itself. This list can be useful for code + generation to generate different code based on if a recursive path + passes through particular types of shapes.

      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          TopologicalIndex

          +
          public TopologicalIndex​(Model model)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          of

          +
          public static TopologicalIndex of​(Model model)
          +
          Creates a new TopologicalIndex.
          +
          +
          Parameters:
          +
          model - Model to create the index from.
          +
          Returns:
          +
          The created (or previously cached) TopologicalIndex.
          +
          +
          • +
        + + + +
          +
        • +

          getOrderedShapes

          +
          public java.util.Set<Shape> getOrderedShapes()
          +
          Gets all reverse-topologically ordered shapes, including members. + +

          When the returned Set is iterated, shapes are returned in + reverse-topological. Note that the returned set does not contain + recursive shapes.

          +
          +
          Returns:
          +
          Non-recursive shapes in a reverse-topological ordered Set.
          +
          +
          • +
        + + + +
          +
        • +

          getRecursiveShapes

          +
          public java.util.Set<Shape> getRecursiveShapes()
          +
          Gets all shapes that have edges that are part of a recursive closure, + including container shapes (list/set/map/structure/union) and members. + +

          When iterated, the returned Set is ordered from fewest number + of edges to the most number of edges in the recursive closures, and then + alphabetically by shape ID when there are multiple entries with + the same number of edges.

          +
          +
          Returns:
          +
          All shapes that are part of a recursive closure.
          +
          +
          • +
        + + + +
          +
        • +

          isRecursive

          +
          public boolean isRecursive​(ToShapeId shape)
          +
          Checks if the given shape has edges with recursive references.
          +
          +
          Parameters:
          +
          shape - Shape to check.
          +
          Returns:
          +
          True if the shape has recursive edges.
          +
          +
          • +
        + + + +
          +
        • +

          getRecursiveClosure

          +
          public java.util.Set<PathFinder.Path> getRecursiveClosure​(ToShapeId shape)
          +
          Gets the recursive closure of a given shape represented as + PathFinder.Path objects. + +

          The first element of each path is the given shape, + and the last element of each path is the first shape that is + encountered a second time in the path (i.e., the point of + recursion).

          +
          +
          Parameters:
          +
          shape - Shape to get the recursive closures of.
          +
          Returns:
          +
          The closures of the shape, or an empty Set if the shape is not recursive.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/WriterDelegator.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/WriterDelegator.html new file mode 100644 index 00000000000..9994025c8ed --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/WriterDelegator.html @@ -0,0 +1,569 @@ + + + + + +WriterDelegator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core
    +

    Class WriterDelegator<W extends SymbolWriter<W,​? extends ImportContainer>>

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.codegen.core.WriterDelegator<W>
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Type Parameters:
      +
      W - The type of SymbolWriter to create and manage.
      +
      +
      +
      All Implemented Interfaces:
      +
      SymbolDependencyContainer
      +
      +
      +
      public class WriterDelegator<W extends SymbolWriter<W,​? extends ImportContainer>>
+extends java.lang.Object
+implements SymbolDependencyContainer
      +

      Creates and manages SymbolWriters for files and namespaces based + on Symbols created for a Shape. + +

      Overview

      + +

      WriterDelegator is designed to generate code in files + returned by the Symbol.getDefinitionFile() method of a Symbol. + If multiple Symbols are created that need to be defined in the same + file, then the WriterDelegator ensures that the state of code + generator associated with the file is persisted and only written when all + shapes have been generated. + +

      SymbolWriters are lazily created each time a new filename is + requested. If a SymbolWriter is already associated with a filename, + a newline (\n) is written to the file before providing access to the + SymbolWriter. All of the files and SymbolWriters stored in the + delegator are eventually written to the provided FileManifest when + the flushWriters() method is called. + +

      This class is not thread-safe. + +

      Extending WriterDelegator

      + +

      Language-specific code generators that utilize Symbol and + SymbolDependency should extend both + WriterDelegator and SymbolWriter to implement + language specific functionality. Extending these classes also makes it + easier to create new instances of them because they will be easier to work + with since generic types aren't needed in concrete implementations.

      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidflushWriters() +
        Writes each pending SymbolWriter to the FileManifest.
        +
        java.util.List<SymbolDependency>getDependencies() +
        Gets all of the dependencies that have been registered in writers + created by the WriterDelegator.
        +
        java.util.Map<java.lang.String,​W>getWriters() +
        Returns an immutable Map of created SymbolWriters.
        +
        voidsetAutomaticSeparator​(java.lang.String automaticSeparator) +
        Sets the automatic separator that is written to a SymbolWriter + each time the writer is reused.
        +
        voidsetInterceptors​(java.util.List<? extends CodeInterceptor<? extends CodeSection,​W>> interceptors) +
        Sets the list of code interceptors to registered with each newly created writer.
        +
        voiduseFileWriter​(java.lang.String filename, + java.lang.String namespace, + java.util.function.Consumer<W> writerConsumer) +
        Gets a previously created writer or creates a new one if needed.
        +
        voiduseFileWriter​(java.lang.String filename, + java.util.function.Consumer<W> writerConsumer) +
        Gets a previously created SymbolWriter or creates a new one + if needed.
        +
        voiduseShapeWriter​(Shape shape, + java.util.function.Consumer<W> writerConsumer) +
        Gets or creates a writer for a Shape by converting the Shape + to a Symbol.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + +
          +
        • +

          setInterceptors

          +
          public void setInterceptors​(java.util.List<? extends CodeInterceptor<? extends CodeSection,​W>> interceptors)
          +
          Sets the list of code interceptors to registered with each newly created writer.
          +
          +
          Parameters:
          +
          interceptors - Interceptors to register.
          +
          +
          • +
        + + + +
          +
        • +

          getDependencies

          +
          public java.util.List<SymbolDependency> getDependencies()
          +
          Gets all of the dependencies that have been registered in writers + created by the WriterDelegator. + +

          This method essentially just aggregates the results of calling + SymbolWriter.getDependencies() of each created writer into + a single array. + +

          This method may be overridden as needed (for example, to add in + some list of default dependencies or to inject other generative + dependencies).

          +
          +
          Specified by:
          +
          getDependencies in interface SymbolDependencyContainer
          +
          Returns:
          +
          Returns all the dependencies used in each writer.
          +
          +
          • +
        + + + +
          +
        • +

          flushWriters

          +
          public void flushWriters()
          +
          Writes each pending SymbolWriter to the FileManifest. + +

          The toString method is called on each writer to generate + the code to write to the manifest. + +

          This method clears out the managed SymbolWriters, meaning a + subsequent call to getWriters() will return an empty map. + +

          This method may be overridden as needed.

          +
          • +
        + + + +
          +
        • +

          getWriters

          +
          public final java.util.Map<java.lang.String,​W> getWriters()
          +
          Returns an immutable Map of created SymbolWriters. + +

          Each map key is the relative filename where the code will be written + in the FileManifest, and each map value is the associated + SymbolWriter of type T.

          +
          +
          Returns:
          +
          Returns the immutable map of files to writers.
          +
          +
          • +
        + + + +
          +
        • +

          useFileWriter

          +
          public final void useFileWriter​(java.lang.String filename,
+                                java.util.function.Consumer<W> writerConsumer)
          +
          Gets a previously created SymbolWriter or creates a new one + if needed. + +

          If a writer already exists, a newline is automatically appended to + the writer (either a newline or whatever value was set on + setAutomaticSeparator(java.lang.String)).

          +
          +
          Parameters:
          +
          filename - Name of the file to create.
          +
          writerConsumer - Consumer that is expected to write to the SymbolWriter.
          +
          +
          • +
        + + + +
          +
        • +

          useFileWriter

          +
          public final void useFileWriter​(java.lang.String filename,
+                                java.lang.String namespace,
+                                java.util.function.Consumer<W> writerConsumer)
          +
          Gets a previously created writer or creates a new one if needed. + +

          If a writer already exists, a newline is automatically appended to + the writer (either a newline or whatever value was set on + setAutomaticSeparator(java.lang.String)).

          +
          +
          Parameters:
          +
          filename - Name of the file to create.
          +
          namespace - Namespace associated with the file (or an empty string).
          +
          writerConsumer - Consumer that is expected to write to the SymbolWriter.
          +
          +
          • +
        + + + +
          +
        • +

          useShapeWriter

          +
          public void useShapeWriter​(Shape shape,
+                           java.util.function.Consumer<W> writerConsumer)
          +
          Gets or creates a writer for a Shape by converting the Shape + to a Symbol. + +

          Any dependencies (i.e., SymbolDependency) required by the + Symbol are automatically registered with the writer. + +

          Any imports required to declare the Symbol in code (i.e., + SymbolReference.ContextOption.DECLARE) are automatically + registered with the writer. + +

          If a writer already exists, a newline is automatically appended to + the writer (either a newline or whatever value was set on + setAutomaticSeparator(java.lang.String)). + +

          This method may be overridden as needed.

          +
          +
          Parameters:
          +
          shape - Shape to create the writer for.
          +
          writerConsumer - Consumer that is expected to write to the SymbolWriter.
          +
          +
          • +
        + + + +
          +
        • +

          setAutomaticSeparator

          +
          public final void setAutomaticSeparator​(java.lang.String automaticSeparator)
          +
          Sets the automatic separator that is written to a SymbolWriter + each time the writer is reused. + +

          The default line separator is a newline ("\n"), but some + implementations may wish to use an alternative value (e.g., "\r\n") or + to disable the newline separator altogether by proving an empty string.

          +
          +
          Parameters:
          +
          automaticSeparator - The non-null line separator to use.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/CodegenDirector.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/CodegenDirector.html new file mode 100644 index 00000000000..bc7d0aa5e6f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/CodegenDirector.html @@ -0,0 +1,759 @@ + + + + + +CodegenDirector (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core.directed
    +

    Class CodegenDirector<W extends SymbolWriter<W,​? extends ImportContainer>,​I extends SmithyIntegration<S,​W,​C>,​C extends CodegenContext<S,​W,​I>,​S>

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.codegen.core.directed.CodegenDirector<W,​I,​C,​S>
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CodegenDirector

          +
          public CodegenDirector()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          simplifyModelForServiceCodegen

          +
          public static Model simplifyModelForServiceCodegen​(Model model,
+                                                   ShapeId service,
+                                                   ModelTransformer transformer)
          +
          Simplifies a Smithy model for code generation of a single service. + +
            +
          • Flattens error hierarchies onto every operation.
            • +
          • Flattens mixins
            • +
          + +

          Note: This transform is applied automatically by a code + generator if performDefaultCodegenTransforms() is + set to true.

          +
          +
          Parameters:
          +
          model - Model being code generated.
          +
          service - Service being generated.
          +
          transformer - Model transformer to use.
          +
          Returns:
          +
          Returns the updated model.
          +
          +
          • +
        + + + +
          +
        • +

          integrationClass

          +
          public void integrationClass​(java.lang.Class<I> integrationClass)
          +
          Sets the required class used for SmithyIntegrations.
          +
          +
          Parameters:
          +
          integrationClass - SmithyIntegration class.
          +
          +
          • +
        + + + +
          +
        • +

          service

          +
          public void service​(ShapeId service)
          +
          Sets the required service being generated.
          +
          +
          Parameters:
          +
          service - Service to generate.
          +
          +
          • +
        + + + +
          +
        • +

          directedCodegen

          +
          public void directedCodegen​(DirectedCodegen<C,​S,​I> directedCodegen)
          +
          Sets the required DirectedCodegen implementation to invoke.
          +
          +
          Parameters:
          +
          directedCodegen - Directed code generator to run.
          +
          +
          • +
        + + + +
          +
        • +

          model

          +
          public void model​(Model model)
          +
          Sets the required model to generate from.
          +
          +
          Parameters:
          +
          model - Model to generate from.
          +
          +
          • +
        + + + + + +
          +
        • +

          settings

          +
          public void settings​(S settings)
          +
          Sets the required settings object used for code generation. + +

          integrationSettings MUST also be set.

          +
          +
          Parameters:
          +
          settings - Settings object.
          +
          +
          • +
        + + + +
          +
        • +

          settings

          +
          public S settings​(java.lang.Class<S> settingsType,
+                  Node settingsNode)
          +
          Sets the required settings object used for code generation using + a Node. + +

          A Node value is used by Smithy-Build plugins to configure settings. + This method is a helper method that uses Smithy's fairly simple + object-mapper to deserialize a node into the desired settings type. + You will need to manually deserialize your settings if using types that + are not supported by Smithy's NodeMapper. + +

          This will also set integrationSettings if the integrations + key is present.

          +
          +
          Parameters:
          +
          settingsType - Settings type to deserialize into.
          +
          settingsNode - Settings node value to deserialize.
          +
          Returns:
          +
          Returns the deserialized settings as this is needed to provide a service shape ID.
          +
          +
          • +
        + + + +
          +
        • +

          integrationSettings

          +
          public void integrationSettings​(ObjectNode integrationSettings)
          +
          Sets the settings node to be passed to integrations. + +

          Generators MUST set this with the integrations key from their + plugin settings. + + 

          
+ {
+     "version": "1.0",
+     "projections": {
+         "codegen-projection": {
+             "plugins": {
+                 "code-generator": {
+                     "service": "com.example#DocumentedService",
+                     "integrations": {
+                         "my-integration": {
+                             "example-setting": "foo"
+                         }
+                     }
+                 }
+             }
+         }
+     }
+ }
+
          + +

          In this example, the value of the integrations key is what must + be passed to this method. The value of the my-integration key will + then be provided to an integration with the name my-integration.

          +
          +
          Parameters:
          +
          integrationSettings - Settings used to configure integrations.
          +
          +
          • +
        + + + +
          +
        • +

          fileManifest

          +
          public void fileManifest​(FileManifest fileManifest)
          +
          Sets the required file manifest used to write files to disk.
          +
          +
          Parameters:
          +
          fileManifest - File manifest to write files.
          +
          +
          • +
        + + + +
          +
        • +

          integrationFinder

          +
          public void integrationFinder​(java.util.function.Supplier<java.lang.Iterable<I>> integrationFinder)
          +
          Sets a custom implementation for finding SmithyIntegrations. + +

          Most implementations can use integrationClassLoader(ClassLoader).

          +
          +
          Parameters:
          +
          integrationFinder - Smithy integration finder.
          +
          +
          • +
        + + + +
          +
        • +

          integrationClassLoader

          +
          public void integrationClassLoader​(java.lang.ClassLoader classLoader)
          +
          Sets a custom class loader for finding implementations of SmithyIntegration.
          +
          +
          Parameters:
          +
          classLoader - Class loader to find integrations.* @return Returns self.
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          createDedicatedInputsAndOutputs

          +
          public void createDedicatedInputsAndOutputs​(java.lang.String inputSuffix,
+                                            java.lang.String outputSuffix)
          +
          Generates dedicated input and output shapes for every operation if the operation + doesn't already have them.
          +
          +
          Parameters:
          +
          inputSuffix - Suffix to use for input shapes (e.g., "Input").
          +
          outputSuffix - Suffix to use for output shapes (e.g., "Output").
          +
          See Also:
          +
          ModelTransformer.createDedicatedInputAndOutput(Model, String, String)
          +
          +
          • +
        + + + +
          +
        • +

          changeStringEnumsToEnumShapes

          +
          public void changeStringEnumsToEnumShapes​(boolean synthesizeEnumNames)
          +
          Changes each compatible string shape with the enum trait to an enum shape.
          +
          +
          Parameters:
          +
          synthesizeEnumNames - Whether enums without names should have names synthesized if possible.
          +
          See Also:
          +
          ModelTransformer.changeStringEnumsToEnumShapes(Model, boolean)
          +
          +
          • +
        + + + +
          +
        • +

          shapeGenerationOrder

          +
          public void shapeGenerationOrder​(ShapeGenerationOrder order)
          +
          Sets the shapes order for code generation. + +

          CodegenDirector order the shapes appropriately before passing them to the code generators. + The default order is topological, and can be overridden with this method

          +
          +
          Parameters:
          +
          order - the order to use for the shape generation process.
          +
          +
          • +
        + + + +
          +
        • +

          sortMembers

          +
          public void sortMembers()
          +
          Sorts all members of the model prior to codegen. + +

          This should only be used by languages where changing the order of members + in a structure or union is a backward compatible change (i.e., not C, C++, Rust, etc). + Once this is performed, there's no need to ever explicitly sort members + throughout the rest of code generation.

          +
          • +
        + + + +
          +
        • +

          run

          +
          public void run()
          +
          Finalizes the Runner and performs directed code generation.
          +
          +
          Throws:
          +
          java.lang.IllegalStateException - if a required value has not been provided.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/ContextualDirective.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/ContextualDirective.html new file mode 100644 index 00000000000..980e6f878df --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/ContextualDirective.html @@ -0,0 +1,328 @@ + + + + + +ContextualDirective (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core.directed
    +

    Class ContextualDirective<C extends CodegenContext<S,​?,​?>,​S>

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          context

          +
          public final C context()
          +
          +
          Returns:
          +
          Returns the codegen context object.
          +
          +
          • +
        + + + +
          +
        • +

          fileManifest

          +
          public final FileManifest fileManifest()
          +
          +
          Returns:
          +
          Gets the FileManifest being written to for code generation.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/CreateContextDirective.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/CreateContextDirective.html new file mode 100644 index 00000000000..2780ac1262c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/CreateContextDirective.html @@ -0,0 +1,351 @@ + + + + + +CreateContextDirective (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core.directed
    +

    Class CreateContextDirective<S,​I extends SmithyIntegration<S,​?,​?>>

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          symbolProvider

          +
          public SymbolProvider symbolProvider()
          +
          +
          Returns:
          +
          Returns the SymbolProvider used during codegen.
          +
          +
          • +
        + + + +
          +
        • +

          fileManifest

          +
          public FileManifest fileManifest()
          +
          +
          Returns:
          +
          Gets the FileManifest being written to for code generation.
          +
          +
          • +
        + + + +
          +
        • +

          integrations

          +
          public java.util.List<I> integrations()
          +
          +
          Returns:
          +
          Returns the list of Integrations used during codegen.
          +
          +
          • +
        + + + +
          +
        • +

          supportedProtocols

          +
          public java.util.Map<ShapeId,​Trait> supportedProtocols()
          +
          Get a map of supported protocols on the service shape in the form of shape ID to + the definition of the trait.
          +
          +
          Returns:
          +
          Returns the protocol shape IDs of the service.
          +
          See Also:
          +
          ServiceIndex
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/CreateSymbolProviderDirective.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/CreateSymbolProviderDirective.html new file mode 100644 index 00000000000..73e916bf62e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/CreateSymbolProviderDirective.html @@ -0,0 +1,241 @@ + + + + + +CreateSymbolProviderDirective (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core.directed
    +

    Class CreateSymbolProviderDirective<S>

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      + +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/CustomizeDirective.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/CustomizeDirective.html new file mode 100644 index 00000000000..656e18d6b82 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/CustomizeDirective.html @@ -0,0 +1,255 @@ + + + + + +CustomizeDirective (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core.directed
    +

    Class CustomizeDirective<C extends CodegenContext<S,​?,​?>,​S>

    +
    +
    + +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/DirectedCodegen.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/DirectedCodegen.html new file mode 100644 index 00000000000..18e863c1e78 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/DirectedCodegen.html @@ -0,0 +1,547 @@ + + + + + +DirectedCodegen (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core.directed
    +

    Interface DirectedCodegen<C extends CodegenContext<S,​?,​I>,​S,​I extends SmithyIntegration<S,​?,​C>>

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          createContext

          +
          C createContext​(CreateContextDirective<S,​I> directive)
          +
          Creates the codegen context object.
          +
          +
          Parameters:
          +
          directive - Directive context data.
          +
          Returns:
          +
          Returns the created context object used by the rest of the directed generation.
          +
          +
          • +
        + + + +
          +
        • +

          generateService

          +
          void generateService​(GenerateServiceDirective<C,​S> directive)
          +
          Generates the code needed for a service shape.
          +
          +
          Parameters:
          +
          directive - Directive to perform.
          +
          +
          • +
        + + + +
          +
        • +

          generateResource

          +
          default void generateResource​(GenerateResourceDirective<C,​S> directive)
          +
          Generates the code needed for a resource shape.
          +
          +
          Parameters:
          +
          directive - Directive to perform.
          +
          +
          • +
        + + + +
          +
        • +

          generateOperation

          +
          default void generateOperation​(GenerateOperationDirective<C,​S> directive)
          +
          Generates the code needed for an operation shape.
          +
          +
          Parameters:
          +
          directive - Directive to perform.
          +
          +
          • +
        + + + +
          +
        • +

          generateStructure

          +
          void generateStructure​(GenerateStructureDirective<C,​S> directive)
          +
          Generates the code needed for a structure shape. + +

          This method should not be invoked for structures marked with the + error trait.

          +
          +
          Parameters:
          +
          directive - Directive to perform.
          +
          +
          • +
        + + + +
          +
        • +

          generateError

          +
          void generateError​(GenerateErrorDirective<C,​S> directive)
          +
          Generates the code needed for an error structure.
          +
          +
          Parameters:
          +
          directive - Directive to perform.
          +
          +
          • +
        + + + +
          +
        • +

          generateUnion

          +
          void generateUnion​(GenerateUnionDirective<C,​S> directive)
          +
          Generates the code needed for a union shape.
          +
          +
          Parameters:
          +
          directive - Directive to perform.
          +
          +
          • +
        + + + +
          +
        • +

          generateEnumShape

          +
          void generateEnumShape​(GenerateEnumDirective<C,​S> directive)
          +
          Generates the code needed for an enum shape, whether it's a string shape + marked with the enum trait, or a proper enum shape introduced in Smithy + IDL 2.0.
          +
          +
          Parameters:
          +
          directive - Directive to perform.
          +
          +
          • +
        + + + +
          +
        • +

          generateIntEnumShape

          +
          void generateIntEnumShape​(GenerateIntEnumDirective<C,​S> directive)
          +
          Generates the code needed for an intEnum shape.
          +
          +
          Parameters:
          +
          directive - Directive to perform.
          +
          +
          • +
        + + + +
          +
        • +

          customizeBeforeShapeGeneration

          +
          default void customizeBeforeShapeGeneration​(CustomizeDirective<C,​S> directive)
          +
          Performs any necessary code generation before all shapes are generated, + using the created codegen context object.
          +
          +
          Parameters:
          +
          directive - Directive to perform.
          +
          +
          • +
        + + + +
          +
        • +

          customizeBeforeIntegrations

          +
          default void customizeBeforeIntegrations​(CustomizeDirective<C,​S> directive)
          +
          Performs any necessary code generation after all shapes are generated, + using the created codegen context object before integrations perform + customizations.
          +
          +
          Parameters:
          +
          directive - Directive to perform.
          +
          +
          • +
        + + + +
          +
        • +

          customizeAfterIntegrations

          +
          default void customizeAfterIntegrations​(CustomizeDirective<C,​S> directive)
          +
          Performs any necessary code generation after all shapes are generated, + using the created codegen context object after all integrations have + performed customizations. + +

          This method should be used to do things like: + +

            +
          • Flush any code writers created by your WriterDelegator.
            • +
          • Generate dependency manifests (e.g., poms) from WriterDelegator.
            • +
          • Perform any remaining codegen tasks like formatting or validating the generated output.
            • +
          +
          +
          Parameters:
          +
          directive - Directive to perform.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/Directive.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/Directive.html new file mode 100644 index 00000000000..ddc22a6dbfb --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/Directive.html @@ -0,0 +1,355 @@ + + + + + +Directive (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core.directed
    +

    Class Directive<S>

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.codegen.core.directed.Directive<S>
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          model

          +
          public final Model model()
          +
          +
          Returns:
          +
          Gets the model being code generated.
          +
          +
          • +
        + + + +
          +
        • +

          settings

          +
          public final S settings()
          +
          +
          Returns:
          +
          Gets code generation settings.
          +
          +
          • +
        + + + +
          +
        • +

          service

          +
          public final ServiceShape service()
          +
          +
          Returns:
          +
          Gets the service being generated.
          +
          +
          • +
        + + + +
          +
        • +

          connectedShapes

          +
          public final java.util.Map<ShapeId,​Shape> connectedShapes()
          +
          +
          Returns:
          +
          Returns a map of shapes connected to the service.
          +
          +
          • +
        + + + +
          +
        • +

          operations

          +
          public java.util.Set<OperationShape> operations()
          +
          Gets a set of all operation shapes in the service, sorted by name. + +

          This includes operations contained in resources in the closure of the service.

          +
          +
          Returns:
          +
          Returns all sorted service operations.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/GenerateEnumDirective.EnumType.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/GenerateEnumDirective.EnumType.html new file mode 100644 index 00000000000..68bf13df6b4 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/GenerateEnumDirective.EnumType.html @@ -0,0 +1,385 @@ + + + + + +GenerateEnumDirective.EnumType (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core.directed
    +

    Enum GenerateEnumDirective.EnumType

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        ENUM 
        STRING +
        A string shape marked with the enum trait is being generated.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static GenerateEnumDirective.EnumTypevalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static GenerateEnumDirective.EnumType[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static GenerateEnumDirective.EnumType[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (GenerateEnumDirective.EnumType c : GenerateEnumDirective.EnumType.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static GenerateEnumDirective.EnumType valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/GenerateEnumDirective.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/GenerateEnumDirective.html new file mode 100644 index 00000000000..12ba53ccee6 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/GenerateEnumDirective.html @@ -0,0 +1,385 @@ + + + + + +GenerateEnumDirective (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core.directed
    +

    Class GenerateEnumDirective<C extends CodegenContext<S,​?,​?>,​S>

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getEnumType

          +
          public GenerateEnumDirective.EnumType getEnumType()
          +
          Gets the type of enum being generated, whether it's a string shape marked with + the enum trait or, in Smithy IDL 2.0, an actual enum shape. + +

          Note that Smithy IDL 2.0 generators can perform a pre-processing transform + to convert eligible string shape enums to proper enums, removing the need to + check this property.

          +
          +
          Returns:
          +
          Gets the type of enum being generated.
          +
          See Also:
          +
          getEnumTrait()
          +
          +
          • +
        + + + +
          +
        • +

          getEnumTrait

          +
          public EnumTrait getEnumTrait()
          +
          Gets the EnumTrait of the shape.
          +
          +
          Returns:
          +
          Returns the enum trait.
          +
          +
          • +
        + + + +
          +
        • +

          expectEnumShape

          +
          public EnumShape expectEnumShape()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/GenerateErrorDirective.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/GenerateErrorDirective.html new file mode 100644 index 00000000000..0f31f8e119e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/GenerateErrorDirective.html @@ -0,0 +1,319 @@ + + + + + +GenerateErrorDirective (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core.directed
    +

    Class GenerateErrorDirective<C extends CodegenContext<S,​?,​?>,​S>

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          errorTrait

          +
          public ErrorTrait errorTrait()
          +
          Gets the error trait. + +

          This is equivalent to calling shape().expectTrait(ErrorTrait.class).

          +
          +
          Returns:
          +
          Gets the ErrorTrait of the error.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/GenerateIntEnumDirective.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/GenerateIntEnumDirective.html new file mode 100644 index 00000000000..de75e4274a0 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/GenerateIntEnumDirective.html @@ -0,0 +1,310 @@ + + + + + +GenerateIntEnumDirective (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core.directed
    +

    Class GenerateIntEnumDirective<C extends CodegenContext<S,​?,​?>,​S>

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          expectIntEnumShape

          +
          public IntEnumShape expectIntEnumShape()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/GenerateOperationDirective.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/GenerateOperationDirective.html new file mode 100644 index 00000000000..1b4509842dc --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/GenerateOperationDirective.html @@ -0,0 +1,266 @@ + + + + + +GenerateOperationDirective (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core.directed
    +

    Class GenerateOperationDirective<C extends CodegenContext<S,​?,​?>,​S>

    +
    +
    + +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/GenerateResourceDirective.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/GenerateResourceDirective.html new file mode 100644 index 00000000000..89a1e50ea98 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/GenerateResourceDirective.html @@ -0,0 +1,266 @@ + + + + + +GenerateResourceDirective (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core.directed
    +

    Class GenerateResourceDirective<C extends CodegenContext<S,​?,​?>,​S>

    +
    +
    + +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/GenerateServiceDirective.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/GenerateServiceDirective.html new file mode 100644 index 00000000000..39c607b1e5e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/GenerateServiceDirective.html @@ -0,0 +1,390 @@ + + + + + +GenerateServiceDirective (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core.directed
    +

    Class GenerateServiceDirective<C extends CodegenContext<S,​?,​?>,​S>

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          serviceTitle

          +
          public java.lang.String serviceTitle()
          +
          Gets the TitleTrait value of the service if present, otherwise returns + the Symbol.getName() value of the service.
          +
          +
          Returns:
          +
          title of service
          +
          +
          • +
        + + + +
          +
        • +

          serviceTitle

          +
          public java.lang.String serviceTitle​(java.lang.String fallback)
          +
          Attempts to get the title of service from the model, returning the fallback value + if the service does not have a TitleTrait.
          +
          +
          Parameters:
          +
          fallback - string to return if service does not have a title
          +
          Returns:
          +
          title of service
          +
          +
          • +
        + + + +
          +
        • +

          inputEventStreamOperations

          +
          public java.util.Map<ShapeId,​EventStreamInfo> inputEventStreamOperations()
          +
          Get a map of operations that use an event stream in their input.
          +
          +
          Returns:
          +
          Returns a map of operation shape IDs to their event stream information.
          +
          See Also:
          +
          EventStreamIndex
          +
          +
          • +
        + + + +
          +
        • +

          outputEventStreamOperations

          +
          public java.util.Map<ShapeId,​EventStreamInfo> outputEventStreamOperations()
          +
          Get a map of operations that use an event stream in their output.
          +
          +
          Returns:
          +
          Returns a map of operation shape IDs to their event stream information.
          +
          See Also:
          +
          EventStreamIndex
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/GenerateStructureDirective.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/GenerateStructureDirective.html new file mode 100644 index 00000000000..cff9c6e52b3 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/GenerateStructureDirective.html @@ -0,0 +1,354 @@ + + + + + +GenerateStructureDirective (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core.directed
    +

    Class GenerateStructureDirective<C extends CodegenContext<S,​?,​?>,​S>

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/GenerateUnionDirective.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/GenerateUnionDirective.html new file mode 100644 index 00000000000..631561e0324 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/GenerateUnionDirective.html @@ -0,0 +1,317 @@ + + + + + +GenerateUnionDirective (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core.directed
    +

    Class GenerateUnionDirective<C extends CodegenContext<S,​?,​?>,​S>

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          isEventStream

          +
          public boolean isEventStream()
          +
          Check if this is an event stream union.
          +
          +
          Returns:
          +
          Returns true if this is an event stream.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/ShapeDirective.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/ShapeDirective.html new file mode 100644 index 00000000000..68b34ee4313 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/ShapeDirective.html @@ -0,0 +1,329 @@ + + + + + +ShapeDirective (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core.directed
    +

    Class ShapeDirective<T extends Shape,​C extends CodegenContext<S,​?,​?>,​S>

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          shape

          +
          public final T shape()
          +
          Gets the shape being generated.
          +
          +
          Returns:
          +
          Returns the shape to generate.
          +
          +
          • +
        + + + +
          +
        • +

          symbol

          +
          public final Symbol symbol()
          +
          Gets the symbol created for the shape. + +

          This is equivalent to calling symbolProvider().toSymbol(shape()).

          +
          +
          Returns:
          +
          Returns the shape's symbol.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/package-summary.html new file mode 100644 index 00000000000..d698df2c6d7 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/package-summary.html @@ -0,0 +1,289 @@ + + + + + +software.amazon.smithy.codegen.core.directed (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.codegen.core.directed

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/package-tree.html new file mode 100644 index 00000000000..1213667daf7 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/directed/package-tree.html @@ -0,0 +1,204 @@ + + + + + +software.amazon.smithy.codegen.core.directed Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.codegen.core.directed

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    +
      +
    • software.amazon.smithy.codegen.core.directed.DirectedCodegen<C,​S,​I>
      • +
    +
    +
    +

    Enum Hierarchy

    +
      +
    • java.lang.Object +
        +
      • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
        • +
      +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/package-summary.html new file mode 100644 index 00000000000..b724f25f492 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/package-summary.html @@ -0,0 +1,374 @@ + + + + + +software.amazon.smithy.codegen.core (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.codegen.core

    +
    +
    +
    + + +
    Defines abstractions for implementing Smithy model code generation.
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/package-tree.html new file mode 100644 index 00000000000..7748fa12f24 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/package-tree.html @@ -0,0 +1,230 @@ + + + + + +software.amazon.smithy.codegen.core Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.codegen.core

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +

    Enum Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/ArtifactDefinitions.Builder.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/ArtifactDefinitions.Builder.html new file mode 100644 index 00000000000..592877211fb --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/ArtifactDefinitions.Builder.html @@ -0,0 +1,405 @@ + + + + + +ArtifactDefinitions.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core.trace
    +

    Class ArtifactDefinitions.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.codegen.core.trace.ArtifactDefinitions.Builder
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Builder() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + + + + + +
          +
        • +

          addTag

          +
          public ArtifactDefinitions.Builder addTag​(java.lang.String name,
+                                          java.lang.String description)
          +
          Adds the tag's key, value pair to the tags map.
          +
          +
          Parameters:
          +
          name - Name of tag.
          +
          description - Description of tag.
          +
          Returns:
          +
          This builder.
          +
          +
          • +
        + + + +
          +
        • +

          addType

          +
          public ArtifactDefinitions.Builder addType​(java.lang.String name,
+                                           java.lang.String description)
          +
          Adds the type's key, value pair to the tags map.
          +
          +
          Parameters:
          +
          name - Key of type.
          +
          description - Value of type.
          +
          Returns:
          +
          This builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/ArtifactDefinitions.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/ArtifactDefinitions.html new file mode 100644 index 00000000000..717def47e8d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/ArtifactDefinitions.html @@ -0,0 +1,483 @@ + + + + + +ArtifactDefinitions (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core.trace
    +

    Class ArtifactDefinitions

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.codegen.core.trace.ArtifactDefinitions
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        static java.lang.StringTAGS_TEXT 
        static java.lang.StringTYPE_TEXT 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static ArtifactDefinitions.Builderbuilder() 
        static ArtifactDefinitionsfromNode​(Node value) +
        Converts an ObjectNode that represents the definitions section of the + trace file into a types maps and tags map.
        +
        java.util.Map<java.lang.String,​java.lang.String>getTags() +
        Gets this Definition's Tags Map.
        +
        java.util.Map<java.lang.String,​java.lang.String>getTypes() +
        Gets this Definition's Types Map.
        +
        ArtifactDefinitions.BuildertoBuilder() +
        Take this object and create a builder that contains all of the + current property values of this object.
        +
        ObjectNodetoNode() +
        Converts the types and tags Maps into a single ObjectNode.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + +
          +
        • +

          fromNode

          +
          public static ArtifactDefinitions fromNode​(Node value)
          +
          Converts an ObjectNode that represents the definitions section of the + trace file into a types maps and tags map.
          +
          +
          Parameters:
          +
          value - ObjectNode that contains the JSON data inside the definitions tag of + the trace file
          +
          Returns:
          +
          an ArtifactDefinitions object created from the ObjectNode.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          toNode

          +
          public ObjectNode toNode()
          +
          Converts the types and tags Maps into a single ObjectNode.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          an ObjectNode that contains two ObjectNode children; one contains the tag map structure the + other contains the type map structure.
          +
          +
          • +
        + + + +
          +
        • +

          getTags

          +
          public java.util.Map<java.lang.String,​java.lang.String> getTags()
          +
          Gets this Definition's Tags Map. + The tags Map defines the set of tags that can be used in a ShapeLink object. + Each key is the name of the tag, and each value is the description of the tag. + Tags are used to provide semantics to links. Tools that evaluate trace models + use these tags to inform their analysis. For example, a tag for an AWS SDK code + generator could be "requestBuilder" to indicate that a class is used as a builder for a request.
          +
          +
          Returns:
          +
          this Definition's Tags Map
          +
          +
          • +
        + + + +
          +
        • +

          getTypes

          +
          public java.util.Map<java.lang.String,​java.lang.String> getTypes()
          +
          Gets this Definition's Types Map. + The types Map defines the set of types that can be used in a ShapeLink object. + Each key is the name of the type, and each value is a description of the type. + For programming languages, these types represent language-specific components. + For example, in Java, types should map to the possible values of ElementType.
          +
          +
          Returns:
          +
          this Definition's Type's Map
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/ShapeLink.Builder.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/ShapeLink.Builder.html new file mode 100644 index 00000000000..8776a416943 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/ShapeLink.Builder.html @@ -0,0 +1,468 @@ + + + + + +ShapeLink.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core.trace
    +

    Class ShapeLink.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.codegen.core.trace.ShapeLink.Builder
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Builder() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public ShapeLink build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Specified by:
          +
          build in interface SmithyBuilder<ShapeLink>
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          tags

          +
          public ShapeLink.Builder tags​(java.util.List<java.lang.String> tags)
          +
          Sets tags list of a ShapeLink.
          +
          +
          Parameters:
          +
          tags - list of tags.
          +
          Returns:
          +
          This builder.
          +
          +
          • +
        + + + +
          +
        • +

          addTag

          +
          public ShapeLink.Builder addTag​(java.lang.String tag)
          +
          Adds a tag to the tags list of a ShapeLink.
          +
          +
          Parameters:
          +
          tag - tag to add.
          +
          Returns:
          +
          This builder.
          +
          +
          • +
        + + + +
          +
        • +

          file

          +
          public ShapeLink.Builder file​(java.lang.String file)
          +
          Sets File of a ShapeLink.
          +
          +
          Parameters:
          +
          file - File.
          +
          Returns:
          +
          This builder.
          +
          +
          • +
        + + + +
          +
        • +

          line

          +
          public ShapeLink.Builder line​(java.lang.Integer line)
          +
          Sets line of a ShapeLink.
          +
          +
          Parameters:
          +
          line - Line number in artifact file.
          +
          Returns:
          +
          This builder.
          +
          +
          • +
        + + + +
          +
        • +

          column

          +
          public ShapeLink.Builder column​(java.lang.Integer column)
          +
          Sets tags list of a ShapeLink.
          +
          +
          Parameters:
          +
          column - Column number in artifact file.
          +
          Returns:
          +
          This builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/ShapeLink.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/ShapeLink.html new file mode 100644 index 00000000000..10aa4d165a7 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/ShapeLink.html @@ -0,0 +1,640 @@ + + + + + +ShapeLink (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core.trace
    +

    Class ShapeLink

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.codegen.core.trace.ShapeLink
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static class ShapeLink.Builder 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        static java.lang.StringCOLUMN_TEXT 
        static java.lang.StringFILE_TEXT 
        static java.lang.StringID_TEXT 
        static java.lang.StringLINE_TEXT 
        static java.lang.StringTAGS_TEXT 
        static java.lang.StringTYPE_TEXT 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static ShapeLink.Builderbuilder() 
        static ShapeLinkfromNode​(Node value) +
        Instantiates ShapeLink instance variables by extracting data from an ObjectNode.
        +
        java.util.Optional<java.lang.Integer>getColumn() +
        Gets this ShapeLink's column number in an optional container.
        +
        java.util.Optional<java.lang.String>getFile() +
        Gets this ShapeLink's file in an optional container.
        +
        java.lang.StringgetId() +
        Gets this ShapeLink's id.
        +
        java.util.Optional<java.lang.Integer>getLine() +
        Gets this ShapeLink's line number in an optional container.
        +
        java.util.List<java.lang.String>getTags() +
        Gets this ShapeLink's tags list.
        +
        java.lang.StringgetType() +
        Gets this ShapeLink's type.
        +
        ShapeLink.BuildertoBuilder() +
        Take this object and create a builder that contains all of the + current property values of this object.
        +
        ObjectNodetoNode() +
        Converts instance variables into an ObjectNode for writing out a ShapeLink.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + +
          +
        • +

          fromNode

          +
          public static ShapeLink fromNode​(Node value)
          +
          Instantiates ShapeLink instance variables by extracting data from an ObjectNode.
          +
          +
          Parameters:
          +
          value - an ObjectNode that represents the a single ShapeLink
          +
          Returns:
          +
          a ShapeLink created from the ObjectNode
          +
          +
          • +
        + + + + + + + +
          +
        • +

          toNode

          +
          public ObjectNode toNode()
          +
          Converts instance variables into an ObjectNode for writing out a ShapeLink.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          returns an ObjectNode that contains the StringNodes with the information + from a ShapeLink
          +
          +
          • +
        + + + +
          +
        • +

          getType

          +
          public java.lang.String getType()
          +
          Gets this ShapeLink's type. + The type is the type of the artifact component. This value MUST correspond to one of the types defined + in the /definitions/types property of the trace file.
          +
          +
          Returns:
          +
          this ShapeLink's type
          +
          +
          • +
        + + + +
          +
        • +

          getId

          +
          public java.lang.String getId()
          +
          Gets this ShapeLink's id. + Id is the artifact-specific identifier for the artifact component. For example, in Java a valid id + would be the fully-qualified name of a class, method, or field as defined in + Documentation Comment + Specification for the Standard Doclet
          +
          +
          Returns:
          +
          this ShapeLink's id
          +
          +
          • +
        + + + +
          +
        • +

          getTags

          +
          public java.util.List<java.lang.String> getTags()
          +
          Gets this ShapeLink's tags list. + Tags defines a list of tags to apply to the trace link. Each tag MUST correspond to a tag defined in + the /definitions/tags property of the trace file.
          +
          +
          Returns:
          +
          This ShapeLink's list of tags
          +
          +
          • +
        + + + +
          +
        • +

          getFile

          +
          public java.util.Optional<java.lang.String> getFile()
          +
          Gets this ShapeLink's file in an optional container. + File is a URI that defines the location of the artifact component. Files MUST use the "file" URI scheme, + and SHOULD be relative.
          +
          +
          Returns:
          +
          Optional container holding this ShapeLink's file
          +
          +
          • +
        + + + +
          +
        • +

          getLine

          +
          public java.util.Optional<java.lang.Integer> getLine()
          +
          Gets this ShapeLink's line number in an optional container. + Line is the line number in the file that contains the artifact component.
          +
          +
          Returns:
          +
          Optional container holding this ShapeLink's line number
          +
          +
          • +
        + + + +
          +
        • +

          getColumn

          +
          public java.util.Optional<java.lang.Integer> getColumn()
          +
          Gets this ShapeLink's column number in an optional container. + Column is the column number in the file that contains the artifact component.
          +
          +
          Returns:
          +
          Optional container holding this ShapeLink's column number
          +
          +
          • +
        + + + +
          +
        • +

          toBuilder

          +
          public ShapeLink.Builder toBuilder()
          +
          Take this object and create a builder that contains all of the + current property values of this object.
          +
          +
          Specified by:
          +
          toBuilder in interface ToSmithyBuilder<ShapeLink>
          +
          Returns:
          +
          a builder for type T
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/TraceFile.Builder.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/TraceFile.Builder.html new file mode 100644 index 00000000000..d4ff46e589a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/TraceFile.Builder.html @@ -0,0 +1,510 @@ + + + + + +TraceFile.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core.trace
    +

    Class TraceFile.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.codegen.core.trace.TraceFile.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public TraceFile build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Specified by:
          +
          build in interface SmithyBuilder<TraceFile>
          +
          Returns:
          +
          The TraceFile.
          +
          +
          • +
        + + + +
          +
        • +

          smithyTrace

          +
          public TraceFile.Builder smithyTrace​(java.lang.String smithyTrace)
          +
          +
          Parameters:
          +
          smithyTrace - Trace file version number.
          +
          Returns:
          +
          This builder.
          +
          +
          • +
        + + + +
          +
        • +

          definitions

          +
          public TraceFile.Builder definitions​(ArtifactDefinitions artifactDefinitions)
          +
          +
          Parameters:
          +
          artifactDefinitions - Trace file definitions.
          +
          Returns:
          +
          This builder.
          +
          +
          • +
        + + + +
          +
        • +

          metadata

          +
          public TraceFile.Builder metadata​(TraceMetadata metadata)
          +
          +
          Parameters:
          +
          metadata - Trace file TraceMetadata.
          +
          Returns:
          +
          This builder.
          +
          +
          • +
        + + + +
          +
        • +

          addShapeLink

          +
          public TraceFile.Builder addShapeLink​(ShapeId id,
+                                      ShapeLink link)
          +
          Adds a ShapeLink to this ShapeId in the TraceFile's shapes map.
          +
          +
          Parameters:
          +
          id - ShapeId
          +
          link - ShapeLink corresponding to ShapeId
          +
          Returns:
          +
          This builder.
          +
          +
          • +
        + + + +
          +
        • +

          addShapeLink

          +
          public TraceFile.Builder addShapeLink​(java.lang.String idString,
+                                      ShapeLink link)
          +
          Adds a ShapeLink to this ShapeId in the TraceFile's shapes map.
          +
          +
          Parameters:
          +
          idString - ShapeId represented as a string.
          +
          link - ShapeLink corresponding to ShapeId
          +
          Returns:
          +
          This builder.
          +
          +
          • +
        + + + +
          +
        • +

          addShapeLinks

          +
          public TraceFile.Builder addShapeLinks​(ShapeId id,
+                                       java.util.List<ShapeLink> linkList)
          +
          Adds a list of ShapeLinks to this ShapeId in the TraceFile's shapes map.
          +
          +
          Parameters:
          +
          id - ShapeId.
          +
          linkList - List of ShapeLinks corresponding to a ShapeId.
          +
          Returns:
          +
          This builder.
          +
          +
          • +
        + + + +
          +
        • +

          addShapeLinks

          +
          public TraceFile.Builder addShapeLinks​(java.lang.String idString,
+                                       java.util.List<ShapeLink> linkList)
          +
          Adds a list of ShapeLinks to this ShapeId in the TraceFile's shapes map.
          +
          +
          Parameters:
          +
          idString - ShapeId as a String.
          +
          linkList - List of ShapeLinks corresponding to a ShapeId.
          +
          Returns:
          +
          This builder.
          +
          +
          • +
        + + + +
          +
        • +

          shapes

          +
          public TraceFile.Builder shapes​(java.util.Map<ShapeId,​java.util.List<ShapeLink>> shapes)
          +
          +
          Parameters:
          +
          shapes - shapes map for TraceFile.
          +
          Returns:
          +
          This builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/TraceFile.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/TraceFile.html new file mode 100644 index 00000000000..100e725584d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/TraceFile.html @@ -0,0 +1,606 @@ + + + + + +TraceFile (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core.trace
    +

    Class TraceFile

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.codegen.core.trace.TraceFile
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static class TraceFile.Builder +
        Builder for constructing TraceFile's from scratch.
        +
        +
        • +
      +
      + +
      + +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          SMITHY_TRACE_TEXT

          +
          public static final java.lang.String SMITHY_TRACE_TEXT
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        + + + +
          +
        • +

          METADATA_TEXT

          +
          public static final java.lang.String METADATA_TEXT
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        + + + +
          +
        • +

          DEFINITIONS_TEXT

          +
          public static final java.lang.String DEFINITIONS_TEXT
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        + + + +
          +
        • +

          SHAPES_TEXT

          +
          public static final java.lang.String SHAPES_TEXT
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        + + + +
          +
        • +

          SMITHY_TRACE_VERSION

          +
          public static final java.lang.String SMITHY_TRACE_VERSION
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          fromNode

          +
          public static TraceFile fromNode​(Node value)
          +
          Converts ObjectNode into TraceFile.
          +
          +
          Parameters:
          +
          value - an ObjectNode that represents the entire trace file.
          +
          Returns:
          +
          TraceFile produced from an ObjectNode.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          toNode

          +
          public ObjectNode toNode()
          +
          Converts TraceFile instance variables into an + ObjectNode.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          ObjectNode representation of a TraceFile.
          +
          +
          • +
        + + + +
          +
        • +

          validateModel

          +
          public void validateModel​(Model model)
          +
          Parses model and determines whether the trace file object meets the specs of the model by checking if + the trace file contains all the ShapeIds in the model and the model contains all the ShapeIDs in the trace file.
          +
          +
          Parameters:
          +
          model - the Smithy model to validate the trace file against.
          +
          Throws:
          +
          ExpectationNotMetException - if model contains a ShapeID not in TraceFile or TraceFile contains a ShapeID + not in model.
          +
          +
          • +
        + + + +
          +
        • +

          getSmithyTrace

          +
          public java.lang.String getSmithyTrace()
          +
          Gets this TraceFile's smithyTrace. + The smithyTrace String contains the Smithy trace file version number.
          +
          +
          Returns:
          +
          a String representing trace file ID.
          +
          +
          • +
        + + + +
          +
        • +

          getMetadata

          +
          public TraceMetadata getMetadata()
          +
          Gets this TraceFile's TraceMetadata.
          +
          +
          Returns:
          +
          a TraceMetadata object.
          +
          +
          • +
        + + + +
          +
        • +

          getArtifactDefinitions

          +
          public java.util.Optional<ArtifactDefinitions> getArtifactDefinitions()
          +
          Gets this TraceFile's Definitions.
          +
          +
          Returns:
          +
          an Optional Definitions container that contains this TraceFile's Definition + or isEmpty if Definition's has not been set.
          +
          +
          • +
        + + + +
          +
        • +

          getShapes

          +
          public java.util.Map<ShapeId,​java.util.List<ShapeLink>> getShapes()
          +
          Gets this TraceFile's Shapes map. + The shapes Map provides a mapping of absolute Smithy shape IDs to a list + of shape link objects. A single Smithy shape can be responsible for generating + multiple components in the target artifact.
          +
          +
          Returns:
          +
          a Map from ShapeIDs to a list of ShapeLink's that represents the contents of the + shapes tag in the trace file.
          +
          +
          • +
        + + + +
          +
        • +

          toBuilder

          +
          public TraceFile.Builder toBuilder()
          +
          Take this object and create a builder that contains all of the + current property values of this object.
          +
          +
          Specified by:
          +
          toBuilder in interface ToSmithyBuilder<TraceFile>
          +
          Returns:
          +
          a builder for type T
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/TraceMetadata.Builder.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/TraceMetadata.Builder.html new file mode 100644 index 00000000000..8297a870d64 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/TraceMetadata.Builder.html @@ -0,0 +1,448 @@ + + + + + +TraceMetadata.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core.trace
    +

    Class TraceMetadata.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.codegen.core.trace.TraceMetadata.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public TraceMetadata build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Specified by:
          +
          build in interface SmithyBuilder<TraceMetadata>
          +
          Returns:
          +
          The TraceMetadata object corresponding to this builder.
          +
          +
          • +
        + + + + + + + + + + + + + + + + + + + +
          +
        • +

          setTimestampAsNow

          +
          public TraceMetadata.Builder setTimestampAsNow()
          +
          Sets the timestamp as the current time in RFC 3339 format.
          +
          +
          Returns:
          +
          This builder.
          +
          +
          • +
        + + + +
          +
        • +

          typeVersion

          +
          public TraceMetadata.Builder typeVersion​(java.lang.String typeVersion)
          +
          Sets this builder's typeVersion.
          +
          +
          Parameters:
          +
          typeVersion - typeVersion of TraceMetadata.
          +
          Returns:
          +
          This builder.
          +
          +
          • +
        + + + +
          +
        • +

          homepage

          +
          public TraceMetadata.Builder homepage​(java.lang.String homepage)
          +
          Sets this builder's homepage.
          +
          +
          Parameters:
          +
          homepage - homepage of TraceMetadata.
          +
          Returns:
          +
          This builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/TraceMetadata.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/TraceMetadata.html new file mode 100644 index 00000000000..ca499096ce8 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/TraceMetadata.html @@ -0,0 +1,637 @@ + + + + + +TraceMetadata (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core.trace
    +

    Class TraceMetadata

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.codegen.core.trace.TraceMetadata
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static class TraceMetadata.Builder 
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static TraceMetadata.Builderbuilder() 
        static TraceMetadatafromNode​(Node value) +
        Instantiates TraceMetadata instance variables using an ObjectNode that contains the artifact section of the + trace file.
        +
        java.util.Optional<java.lang.String>getHomepage() +
        Gets this TraceMetadata's Homepage in an Optional container.
        +
        java.lang.StringgetId() +
        Gets this TraceMetadata's id.
        +
        java.lang.StringgetTimestamp() +
        Gets this TraceMetadata's timestamp.
        +
        java.lang.StringgetType() +
        Gets this TraceMetadata's type.
        +
        java.util.Optional<java.lang.String>getTypeVersion() +
        Gets this TraceMetadata's TypeVersion in an Optional container.
        +
        java.lang.StringgetVersion() +
        Gets this TraceMetadata's version (for example, the AWS SDK release number).
        +
        TraceMetadata.BuildertoBuilder() +
        Take this object and create a builder that contains all of the + current property values of this object.
        +
        ObjectNodetoNode() +
        Converts the metadata contained in TraceMetadata's variables into an ObjectNode.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + +
          +
        • +

          fromNode

          +
          public static TraceMetadata fromNode​(Node value)
          +
          Instantiates TraceMetadata instance variables using an ObjectNode that contains the artifact section of the + trace file.
          +
          +
          Parameters:
          +
          value - an ObjectNode that contains all children of the artifact tag in the trace file
          +
          Returns:
          +
          TraceMetadata produced by deserializing the node.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          toNode

          +
          public ObjectNode toNode()
          +
          Converts the metadata contained in TraceMetadata's variables into an ObjectNode.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          an ObjectNode with that contains StringNodes representing the trace file + metadata
          +
          +
          • +
        + + + +
          +
        • +

          getId

          +
          public java.lang.String getId()
          +
          Gets this TraceMetadata's id. + The id is the identifier of the artifact. For example, Java packages should use the Maven artifact ID.
          +
          +
          Returns:
          +
          TraceMetadata's id
          +
          +
          • +
        + + + +
          +
        • +

          getVersion

          +
          public java.lang.String getVersion()
          +
          Gets this TraceMetadata's version (for example, the AWS SDK release number).
          +
          +
          Returns:
          +
          TraceMetadata's version
          +
          +
          • +
        + + + +
          +
        • +

          getTimestamp

          +
          public java.lang.String getTimestamp()
          +
          Gets this TraceMetadata's timestamp. + The timestamp is the RFC 3339 date and time that the artifact was created.
          +
          +
          Returns:
          +
          TraceMetadata's timestamp
          +
          +
          • +
        + + + +
          +
        • +

          getType

          +
          public java.lang.String getType()
          +
          Gets this TraceMetadata's type. For code generation, this is the programming language.
          +
          +
          Returns:
          +
          TraceMetadata's type
          +
          +
          • +
        + + + +
          +
        • +

          getTypeVersion

          +
          public java.util.Optional<java.lang.String> getTypeVersion()
          +
          Gets this TraceMetadata's TypeVersion in an Optional container. For example, when defining + trace files for Java source code, the typeVersion would be the minimum supported JDK version. + Different artifacts may have different output based on the version targets (for example the ability + to use more features in a newer version of a language).
          +
          +
          Returns:
          +
          Optional container with type version or empty container if + TypeVersion has not been set.
          +
          +
          • +
        + + + +
          +
        • +

          getHomepage

          +
          public java.util.Optional<java.lang.String> getHomepage()
          +
          Gets this TraceMetadata's Homepage in an Optional container. + The homepage is the homepage URL of the artifact.
          +
          +
          Returns:
          +
          Optional container with homepage or empty container if + homepage has not been set
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/TracingSymbolProvider.Builder.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/TracingSymbolProvider.Builder.html new file mode 100644 index 00000000000..fb93841ee07 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/TracingSymbolProvider.Builder.html @@ -0,0 +1,460 @@ + + + + + +TracingSymbolProvider.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core.trace
    +

    Class TracingSymbolProvider.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.codegen.core.trace.TracingSymbolProvider.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          artifactDefinitions

          +
          public TracingSymbolProvider.Builder artifactDefinitions​(ArtifactDefinitions artifactDefinitions)
          +
          Sets this Builder's ArtifactDefinitions.
          +
          +
          Parameters:
          +
          artifactDefinitions - ArtifactDefinitions for this TracingSymbolProvider's + TraceFile.
          +
          Returns:
          +
          This Builder.
          +
          +
          • +
        + + + +
          +
        • +

          metadata

          +
          public TracingSymbolProvider.Builder metadata​(TraceMetadata metadata)
          +
          Sets this Builder's TraceMetadata.
          +
          +
          Parameters:
          +
          metadata - TraceMetadata for this TracingSymbolProvider's + TraceFile.
          +
          Returns:
          +
          This Builder.
          +
          +
          • +
        + + + +
          +
        • +

          setTraceMetadataAsDefault

          +
          public TracingSymbolProvider.Builder setTraceMetadataAsDefault​(java.lang.String artifactType)
          +
          Sets the Builder's TraceMetadata based on the given type and + default values for other required fields. This method should ONLY be used + when the version, type, homepage, and typeVersion of the TraceMetadata + object is unknown at the time of code generation. This method will ONLY set + the required fields of the TraceMetadata. + +

          The type is set to the artifactType that is passed in. The artifactType is + the code language of the generated artifact, e.g. Java. + +

          The timestamp in TraceMetadata is set to the current time when the + method is called. + +

          The id and version are set to a UUID that should be changed after the + TraceFile is constructed and the correct id and version are known.

          +
          +
          Parameters:
          +
          artifactType - The type, i.e. language, of the TraceMetadata object.
          +
          Returns:
          +
          This Builder.
          +
          +
          • +
        + + + +
          +
        • +

          shapeLinkCreator

          +
          public TracingSymbolProvider.Builder shapeLinkCreator​(java.util.function.BiFunction<Shape,​Symbol,​java.util.List<ShapeLink>> shapeLinkCreator)
          +
          Sets this Builder's shapeLinkCreator. The shapeLinkCreator + is a function that maps from a Symbol to a List of ShapeLinks. + Custom Functions should be designed for each code generator + that map apply the tags and types in the definitions files + to specific ShapeLinks.
          +
          +
          Parameters:
          +
          shapeLinkCreator - A Function that defines a mapping + from a Symbol to a List of ShapeLinks.
          +
          Returns:
          +
          This Builder.
          +
          +
          • +
        + + + +
          +
        • +

          symbolProvider

          +
          public TracingSymbolProvider.Builder symbolProvider​(SymbolProvider symbolProvider)
          +
          Sets this Builder's SymbolProvider.
          +
          +
          Parameters:
          +
          symbolProvider - The SymbolProvider that the + TracingSymbolProvider will decorate.
          +
          Returns:
          +
          This Builder.
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/TracingSymbolProvider.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/TracingSymbolProvider.html new file mode 100644 index 00000000000..db216269d59 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/TracingSymbolProvider.html @@ -0,0 +1,383 @@ + + + + + +TracingSymbolProvider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core.trace
    +

    Class TracingSymbolProvider

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.codegen.core.trace.TracingSymbolProvider
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          builder

          +
          public static TracingSymbolProvider.Builder builder()
          +
          Builder to create a TracingSymbolProvider instance.
          +
          +
          Returns:
          +
          Returns a new Builder.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          toSymbol

          +
          public Symbol toSymbol​(Shape shape)
          +
          Converts a shape into a symbol by calling the toSymbol method of the + SymbolProvider used to construct this TracingSymbolProvider. Adds a + list of ShapeLinks to the TracingSymbolProvider's TraceFile.Builder.
          +
          +
          Specified by:
          +
          toSymbol in interface SymbolProvider
          +
          Parameters:
          +
          shape - Shape to convert to Symbol.
          +
          Returns:
          +
          Symbol created from Shape.
          +
          +
          • +
        + + + +
          +
        • +

          toMemberName

          +
          public java.lang.String toMemberName​(MemberShape shape)
          +
          Description copied from interface: SymbolProvider
          +
          Converts a member shape to a member/property name of a containing + data structure. + +

          The default implementation will return the member name of + the provided shape ID and should be overridden if necessary.

          +
          +
          Specified by:
          +
          toMemberName in interface SymbolProvider
          +
          Parameters:
          +
          shape - Shape to convert.
          +
          Returns:
          +
          Returns the converted member name.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/package-summary.html new file mode 100644 index 00000000000..904f7362032 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/package-summary.html @@ -0,0 +1,221 @@ + + + + + +software.amazon.smithy.codegen.core.trace (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.codegen.core.trace

    +
    +
    +
    + + +
    Defines abstractions for implementing Smithy model trace file generation.
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/package-tree.html new file mode 100644 index 00000000000..2e65b2e4f49 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/trace/package-tree.html @@ -0,0 +1,170 @@ + + + + + +software.amazon.smithy.codegen.core.trace Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.codegen.core.trace

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/CodegenWriter.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/CodegenWriter.html new file mode 100644 index 00000000000..dfb420a2991 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/CodegenWriter.html @@ -0,0 +1,710 @@ + + + + + +CodegenWriter (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core.writer
    +

    Class CodegenWriter<T extends CodegenWriter<T,​U>,​U extends ImportContainer>

    +
    +
    + +
    +
      +
    • +
      +
      Type Parameters:
      +
      T - The concrete type, used to provide a fluent interface.
      +
      U - The import container used by the writer to manage imports.
      +
      +
      +
      All Implemented Interfaces:
      +
      SymbolDependencyContainer
      +
      +
      +
      @Deprecated
+public class CodegenWriter<T extends CodegenWriter<T,​U>,​U extends ImportContainer>
+extends CodeWriter
+implements SymbolDependencyContainer
      +
      Deprecated. +
      prefer SymbolWriter. + This will be removed in a future release.
      +
      +
      A CodeGenWriter is a specialized CodeWriter that makes it + easier to implement code generation that utilizes Symbols and + SymbolDependency values. + +

      A CodegenWriter is expected to be subclassed, and the + subclass is expected to implement language-specific functionality + like writing documentation comments, tracking "imports", and adding + any other kinds of helpful functionality for generating source code + for a programming language. + +

      The following example shows how a subclass of CodegenWriter + should be created. CodegenWriters are expected to define a recursive + type signature (notice that MyWriter is a generic parametric + type in its own type definition). + + 

      
+ public final class MyWriter extends CodegenWriter<MyWriter, MyImportContainer> {
+     public MyWriter(String namespace) {
+         super(new MyDocumentationWriter(), new MyImportContainer(namespace));
+     }
+
+     \@Override
+     public String toString() {
+         return getImportContainer().toString() + "\n\n" + super.toString();
+     }
+
+     public MyWriter someCustomMethod() {
+         // You can implement custom methods that are specific to whatever
+         // language you're implementing a generator for.
+         return this;
+     }
+ }
+
      + + +

      Formatting symbols with "T"

      + +

      CodegenWriter registers a default formatter for "T" that writes + Symbols and SymbolReferences. Imports needed by these types + are automatically registered with addUseImports(software.amazon.smithy.codegen.core.SymbolContainer) for a Symbol + and addImport(software.amazon.smithy.codegen.core.Symbol, java.lang.String, software.amazon.smithy.codegen.core.SymbolReference.ContextOption...) for a SymbolReference. Programming languages + that have a concept of namespaces can use setRelativizeSymbols(java.lang.String) to + the namespace of the CodegenWriter, and then the default symbol formatter + will relativize symbols against that namespace using Symbol.relativize(java.lang.String) + when writing the symbol as a string.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + + + +
          +
        • +

          CodegenWriter

          +
          public CodegenWriter​(DocumentationWriter<T> documentationWriter,
+                     U importContainer)
          +
          Deprecated.
          +
          +
          Parameters:
          +
          documentationWriter - Writes out documentation emitted by a Runnable.
          +
          importContainer - Container used to persist and filter imports based on package names.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setRelativizeSymbols

          +
          public T setRelativizeSymbols​(java.lang.String relativizeSymbols)
          +
          Deprecated.
          +
          Sets a string used to relativize Symbols formatted using the default T + implementation used by CodegenWriter in the current state. + +

          In many programming languages, when referring to types in the same namespace as + the current scope of a CodegenWriter, the symbols written in that scope don't need + to be fully-qualified. They can just reference the unqualified type name. By setting + a value for relativizeSymbols, if the result of Symbol.getNamespace() + is equal to relativizeSymbols, then the unqualified name of the symbol is + written to the CodegenWriter when the default implementation of T + is written. Symbols that refer to types in other namespaces will write the fully + qualified type. + +

          Note: This method may have no effect if a programming language + does not use namespaces or concepts like namespaces or if T has been + overridden with another implementation.

          +
          +
          Parameters:
          +
          relativizeSymbols - The package name, namespace, etc to relativize symbols with.
          +
          Returns:
          +
          Returns the CodegenWriter.
          +
          +
          • +
        + + + +
          +
        • +

          getDocumentationWriter

          +
          public final DocumentationWriter<T> getDocumentationWriter()
          +
          Deprecated.
          +
          Gets the documentation writer.
          +
          +
          Returns:
          +
          Returns the documentation writer.
          +
          +
          • +
        + + + +
          +
        • +

          getImportContainer

          +
          public final U getImportContainer()
          +
          Deprecated.
          +
          Gets the import container associated with the writer. + +

          The AbstractCodeWriter.toString() method of the CodegenWriter should + be overridden so that it includes the import container's contents in + the output as appropriate.

          +
          +
          Returns:
          +
          Returns the import container.
          +
          +
          • +
        + + + +
          +
        • +

          getDependencies

          +
          public final java.util.List<SymbolDependency> getDependencies()
          +
          Deprecated.
          +
          Description copied from interface: SymbolDependencyContainer
          +
          Gets the list of dependencies that this object introduces. + +

          A dependency is a dependency on another package that a Symbol + or type requires. It is quite different from a reference since a + reference only refers to a symbol; a reference provides no context + as to whether or not a dependency is required or the dependency's + coordinates.

          +
          +
          Specified by:
          +
          getDependencies in interface SymbolDependencyContainer
          +
          Returns:
          +
          Returns the dependencies.
          +
          +
          • +
        + + + +
          +
        • +

          addDependency

          +
          public final T addDependency​(SymbolDependencyContainer dependencies)
          +
          Deprecated.
          +
          Adds one or more dependencies to the generated code (represented as + a SymbolDependency). + +

          Tracking dependencies on a CodegenWriter allows dependencies + to be automatically aggregated and collected in order to generate + configuration files for dependency management tools (e.g., npm, + maven, etc).

          +
          +
          Parameters:
          +
          dependencies - Dependency to add.
          +
          Returns:
          +
          Returns the writer.
          +
          +
          • +
        + + + +
          +
        • +

          addUseImports

          +
          public T addUseImports​(SymbolContainer container)
          +
          Deprecated.
          +
          Imports one or more USE symbols using the name of the symbol + (e.g., SymbolReference.ContextOption.USE references). + +

          USE references are only necessary when referring to a symbol, not + declaring the symbol. For example, when referring to a + List<Foo>, the USE references would be both the List + type and Foo type. + +

          This method may be overridden as needed.

          +
          +
          Parameters:
          +
          container - Symbols to add.
          +
          Returns:
          +
          Returns the writer.
          +
          +
          • +
        + + + +
          +
        • +

          addUseImports

          +
          public T addUseImports​(SymbolReference symbolReference)
          +
          Deprecated.
          +
          Imports a USE symbols possibly using an alias of the symbol + (e.g., SymbolReference.ContextOption.USE references). + +

          This method may be overridden as needed.

          +
          +
          Parameters:
          +
          symbolReference - Symbol reference to import.
          +
          Returns:
          +
          Returns the writer.
          +
          See Also:
          +
          addUseImports(SymbolContainer)
          +
          +
          • +
        + + + + + + + +
          +
        • +

          writeDocs

          +
          public final T writeDocs​(java.lang.Runnable runnable)
          +
          Deprecated.
          +
          Writes documentation comments. + +

          This method is responsible for setting up the writer to begin + writing documentation comments. This includes writing any necessary + opening tokens (e.g., "/*"), adding tokens to the beginning of lines + (e.g., "*"), sanitizing documentation strings, and writing any + tokens necessary to close documentation comments (e.g., "*\/"). + +

          This method does not automatically escape the expression + start character ("$" by default). Write calls made by the Runnable + should either use AbstractCodeWriter.writeWithNoFormatting(java.lang.Object) or escape + the expression start character manually. + +

          This method may be overridden as needed.

          +
          +
          Parameters:
          +
          runnable - Runnable that handles actually writing docs with the writer.
          +
          Returns:
          +
          Returns the writer.
          +
          +
          • +
        + + + +
          +
        • +

          writeDocs

          +
          public final T writeDocs​(java.lang.String docs)
          +
          Deprecated.
          +
          Writes documentation comments from a string.
          +
          +
          Parameters:
          +
          docs - Documentation to write.
          +
          Returns:
          +
          Returns the writer.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/CodegenWriterDelegator.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/CodegenWriterDelegator.html new file mode 100644 index 00000000000..aad56e0311b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/CodegenWriterDelegator.html @@ -0,0 +1,561 @@ + + + + + +CodegenWriterDelegator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core.writer
    +

    Class CodegenWriterDelegator<T extends CodegenWriter<T,​?>>

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.codegen.core.writer.CodegenWriterDelegator<T>
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Type Parameters:
      +
      T - The type of CodegenWriter to create and manage.
      +
      +
      +
      @Deprecated
+public class CodegenWriterDelegator<T extends CodegenWriter<T,​?>>
+extends java.lang.Object
      +
      Deprecated. +
      prefer WriterDelegator. + This class will be removed in a future release.
      +
      +

      Creates and manages CodegenWriters for files and namespaces based + on Symbols created for a Shape. + +

      Overview

      + +

      CodegenWriterDelegator is designed to generate code in files + returned by the Symbol.getDefinitionFile() method of a Symbol. + If multiple Symbols are created that need to be defined in the same + file, then the CodegenWriterDelegator ensures that the state of code + generator associated with the file is persisted and only written when all + shapes have been generated. + +

      CodegenWriters are lazily created each time a new filename is + requested. If a CodegenWriter is already associated with a filename, + a newline (\n) is written to the file before providing access to the + CodegenWriter. All of the files and CodegenWriters stored in the + delegator are eventually written to the provided FileManifest when + the flushWriters() method is called. + +

      This class is not thread-safe. + +

      Extending CodegenWriterDelegator

      + +

      Language-specific code generators that utilize Symbol and + SymbolDependency should extend both + CodegenWriterDelegator and CodegenWriter to implement + language specific functionality. Extending these classes also makes it + easier to create new instances of them because they will be easier to work + with since generic types aren't needed in concrete implementations.

      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods Deprecated Methods 
        Modifier and TypeMethodDescription
        voidflushWriters() +
        Deprecated.
        +
        Writes each pending CodegenWriter to the FileManifest.
        +
        java.util.List<SymbolDependency>getDependencies() +
        Deprecated.
        +
        Gets all of the dependencies that have been registered in writers + created by the CodegenWriterDelegator.
        +
        java.util.Map<java.lang.String,​T>getWriters() +
        Deprecated.
        +
        Returns an immutable Map of created CodegenWriters.
        +
        voidsetAutomaticSeparator​(java.lang.String automaticSeparator) +
        Deprecated.
        +
        Sets the automatic separator that is written to a CodegenWriter + each time the writer is reused.
        +
        voiduseFileWriter​(java.lang.String filename, + java.lang.String namespace, + java.util.function.Consumer<T> writerConsumer) +
        Deprecated.
        +
        Gets a previously created writer or creates a new one if needed.
        +
        voiduseFileWriter​(java.lang.String filename, + java.util.function.Consumer<T> writerConsumer) +
        Deprecated.
        +
        Gets a previously created CodegenWriter or creates a new one + if needed.
        +
        voiduseShapeWriter​(Shape shape, + java.util.function.Consumer<T> writerConsumer) +
        Deprecated.
        +
        Gets or creates a writer for a Shape by converting the Shape + to a Symbol.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          CodegenWriterDelegator

          +
          public CodegenWriterDelegator​(FileManifest fileManifest,
+                              SymbolProvider symbolProvider,
+                              CodegenWriterFactory<T> codegenWriterFactory)
          +
          Deprecated.
          +
          +
          Parameters:
          +
          fileManifest - Where code is written when flushWriters() is called.
          +
          symbolProvider - Maps Shape to Symbol to determine the "namespace" and file of a shape.
          +
          codegenWriterFactory - Factory used to create new CodegenWriters.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getDependencies

          +
          public java.util.List<SymbolDependency> getDependencies()
          +
          Deprecated.
          +
          Gets all of the dependencies that have been registered in writers + created by the CodegenWriterDelegator. + +

          This method essentially just aggregates the results of calling + CodegenWriter.getDependencies() of each created writer into + a single array. + +

          This method may be overridden as needed (for example, to add in + some list of default dependencies or to inject other generative + dependencies).

          +
          +
          Returns:
          +
          Returns all the dependencies used in each CodegenWriter.
          +
          +
          • +
        + + + +
          +
        • +

          flushWriters

          +
          public void flushWriters()
          +
          Deprecated.
          +
          Writes each pending CodegenWriter to the FileManifest. + +

          The toString method is called on each writer to generate + the code to write to the manifest. + +

          This method clears out the managed CodegenWriters, meaning a + subsequent call to getWriters() will return an empty map. + +

          This method may be overridden as needed.

          +
          • +
        + + + +
          +
        • +

          getWriters

          +
          public final java.util.Map<java.lang.String,​T> getWriters()
          +
          Deprecated.
          +
          Returns an immutable Map of created CodegenWriters. + +

          Each map key is the relative filename where the code will be written + in the FileManifest, and each map value is the associated + CodegenWriter of type T.

          +
          +
          Returns:
          +
          Returns the immutable map of files to writers.
          +
          +
          • +
        + + + +
          +
        • +

          useFileWriter

          +
          public final void useFileWriter​(java.lang.String filename,
+                                java.util.function.Consumer<T> writerConsumer)
          +
          Deprecated.
          +
          Gets a previously created CodegenWriter or creates a new one + if needed. + +

          If a writer already exists, a newline is automatically appended to + the writer (either a newline or whatever value was set on + setAutomaticSeparator(java.lang.String)).

          +
          +
          Parameters:
          +
          filename - Name of the file to create.
          +
          writerConsumer - Consumer that is expected to write to the CodegenWriter.
          +
          +
          • +
        + + + +
          +
        • +

          useFileWriter

          +
          public final void useFileWriter​(java.lang.String filename,
+                                java.lang.String namespace,
+                                java.util.function.Consumer<T> writerConsumer)
          +
          Deprecated.
          +
          Gets a previously created writer or creates a new one if needed. + +

          If a writer already exists, a newline is automatically appended to + the writer (either a newline or whatever value was set on + setAutomaticSeparator(java.lang.String)).

          +
          +
          Parameters:
          +
          filename - Name of the file to create.
          +
          namespace - Namespace associated with the file (or an empty string).
          +
          writerConsumer - Consumer that is expected to write to the CodegenWriter.
          +
          +
          • +
        + + + +
          +
        • +

          useShapeWriter

          +
          public final void useShapeWriter​(Shape shape,
+                                 java.util.function.Consumer<T> writerConsumer)
          +
          Deprecated.
          +
          Gets or creates a writer for a Shape by converting the Shape + to a Symbol. + +

          Any dependencies (i.e., SymbolDependency) required by the + Symbol are automatically registered with the writer. + +

          Any imports required to declare the Symbol in code (i.e., + SymbolReference.ContextOption.DECLARE) are automatically + registered with the writer. + +

          If a writer already exists, a newline is automatically appended to + the writer (either a newline or whatever value was set on + setAutomaticSeparator(java.lang.String)).

          +
          +
          Parameters:
          +
          shape - Shape to create the writer for.
          +
          writerConsumer - Consumer that is expected to write to the CodegenWriter.
          +
          +
          • +
        + + + +
          +
        • +

          setAutomaticSeparator

          +
          public final void setAutomaticSeparator​(java.lang.String automaticSeparator)
          +
          Deprecated.
          +
          Sets the automatic separator that is written to a CodegenWriter + each time the writer is reused. + +

          The default line separator is a newline ("\n"), but some + implementations may wish to use an alternative value (e.g., "\r\n") or + to disable the newline separator altogether by proving an empty string.

          +
          +
          Parameters:
          +
          automaticSeparator - The non-null line separator to use.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/CodegenWriterFactory.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/CodegenWriterFactory.html new file mode 100644 index 00000000000..7f517225157 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/CodegenWriterFactory.html @@ -0,0 +1,312 @@ + + + + + +CodegenWriterFactory (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core.writer
    +

    Interface CodegenWriterFactory<T extends CodegenWriter<T,​?>>

    +
    +
    +
    +
      +
    • +
      +
      Type Parameters:
      +
      T - Type of CodegenWriter to create.
      +
      +
      +
      All Superinterfaces:
      +
      java.util.function.BiFunction<java.lang.String,​java.lang.String,​T>
      +
      +
      +
      Functional Interface:
      +
      This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
      +
      +
      +
      @FunctionalInterface
+@Deprecated
+public interface CodegenWriterFactory<T extends CodegenWriter<T,​?>>
+extends java.util.function.BiFunction<java.lang.String,​java.lang.String,​T>
      +
      Deprecated. +
      prefer SymbolWriter.Factory. + This will be removed in a future release.
      +
      +

      Factory used to create a CodegenWriter. + +

      The following example shows how to implement a basic + CodegenWriterFactory. + + 

      
+ public final class MyWriterFactory implements CodegenWriterFactory<MyWriter> {
+     \@Override
+     public MyWriter apply(String filename, String namespace) {
+         return new MyWriter(namespace);
+     }
+ }
+
      + +

      Because CodegenWriterFactory is a FunctionalInterface, + it can be implemented using a lambda expression: + + 

      
+ CodegenWriterFactory<MyWriter> = (filename, namespace) -> new MyWriter(namespace);
+
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods Deprecated Methods 
        Modifier and TypeMethodDescription
        Tapply​(java.lang.String filename, + java.lang.String namespace) +
        Deprecated.
        +
        Creates a CodegenWriter of type T for the given + filename and namespace.
        +
        +
          +
        • + + +

          Methods inherited from interface java.util.function.BiFunction

          +andThen
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          apply

          +
          T apply​(java.lang.String filename,
+        java.lang.String namespace)
          +
          Deprecated.
          +
          Creates a CodegenWriter of type T for the given + filename and namespace.
          +
          +
          Specified by:
          +
          apply in interface java.util.function.BiFunction<java.lang.String,​java.lang.String,​T extends CodegenWriter<T,​?>>
          +
          Parameters:
          +
          filename - Non-null filename of the writer being created.
          +
          namespace - Non-null namespace associated with the file (possibly empty string).
          +
          Returns:
          +
          Returns the created writer of type T.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/DocWriter.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/DocWriter.html new file mode 100644 index 00000000000..6403a25d265 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/DocWriter.html @@ -0,0 +1,298 @@ + + + + + +DocWriter (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core.writer
    +

    Interface DocWriter<T extends AbstractCodeWriter<T>>

    +
    +
    +
    +
      +
    • +
      +
      Type Parameters:
      +
      T - The type of AbstractCodeWriter being written to.
      +
      +
      +
      Functional Interface:
      +
      This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
      +
      +
      +
      @FunctionalInterface
+@Deprecated
+public interface DocWriter<T extends AbstractCodeWriter<T>>
      +
      Deprecated.
      +

      This class is deprecated and will be removed in a future release. + +

      Use SymbolWriter directly instead. + + Responsible for properly writing documentation emitted when a + Runnable in invoked. + +

      The following example shows how to implement a basic + DocumentationWriter that encloses documentation in + successive lines that start with "///". + + 

      
+ public final class MyDocWriter implements DocumentationWriter<MyWriter> {
+     \@Override
+     public void writeDocs(T writer, Runnable runnable) {
+         setNewlinePrefix("/// ")
+         runnable.run();
+     }
+ }
+
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + +
          +
        • +

          writeDocs

          +
          void writeDocs​(T writer,
+               java.lang.Runnable runnable)
          +
          Deprecated.
          +
          Writes documentation comments. + +

          Implementations are expected to write out the beginning of a documentation + comment, set any necessary prefix for each line written while writing docs, + then invoke the given runnable, then finally write the closing + characters for documentation.

          +
          +
          Parameters:
          +
          writer - Writer to configure for writing documentation.
          +
          runnable - Runnable that handles actually writing docs with the writer.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/DocumentationWriter.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/DocumentationWriter.html new file mode 100644 index 00000000000..43fa41f9f53 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/DocumentationWriter.html @@ -0,0 +1,296 @@ + + + + + +DocumentationWriter (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core.writer
    +

    Interface DocumentationWriter<T extends CodeWriter>

    +
    +
    +
    +
      +
    • +
      +
      Type Parameters:
      +
      T - The type of CodegenWriter being written to.
      +
      +
      +
      Functional Interface:
      +
      This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
      +
      +
      +
      @Deprecated
+@FunctionalInterface
+public interface DocumentationWriter<T extends CodeWriter>
      +
      Deprecated. +
      prefer DocWriter. This will be removed in a future release.
      +
      +
      Responsible for properly writing documentation emitted when a + Runnable in invoked. + +

      The following example shows how to implement a basic + DocumentationWriter that encloses documentation in + successive lines that start with "///". + + 

      
+ public final class MyDocWriter implements DocumentationWriter<MyWriter> {
+     \@Override
+     public void writeDocs(T writer, Runnable runnable) {
+         setNewlinePrefix("/// ")
+         runnable.run();
+     }
+ }
+
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + +
          +
        • +

          writeDocs

          +
          void writeDocs​(T writer,
+               java.lang.Runnable runnable)
          +
          Deprecated.
          +
          Writes documentation comments. + +

          Implementations are expected to write out the beginning of a documentation + comment, set any necessary prefix for each line written while writing docs, + then invoke the given runnable, then finally write the closing + characters for documentation.

          +
          +
          Parameters:
          +
          writer - Writer to configure for writing documentation.
          +
          runnable - Runnable that handles actually writing docs with the writer.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/ImportContainer.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/ImportContainer.html new file mode 100644 index 00000000000..87098cc38c1 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/ImportContainer.html @@ -0,0 +1,306 @@ + + + + + +ImportContainer (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core.writer
    +

    Interface ImportContainer

    +
    +
    +
    +
      +
    • +
      +
      @Deprecated
+public interface ImportContainer
      +
      Deprecated.
      +
      Contains the imports associated with a specific file. + +

      This class is deprecated and will be removed in a future release. + +

      Use ImportContainer instead.

      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods Deprecated Methods 
        Modifier and TypeMethodDescription
        voidimportSymbol​(Symbol symbol, + java.lang.String alias) +
        Deprecated.
        +
        Adds an import for the given symbol if and only if the "namespace" of the + provided Symbol differs from the "namespace" associated with the + ImportContainer.
        +
        java.lang.StringtoString() +
        Deprecated.
        +
        Implementations must implement a custom toString method that + converts the collected imports to code that can be written to a + CodeWriter.
        +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          importSymbol

          +
          void importSymbol​(Symbol symbol,
+                  java.lang.String alias)
          +
          Deprecated.
          +
          Adds an import for the given symbol if and only if the "namespace" of the + provided Symbol differs from the "namespace" associated with the + ImportContainer. + +

          "namespace" in this context can mean whatever it needs to mean for the + target programming language. In some languages, it might mean the path to + a file. In others, it might mean a proper namespace string. It's up to + subclasses to both track a current "namespace" and implement this method + in a way that makes sense.

          +
          +
          Parameters:
          +
          symbol - Symbol to import if it's in another namespace.
          +
          alias - Alias to import the symbol as.
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          java.lang.String toString()
          +
          Deprecated.
          +
          Implementations must implement a custom toString method that + converts the collected imports to code that can be written to a + CodeWriter.
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          Returns:
          +
          Returns the collected imports as a string.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/JavaStyleDocumentationWriterBuilder.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/JavaStyleDocumentationWriterBuilder.html new file mode 100644 index 00000000000..8937fc192bc --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/JavaStyleDocumentationWriterBuilder.html @@ -0,0 +1,464 @@ + + + + + +JavaStyleDocumentationWriterBuilder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core.writer
    +

    Class JavaStyleDocumentationWriterBuilder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.codegen.core.writer.JavaStyleDocumentationWriterBuilder
        • +
      +
      • +
    +
    +
      +
    • +
      +
      @Deprecated
+public final class JavaStyleDocumentationWriterBuilder
+extends java.lang.Object
      +
      Deprecated. +
      this class uses CodeWriter, which is deprecated.
      +
      +
      A builder used to create a DocumentationWriter for Java style + documentation comments. + +

      Documentation comments are automatically sanitized by escaping a + closing documentation comment (i.e., star (*) followed by a forward slash + (/)). This should also work for JavaScript, PHP, and other languages that + use Java-style comments.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          JavaStyleDocumentationWriterBuilder

          +
          public JavaStyleDocumentationWriterBuilder()
          +
          Deprecated.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          escapeClosingChars

          +
          public static java.lang.String escapeClosingChars​(java.lang.String contents)
          +
          Deprecated.
          +
          A function used to escape the closing tokens of a documentation comment.
          +
          +
          Parameters:
          +
          contents - Contents to sanitize.
          +
          Returns:
          +
          Returns the sanitized contents.
          +
          +
          • +
        + + + +
          +
        • +

          escapeAtSignWithEntity

          +
          public static java.lang.String escapeAtSignWithEntity​(java.lang.String contents)
          +
          Deprecated.
          +
          A function used to escape the @ sign of a documentation + comment with an HTML entity of &#064;.
          +
          +
          Parameters:
          +
          contents - Contents to sanitize.
          +
          Returns:
          +
          Returns the sanitized contents.
          +
          +
          • +
        + + + +
          +
        • +

          build

          +
          public <T extends CodeWriter> DocumentationWriter<T> build()
          +
          Deprecated.
          +
          Creates a DocumentationWriter configured by the builder.
          +
          +
          Type Parameters:
          +
          T - The type of writer to create.
          +
          Returns:
          +
          Returns the created documentation writer.
          +
          +
          • +
        + + + +
          +
        • +

          namedDocumentationSection

          +
          public JavaStyleDocumentationWriterBuilder namedDocumentationSection​(java.lang.String namedDocumentationSection)
          +
          Deprecated.
          +
          Sets a specific named section to use when writing documentation.
          +
          +
          Parameters:
          +
          namedDocumentationSection - The name of the state's section to use.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          mappingFunction

          +
          public JavaStyleDocumentationWriterBuilder mappingFunction​(java.util.function.Function<java.lang.String,​java.lang.String> mappingFunction)
          +
          Deprecated.
          +
          Sets a custom mapping function to use when filtering documentation. + +

          Setting a custom mapping function will disable the default mapping + function that is used to escape the closing tokens of a block comment. + However, other mapping functions will still compose with a custom + mapping function if provided (e.g., escaping @ symbols via + escapeAtSignWithEntity(boolean) still compose with a custom mapping function).

          +
          +
          Parameters:
          +
          mappingFunction - Mapping function to use. Set to null to use the default.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          escapeAtSignWithEntity

          +
          public JavaStyleDocumentationWriterBuilder escapeAtSignWithEntity​(boolean escapeAtSignWithEntity)
          +
          Deprecated.
          +
          Sets whether or not the "@" sign is escaped with an HTML entity. + +

          At signs are not escaped by default.

          +
          +
          Parameters:
          +
          escapeAtSignWithEntity - Set to true to escape, false to not.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/SymbolWriter.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/SymbolWriter.html new file mode 100644 index 00000000000..c65a2b348dc --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/SymbolWriter.html @@ -0,0 +1,653 @@ + + + + + +SymbolWriter (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.codegen.core.writer
    +

    Class SymbolWriter<T extends SymbolWriter<T,​U>,​U extends ImportContainer>

    +
    +
    + +
    +
      +
    • +
      +
      Type Parameters:
      +
      T - The concrete type, used to provide a fluent interface.
      +
      U - The import container used by the writer to manage imports.
      +
      +
      +
      All Implemented Interfaces:
      +
      SymbolDependencyContainer
      +
      +
      +
      @Deprecated
+public class SymbolWriter<T extends SymbolWriter<T,​U>,​U extends ImportContainer>
+extends AbstractCodeWriter<T>
+implements SymbolDependencyContainer
      +
      Deprecated.
      +
      This class is deprecated and will be removed in a future release. + +

      Use SymbolWriter instead.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + + + +
          +
        • +

          SymbolWriter

          +
          public SymbolWriter​(DocWriter<T> documentationWriter,
+                    U importContainer)
          +
          Deprecated.
          +
          +
          Parameters:
          +
          documentationWriter - Writes out documentation emitted by a Runnable.
          +
          importContainer - Container used to persist and filter imports based on package names.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setRelativizeSymbols

          +
          public T setRelativizeSymbols​(java.lang.String relativizeSymbols)
          +
          Deprecated.
          +
          Sets a string used to relativize Symbols formatted using the default T + implementation used by CodegenWriter in the current state. + +

          In many programming languages, when referring to types in the same namespace as + the current scope of a CodegenWriter, the symbols written in that scope don't need + to be fully-qualified. They can just reference the unqualified type name. By setting + a value for relativizeSymbols, if the result of Symbol.getNamespace() + is equal to relativizeSymbols, then the unqualified name of the symbol is + written to the CodegenWriter when the default implementation of T + is written. Symbols that refer to types in other namespaces will write the fully + qualified type. + +

          Note: This method may have no effect if a programming language + does not use namespaces or concepts like namespaces or if T has been + overridden with another implementation.

          +
          +
          Parameters:
          +
          relativizeSymbols - The package name, namespace, etc to relativize symbols with.
          +
          Returns:
          +
          Returns the CodegenWriter.
          +
          +
          • +
        + + + +
          +
        • +

          getDocumentationWriter

          +
          public final DocWriter<T> getDocumentationWriter()
          +
          Deprecated.
          +
          Gets the documentation writer.
          +
          +
          Returns:
          +
          Returns the documentation writer.
          +
          +
          • +
        + + + +
          +
        • +

          getImportContainer

          +
          public final U getImportContainer()
          +
          Deprecated.
          +
          Gets the import container associated with the writer. + +

          The AbstractCodeWriter.toString() method of the CodegenWriter should + be overridden so that it includes the import container's contents in + the output as appropriate.

          +
          +
          Returns:
          +
          Returns the import container.
          +
          +
          • +
        + + + +
          +
        • +

          getDependencies

          +
          public final java.util.List<SymbolDependency> getDependencies()
          +
          Deprecated.
          +
          Description copied from interface: SymbolDependencyContainer
          +
          Gets the list of dependencies that this object introduces. + +

          A dependency is a dependency on another package that a Symbol + or type requires. It is quite different from a reference since a + reference only refers to a symbol; a reference provides no context + as to whether or not a dependency is required or the dependency's + coordinates.

          +
          +
          Specified by:
          +
          getDependencies in interface SymbolDependencyContainer
          +
          Returns:
          +
          Returns the dependencies.
          +
          +
          • +
        + + + +
          +
        • +

          addDependency

          +
          public final T addDependency​(SymbolDependencyContainer dependencies)
          +
          Deprecated.
          +
          Adds one or more dependencies to the generated code (represented as + a SymbolDependency). + +

          Tracking dependencies on a CodegenWriter allows dependencies + to be automatically aggregated and collected in order to generate + configuration files for dependency management tools (e.g., npm, + maven, etc).

          +
          +
          Parameters:
          +
          dependencies - Dependency to add.
          +
          Returns:
          +
          Returns the writer.
          +
          +
          • +
        + + + +
          +
        • +

          addUseImports

          +
          public T addUseImports​(SymbolContainer container)
          +
          Deprecated.
          +
          Imports one or more USE symbols using the name of the symbol + (e.g., SymbolReference.ContextOption.USE references). + +

          USE references are only necessary when referring to a symbol, not + declaring the symbol. For example, when referring to a + List<Foo>, the USE references would be both the List + type and Foo type. + +

          This method may be overridden as needed.

          +
          +
          Parameters:
          +
          container - Symbols to add.
          +
          Returns:
          +
          Returns the writer.
          +
          +
          • +
        + + + +
          +
        • +

          addUseImports

          +
          public T addUseImports​(SymbolReference symbolReference)
          +
          Deprecated.
          +
          Imports a USE symbols possibly using an alias of the symbol + (e.g., SymbolReference.ContextOption.USE references). + +

          This method may be overridden as needed.

          +
          +
          Parameters:
          +
          symbolReference - Symbol reference to import.
          +
          Returns:
          +
          Returns the writer.
          +
          See Also:
          +
          addUseImports(SymbolContainer)
          +
          +
          • +
        + + + + + + + +
          +
        • +

          writeDocs

          +
          public final T writeDocs​(java.lang.Runnable runnable)
          +
          Deprecated.
          +
          Writes documentation comments. + +

          This method is responsible for setting up the writer to begin + writing documentation comments. This includes writing any necessary + opening tokens (e.g., "/*"), adding tokens to the beginning of lines + (e.g., "*"), sanitizing documentation strings, and writing any + tokens necessary to close documentation comments (e.g., "*\/"). + +

          This method does not automatically escape the expression + start character ("$" by default). Write calls made by the Runnable + should either use AbstractCodeWriter.writeWithNoFormatting(java.lang.Object) or escape + the expression start character manually. + +

          This method may be overridden as needed.

          +
          +
          Parameters:
          +
          runnable - Runnable that handles actually writing docs with the writer.
          +
          Returns:
          +
          Returns the writer.
          +
          +
          • +
        + + + +
          +
        • +

          writeDocs

          +
          public final T writeDocs​(java.lang.String docs)
          +
          Deprecated.
          +
          Writes documentation comments from a string.
          +
          +
          Parameters:
          +
          docs - Documentation to write.
          +
          Returns:
          +
          Returns the writer.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/package-summary.html new file mode 100644 index 00000000000..225419b067a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/package-summary.html @@ -0,0 +1,221 @@ + + + + + +software.amazon.smithy.codegen.core.writer (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    @Deprecated +

    +

    Package software.amazon.smithy.codegen.core.writer

    +
    +
    +
    + + +
    Deprecated.
    +
    This package is deprecated and will be removed in a future release.
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/package-tree.html new file mode 100644 index 00000000000..4bb398446c1 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/codegen/core/writer/package-tree.html @@ -0,0 +1,185 @@ + + + + + +software.amazon.smithy.codegen.core.writer Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.codegen.core.writer

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/ChangedMetadata.html b/javadoc/1.47.0/software/amazon/smithy/diff/ChangedMetadata.html new file mode 100644 index 00000000000..049fe633785 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/ChangedMetadata.html @@ -0,0 +1,379 @@ + + + + + +ChangedMetadata (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.diff
    +

    Class ChangedMetadata

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.diff.ChangedMetadata
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      FromSourceLocation
      +
      +
      +
      public final class ChangedMetadata
+extends java.lang.Object
+implements FromSourceLocation
      +
      Represents a change in metadata.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        booleanequals​(java.lang.Object o) 
        java.lang.StringgetKey() +
        Gets the key of the metadata that changed.
        +
        NodegetNewValue() +
        Gets the new metadata value for this key.
        +
        NodegetOldValue() +
        Gets the old metadata value for this key.
        +
        SourceLocationgetSourceLocation() +
        Gets the source location of a value.
        +
        inthashCode() 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getKey

          +
          public java.lang.String getKey()
          +
          Gets the key of the metadata that changed.
          +
          +
          Returns:
          +
          Returns the changed key.
          +
          +
          • +
        + + + +
          +
        • +

          getOldValue

          +
          public Node getOldValue()
          +
          Gets the old metadata value for this key.
          +
          +
          Returns:
          +
          Returns the value in the old model.
          +
          +
          • +
        + + + +
          +
        • +

          getNewValue

          +
          public Node getNewValue()
          +
          Gets the new metadata value for this key.
          +
          +
          Returns:
          +
          Returns the value in the new model.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/ChangedShape.html b/javadoc/1.47.0/software/amazon/smithy/diff/ChangedShape.html new file mode 100644 index 00000000000..c20b0aaa144 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/ChangedShape.html @@ -0,0 +1,613 @@ + + + + + +ChangedShape (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.diff
    +

    Class ChangedShape<S extends Shape>

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.diff.ChangedShape<S>
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Type Parameters:
      +
      S - The type of shape. Note that this may be just Shape + in the event that the shape changed classes.
      +
      +
      +
      All Implemented Interfaces:
      +
      FromSourceLocation
      +
      +
      +
      public final class ChangedShape<S extends Shape>
+extends java.lang.Object
+implements FromSourceLocation
      +
      Represents a changed shape.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + + + +
          +
        • +

          ChangedShape

          +
          public ChangedShape​(S oldShape,
+                    S newShape)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getOldShape

          +
          public S getOldShape()
          +
          Gets the old shape value.
          +
          +
          Returns:
          +
          Returns the old shape.
          +
          +
          • +
        + + + +
          +
        • +

          getNewShape

          +
          public S getNewShape()
          +
          Gets the new shape value.
          +
          +
          Returns:
          +
          Returns the new shape.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getShapeId

          +
          public ShapeId getShapeId()
          +
          Gets the shape ID of the changed shape.
          +
          +
          Returns:
          +
          Return the shape ID.
          +
          +
          • +
        + + + +
          +
        • +

          addedTraits

          +
          public java.util.stream.Stream<Trait> addedTraits()
          +
          Gets a stream of added traits.
          +
          +
          Returns:
          +
          Returns the traits that were added.
          +
          +
          • +
        + + + +
          +
        • +

          removedTraits

          +
          public java.util.stream.Stream<Trait> removedTraits()
          +
          Gets a stream of removed traits.
          +
          +
          Returns:
          +
          Returns the traits that were removed.
          +
          +
          • +
        + + + +
          +
        • +

          changedTraits

          +
          public java.util.stream.Stream<Pair<Trait,​Trait>> changedTraits()
          +
          Gets a stream of changed traits.
          +
          +
          Returns:
          +
          Returns the traits that were changed.
          +
          +
          • +
        + + + +
          +
        • +

          isTraitAdded

          +
          public boolean isTraitAdded​(ShapeId trait)
          +
          Checks if the trait was added.
          +
          +
          Parameters:
          +
          trait - Trait to check.
          +
          Returns:
          +
          Returns true if the trait was added.
          +
          +
          • +
        + + + +
          +
        • +

          isTraitRemoved

          +
          public boolean isTraitRemoved​(ShapeId trait)
          +
          Checks if the trait was removed.
          +
          +
          Parameters:
          +
          trait - Trait to check.
          +
          Returns:
          +
          Returns true if the trait was removed.
          +
          +
          • +
        + + + +
          +
        • +

          isTraitInBoth

          +
          public boolean isTraitInBoth​(ShapeId trait)
          +
          Checks if the given trait is in the old shape and new shape.
          +
          +
          Parameters:
          +
          trait - Trait to check.
          +
          Returns:
          +
          Returns true if the trait is in the old and new shape.
          +
          +
          • +
        + + + +
          +
        • +

          getChangedTrait

          +
          public <T extends Trait> java.util.Optional<Pair<T,​T>> getChangedTrait​(java.lang.Class<T> traitType)
          +
          Gets a changed trait of a specific type.
          +
          +
          Type Parameters:
          +
          T - Type of trait to find.
          +
          Parameters:
          +
          traitType - Type of trait to find.
          +
          Returns:
          +
          Returns the optionally found old and new typed trait values.
          +
          +
          • +
        + + + +
          +
        • +

          getTraitDifferences

          +
          public java.util.Map<ShapeId,​Pair<Trait,​Trait>> getTraitDifferences()
          +
          Gets the trait differences between the old and new shape. + +

          The returned map is a mapping of a trait name to a pair in which the + left side of the pair contains the nullable old trait value, and the + right side of the pair contains the nullable new trait value. The left + side will be null if the trait was added, the right side will be null + if the trait was removed, and both traits will be present if the trait + changed.

          +
          +
          Returns:
          +
          Returns a map of each changed trait name to a pair of the old and new trait values.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/DiffEvaluator.html b/javadoc/1.47.0/software/amazon/smithy/diff/DiffEvaluator.html new file mode 100644 index 00000000000..4343e8aa4ae --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/DiffEvaluator.html @@ -0,0 +1,278 @@ + + + + + +DiffEvaluator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.diff
    +

    Interface DiffEvaluator

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          evaluate

          +
          java.util.List<ValidationEvent> evaluate​(Differences differences)
          +
          Returns validation events given two models and the detected + differences between them.
          +
          +
          Parameters:
          +
          differences - Detected differences.
          +
          Returns:
          +
          Returns validation events that are relative to the new model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/Differences.html b/javadoc/1.47.0/software/amazon/smithy/diff/Differences.html new file mode 100644 index 00000000000..981976de70d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/Differences.html @@ -0,0 +1,536 @@ + + + + + +Differences (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.diff
    +

    Class Differences

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.diff.Differences
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class Differences
+extends java.lang.Object
      +
      Queryable container for detected structural differences between two models.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.util.stream.Stream<Pair<java.lang.String,​Node>>addedMetadata() +
        Gets all added metadata.
        +
        java.util.stream.Stream<Shape>addedShapes() +
        Gets all added shapes.
        +
        <T extends Shape>
        java.util.stream.Stream<T>        		addedShapes​(java.lang.Class<T> shapeType) +
        Gets all of the added shapes of a specific type.
        +
        java.util.stream.Stream<ChangedMetadata>changedMetadata() +
        Gets a stream of all changed metadata.
        +
        java.util.stream.Stream<ChangedShape<Shape>>changedShapes() +
        Gets all changed shapes.
        +
        <T extends Shape>
        java.util.stream.Stream<ChangedShape<T>>        		changedShapes​(java.lang.Class<T> type) +
        Gets all changed shapes of a specific type.
        +
        booleanequals​(java.lang.Object o) 
        ModelgetNewModel() +
        Gets the new model.
        +
        ModelgetOldModel() +
        Gets the old model.
        +
        inthashCode() 
        java.util.stream.Stream<Pair<java.lang.String,​Node>>removedMetadata() +
        Gets all removed metadata.
        +
        java.util.stream.Stream<Shape>removedShapes() +
        Gets all removed shapes.
        +
        <T extends Shape>
        java.util.stream.Stream<T>        		removedShapes​(java.lang.Class<T> shapeType) +
        Gets all of the removed shapes of a specific type.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getOldModel

          +
          public Model getOldModel()
          +
          Gets the old model.
          +
          +
          Returns:
          +
          Returns the old model.
          +
          +
          • +
        + + + +
          +
        • +

          getNewModel

          +
          public Model getNewModel()
          +
          Gets the new model.
          +
          +
          Returns:
          +
          Returns the new model.
          +
          +
          • +
        + + + +
          +
        • +

          addedShapes

          +
          public java.util.stream.Stream<Shape> addedShapes()
          +
          Gets all added shapes.
          +
          +
          Returns:
          +
          Returns a stream of each added shape.
          +
          +
          • +
        + + + +
          +
        • +

          addedShapes

          +
          public <T extends Shape> java.util.stream.Stream<T> addedShapes​(java.lang.Class<T> shapeType)
          +
          Gets all of the added shapes of a specific type.
          +
          +
          Type Parameters:
          +
          T - Type of shape.
          +
          Parameters:
          +
          shapeType - Type of shape to find.
          +
          Returns:
          +
          Returns a stream of each added shape of a specific type.
          +
          +
          • +
        + + + +
          +
        • +

          addedMetadata

          +
          public java.util.stream.Stream<Pair<java.lang.String,​Node>> addedMetadata()
          +
          Gets all added metadata. + +

          Each Pair returned contains the name of the metadata key on + the left of the Pair and the metadata value on the right.

          +
          +
          Returns:
          +
          Returns a stream of added metadata.
          +
          +
          • +
        + + + +
          +
        • +

          removedShapes

          +
          public java.util.stream.Stream<Shape> removedShapes()
          +
          Gets all removed shapes.
          +
          +
          Returns:
          +
          Returns a stream of each removed shape.
          +
          +
          • +
        + + + +
          +
        • +

          removedShapes

          +
          public <T extends Shape> java.util.stream.Stream<T> removedShapes​(java.lang.Class<T> shapeType)
          +
          Gets all of the removed shapes of a specific type.
          +
          +
          Type Parameters:
          +
          T - Type of shape.
          +
          Parameters:
          +
          shapeType - Type of shape to find.
          +
          Returns:
          +
          Returns a stream of each removed shape of a specific type.
          +
          +
          • +
        + + + +
          +
        • +

          removedMetadata

          +
          public java.util.stream.Stream<Pair<java.lang.String,​Node>> removedMetadata()
          +
          Gets all removed metadata. + +

          Each Pair returned contains the name of the metadata key on + the left of the Pair and the metadata value on the right.

          +
          +
          Returns:
          +
          Returns a stream of removed metadata.
          +
          +
          • +
        + + + +
          +
        • +

          changedShapes

          +
          public java.util.stream.Stream<ChangedShape<Shape>> changedShapes()
          +
          Gets all changed shapes.
          +
          +
          Returns:
          +
          Returns a stream of changed shapes.
          +
          +
          • +
        + + + +
          +
        • +

          changedShapes

          +
          public <T extends Shape> java.util.stream.Stream<ChangedShape<T>> changedShapes​(java.lang.Class<T> type)
          +
          Gets all changed shapes of a specific type.
          +
          +
          Type Parameters:
          +
          T - Type of shape.
          +
          Parameters:
          +
          type - Type of shape to find.
          +
          Returns:
          +
          Returns a stream of matching changed shapes.
          +
          +
          • +
        + + + +
          +
        • +

          changedMetadata

          +
          public java.util.stream.Stream<ChangedMetadata> changedMetadata()
          +
          Gets a stream of all changed metadata.
          +
          +
          Returns:
          +
          Returns the changed metadata.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/ModelDiff.Builder.html b/javadoc/1.47.0/software/amazon/smithy/diff/ModelDiff.Builder.html new file mode 100644 index 00000000000..89401d6c0de --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/ModelDiff.Builder.html @@ -0,0 +1,399 @@ + + + + + +ModelDiff.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.diff
    +

    Class ModelDiff.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.diff.ModelDiff.Builder
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      ModelDiff
      +
      +
      +
      public static final class ModelDiff.Builder
+extends java.lang.Object
      +
      Builder used to construct a diff of two Smithy models.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          classLoader

          +
          public ModelDiff.Builder classLoader​(java.lang.ClassLoader classLoader)
          +
          Sets the ClassLoader used to find DiffEvaluator service + providers.
          +
          +
          Parameters:
          +
          classLoader - ClassLoader to use.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          oldModel

          +
          public ModelDiff.Builder oldModel​(Model oldModel)
          +
          Sets the old model to compare against.
          +
          +
          Parameters:
          +
          oldModel - Old version of a model.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          newModel

          +
          public ModelDiff.Builder newModel​(Model newModel)
          +
          Sets the new model to compare against.
          +
          +
          Parameters:
          +
          newModel - New version of a model.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          oldModel

          +
          public ModelDiff.Builder oldModel​(ValidatedResult<Model> oldModel)
          +
          Sets the old model to compare against along with the validation + events encountered while loading the model.
          +
          +
          Parameters:
          +
          oldModel - Old version of a model with events.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          newModel

          +
          public ModelDiff.Builder newModel​(ValidatedResult<Model> newModel)
          +
          Sets the new model to compare against along with the validation + events encountered while loading the model.
          +
          +
          Parameters:
          +
          newModel - New version of a model with events.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          compare

          +
          public ModelDiff.Result compare()
          +
          Performs the diff of the old and new models.
          +
          +
          Returns:
          +
          Returns the diff ModelDiff.Result.
          +
          Throws:
          +
          java.lang.IllegalStateException - if oldModel and newModel are not set.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/ModelDiff.Result.html b/javadoc/1.47.0/software/amazon/smithy/diff/ModelDiff.Result.html new file mode 100644 index 00000000000..3b086deb989 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/ModelDiff.Result.html @@ -0,0 +1,488 @@ + + + + + +ModelDiff.Result (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.diff
    +

    Class ModelDiff.Result

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.diff.ModelDiff.Result
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      ModelDiff
      +
      +
      +
      public static final class ModelDiff.Result
+extends java.lang.Object
      +
      The result of comparing two Smithy models.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getDifferences

          +
          public Differences getDifferences()
          +
          Gets a queryable set of differences between two models.
          +
          +
          Returns:
          +
          Returns the differences.
          +
          +
          • +
        + + + +
          +
        • +

          getDiffEvents

          +
          public java.util.List<ValidationEvent> getDiffEvents()
          +
          Gets the diff analysis as a list of ValidationEvents.
          +
          +
          Returns:
          +
          Returns the diff validation events.
          +
          +
          • +
        + + + +
          +
        • +

          getOldModelEvents

          +
          public java.util.List<ValidationEvent> getOldModelEvents()
          +
          Gets the validation events emitted when validating the old model.
          +
          +
          Returns:
          +
          Returns the old model's validation events.
          +
          +
          • +
        + + + +
          +
        • +

          getNewModelEvents

          +
          public java.util.List<ValidationEvent> getNewModelEvents()
          +
          Gets the validation events emitted when validating the new model.
          +
          +
          Returns:
          +
          Returns the new model's validation events.
          +
          +
          • +
        + + + +
          +
        • +

          determineResolvedEvents

          +
          public java.util.Set<ValidationEvent> determineResolvedEvents()
          +
          Gets the validation events that were present in the old model but + are no longer an issue in the new model.
          +
          +
          Returns:
          +
          Returns the resolved validation events.
          +
          +
          • +
        + + + +
          +
        • +

          determineIntroducedEvents

          +
          public java.util.Set<ValidationEvent> determineIntroducedEvents()
          +
          Gets the validation events that were introduced by whatever changes + were made to the new model.
          +
          +
          Returns:
          +
          Returns the validation events introduced by the new model.
          +
          +
          • +
        + + + +
          +
        • +

          isDiffBreaking

          +
          public boolean isDiffBreaking()
          +
          Determines if the diff events contain any DANGER or ERROR events.
          +
          +
          Returns:
          +
          Returns true if this diff has breaking changes.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/ModelDiff.html b/javadoc/1.47.0/software/amazon/smithy/diff/ModelDiff.html new file mode 100644 index 00000000000..1cca1b49866 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/ModelDiff.html @@ -0,0 +1,364 @@ + + + + + +ModelDiff (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.diff
    +

    Class ModelDiff

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.diff.ModelDiff
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class ModelDiff
+extends java.lang.Object
      +
      Computes the difference between two models and any problems that might + occur due to those differences.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static class ModelDiff.Builder +
        Builder used to construct a diff of two Smithy models.
        +
        static class ModelDiff.Result +
        The result of comparing two Smithy models.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static ModelDiff.Builderbuilder() +
        Creates a new ModelDiff.Builder that provides in-depth diff analysis.
        +
        static java.util.List<ValidationEvent>compare​(java.lang.ClassLoader classLoader, + Model oldModel, + Model newModel) +
        Evaluates the differences between two models.
        +
        static java.util.List<ValidationEvent>compare​(Model oldModel, + Model newModel) +
        Evaluates the differences between two models.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + +
          +
        • +

          builder

          +
          public static ModelDiff.Builder builder()
          +
          Creates a new ModelDiff.Builder that provides in-depth diff analysis.
          +
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          compare

          +
          public static java.util.List<ValidationEvent> compare​(Model oldModel,
+                                                      Model newModel)
          +
          Evaluates the differences between two models. + +

          Use ModelDiff.Builder directly to get access to additional information.

          +
          +
          Parameters:
          +
          oldModel - Previous version of the model.
          +
          newModel - New model to compare.
          +
          Returns:
          +
          Returns the computed validation events.
          +
          +
          • +
        + + + +
          +
        • +

          compare

          +
          public static java.util.List<ValidationEvent> compare​(java.lang.ClassLoader classLoader,
+                                                      Model oldModel,
+                                                      Model newModel)
          +
          Evaluates the differences between two models. + +

          Use ModelDiff.Builder directly to get access to additional information.

          +
          +
          Parameters:
          +
          classLoader - ClassLoader used to find DiffEvaluator service providers.
          +
          oldModel - Previous version of the model.
          +
          newModel - New model to compare.
          +
          Returns:
          +
          Returns the computed validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/AbstractDiffEvaluator.html b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/AbstractDiffEvaluator.html new file mode 100644 index 00000000000..385fd8e82f0 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/AbstractDiffEvaluator.html @@ -0,0 +1,467 @@ + + + + + +AbstractDiffEvaluator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.diff.evaluators
    +

    Class AbstractDiffEvaluator

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.diff.evaluators.AbstractDiffEvaluator
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/AddedEntityBinding.html b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/AddedEntityBinding.html new file mode 100644 index 00000000000..d869016470d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/AddedEntityBinding.html @@ -0,0 +1,338 @@ + + + + + +AddedEntityBinding (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.diff.evaluators
    +

    Class AddedEntityBinding

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      DiffEvaluator
      +
      +
      +
      public final class AddedEntityBinding
+extends AbstractDiffEvaluator
      +
      A meta-validator that emits a NOTE when an operation resource is added + to a service or resource entity. + +

      An "AddedOperationBinding" eventId is used when an operation is + added, and an "AddedResourceBinding" eventId is used when a + resource is added.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          AddedEntityBinding

          +
          public AddedEntityBinding()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          evaluate

          +
          public java.util.List<ValidationEvent> evaluate​(Differences differences)
          +
          Description copied from interface: DiffEvaluator
          +
          Returns validation events given two models and the detected + differences between them.
          +
          +
          Parameters:
          +
          differences - Detected differences.
          +
          Returns:
          +
          Returns validation events that are relative to the new model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/AddedMetadata.html b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/AddedMetadata.html new file mode 100644 index 00000000000..02bc07e1205 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/AddedMetadata.html @@ -0,0 +1,333 @@ + + + + + +AddedMetadata (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.diff.evaluators
    +

    Class AddedMetadata

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          AddedMetadata

          +
          public AddedMetadata()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          evaluate

          +
          public java.util.List<ValidationEvent> evaluate​(Differences differences)
          +
          Description copied from interface: DiffEvaluator
          +
          Returns validation events given two models and the detected + differences between them.
          +
          +
          Parameters:
          +
          differences - Detected differences.
          +
          Returns:
          +
          Returns validation events that are relative to the new model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/AddedOperationError.html b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/AddedOperationError.html new file mode 100644 index 00000000000..31cdf84a008 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/AddedOperationError.html @@ -0,0 +1,333 @@ + + + + + +AddedOperationError (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.diff.evaluators
    +

    Class AddedOperationError

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      DiffEvaluator
      +
      +
      +
      public final class AddedOperationError
+extends AbstractDiffEvaluator
      +
      Emits a warning when an error is added to an operation.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          AddedOperationError

          +
          public AddedOperationError()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          evaluate

          +
          public java.util.List<ValidationEvent> evaluate​(Differences differences)
          +
          Description copied from interface: DiffEvaluator
          +
          Returns validation events given two models and the detected + differences between them.
          +
          +
          Parameters:
          +
          differences - Detected differences.
          +
          Returns:
          +
          Returns validation events that are relative to the new model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/AddedRequiredMember.html b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/AddedRequiredMember.html new file mode 100644 index 00000000000..a08f924f77b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/AddedRequiredMember.html @@ -0,0 +1,334 @@ + + + + + +AddedRequiredMember (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.diff.evaluators
    +

    Class AddedRequiredMember

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      DiffEvaluator
      +
      +
      +
      public class AddedRequiredMember
+extends AbstractDiffEvaluator
      +
      Validates that no members are newly created with the required trait + (but no default trait) in existing structures.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          AddedRequiredMember

          +
          public AddedRequiredMember()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          evaluate

          +
          public java.util.List<ValidationEvent> evaluate​(Differences differences)
          +
          Description copied from interface: DiffEvaluator
          +
          Returns validation events given two models and the detected + differences between them.
          +
          +
          Parameters:
          +
          differences - Detected differences.
          +
          Returns:
          +
          Returns validation events that are relative to the new model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/AddedServiceError.html b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/AddedServiceError.html new file mode 100644 index 00000000000..e8c91a59a5d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/AddedServiceError.html @@ -0,0 +1,333 @@ + + + + + +AddedServiceError (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.diff.evaluators
    +

    Class AddedServiceError

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      DiffEvaluator
      +
      +
      +
      public final class AddedServiceError
+extends AbstractDiffEvaluator
      +
      Emits a warning when an error is added to a service.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          AddedServiceError

          +
          public AddedServiceError()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          evaluate

          +
          public java.util.List<ValidationEvent> evaluate​(Differences differences)
          +
          Description copied from interface: DiffEvaluator
          +
          Returns validation events given two models and the detected + differences between them.
          +
          +
          Parameters:
          +
          differences - Detected differences.
          +
          Returns:
          +
          Returns validation events that are relative to the new model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/AddedShape.html b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/AddedShape.html new file mode 100644 index 00000000000..08c97a7fad4 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/AddedShape.html @@ -0,0 +1,333 @@ + + + + + +AddedShape (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.diff.evaluators
    +

    Class AddedShape

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          AddedShape

          +
          public AddedShape()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          evaluate

          +
          public java.util.List<ValidationEvent> evaluate​(Differences differences)
          +
          Description copied from interface: DiffEvaluator
          +
          Returns validation events given two models and the detected + differences between them.
          +
          +
          Parameters:
          +
          differences - Detected differences.
          +
          Returns:
          +
          Returns validation events that are relative to the new model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/AddedTraitDefinition.html b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/AddedTraitDefinition.html new file mode 100644 index 00000000000..8fde10152ea --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/AddedTraitDefinition.html @@ -0,0 +1,333 @@ + + + + + +AddedTraitDefinition (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.diff.evaluators
    +

    Class AddedTraitDefinition

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      DiffEvaluator
      +
      +
      +
      public final class AddedTraitDefinition
+extends AbstractDiffEvaluator
      +
      Creates a NOTE event when a trait definition is added.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          AddedTraitDefinition

          +
          public AddedTraitDefinition()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          evaluate

          +
          public java.util.List<ValidationEvent> evaluate​(Differences differences)
          +
          Description copied from interface: DiffEvaluator
          +
          Returns validation events given two models and the detected + differences between them.
          +
          +
          Parameters:
          +
          differences - Detected differences.
          +
          Returns:
          +
          Returns validation events that are relative to the new model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedDefault.html b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedDefault.html new file mode 100644 index 00000000000..24cb39145ae --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedDefault.html @@ -0,0 +1,332 @@ + + + + + +ChangedDefault (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.diff.evaluators
    +

    Class ChangedDefault

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ChangedDefault

          +
          public ChangedDefault()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          evaluate

          +
          public java.util.List<ValidationEvent> evaluate​(Differences differences)
          +
          Description copied from interface: DiffEvaluator
          +
          Returns validation events given two models and the detected + differences between them.
          +
          +
          Parameters:
          +
          differences - Detected differences.
          +
          Returns:
          +
          Returns validation events that are relative to the new model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedEnumTrait.html b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedEnumTrait.html new file mode 100644 index 00000000000..1385cad6b98 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedEnumTrait.html @@ -0,0 +1,336 @@ + + + + + +ChangedEnumTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.diff.evaluators
    +

    Class ChangedEnumTrait

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      DiffEvaluator
      +
      +
      +
      public final class ChangedEnumTrait
+extends AbstractDiffEvaluator
      +
      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.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ChangedEnumTrait

          +
          public ChangedEnumTrait()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          evaluate

          +
          public java.util.List<ValidationEvent> evaluate​(Differences differences)
          +
          Description copied from interface: DiffEvaluator
          +
          Returns validation events given two models and the detected + differences between them.
          +
          +
          Parameters:
          +
          differences - Detected differences.
          +
          Returns:
          +
          Returns validation events that are relative to the new model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedLengthTrait.html b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedLengthTrait.html new file mode 100644 index 00000000000..64c51a5be3f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedLengthTrait.html @@ -0,0 +1,376 @@ + + + + + +ChangedLengthTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.diff.evaluators
    +

    Class ChangedLengthTrait

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      DiffEvaluator
      +
      +
      +
      public final class ChangedLengthTrait
+extends AbstractDiffEvaluator
      +
      Detects when the Length trait is made more restrictive by either + raising the min or lowering the max.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ChangedLengthTrait

          +
          public ChangedLengthTrait()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getTraitType

          +
          protected java.lang.Class<LengthTrait> getTraitType()
          +
          • +
        + + + +
          +
        • +

          getMin

          +
          protected java.util.Optional<java.math.BigDecimal> getMin​(LengthTrait t)
          +
          • +
        + + + +
          +
        • +

          getMax

          +
          protected java.util.Optional<java.math.BigDecimal> getMax​(LengthTrait t)
          +
          • +
        + + + +
          +
        • +

          evaluate

          +
          public final java.util.List<ValidationEvent> evaluate​(Differences differences)
          +
          Description copied from interface: DiffEvaluator
          +
          Returns validation events given two models and the detected + differences between them.
          +
          +
          Parameters:
          +
          differences - Detected differences.
          +
          Returns:
          +
          Returns validation events that are relative to the new model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedMemberOrder.html b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedMemberOrder.html new file mode 100644 index 00000000000..265585acb7c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedMemberOrder.html @@ -0,0 +1,335 @@ + + + + + +ChangedMemberOrder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.diff.evaluators
    +

    Class ChangedMemberOrder

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      DiffEvaluator
      +
      +
      +
      public final class ChangedMemberOrder
+extends AbstractDiffEvaluator
      +
      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.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ChangedMemberOrder

          +
          public ChangedMemberOrder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          evaluate

          +
          public java.util.List<ValidationEvent> evaluate​(Differences differences)
          +
          Description copied from interface: DiffEvaluator
          +
          Returns validation events given two models and the detected + differences between them.
          +
          +
          Parameters:
          +
          differences - Detected differences.
          +
          Returns:
          +
          Returns validation events that are relative to the new model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedMemberTarget.html b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedMemberTarget.html new file mode 100644 index 00000000000..3b49ec2be87 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedMemberTarget.html @@ -0,0 +1,341 @@ + + + + + +ChangedMemberTarget (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.diff.evaluators
    +

    Class ChangedMemberTarget

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      DiffEvaluator
      +
      +
      +
      public final class ChangedMemberTarget
+extends AbstractDiffEvaluator
      +
      Checks for changes in the shapes targeted by a member. + +

      If the shape targeted by the member changes from a simple shape to + a simple shape of the same type with the same traits, or a list or set + that has a member that targets the shame exact shape and has the same + traits, then the emitted event is a WARNING. If an enum trait is + found on the old or newly targeted shape, then the event is an ERROR, + because enum traits typically materialize as named types in codegen. + All other changes are ERROR events.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ChangedMemberTarget

          +
          public ChangedMemberTarget()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          evaluate

          +
          public java.util.List<ValidationEvent> evaluate​(Differences differences)
          +
          Description copied from interface: DiffEvaluator
          +
          Returns validation events given two models and the detected + differences between them.
          +
          +
          Parameters:
          +
          differences - Detected differences.
          +
          Returns:
          +
          Returns validation events that are relative to the new model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedMetadata.html b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedMetadata.html new file mode 100644 index 00000000000..104360444aa --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedMetadata.html @@ -0,0 +1,333 @@ + + + + + +ChangedMetadata (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.diff.evaluators
    +

    Class ChangedMetadata

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      DiffEvaluator
      +
      +
      +
      public final class ChangedMetadata
+extends AbstractDiffEvaluator
      +
      Creates a WARNING event when metadata is changed.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ChangedMetadata

          +
          public ChangedMetadata()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          evaluate

          +
          public java.util.List<ValidationEvent> evaluate​(Differences differences)
          +
          Description copied from interface: DiffEvaluator
          +
          Returns validation events given two models and the detected + differences between them.
          +
          +
          Parameters:
          +
          differences - Detected differences.
          +
          Returns:
          +
          Returns validation events that are relative to the new model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedNullability.html b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedNullability.html new file mode 100644 index 00000000000..b5e8527bbbc --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedNullability.html @@ -0,0 +1,336 @@ + + + + + +ChangedNullability (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.diff.evaluators
    +

    Class ChangedNullability

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      DiffEvaluator
      +
      +
      +
      public class ChangedNullability
+extends AbstractDiffEvaluator
      +
      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.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ChangedNullability

          +
          public ChangedNullability()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          evaluate

          +
          public java.util.List<ValidationEvent> evaluate​(Differences differences)
          +
          Description copied from interface: DiffEvaluator
          +
          Returns validation events given two models and the detected + differences between them.
          +
          +
          Parameters:
          +
          differences - Detected differences.
          +
          Returns:
          +
          Returns validation events that are relative to the new model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedOperationInput.html b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedOperationInput.html new file mode 100644 index 00000000000..77bde641262 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedOperationInput.html @@ -0,0 +1,334 @@ + + + + + +ChangedOperationInput (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.diff.evaluators
    +

    Class ChangedOperationInput

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      DiffEvaluator
      +
      +
      +
      public final class ChangedOperationInput
+extends AbstractDiffEvaluator
      +
      Emits an ERROR when the input shape of an operation is changed to + another shape.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ChangedOperationInput

          +
          public ChangedOperationInput()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          evaluate

          +
          public java.util.List<ValidationEvent> evaluate​(Differences differences)
          +
          Description copied from interface: DiffEvaluator
          +
          Returns validation events given two models and the detected + differences between them.
          +
          +
          Parameters:
          +
          differences - Detected differences.
          +
          Returns:
          +
          Returns validation events that are relative to the new model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedOperationOutput.html b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedOperationOutput.html new file mode 100644 index 00000000000..6677ea70195 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedOperationOutput.html @@ -0,0 +1,334 @@ + + + + + +ChangedOperationOutput (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.diff.evaluators
    +

    Class ChangedOperationOutput

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      DiffEvaluator
      +
      +
      +
      public final class ChangedOperationOutput
+extends AbstractDiffEvaluator
      +
      Emits an ERROR when the output shape of an operation is changed to + another shape.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ChangedOperationOutput

          +
          public ChangedOperationOutput()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          evaluate

          +
          public java.util.List<ValidationEvent> evaluate​(Differences differences)
          +
          Description copied from interface: DiffEvaluator
          +
          Returns validation events given two models and the detected + differences between them.
          +
          +
          Parameters:
          +
          differences - Detected differences.
          +
          Returns:
          +
          Returns validation events that are relative to the new model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedRangeTrait.html b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedRangeTrait.html new file mode 100644 index 00000000000..ec362610417 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedRangeTrait.html @@ -0,0 +1,376 @@ + + + + + +ChangedRangeTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.diff.evaluators
    +

    Class ChangedRangeTrait

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      DiffEvaluator
      +
      +
      +
      public final class ChangedRangeTrait
+extends AbstractDiffEvaluator
      +
      Detects when the Range trait is made more restrictive by either + raising the min or lowering the max.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ChangedRangeTrait

          +
          public ChangedRangeTrait()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getTraitType

          +
          protected java.lang.Class<RangeTrait> getTraitType()
          +
          • +
        + + + +
          +
        • +

          getMin

          +
          protected java.util.Optional<java.math.BigDecimal> getMin​(RangeTrait t)
          +
          • +
        + + + +
          +
        • +

          getMax

          +
          protected java.util.Optional<java.math.BigDecimal> getMax​(RangeTrait t)
          +
          • +
        + + + +
          +
        • +

          evaluate

          +
          public final java.util.List<ValidationEvent> evaluate​(Differences differences)
          +
          Description copied from interface: DiffEvaluator
          +
          Returns validation events given two models and the detected + differences between them.
          +
          +
          Parameters:
          +
          differences - Detected differences.
          +
          Returns:
          +
          Returns validation events that are relative to the new model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedResourceIdentifiers.html b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedResourceIdentifiers.html new file mode 100644 index 00000000000..8845686ab71 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedResourceIdentifiers.html @@ -0,0 +1,333 @@ + + + + + +ChangedResourceIdentifiers (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.diff.evaluators
    +

    Class ChangedResourceIdentifiers

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      DiffEvaluator
      +
      +
      +
      public final class ChangedResourceIdentifiers
+extends AbstractDiffEvaluator
      +
      Creates an ERROR event when the identifiers of a resource changes.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ChangedResourceIdentifiers

          +
          public ChangedResourceIdentifiers()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          evaluate

          +
          public java.util.List<ValidationEvent> evaluate​(Differences differences)
          +
          Description copied from interface: DiffEvaluator
          +
          Returns validation events given two models and the detected + differences between them.
          +
          +
          Parameters:
          +
          differences - Detected differences.
          +
          Returns:
          +
          Returns validation events that are relative to the new model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedShapeType.html b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedShapeType.html new file mode 100644 index 00000000000..ee2c4d58d39 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ChangedShapeType.html @@ -0,0 +1,333 @@ + + + + + +ChangedShapeType (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.diff.evaluators
    +

    Class ChangedShapeType

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      DiffEvaluator
      +
      +
      +
      public final class ChangedShapeType
+extends AbstractDiffEvaluator
      +
      Creates an ERROR event when the type of a shape changes.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ChangedShapeType

          +
          public ChangedShapeType()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          evaluate

          +
          public java.util.List<ValidationEvent> evaluate​(Differences differences)
          +
          Description copied from interface: DiffEvaluator
          +
          Returns validation events given two models and the detected + differences between them.
          +
          +
          Parameters:
          +
          differences - Detected differences.
          +
          Returns:
          +
          Returns validation events that are relative to the new model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ModifiedTrait.html b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ModifiedTrait.html new file mode 100644 index 00000000000..d8810352630 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ModifiedTrait.html @@ -0,0 +1,370 @@ + + + + + +ModifiedTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.diff.evaluators
    +

    Class ModifiedTrait

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      DiffEvaluator
      +
      +
      +
      public final class ModifiedTrait
+extends AbstractDiffEvaluator
      +
      Finds breaking changes related to when a trait is added, removed, or + updated. + +

      Note that the use of special diff tags is deprecated in favor of using + the breakingChanges property of a trait definition. See + TraitBreakingChange. + +

      This evaluator looks for trait definitions with specific tags. When + traits that use these tags are added, removed, or updated, a validation + event is emitted for the change. This uses honors the following tags: + +

        +
      • diff.error.add: It is an error to add a trait to an existing shape or to add + a member to a nested trait value.
        • +
      • diff.error.remove: It is an error to remove this trait from a shape or to + remove a member from a nested trait value.
        • +
      • diff.error.update: It is an error to change the value of this shape + or a member of a nested trait value.
        • +
      • diff.error.const: It is an error to add, remove, or update a trait or + a member of a nested trait value.
        • +
      • diff.danger.add: It is a danger to add a trait to an existing shape or to add + a member to a nested trait value.
        • +
      • diff.danger.remove: It is a danger to remove this trait from a shape or to + remove a member from a nested trait value.
        • +
      • diff.danger.update: It is a danger to change the value of this shape + or a member of a nested trait value.
        • +
      • diff.danger.const: It is a danger to add, remove, or update a trait or + a member of a nested trait value.
        • +
      • diff.warning.add: It is a warning to add a trait to an existing shape or to add + a member to a nested trait value.
        • +
      • diff.warning.remove: It is a warning to remove this trait from a shape or to + remove a member from a nested trait value.
        • +
      • diff.warning.update: It is a warning to change the value of this shape + or a member of a nested trait value.
        • +
      • diff.warning.const: It is a warning to add, remove, or update a trait or + a member of a nested trait value.
        • +
      • diff.contents: Inspect the nested contents of a trait using diff tags.
        • +
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ModifiedTrait

          +
          public ModifiedTrait()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          evaluate

          +
          public java.util.List<ValidationEvent> evaluate​(Differences differences)
          +
          Description copied from interface: DiffEvaluator
          +
          Returns validation events given two models and the detected + differences between them.
          +
          +
          Parameters:
          +
          differences - Detected differences.
          +
          Returns:
          +
          Returns validation events that are relative to the new model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/RemovedAuthenticationScheme.html b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/RemovedAuthenticationScheme.html new file mode 100644 index 00000000000..32475cd3c6b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/RemovedAuthenticationScheme.html @@ -0,0 +1,333 @@ + + + + + +RemovedAuthenticationScheme (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.diff.evaluators
    +

    Class RemovedAuthenticationScheme

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      DiffEvaluator
      +
      +
      +
      public final class RemovedAuthenticationScheme
+extends AbstractDiffEvaluator
      +
      TODO: Implement evaluator to find removed authentication schemes.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          RemovedAuthenticationScheme

          +
          public RemovedAuthenticationScheme()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          evaluate

          +
          public java.util.List<ValidationEvent> evaluate​(Differences differences)
          +
          Description copied from interface: DiffEvaluator
          +
          Returns validation events given two models and the detected + differences between them.
          +
          +
          Parameters:
          +
          differences - Detected differences.
          +
          Returns:
          +
          Returns validation events that are relative to the new model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/RemovedEntityBinding.html b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/RemovedEntityBinding.html new file mode 100644 index 00000000000..16f9d4e33d2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/RemovedEntityBinding.html @@ -0,0 +1,338 @@ + + + + + +RemovedEntityBinding (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.diff.evaluators
    +

    Class RemovedEntityBinding

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      DiffEvaluator
      +
      +
      +
      public final class RemovedEntityBinding
+extends AbstractDiffEvaluator
      +
      A meta-validator that checks for the removal of an operation or + resource binding from a service or resource. + +

      A "RemovedOperationBinding" eventId is used when an operation is + removed, and a "RemovedResourceBinding" eventId is used when a + resource is removed.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          RemovedEntityBinding

          +
          public RemovedEntityBinding()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          evaluate

          +
          public java.util.List<ValidationEvent> evaluate​(Differences differences)
          +
          Description copied from interface: DiffEvaluator
          +
          Returns validation events given two models and the detected + differences between them.
          +
          +
          Parameters:
          +
          differences - Detected differences.
          +
          Returns:
          +
          Returns validation events that are relative to the new model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/RemovedMetadata.html b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/RemovedMetadata.html new file mode 100644 index 00000000000..b6e2e43c923 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/RemovedMetadata.html @@ -0,0 +1,333 @@ + + + + + +RemovedMetadata (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.diff.evaluators
    +

    Class RemovedMetadata

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      DiffEvaluator
      +
      +
      +
      public final class RemovedMetadata
+extends AbstractDiffEvaluator
      +
      Creates a DANGER event when metadata is removed.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          RemovedMetadata

          +
          public RemovedMetadata()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          evaluate

          +
          public java.util.List<ValidationEvent> evaluate​(Differences differences)
          +
          Description copied from interface: DiffEvaluator
          +
          Returns validation events given two models and the detected + differences between them.
          +
          +
          Parameters:
          +
          differences - Detected differences.
          +
          Returns:
          +
          Returns validation events that are relative to the new model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/RemovedOperationError.html b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/RemovedOperationError.html new file mode 100644 index 00000000000..d0a2922d228 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/RemovedOperationError.html @@ -0,0 +1,333 @@ + + + + + +RemovedOperationError (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.diff.evaluators
    +

    Class RemovedOperationError

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      DiffEvaluator
      +
      +
      +
      public final class RemovedOperationError
+extends AbstractDiffEvaluator
      +
      Emits a warning when an error is removed from an operation.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          RemovedOperationError

          +
          public RemovedOperationError()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          evaluate

          +
          public java.util.List<ValidationEvent> evaluate​(Differences differences)
          +
          Description copied from interface: DiffEvaluator
          +
          Returns validation events given two models and the detected + differences between them.
          +
          +
          Parameters:
          +
          differences - Detected differences.
          +
          Returns:
          +
          Returns validation events that are relative to the new model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/RemovedServiceError.html b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/RemovedServiceError.html new file mode 100644 index 00000000000..caa9f1a8440 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/RemovedServiceError.html @@ -0,0 +1,333 @@ + + + + + +RemovedServiceError (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.diff.evaluators
    +

    Class RemovedServiceError

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      DiffEvaluator
      +
      +
      +
      public final class RemovedServiceError
+extends AbstractDiffEvaluator
      +
      Emits a warning when an error is removed from a service.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          RemovedServiceError

          +
          public RemovedServiceError()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          evaluate

          +
          public java.util.List<ValidationEvent> evaluate​(Differences differences)
          +
          Description copied from interface: DiffEvaluator
          +
          Returns validation events given two models and the detected + differences between them.
          +
          +
          Parameters:
          +
          differences - Detected differences.
          +
          Returns:
          +
          Returns validation events that are relative to the new model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/RemovedShape.html b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/RemovedShape.html new file mode 100644 index 00000000000..a49945733d2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/RemovedShape.html @@ -0,0 +1,334 @@ + + + + + +RemovedShape (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.diff.evaluators
    +

    Class RemovedShape

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      DiffEvaluator
      +
      +
      +
      public final class RemovedShape
+extends AbstractDiffEvaluator
      +
      Creates an ERROR event when a non-private non-scalar shape is removed. + Creates a WARNING event when a non-private scalar shape is removed.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          RemovedShape

          +
          public RemovedShape()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          evaluate

          +
          public java.util.List<ValidationEvent> evaluate​(Differences differences)
          +
          Description copied from interface: DiffEvaluator
          +
          Returns validation events given two models and the detected + differences between them.
          +
          +
          Parameters:
          +
          differences - Detected differences.
          +
          Returns:
          +
          Returns validation events that are relative to the new model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/RemovedTraitDefinition.html b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/RemovedTraitDefinition.html new file mode 100644 index 00000000000..8150678cd8f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/RemovedTraitDefinition.html @@ -0,0 +1,333 @@ + + + + + +RemovedTraitDefinition (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.diff.evaluators
    +

    Class RemovedTraitDefinition

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      DiffEvaluator
      +
      +
      +
      public final class RemovedTraitDefinition
+extends AbstractDiffEvaluator
      +
      Creates an ERROR event when a trait definition is removed.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          RemovedTraitDefinition

          +
          public RemovedTraitDefinition()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          evaluate

          +
          public java.util.List<ValidationEvent> evaluate​(Differences differences)
          +
          Description copied from interface: DiffEvaluator
          +
          Returns validation events given two models and the detected + differences between them.
          +
          +
          Parameters:
          +
          differences - Detected differences.
          +
          Returns:
          +
          Returns validation events that are relative to the new model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ServiceRename.html b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ServiceRename.html new file mode 100644 index 00000000000..26fdda2f1cd --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/ServiceRename.html @@ -0,0 +1,335 @@ + + + + + +ServiceRename (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.diff.evaluators
    +

    Class ServiceRename

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      DiffEvaluator
      +
      +
      +
      public final class ServiceRename
+extends AbstractDiffEvaluator
      +
      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.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ServiceRename

          +
          public ServiceRename()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          evaluate

          +
          public java.util.List<ValidationEvent> evaluate​(Differences differences)
          +
          Description copied from interface: DiffEvaluator
          +
          Returns validation events given two models and the detected + differences between them.
          +
          +
          Parameters:
          +
          differences - Detected differences.
          +
          Returns:
          +
          Returns validation events that are relative to the new model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/TraitBreakingChange.html b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/TraitBreakingChange.html new file mode 100644 index 00000000000..c52c675cfc2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/TraitBreakingChange.html @@ -0,0 +1,334 @@ + + + + + +TraitBreakingChange (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.diff.evaluators
    +

    Class TraitBreakingChange

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      DiffEvaluator
      +
      +
      +
      public final class TraitBreakingChange
+extends AbstractDiffEvaluator
      +
      Finds breaking changes related to when a trait is added, removed, or + updated based on the breakingChanges property of traits.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          TraitBreakingChange

          +
          public TraitBreakingChange()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          evaluate

          +
          public java.util.List<ValidationEvent> evaluate​(Differences differences)
          +
          Description copied from interface: DiffEvaluator
          +
          Returns validation events given two models and the detected + differences between them.
          +
          +
          Parameters:
          +
          differences - Detected differences.
          +
          Returns:
          +
          Returns validation events that are relative to the new model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/package-summary.html new file mode 100644 index 00000000000..5b97146a3cb --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/package-summary.html @@ -0,0 +1,358 @@ + + + + + +software.amazon.smithy.diff.evaluators (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.diff.evaluators

    +
    +
    +
      +
    • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      AbstractDiffEvaluator +
      Provides a default diff evaluator implementation with utility methods + for emitting events of different severities.
      +
      AddedEntityBinding +
      A meta-validator that emits a NOTE when an operation resource is added + to a service or resource entity.
      +
      AddedMetadata +
      Creates a NOTE event when metadata is added.
      +
      AddedOperationError +
      Emits a warning when an error is added to an operation.
      +
      AddedRequiredMember +
      Validates that no members are newly created with the required trait + (but no default trait) in existing structures.
      +
      AddedServiceError +
      Emits a warning when an error is added to a service.
      +
      AddedShape +
      Creates a NOTE event when a shape is added.
      +
      AddedTraitDefinition +
      Creates a NOTE event when a trait definition is added.
      +
      ChangedDefault 
      ChangedEnumTrait +
      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.
      +
      ChangedLengthTrait +
      Detects when the Length trait is made more restrictive by either + raising the min or lowering the max.
      +
      ChangedMemberOrder +
      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.
      +
      ChangedMemberTarget +
      Checks for changes in the shapes targeted by a member.
      +
      ChangedMetadata +
      Creates a WARNING event when metadata is changed.
      +
      ChangedNullability +
      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.
      +
      ChangedOperationInput +
      Emits an ERROR when the input shape of an operation is changed to + another shape.
      +
      ChangedOperationOutput +
      Emits an ERROR when the output shape of an operation is changed to + another shape.
      +
      ChangedRangeTrait +
      Detects when the Range trait is made more restrictive by either + raising the min or lowering the max.
      +
      ChangedResourceIdentifiers +
      Creates an ERROR event when the identifiers of a resource changes.
      +
      ChangedShapeType +
      Creates an ERROR event when the type of a shape changes.
      +
      ModifiedTrait +
      Finds breaking changes related to when a trait is added, removed, or + updated.
      +
      RemovedAuthenticationScheme +
      TODO: Implement evaluator to find removed authentication schemes.
      +
      RemovedEntityBinding +
      A meta-validator that checks for the removal of an operation or + resource binding from a service or resource.
      +
      RemovedMetadata +
      Creates a DANGER event when metadata is removed.
      +
      RemovedOperationError +
      Emits a warning when an error is removed from an operation.
      +
      RemovedServiceError +
      Emits a warning when an error is removed from a service.
      +
      RemovedShape +
      Creates an ERROR event when a non-private non-scalar shape is removed.
      +
      RemovedTraitDefinition +
      Creates an ERROR event when a trait definition is removed.
      +
      ServiceRename +
      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.
      +
      TraitBreakingChange +
      Finds breaking changes related to when a trait is added, removed, or + updated based on the breakingChanges property of traits.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/package-tree.html new file mode 100644 index 00000000000..d937d584264 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/evaluators/package-tree.html @@ -0,0 +1,193 @@ + + + + + +software.amazon.smithy.diff.evaluators Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.diff.evaluators

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/diff/package-summary.html new file mode 100644 index 00000000000..ccb5ae73b05 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/package-summary.html @@ -0,0 +1,216 @@ + + + + + +software.amazon.smithy.diff (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.diff

    +
    +
    +
      +
    • + + + + + + + + + + + + +
      Interface Summary 
      InterfaceDescription
      DiffEvaluator +
      Interface used to evaluate two models and their normalized + differences and return ValidationEvents that are relative to + the new model.
      +
      +
      • +
    • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      ChangedMetadata +
      Represents a change in metadata.
      +
      ChangedShape<S extends Shape> +
      Represents a changed shape.
      +
      Differences +
      Queryable container for detected structural differences between two models.
      +
      ModelDiff +
      Computes the difference between two models and any problems that might + occur due to those differences.
      +
      ModelDiff.Builder +
      Builder used to construct a diff of two Smithy models.
      +
      ModelDiff.Result +
      The result of comparing two Smithy models.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/diff/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/diff/package-tree.html new file mode 100644 index 00000000000..792356d3631 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/diff/package-tree.html @@ -0,0 +1,172 @@ + + + + + +software.amazon.smithy.diff Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.diff

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jmespath/ExpressionProblem.Severity.html b/javadoc/1.47.0/software/amazon/smithy/jmespath/ExpressionProblem.Severity.html new file mode 100644 index 00000000000..493aecbbfa5 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jmespath/ExpressionProblem.Severity.html @@ -0,0 +1,403 @@ + + + + + +ExpressionProblem.Severity (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jmespath
    +

    Enum ExpressionProblem.Severity

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        DANGER +
        The problem is a warning that you might be able to ignore depending on the input.
        +
        ERROR +
        The problem is an unrecoverable error.
        +
        WARNING +
        The problem points out a potential issue that may be intentional.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static ExpressionProblem.SeverityvalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static ExpressionProblem.Severity[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static ExpressionProblem.Severity[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (ExpressionProblem.Severity c : ExpressionProblem.Severity.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static ExpressionProblem.Severity valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jmespath/ExpressionProblem.html b/javadoc/1.47.0/software/amazon/smithy/jmespath/ExpressionProblem.html new file mode 100644 index 00000000000..74500c9aa62 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jmespath/ExpressionProblem.html @@ -0,0 +1,449 @@ + + + + + +ExpressionProblem (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jmespath
    +

    Class ExpressionProblem

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.jmespath.ExpressionProblem
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.lang.Comparable<ExpressionProblem>
      +
      +
      +
      public final class ExpressionProblem
+extends java.lang.Object
+implements java.lang.Comparable<ExpressionProblem>
      +
      Represents a problem detected by static analysis.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static class ExpressionProblem.Severity +
        The severity of the problem.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        intcolumn +
        The column where the problem occurred.
        +
        intline +
        The line where the problem occurred.
        +
        java.lang.Stringmessage +
        The description of the problem.
        +
        ExpressionProblem.Severityseverity +
        The severity of the problem.
        +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          message

          +
          public final java.lang.String message
          +
          The description of the problem.
          +
          • +
        + + + +
          +
        • +

          line

          +
          public final int line
          +
          The line where the problem occurred.
          +
          • +
        + + + +
          +
        • +

          column

          +
          public final int column
          +
          The column where the problem occurred.
          +
          • +
        + + + + +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jmespath/ExpressionSerializer.html b/javadoc/1.47.0/software/amazon/smithy/jmespath/ExpressionSerializer.html new file mode 100644 index 00000000000..86134598d79 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jmespath/ExpressionSerializer.html @@ -0,0 +1,314 @@ + + + + + +ExpressionSerializer (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jmespath
    +

    Class ExpressionSerializer

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.jmespath.ExpressionSerializer
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class ExpressionSerializer
+extends java.lang.Object
      +
      Serializes the JMESPath expression AST back to a JMESPath expression.
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.lang.Stringserialize​(JmespathExpression expression) +
        Serialize the given JMESPath expression to a string.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          ExpressionSerializer

          +
          public ExpressionSerializer()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          serialize

          +
          public java.lang.String serialize​(JmespathExpression expression)
          +
          Serialize the given JMESPath expression to a string.
          +
          +
          Parameters:
          +
          expression - JMESPath expression to serialize.
          +
          Returns:
          +
          Returns the serialized expression.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jmespath/ExpressionVisitor.html b/javadoc/1.47.0/software/amazon/smithy/jmespath/ExpressionVisitor.html new file mode 100644 index 00000000000..5263340a77d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jmespath/ExpressionVisitor.html @@ -0,0 +1,491 @@ + + + + + +ExpressionVisitor (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jmespath
    +

    Interface ExpressionVisitor<T>

    +
    +
    +
    +
      +
    • +
      +
      Type Parameters:
      +
      T - Value returned from the visitor.
      +
      +
      +
      public interface ExpressionVisitor<T>
      +
      Visits each type of AST node.
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jmespath/JmespathException.html b/javadoc/1.47.0/software/amazon/smithy/jmespath/JmespathException.html new file mode 100644 index 00000000000..ab49c646d18 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jmespath/JmespathException.html @@ -0,0 +1,312 @@ + + + + + +JmespathException (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jmespath
    +

    Class JmespathException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Throwable
        • +
      • +
          +
        • java.lang.Exception
          • +
        • +
            +
          • java.lang.RuntimeException
            • +
          • +
              +
            • software.amazon.smithy.jmespath.JmespathException
              • +
            +
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      public class JmespathException
+extends java.lang.RuntimeException
      +
      Thrown when any JMESPath error occurs.
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        JmespathException​(java.lang.String message) 
        JmespathException​(java.lang.String message, + java.lang.Throwable previous) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          JmespathException

          +
          public JmespathException​(java.lang.String message)
          +
          • +
        + + + +
          +
        • +

          JmespathException

          +
          public JmespathException​(java.lang.String message,
+                         java.lang.Throwable previous)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jmespath/JmespathExpression.html b/javadoc/1.47.0/software/amazon/smithy/jmespath/JmespathExpression.html new file mode 100644 index 00000000000..5a72f4d001b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jmespath/JmespathExpression.html @@ -0,0 +1,437 @@ + + + + + +JmespathExpression (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jmespath
    +

    Class JmespathExpression

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.jmespath.JmespathExpression
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + + +
        Constructors 
        ModifierConstructorDescription
        protected JmespathExpression​(int line, + int column) 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          JmespathExpression

          +
          protected JmespathExpression​(int line,
+                             int column)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          parse

          +
          public static JmespathExpression parse​(java.lang.String text)
          +
          Parse a JMESPath expression.
          +
          +
          Parameters:
          +
          text - Expression to parse.
          +
          Returns:
          +
          Returns the parsed expression.
          +
          Throws:
          +
          JmespathException - if the expression is invalid.
          +
          +
          • +
        + + + +
          +
        • +

          getLine

          +
          public final int getLine()
          +
          Get the approximate line where the node was defined.
          +
          +
          Returns:
          +
          Returns the line.
          +
          +
          • +
        + + + +
          +
        • +

          getColumn

          +
          public final int getColumn()
          +
          Get the approximate column where the node was defined.
          +
          +
          Returns:
          +
          Returns the column.
          +
          +
          • +
        + + + +
          +
        • +

          accept

          +
          public abstract <T> T accept​(ExpressionVisitor<T> visitor)
          +
          Visits a node using a double-dispatch visitor.
          +
          +
          Type Parameters:
          +
          T - Type of value the visitor returns.
          +
          Parameters:
          +
          visitor - Visitor to accept on the node.
          +
          Returns:
          +
          Returns the result of applying the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          lint

          +
          public LinterResult lint()
          +
          Lint the expression using static analysis using "any" as the + current node.
          +
          +
          Returns:
          +
          Returns the linter result.
          +
          +
          • +
        + + + +
          +
        • +

          lint

          +
          public LinterResult lint​(LiteralExpression currentNode)
          +
          Lint the expression using static analysis.
          +
          +
          Parameters:
          +
          currentNode - The value to set as the current node.
          +
          Returns:
          +
          Returns the problems that were detected.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jmespath/LinterResult.html b/javadoc/1.47.0/software/amazon/smithy/jmespath/LinterResult.html new file mode 100644 index 00000000000..82dbafdc5e8 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jmespath/LinterResult.html @@ -0,0 +1,371 @@ + + + + + +LinterResult (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jmespath
    +

    Class LinterResult

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.jmespath.LinterResult
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getReturnType

          +
          public RuntimeType getReturnType()
          +
          Gets the statically known return type of the expression.
          +
          +
          Returns:
          +
          Returns the return type of the expression.
          +
          +
          • +
        + + + +
          +
        • +

          getProblems

          +
          public java.util.Set<ExpressionProblem> getProblems()
          +
          Gets the set of problems in the expression.
          +
          +
          Returns:
          +
          Returns the detected problems.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jmespath/RuntimeType.html b/javadoc/1.47.0/software/amazon/smithy/jmespath/RuntimeType.html new file mode 100644 index 00000000000..b2fafe31485 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jmespath/RuntimeType.html @@ -0,0 +1,490 @@ + + + + + +RuntimeType (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jmespath
    +

    Enum RuntimeType

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Enum<RuntimeType>
        • +
      • +
          +
        • software.amazon.smithy.jmespath.RuntimeType
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable, java.lang.Comparable<RuntimeType>
      +
      +
      +
      public enum RuntimeType
+extends java.lang.Enum<RuntimeType>
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static RuntimeType[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (RuntimeType c : RuntimeType.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static RuntimeType valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Enum<RuntimeType>
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/AndExpression.html b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/AndExpression.html new file mode 100644 index 00000000000..aab8a71c35f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/AndExpression.html @@ -0,0 +1,369 @@ + + + + + +AndExpression (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jmespath.ast
    +

    Class AndExpression

    +
    +
    + +
    +
      +
    • +
      +
      public final class AndExpression
+extends BinaryExpression
      +
      And expression where both sides must return truthy values. The second + truthy value becomes the result of the expression.
      +
      +
      See Also:
      +
      And Expressions
      +
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/BinaryExpression.html b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/BinaryExpression.html new file mode 100644 index 00000000000..f5b5539e6a6 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/BinaryExpression.html @@ -0,0 +1,409 @@ + + + + + +BinaryExpression (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jmespath.ast
    +

    Class BinaryExpression

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getLeft

          +
          public final JmespathExpression getLeft()
          +
          Gets the left side of the expression.
          +
          +
          Returns:
          +
          Returns the expression on the left.
          +
          +
          • +
        + + + +
          +
        • +

          getRight

          +
          public final JmespathExpression getRight()
          +
          Gets the right side of the expression.
          +
          +
          Returns:
          +
          Returns the expression on the right.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/ComparatorExpression.html b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/ComparatorExpression.html new file mode 100644 index 00000000000..0164839e9be --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/ComparatorExpression.html @@ -0,0 +1,448 @@ + + + + + +ComparatorExpression (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jmespath.ast
    +

    Class ComparatorExpression

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/ComparatorType.html b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/ComparatorType.html new file mode 100644 index 00000000000..9999226e8a2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/ComparatorType.html @@ -0,0 +1,447 @@ + + + + + +ComparatorType (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jmespath.ast
    +

    Enum ComparatorType

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Enum<ComparatorType>
        • +
      • +
          +
        • software.amazon.smithy.jmespath.ast.ComparatorType
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable, java.lang.Comparable<ComparatorType>
      +
      +
      +
      public enum ComparatorType
+extends java.lang.Enum<ComparatorType>
      +
      A comparator in a comparison expression.
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.lang.StringtoString() 
        static ComparatorTypevalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static ComparatorType[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static ComparatorType[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (ComparatorType c : ComparatorType.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static ComparatorType valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Enum<ComparatorType>
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/CurrentExpression.html b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/CurrentExpression.html new file mode 100644 index 00000000000..5d42566034e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/CurrentExpression.html @@ -0,0 +1,402 @@ + + + + + +CurrentExpression (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jmespath.ast
    +

    Class CurrentExpression

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CurrentExpression

          +
          public CurrentExpression()
          +
          • +
        + + + +
          +
        • +

          CurrentExpression

          +
          public CurrentExpression​(int line,
+                         int column)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          accept

          +
          public <T> T accept​(ExpressionVisitor<T> visitor)
          +
          Description copied from class: JmespathExpression
          +
          Visits a node using a double-dispatch visitor.
          +
          +
          Specified by:
          +
          accept in class JmespathExpression
          +
          Type Parameters:
          +
          T - Type of value the visitor returns.
          +
          Parameters:
          +
          visitor - Visitor to accept on the node.
          +
          Returns:
          +
          Returns the result of applying the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object other)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/ExpressionTypeExpression.html b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/ExpressionTypeExpression.html new file mode 100644 index 00000000000..472f842ee24 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/ExpressionTypeExpression.html @@ -0,0 +1,428 @@ + + + + + +ExpressionTypeExpression (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jmespath.ast
    +

    Class ExpressionTypeExpression

    +
    +
    + +
    +
      +
    • +
      +
      public final class ExpressionTypeExpression
+extends JmespathExpression
      +
      Contains a reference to an expression that can be run zero or more + times by a function.
      +
      +
      See Also:
      +
      Data types
      +
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ExpressionTypeExpression

          +
          public ExpressionTypeExpression​(JmespathExpression expression)
          +
          • +
        + + + +
          +
        • +

          ExpressionTypeExpression

          +
          public ExpressionTypeExpression​(JmespathExpression expression,
+                                int line,
+                                int column)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          accept

          +
          public <T> T accept​(ExpressionVisitor<T> visitor)
          +
          Description copied from class: JmespathExpression
          +
          Visits a node using a double-dispatch visitor.
          +
          +
          Specified by:
          +
          accept in class JmespathExpression
          +
          Type Parameters:
          +
          T - Type of value the visitor returns.
          +
          Parameters:
          +
          visitor - Visitor to accept on the node.
          +
          Returns:
          +
          Returns the result of applying the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          getExpression

          +
          public JmespathExpression getExpression()
          +
          Gets the contained expression.
          +
          +
          Returns:
          +
          Returns the contained expression.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/FieldExpression.html b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/FieldExpression.html new file mode 100644 index 00000000000..34ff604c737 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/FieldExpression.html @@ -0,0 +1,430 @@ + + + + + +FieldExpression (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jmespath.ast
    +

    Class FieldExpression

    +
    +
    + +
    +
      +
    • +
      +
      public final class FieldExpression
+extends JmespathExpression
      +
      Gets a field by name from an object. + +

      This AST node is created for identifiers. For example, + foo creates a FieldExpression.

      +
      +
      See Also:
      +
      Identifiers
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        FieldExpression​(java.lang.String name) 
        FieldExpression​(java.lang.String name, + int line, + int column) 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          FieldExpression

          +
          public FieldExpression​(java.lang.String name)
          +
          • +
        + + + +
          +
        • +

          FieldExpression

          +
          public FieldExpression​(java.lang.String name,
+                       int line,
+                       int column)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          accept

          +
          public <T> T accept​(ExpressionVisitor<T> visitor)
          +
          Description copied from class: JmespathExpression
          +
          Visits a node using a double-dispatch visitor.
          +
          +
          Specified by:
          +
          accept in class JmespathExpression
          +
          Type Parameters:
          +
          T - Type of value the visitor returns.
          +
          Parameters:
          +
          visitor - Visitor to accept on the node.
          +
          Returns:
          +
          Returns the result of applying the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          getName

          +
          public java.lang.String getName()
          +
          Get the name of the field to retrieve.
          +
          +
          Returns:
          +
          Returns the name of the field.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/FilterProjectionExpression.html b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/FilterProjectionExpression.html new file mode 100644 index 00000000000..4a4abbf3792 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/FilterProjectionExpression.html @@ -0,0 +1,449 @@ + + + + + +FilterProjectionExpression (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jmespath.ast
    +

    Class FilterProjectionExpression

    +
    +
    + +
    +
      +
    • +
      +
      public final class FilterProjectionExpression
+extends BinaryExpression
      +
      A projection that filters values using a comparison. + +

      A filter projection executes the left AST expression, expects it to + return an array of values, passes each result of the left expression to + a ComparatorExpression, and yields any value from the comparison + expression that returns true to the right AST expression. + +

      Note: while this expression does have a comparator expression, it is + still considered a binary expression because it has a left hand side and + a right hand side.

      +
      +
      See Also:
      +
      Filter Expressions
      +
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/FlattenExpression.html b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/FlattenExpression.html new file mode 100644 index 00000000000..f1d2f6b8fc3 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/FlattenExpression.html @@ -0,0 +1,427 @@ + + + + + +FlattenExpression (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jmespath.ast
    +

    Class FlattenExpression

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + + + + + +
          +
        • +

          FlattenExpression

          +
          public FlattenExpression​(JmespathExpression expression,
+                         int line,
+                         int column)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          accept

          +
          public <T> T accept​(ExpressionVisitor<T> visitor)
          +
          Description copied from class: JmespathExpression
          +
          Visits a node using a double-dispatch visitor.
          +
          +
          Specified by:
          +
          accept in class JmespathExpression
          +
          Type Parameters:
          +
          T - Type of value the visitor returns.
          +
          Parameters:
          +
          visitor - Visitor to accept on the node.
          +
          Returns:
          +
          Returns the result of applying the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          getExpression

          +
          public JmespathExpression getExpression()
          +
          Returns the expression being flattened.
          +
          +
          Returns:
          +
          Returns the expression.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/FunctionExpression.html b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/FunctionExpression.html new file mode 100644 index 00000000000..22c7bd3509b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/FunctionExpression.html @@ -0,0 +1,508 @@ + + + + + +FunctionExpression (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jmespath.ast
    +

    Class FunctionExpression

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          name

          +
          public java.lang.String name
          +
          • +
        + + + + +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          FunctionExpression

          +
          public FunctionExpression​(java.lang.String name,
+                          java.util.List<JmespathExpression> arguments)
          +
          • +
        + + + +
          +
        • +

          FunctionExpression

          +
          public FunctionExpression​(java.lang.String name,
+                          java.util.List<JmespathExpression> arguments,
+                          int line,
+                          int column)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          accept

          +
          public <T> T accept​(ExpressionVisitor<T> visitor)
          +
          Description copied from class: JmespathExpression
          +
          Visits a node using a double-dispatch visitor.
          +
          +
          Specified by:
          +
          accept in class JmespathExpression
          +
          Type Parameters:
          +
          T - Type of value the visitor returns.
          +
          Parameters:
          +
          visitor - Visitor to accept on the node.
          +
          Returns:
          +
          Returns the result of applying the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          getName

          +
          public java.lang.String getName()
          +
          Gets the function name.
          +
          +
          Returns:
          +
          Returns the name.
          +
          +
          • +
        + + + +
          +
        • +

          getArguments

          +
          public java.util.List<JmespathExpression> getArguments()
          +
          Gets the function arguments.
          +
          +
          Returns:
          +
          Returns the argument expressions.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/IndexExpression.html b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/IndexExpression.html new file mode 100644 index 00000000000..efb133cd5f4 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/IndexExpression.html @@ -0,0 +1,431 @@ + + + + + +IndexExpression (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jmespath.ast
    +

    Class IndexExpression

    +
    +
    + +
    +
      +
    • +
      +
      public final class IndexExpression
+extends JmespathExpression
      +
      Gets a specific element by zero-based index. + +

      Use a negative index to get an element from the end of the array + (e.g., -1 is used to get the last element of the array). If an + array element does not exist, a null value is returned.

      +
      +
      See Also:
      +
      Index Expressions
      +
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          IndexExpression

          +
          public IndexExpression​(int index)
          +
          • +
        + + + +
          +
        • +

          IndexExpression

          +
          public IndexExpression​(int index,
+                       int line,
+                       int column)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          accept

          +
          public <T> T accept​(ExpressionVisitor<T> visitor)
          +
          Description copied from class: JmespathExpression
          +
          Visits a node using a double-dispatch visitor.
          +
          +
          Specified by:
          +
          accept in class JmespathExpression
          +
          Type Parameters:
          +
          T - Type of value the visitor returns.
          +
          Parameters:
          +
          visitor - Visitor to accept on the node.
          +
          Returns:
          +
          Returns the result of applying the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          getIndex

          +
          public int getIndex()
          +
          Gets the index to retrieve.
          +
          +
          Returns:
          +
          Returns the index.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/LiteralExpression.html b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/LiteralExpression.html new file mode 100644 index 00000000000..b91962fb437 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/LiteralExpression.html @@ -0,0 +1,971 @@ + + + + + +LiteralExpression (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jmespath.ast
    +

    Class LiteralExpression

    +
    +
    + +
    +
      +
    • +
      +
      public final class LiteralExpression
+extends JmespathExpression
      +
      Represents a literal value.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ANY

          +
          public static final LiteralExpression ANY
          +
          Sentinel value to represent ANY.
          +
          • +
        + + + +
          +
        • +

          ARRAY

          +
          public static final LiteralExpression ARRAY
          +
          Sentinel value to represent any ARRAY.
          +
          • +
        + + + +
          +
        • +

          OBJECT

          +
          public static final LiteralExpression OBJECT
          +
          Sentinel value to represent any OBJECT.
          +
          • +
        + + + +
          +
        • +

          BOOLEAN

          +
          public static final LiteralExpression BOOLEAN
          +
          Sentinel value to represent any BOOLEAN.
          +
          • +
        + + + +
          +
        • +

          STRING

          +
          public static final LiteralExpression STRING
          +
          Sentinel value to represent any STRING.
          +
          • +
        + + + +
          +
        • +

          NUMBER

          +
          public static final LiteralExpression NUMBER
          +
          Sentinel value to represent any NULL.
          +
          • +
        + + + +
          +
        • +

          EXPREF

          +
          public static final LiteralExpression EXPREF
          +
          Sentinel value to represent an expression reference.
          +
          • +
        + + + +
          +
        • +

          NULL

          +
          public static final LiteralExpression NULL
          +
          Sentinel value to represent null.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          LiteralExpression

          +
          public LiteralExpression​(java.lang.Object value)
          +
          • +
        + + + +
          +
        • +

          LiteralExpression

          +
          public LiteralExpression​(java.lang.Object value,
+                         int line,
+                         int column)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          from

          +
          public static LiteralExpression from​(java.lang.Object value)
          +
          Creates a LiteralExpression from value, unwrapping it if necessary.
          +
          +
          Parameters:
          +
          value - Value to create the expression from.
          +
          Returns:
          +
          Returns the LiteralExpression of the given value.
          +
          +
          • +
        + + + +
          +
        • +

          accept

          +
          public <T> T accept​(ExpressionVisitor<T> visitor)
          +
          Description copied from class: JmespathExpression
          +
          Visits a node using a double-dispatch visitor.
          +
          +
          Specified by:
          +
          accept in class JmespathExpression
          +
          Type Parameters:
          +
          T - Type of value the visitor returns.
          +
          Parameters:
          +
          visitor - Visitor to accept on the node.
          +
          Returns:
          +
          Returns the result of applying the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public java.lang.Object getValue()
          +
          Gets the nullable value contained in the literal value.
          +
          +
          Returns:
          +
          Returns the contained value.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          getType

          +
          public RuntimeType getType()
          +
          Gets the type of the value.
          +
          +
          Returns:
          +
          Returns the literal expression's runtime type.
          +
          +
          • +
        + + + +
          +
        • +

          getObjectField

          +
          public LiteralExpression getObjectField​(java.lang.String name)
          +
          Expects the value to be an object and gets a field by + name. If the field does not exist, then a + LiteralExpression with a null value is returned.
          +
          +
          Parameters:
          +
          name - Field to get from the expected object.
          +
          Returns:
          +
          Returns the object field value.
          +
          +
          • +
        + + + +
          +
        • +

          hasObjectField

          +
          public boolean hasObjectField​(java.lang.String name)
          +
          Expects the value to be an object and checks if it contains + a field by name.
          +
          +
          Parameters:
          +
          name - Field to get from the expected object.
          +
          Returns:
          +
          Returns true if the object contains the given key.
          +
          +
          • +
        + + + +
          +
        • +

          getArrayIndex

          +
          public LiteralExpression getArrayIndex​(int index)
          +
          Expects the value to be an array and gets the value at the given + index. If the index is negative, it is computed to the array + length minus the index. If the computed index does not exist, + a LiteralExpression with a null value is returned.
          +
          +
          Parameters:
          +
          index - Index to get from the array.
          +
          Returns:
          +
          Returns the array value.
          +
          +
          • +
        + + + +
          +
        • +

          isStringValue

          +
          public boolean isStringValue()
          +
          Checks if the value is a string.
          +
          +
          Returns:
          +
          Returns true if the value is a string.
          +
          +
          • +
        + + + +
          +
        • +

          isNumberValue

          +
          public boolean isNumberValue()
          +
          Checks if the value is a number.
          +
          +
          Returns:
          +
          Returns true if the value is a number.
          +
          +
          • +
        + + + +
          +
        • +

          isBooleanValue

          +
          public boolean isBooleanValue()
          +
          Checks if the value is a boolean.
          +
          +
          Returns:
          +
          Returns true if the value is a boolean.
          +
          +
          • +
        + + + +
          +
        • +

          isArrayValue

          +
          public boolean isArrayValue()
          +
          Checks if the value is an array.
          +
          +
          Returns:
          +
          Returns true if the value is an array.
          +
          +
          • +
        + + + +
          +
        • +

          isObjectValue

          +
          public boolean isObjectValue()
          +
          Checks if the value is an object.
          +
          +
          Returns:
          +
          Returns true if the value is an object.
          +
          +
          • +
        + + + +
          +
        • +

          isNullValue

          +
          public boolean isNullValue()
          +
          Checks if the value is null.
          +
          +
          Returns:
          +
          Returns true if the value is null.
          +
          +
          • +
        + + + +
          +
        • +

          expectStringValue

          +
          public java.lang.String expectStringValue()
          +
          Gets the value as a string.
          +
          +
          Returns:
          +
          Returns the string value.
          +
          Throws:
          +
          JmespathException - if the value is not a string.
          +
          +
          • +
        + + + +
          +
        • +

          expectNumberValue

          +
          public java.lang.Number expectNumberValue()
          +
          Gets the value as a number.
          +
          +
          Returns:
          +
          Returns the number value.
          +
          Throws:
          +
          JmespathException - if the value is not a number.
          +
          +
          • +
        + + + +
          +
        • +

          expectBooleanValue

          +
          public boolean expectBooleanValue()
          +
          Gets the value as a boolean.
          +
          +
          Returns:
          +
          Returns the boolean value.
          +
          Throws:
          +
          JmespathException - if the value is not a boolean.
          +
          +
          • +
        + + + +
          +
        • +

          expectArrayValue

          +
          public java.util.List<java.lang.Object> expectArrayValue()
          +
          Gets the value as an array.
          +
          +
          Returns:
          +
          Returns the array value.
          +
          Throws:
          +
          JmespathException - if the value is not an array.
          +
          +
          • +
        + + + +
          +
        • +

          expectObjectValue

          +
          public java.util.Map<java.lang.String,​java.lang.Object> expectObjectValue()
          +
          Gets the value as an object.
          +
          +
          Returns:
          +
          Returns the object value.
          +
          Throws:
          +
          JmespathException - if the value is not an object.
          +
          +
          • +
        + + + +
          +
        • +

          isTruthy

          +
          public boolean isTruthy()
          +
          Returns true if the value is truthy according to JMESPath.
          +
          +
          Returns:
          +
          Returns true or false if truthy.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/MultiSelectHashExpression.html b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/MultiSelectHashExpression.html new file mode 100644 index 00000000000..26d8ab4c8bd --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/MultiSelectHashExpression.html @@ -0,0 +1,427 @@ + + + + + +MultiSelectHashExpression (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jmespath.ast
    +

    Class MultiSelectHashExpression

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          MultiSelectHashExpression

          +
          public MultiSelectHashExpression​(java.util.Map<java.lang.String,​JmespathExpression> expressions)
          +
          • +
        + + + +
          +
        • +

          MultiSelectHashExpression

          +
          public MultiSelectHashExpression​(java.util.Map<java.lang.String,​JmespathExpression> expressions,
+                                 int line,
+                                 int column)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          accept

          +
          public <T> T accept​(ExpressionVisitor<T> visitor)
          +
          Description copied from class: JmespathExpression
          +
          Visits a node using a double-dispatch visitor.
          +
          +
          Specified by:
          +
          accept in class JmespathExpression
          +
          Type Parameters:
          +
          T - Type of value the visitor returns.
          +
          Parameters:
          +
          visitor - Visitor to accept on the node.
          +
          Returns:
          +
          Returns the result of applying the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          getExpressions

          +
          public java.util.Map<java.lang.String,​JmespathExpression> getExpressions()
          +
          Gets the map of key-value pairs to add to the created object.
          +
          +
          Returns:
          +
          Returns the map of key names to expressions.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/MultiSelectListExpression.html b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/MultiSelectListExpression.html new file mode 100644 index 00000000000..29b1fe0d3db --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/MultiSelectListExpression.html @@ -0,0 +1,427 @@ + + + + + +MultiSelectListExpression (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jmespath.ast
    +

    Class MultiSelectListExpression

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          MultiSelectListExpression

          +
          public MultiSelectListExpression​(java.util.List<JmespathExpression> expressions)
          +
          • +
        + + + +
          +
        • +

          MultiSelectListExpression

          +
          public MultiSelectListExpression​(java.util.List<JmespathExpression> expressions,
+                                 int line,
+                                 int column)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          accept

          +
          public <T> T accept​(ExpressionVisitor<T> visitor)
          +
          Description copied from class: JmespathExpression
          +
          Visits a node using a double-dispatch visitor.
          +
          +
          Specified by:
          +
          accept in class JmespathExpression
          +
          Type Parameters:
          +
          T - Type of value the visitor returns.
          +
          Parameters:
          +
          visitor - Visitor to accept on the node.
          +
          Returns:
          +
          Returns the result of applying the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          getExpressions

          +
          public java.util.List<JmespathExpression> getExpressions()
          +
          Gets the ordered list of expressions to add to the list.
          +
          +
          Returns:
          +
          Returns the expressions.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/NotExpression.html b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/NotExpression.html new file mode 100644 index 00000000000..5c2660d2010 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/NotExpression.html @@ -0,0 +1,423 @@ + + + + + +NotExpression (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jmespath.ast
    +

    Class NotExpression

    +
    +
    + +
    +
      +
    • +
      +
      public final class NotExpression
+extends JmespathExpression
      +
      Negates an expression based on if the wrapped expression is truthy.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          accept

          +
          public <T> T accept​(ExpressionVisitor<T> visitor)
          +
          Description copied from class: JmespathExpression
          +
          Visits a node using a double-dispatch visitor.
          +
          +
          Specified by:
          +
          accept in class JmespathExpression
          +
          Type Parameters:
          +
          T - Type of value the visitor returns.
          +
          Parameters:
          +
          visitor - Visitor to accept on the node.
          +
          Returns:
          +
          Returns the result of applying the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          getExpression

          +
          public JmespathExpression getExpression()
          +
          Gets the contained expression to negate.
          +
          +
          Returns:
          +
          Returns the contained expression.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/ObjectProjectionExpression.html b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/ObjectProjectionExpression.html new file mode 100644 index 00000000000..46e31830299 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/ObjectProjectionExpression.html @@ -0,0 +1,378 @@ + + + + + +ObjectProjectionExpression (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jmespath.ast
    +

    Class ObjectProjectionExpression

    +
    +
    + +
    +
      +
    • +
      +
      public final class ObjectProjectionExpression
+extends ProjectionExpression
      +
      A projection of object values. + +

      If the left AST expression does not return an object, then the + result of the projection is a null value. Otherwise, the + object values are each yielded to the right AST expression, + building up a list of results.

      +
      +
      See Also:
      +
      Wildcard Expressions
      +
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          accept

          +
          public <T> T accept​(ExpressionVisitor<T> visitor)
          +
          Description copied from class: JmespathExpression
          +
          Visits a node using a double-dispatch visitor.
          +
          +
          Overrides:
          +
          accept in class ProjectionExpression
          +
          Type Parameters:
          +
          T - Type of value the visitor returns.
          +
          Parameters:
          +
          visitor - Visitor to accept on the node.
          +
          Returns:
          +
          Returns the result of applying the visitor.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/OrExpression.html b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/OrExpression.html new file mode 100644 index 00000000000..78e35c4e8f9 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/OrExpression.html @@ -0,0 +1,368 @@ + + + + + +OrExpression (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jmespath.ast
    +

    Class OrExpression

    +
    +
    + +
    +
      +
    • +
      +
      public final class OrExpression
+extends BinaryExpression
      +
      Or expression that returns the expression that returns a truthy value.
      +
      +
      See Also:
      +
      Or Expressions
      +
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/ProjectionExpression.html b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/ProjectionExpression.html new file mode 100644 index 00000000000..98531e1d814 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/ProjectionExpression.html @@ -0,0 +1,376 @@ + + + + + +ProjectionExpression (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jmespath.ast
    +

    Class ProjectionExpression

    +
    +
    + +
    +
      +
    • +
      +
      Direct Known Subclasses:
      +
      ObjectProjectionExpression
      +
      +
      +
      public class ProjectionExpression
+extends BinaryExpression
      +
      Iterates over each element in the array returned from the left expression, + passes it to the right expression, and returns the aggregated results. + +

      This AST node is created when parsing expressions like [*], + [], and [1:1].

      +
      +
      See Also:
      +
      Wildcard Expressions
      +
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          accept

          +
          public <T> T accept​(ExpressionVisitor<T> visitor)
          +
          Description copied from class: JmespathExpression
          +
          Visits a node using a double-dispatch visitor.
          +
          +
          Specified by:
          +
          accept in class JmespathExpression
          +
          Type Parameters:
          +
          T - Type of value the visitor returns.
          +
          Parameters:
          +
          visitor - Visitor to accept on the node.
          +
          Returns:
          +
          Returns the result of applying the visitor.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/SliceExpression.html b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/SliceExpression.html new file mode 100644 index 00000000000..0ee1cbe2738 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/SliceExpression.html @@ -0,0 +1,457 @@ + + + + + +SliceExpression (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jmespath.ast
    +

    Class SliceExpression

    +
    +
    + +
    +
      +
    • +
      +
      public final class SliceExpression
+extends JmespathExpression
      +
      Represents a slice expression, containing an optional zero-based + start offset, zero-based stop offset, and step.
      +
      +
      See Also:
      +
      Slices
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        SliceExpression​(java.lang.Integer start, + java.lang.Integer stop, + int step) 
        SliceExpression​(java.lang.Integer start, + java.lang.Integer stop, + int step, + int line, + int column) 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          SliceExpression

          +
          public SliceExpression​(java.lang.Integer start,
+                       java.lang.Integer stop,
+                       int step)
          +
          • +
        + + + +
          +
        • +

          SliceExpression

          +
          public SliceExpression​(java.lang.Integer start,
+                       java.lang.Integer stop,
+                       int step,
+                       int line,
+                       int column)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          accept

          +
          public <T> T accept​(ExpressionVisitor<T> visitor)
          +
          Description copied from class: JmespathExpression
          +
          Visits a node using a double-dispatch visitor.
          +
          +
          Specified by:
          +
          accept in class JmespathExpression
          +
          Type Parameters:
          +
          T - Type of value the visitor returns.
          +
          Parameters:
          +
          visitor - Visitor to accept on the node.
          +
          Returns:
          +
          Returns the result of applying the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          getStart

          +
          public java.util.OptionalInt getStart()
          +
          • +
        + + + +
          +
        • +

          getStop

          +
          public java.util.OptionalInt getStop()
          +
          • +
        + + + +
          +
        • +

          getStep

          +
          public int getStep()
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/Subexpression.html b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/Subexpression.html new file mode 100644 index 00000000000..3f07f69ea8d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/Subexpression.html @@ -0,0 +1,428 @@ + + + + + +Subexpression (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jmespath.ast
    +

    Class Subexpression

    +
    +
    + +
    +
      +
    • +
      +
      public final class Subexpression
+extends BinaryExpression
      +
      Visits the left expression and passes its result to the right expression. + +

      This AST node is used for both sub-expressions and pipe-expressions in + the JMESPath specification.

      +
      +
      See Also:
      +
      SubExpressions, +Pipe expressions
      +
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/package-summary.html new file mode 100644 index 00000000000..9b71157e208 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/package-summary.html @@ -0,0 +1,295 @@ + + + + + +software.amazon.smithy.jmespath.ast (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.jmespath.ast

    +
    +
    +
      +
    • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      AndExpression +
      And expression where both sides must return truthy values.
      +
      BinaryExpression +
      Abstract class representing expressions that have a left and right side.
      +
      ComparatorExpression +
      Compares the left and right expression using a comparator, + resulting in a boolean value.
      +
      CurrentExpression +
      Gets the current node.
      +
      ExpressionTypeExpression +
      Contains a reference to an expression that can be run zero or more + times by a function.
      +
      FieldExpression +
      Gets a field by name from an object.
      +
      FilterProjectionExpression +
      A projection that filters values using a comparison.
      +
      FlattenExpression +
      Flattens the wrapped expression into an array.
      +
      FunctionExpression +
      Executes a function by name using a list of argument expressions.
      +
      IndexExpression +
      Gets a specific element by zero-based index.
      +
      LiteralExpression +
      Represents a literal value.
      +
      MultiSelectHashExpression +
      Creates an object using key-value pairs.
      +
      MultiSelectListExpression +
      Selects one or more values into a created array.
      +
      NotExpression +
      Negates an expression based on if the wrapped expression is truthy.
      +
      ObjectProjectionExpression +
      A projection of object values.
      +
      OrExpression +
      Or expression that returns the expression that returns a truthy value.
      +
      ProjectionExpression +
      Iterates over each element in the array returned from the left expression, + passes it to the right expression, and returns the aggregated results.
      +
      SliceExpression +
      Represents a slice expression, containing an optional zero-based + start offset, zero-based stop offset, and step.
      +
      Subexpression +
      Visits the left expression and passes its result to the right expression.
      +
      +
      • +
    • + + + + + + + + + + + + +
      Enum Summary 
      EnumDescription
      ComparatorType +
      A comparator in a comparison expression.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/package-tree.html new file mode 100644 index 00000000000..376154ad009 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jmespath/ast/package-tree.html @@ -0,0 +1,203 @@ + + + + + +software.amazon.smithy.jmespath.ast Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.jmespath.ast

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Enum Hierarchy

    +
      +
    • java.lang.Object +
        +
      • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
        • +
      +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jmespath/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/jmespath/package-summary.html new file mode 100644 index 00000000000..5d1429d1269 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jmespath/package-summary.html @@ -0,0 +1,239 @@ + + + + + +software.amazon.smithy.jmespath (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.jmespath

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jmespath/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/jmespath/package-tree.html new file mode 100644 index 00000000000..6770ad561ae --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jmespath/package-tree.html @@ -0,0 +1,198 @@ + + + + + +software.amazon.smithy.jmespath Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.jmespath

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    +
      +
    • java.lang.Object + +
      • +
    +
    +
    +

    Interface Hierarchy

    + +
    +
    +

    Enum Hierarchy

    +
      +
    • java.lang.Object +
        +
      • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
        • +
      +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jsonschema/ConflictingShapeNameException.html b/javadoc/1.47.0/software/amazon/smithy/jsonschema/ConflictingShapeNameException.html new file mode 100644 index 00000000000..6d9ea81dfe4 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jsonschema/ConflictingShapeNameException.html @@ -0,0 +1,256 @@ + + + + + +ConflictingShapeNameException (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jsonschema
    +

    Class ConflictingShapeNameException

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      public class ConflictingShapeNameException
+extends SmithyJsonSchemaException
      +
      Thrown when two shapes generate the same JSON schema pointer.
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jsonschema/JsonSchemaConfig.MapStrategy.html b/javadoc/1.47.0/software/amazon/smithy/jsonschema/JsonSchemaConfig.MapStrategy.html new file mode 100644 index 00000000000..2f2fa3f326a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jsonschema/JsonSchemaConfig.MapStrategy.html @@ -0,0 +1,411 @@ + + + + + +JsonSchemaConfig.MapStrategy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jsonschema
    +

    Enum JsonSchemaConfig.MapStrategy

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        PATTERN_PROPERTIES +
        Converts to a schema that uses "patternProperties".
        +
        PROPERTY_NAMES +
        Converts to a schema that uses a combination of "propertyNames" + and "additionalProperties".
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.lang.StringtoString() 
        static JsonSchemaConfig.MapStrategyvalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static JsonSchemaConfig.MapStrategy[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + +
          +
        • +

          PROPERTY_NAMES

          +
          public static final JsonSchemaConfig.MapStrategy PROPERTY_NAMES
          +
          Converts to a schema that uses a combination of "propertyNames" + and "additionalProperties". + +

          This is the default setting used if not configured.

          +
          • +
        + + + +
          +
        • +

          PATTERN_PROPERTIES

          +
          public static final JsonSchemaConfig.MapStrategy PATTERN_PROPERTIES
          +
          Converts to a schema that uses "patternProperties". If a map's key + member or its target does not have a pattern trait, a default + indicating one or more of any character (".+") is applied.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static JsonSchemaConfig.MapStrategy[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (JsonSchemaConfig.MapStrategy c : JsonSchemaConfig.MapStrategy.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static JsonSchemaConfig.MapStrategy valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jsonschema/JsonSchemaConfig.UnionStrategy.html b/javadoc/1.47.0/software/amazon/smithy/jsonschema/JsonSchemaConfig.UnionStrategy.html new file mode 100644 index 00000000000..79b61753938 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jsonschema/JsonSchemaConfig.UnionStrategy.html @@ -0,0 +1,423 @@ + + + + + +JsonSchemaConfig.UnionStrategy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jsonschema
    +

    Enum JsonSchemaConfig.UnionStrategy

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        OBJECT +
        Converts to an empty object "{}".
        +
        ONE_OF +
        Converts to a schema that uses "oneOf".
        +
        STRUCTURE +
        Converts to an object with properties just like a structure.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.lang.StringtoString() 
        static JsonSchemaConfig.UnionStrategyvalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static JsonSchemaConfig.UnionStrategy[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static JsonSchemaConfig.UnionStrategy[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (JsonSchemaConfig.UnionStrategy c : JsonSchemaConfig.UnionStrategy.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static JsonSchemaConfig.UnionStrategy valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jsonschema/JsonSchemaConfig.html b/javadoc/1.47.0/software/amazon/smithy/jsonschema/JsonSchemaConfig.html new file mode 100644 index 00000000000..c72e713bec9 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jsonschema/JsonSchemaConfig.html @@ -0,0 +1,1100 @@ + + + + + +JsonSchemaConfig (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jsonschema
    +

    Class JsonSchemaConfig

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.jsonschema.JsonSchemaConfig
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Direct Known Subclasses:
      +
      CfnConfig, OpenApiConfig
      +
      +
      +
      public class JsonSchemaConfig
+extends java.lang.Object
      +
      JSON Schema configuration options.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          JsonSchemaConfig

          +
          public JsonSchemaConfig()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getAlphanumericOnlyRefs

          +
          public boolean getAlphanumericOnlyRefs()
          +
          • +
        + + + +
          +
        • +

          setAlphanumericOnlyRefs

          +
          public void setAlphanumericOnlyRefs​(boolean alphanumericOnlyRefs)
          +
          Creates shape name pointers that strip out non-alphanumeric characters. + +

          This is necessary for compatibility with some vendors like + Amazon API Gateway that only allow alphanumeric shape names.

          +
          +
          Parameters:
          +
          alphanumericOnlyRefs - Set to true to strip non-alphanumeric characters.
          +
          +
          • +
        + + + +
          +
        • +

          getUseJsonName

          +
          public boolean getUseJsonName()
          +
          • +
        + + + +
          +
        • +

          setUseJsonName

          +
          public void setUseJsonName​(boolean useJsonName)
          +
          Uses the value of the jsonName trait when creating JSON schema + properties for structure and union shapes. + +

          This property has no effect if a PropertyNamingStrategy is + manually configured on a JsonSchemaConverter.

          +
          +
          Parameters:
          +
          useJsonName - Set to true to use jsonName traits when creating refs..
          +
          +
          • +
        + + + + + + + +
          +
        • +

          setDefaultTimestampFormat

          +
          public void setDefaultTimestampFormat​(TimestampFormatTrait.Format defaultTimestampFormat)
          +
          Sets the assumed timestampFormat trait for timestamps with no + timestampFormat trait. The provided value is expected to be a string. + +

          Defaults to "date-time" if not set. Can be set to "date-time", + "epoch-seconds", or "http-date".

          +
          +
          Parameters:
          +
          defaultTimestampFormat - The default timestamp format to use when none is set.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          setUnionStrategy

          +
          public void setUnionStrategy​(JsonSchemaConfig.UnionStrategy unionStrategy)
          +
          Configures how Smithy union shapes are converted to JSON Schema.
          +
          +
          Parameters:
          +
          unionStrategy - The union strategy to use.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          setMapStrategy

          +
          public void setMapStrategy​(JsonSchemaConfig.MapStrategy mapStrategy)
          +
          Configures how Smithy map shapes are converted to JSON Schema.
          +
          +
          Parameters:
          +
          mapStrategy - The map strategy to use.
          +
          +
          • +
        + + + +
          +
        • +

          getDefinitionPointer

          +
          public java.lang.String getDefinitionPointer()
          +
          • +
        + + + +
          +
        • +

          setDefinitionPointer

          +
          public void setDefinitionPointer​(java.lang.String definitionPointer)
          +
          Configures location of where definitions are written using JSON Pointer. + +

          The provided String value MUST start with "#/" and can use nested "/" + characters to place schemas in nested object properties. The provided + JSON Pointer does not support escaping. + +

          Defaults to "#/definitions" for schema versions less than 2019-09 and "#/$defs" for schema + versions 2019-09 and greater. OpenAPI artifacts will want to use "#/components/schemas".

          +
          +
          Parameters:
          +
          definitionPointer - The root definition pointer to use.
          +
          +
          • +
        + + + +
          +
        • +

          getSchemaDocumentExtensions

          +
          public ObjectNode getSchemaDocumentExtensions()
          +
          • +
        + + + +
          +
        • +

          setSchemaDocumentExtensions

          +
          public void setSchemaDocumentExtensions​(ObjectNode schemaDocumentExtensions)
          +
          Adds custom key-value pairs to the JSON Schema document generated from + a Smithy model.
          +
          +
          Parameters:
          +
          schemaDocumentExtensions - Custom extensions to merge into the created schema.
          +
          +
          • +
        + + + +
          +
        • +

          getDisableFeatures

          +
          public java.util.Set<java.lang.String> getDisableFeatures()
          +
          • +
        + + + +
          +
        • +

          setDisableFeatures

          +
          public void setDisableFeatures​(java.util.Set<java.lang.String> disableFeatures)
          +
          Disables OpenAPI features by their property name (e.g., "allOf").
          +
          +
          Parameters:
          +
          disableFeatures - Feature names to disable.
          +
          +
          • +
        + + + +
          +
        • +

          getExtensions

          +
          public ObjectNode getExtensions()
          +
          • +
        + + + +
          +
        • +

          getExtensions

          +
          public <T> T getExtensions​(java.lang.Class<T> as)
          +
          Attempts to deserialize the extensions into the targeted + type using a NodeMapper. + +

          Extraneous properties are ignored and not warned on + because many different plugins could be used with different + configuration POJOs. + +

          The result of calling this method is cached for each type, + and the cache is cleared when any mutation is made to + extensions.

          +
          +
          Type Parameters:
          +
          T - Type to deserialize extensions into.
          +
          Parameters:
          +
          as - Type to deserialize extensions into.
          +
          Returns:
          +
          Returns the deserialized type.
          +
          +
          • +
        + + + +
          +
        • +

          setExtensions

          +
          public void setExtensions​(ObjectNode extensions)
          +
          Sets an arbitrary map of "extensions" used by plugins that need + configuration.
          +
          +
          Parameters:
          +
          extensions - Extensions to set.
          +
          +
          • +
        + + + +
          +
        • +

          putExtensions

          +
          public void putExtensions​(java.lang.Object extensionContainer)
          +
          Add an extension to the "extensions" object node using a POJO.
          +
          +
          Parameters:
          +
          extensionContainer - POJO to serialize and merge into extensions.
          +
          +
          • +
        + + + +
          +
        • +

          putExtension

          +
          public void putExtension​(java.lang.String key,
+                         Node value)
          +
          Add an extension to the "extensions" object node.
          +
          +
          Parameters:
          +
          key - Property name to set.
          +
          value - Value to assigned.
          +
          +
          • +
        + + + +
          +
        • +

          putExtension

          +
          public void putExtension​(java.lang.String key,
+                         boolean value)
          +
          Add an extension to the "extensions" object node.
          +
          +
          Parameters:
          +
          key - Property name to set.
          +
          value - Value to assigned.
          +
          +
          • +
        + + + +
          +
        • +

          putExtension

          +
          public void putExtension​(java.lang.String key,
+                         java.lang.String value)
          +
          Add an extension to the "extensions" object node.
          +
          +
          Parameters:
          +
          key - Property name to set.
          +
          value - Value to assigned.
          +
          +
          • +
        + + + +
          +
        • +

          getService

          +
          public ShapeId getService()
          +
          Gets the service shape ID that is used to contextualize the created + schemas by using things like the "rename" property of the service.
          +
          +
          Returns:
          +
          the nullable Smithy service shape ID.
          +
          +
          • +
        + + + +
          +
        • +

          setService

          +
          public void setService​(ShapeId service)
          +
          Sets the service shape ID that is used to contextualize the created + schemas by using things like the "rename" property of the service.
          +
          +
          Parameters:
          +
          service - the Smithy service shape ID.
          +
          +
          • +
        + + + +
          +
        • +

          detectJsonTimestampFormat

          +
          public java.util.Optional<java.lang.String> detectJsonTimestampFormat​(Shape shape)
          +
          Detects the TimestampFormat of the given shape, falling back to the + configured default format specified in setDefaultTimestampFormat(TimestampFormatTrait.Format).
          +
          +
          Parameters:
          +
          shape - Shape to extract the timestamp format from.
          +
          Returns:
          +
          Returns the optionally detected format.
          +
          +
          • +
        + + + +
          +
        • +

          getSupportNonNumericFloats

          +
          public boolean getSupportNonNumericFloats()
          +
          • +
        + + + +
          +
        • +

          setSupportNonNumericFloats

          +
          public void setSupportNonNumericFloats​(boolean supportNonNumericFloats)
          +
          Set to true to add support for NaN, Infinity, and -Infinity in float + and double shapes. These values will be serialized as strings. The + OpenAPI document will be updated to refer to them as a "oneOf" of number + and string. + +

          By default, non-numeric values are not supported.

          +
          +
          Parameters:
          +
          supportNonNumericFloats - True if non-numeric float values should be supported.
          +
          +
          • +
        + + + +
          +
        • +

          isEnableOutOfServiceReferences

          +
          public boolean isEnableOutOfServiceReferences()
          +
          • +
        + + + +
          +
        • +

          setEnableOutOfServiceReferences

          +
          public void setEnableOutOfServiceReferences​(boolean enableOutOfServiceReferences)
          +
          Set to true to enable references to shapes outside the service closure. + + Setting this to true means that all the shapes in the model must not conflict, whereas + leaving it at the default, false, means that only the shapes connected to the configured + service via setService(ShapeId) must not conflict.
          +
          +
          Parameters:
          +
          enableOutOfServiceReferences - true if out-of-service references should be allowed. default: false
          +
          +
          • +
        + + + +
          +
        • +

          getUseIntegerType

          +
          public boolean getUseIntegerType()
          +
          • +
        + + + +
          +
        • +

          setUseIntegerType

          +
          public void setUseIntegerType​(boolean useIntegerType)
          +
          Set to true to use the "integer" type when converting byte, + short, integer, and long shapes to Json Schema. + +

          By default, these shape types are converted to Json Schema with a type + of "number".

          +
          +
          Parameters:
          +
          useIntegerType - True to use "integer".
          +
          +
          • +
        + + + +
          +
        • +

          getDisableDefaultValues

          +
          public boolean getDisableDefaultValues()
          +
          • +
        + + + +
          +
        • +

          setDisableDefaultValues

          +
          public void setDisableDefaultValues​(boolean disableDefaultValues)
          +
          Set to true to disable default values on schemas, including wrapping $ref pointers in an `allOf`.
          +
          +
          Parameters:
          +
          disableDefaultValues - True to disable setting default values.
          +
          +
          • +
        + + + +
          +
        • +

          getDisableIntEnums

          +
          public boolean getDisableIntEnums()
          +
          • +
        + + + +
          +
        • +

          setDisableIntEnums

          +
          public void setDisableIntEnums​(boolean disableIntEnums)
          +
          Set to true to disable setting an `enum` property for intEnums. When disabled, + intEnums are inlined instead of using a $ref.
          +
          +
          Parameters:
          +
          disableIntEnums - True to disable setting `enum` property for intEnums.
          +
          +
          • +
        + + + +
          +
        • +

          getJsonSchemaVersion

          +
          public JsonSchemaVersion getJsonSchemaVersion()
          +
          JSON schema version to use when converting Smithy shapes into Json Schema. + +

          Defaults to JSON Schema version draft07 if no schema version is specified

          +
          +
          Returns:
          +
          JSON Schema version that will be used for generated JSON schema
          +
          +
          • +
        + + + +
          +
        • +

          setJsonSchemaVersion

          +
          public void setJsonSchemaVersion​(JsonSchemaVersion schemaVersion)
          +
          Set the JSON schema version to use when converting Smithy shapes into Json Schema.
          +
          +
          Parameters:
          +
          schemaVersion - JSON Schema version to use for generated schema
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jsonschema/JsonSchemaConverter.Builder.html b/javadoc/1.47.0/software/amazon/smithy/jsonschema/JsonSchemaConverter.Builder.html new file mode 100644 index 00000000000..a352b598161 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jsonschema/JsonSchemaConverter.Builder.html @@ -0,0 +1,454 @@ + + + + + +JsonSchemaConverter.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jsonschema
    +

    Class JsonSchemaConverter.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.jsonschema.JsonSchemaConverter.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          model

          +
          public JsonSchemaConverter.Builder model​(Model model)
          +
          Sets the shape index to convert.
          +
          +
          Parameters:
          +
          model - Shape index to convert.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          rootShape

          +
          public JsonSchemaConverter.Builder rootShape​(ToShapeId rootShape)
          +
          Only generates shapes connected to the given shape and set the + given shape as the root of the created schema document.
          +
          +
          Parameters:
          +
          rootShape - ID of the shape that is used to limit + the closure of the generated document.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          shapePredicate

          +
          public JsonSchemaConverter.Builder shapePredicate​(java.util.function.Predicate<Shape> shapePredicate)
          +
          Sets a predicate used to filter Smithy shapes from being converted + to JSON Schema.
          +
          +
          Parameters:
          +
          shapePredicate - Predicate that returns true if a shape is to be converted.
          +
          Returns:
          +
          Returns the converter.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          propertyNamingStrategy

          +
          public JsonSchemaConverter.Builder propertyNamingStrategy​(PropertyNamingStrategy propertyNamingStrategy)
          +
          Sets a custom property naming strategy. + +

          This method overrides an configuration values specified by + the configuration object.

          +
          +
          Parameters:
          +
          propertyNamingStrategy - Property name strategy to use.
          +
          Returns:
          +
          Returns the converter.
          +
          +
          • +
        + + + +
          +
        • +

          addMapper

          +
          public JsonSchemaConverter.Builder addMapper​(JsonSchemaMapper jsonSchemaMapper)
          +
          Adds a mapper used to update schema builders.
          +
          +
          Parameters:
          +
          jsonSchemaMapper - Mapper to add.
          +
          Returns:
          +
          Returns the converter.
          +
          +
          • +
        + + + +
          +
        • +

          mappers

          +
          public JsonSchemaConverter.Builder mappers​(java.util.List<JsonSchemaMapper> jsonSchemaMappers)
          +
          Replaces the mappers of the builder with the given mappers.
          +
          +
          Parameters:
          +
          jsonSchemaMappers - Mappers to replace with.
          +
          Returns:
          +
          Returns the converter.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jsonschema/JsonSchemaConverter.html b/javadoc/1.47.0/software/amazon/smithy/jsonschema/JsonSchemaConverter.html new file mode 100644 index 00000000000..538f6bcd64c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jsonschema/JsonSchemaConverter.html @@ -0,0 +1,512 @@ + + + + + +JsonSchemaConverter (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jsonschema
    +

    Class JsonSchemaConverter

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.jsonschema.JsonSchemaConverter
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getConfig

          +
          public JsonSchemaConfig getConfig()
          +
          Gets the configuration object.
          +
          +
          Returns:
          +
          Returns the config object.
          +
          +
          • +
        + + + +
          +
        • +

          setConfig

          +
          public void setConfig​(JsonSchemaConfig config)
          +
          Set the JSON Schema configuration settings.
          +
          +
          Parameters:
          +
          config - Config object to set.
          +
          +
          • +
        + + + +
          +
        • +

          toPropertyName

          +
          public java.lang.String toPropertyName​(MemberShape member)
          +
          Gets the property naming strategy of the converter.
          +
          +
          Parameters:
          +
          member - Member to convert to a property name.
          +
          Returns:
          +
          Returns the PropertyNamingStrategy.
          +
          +
          • +
        + + + +
          +
        • +

          toPointer

          +
          public java.lang.String toPointer​(ToShapeId id)
          +
          Given a shape ID, returns the value used in a $ref to refer to it. + +

          The return value is expected to be a JSON pointer.

          +
          +
          Parameters:
          +
          id - Shape ID to convert to a $ref string.
          +
          Returns:
          +
          Returns the $ref string (e.g., "#/responses/MyShape").
          +
          +
          • +
        + + + +
          +
        • +

          isTopLevelPointer

          +
          public boolean isTopLevelPointer​(java.lang.String pointer)
          +
          Checks if the given JSON pointer points to a top-level definition. + +

          Note that this expects the pointer to exactly start with the same + string that is configured as JsonSchemaConfig.getDefinitionPointer(), + or the default value of "#/definitions". If the number of segments + in the provided pointer is also equal to the number of segments + in the default pointer + 1, then it is considered a top-level pointer.

          +
          +
          Parameters:
          +
          pointer - Pointer to check.
          +
          Returns:
          +
          Returns true if this is a top-level definition pointer.
          +
          +
          • +
        + + + +
          +
        • +

          isInlined

          +
          public boolean isInlined​(Shape shape)
          +
          Checks if the given shape is inlined into its container when targeted + by a member.
          +
          +
          Parameters:
          +
          shape - Shape to check.
          +
          Returns:
          +
          Returns true if this shape is inlined into its containing shape.
          +
          +
          • +
        + + + +
          +
        • +

          convert

          +
          public SchemaDocument convert()
          +
          Perform the conversion of the entire shape index.
          +
          +
          Returns:
          +
          Returns the created SchemaDocument.
          +
          +
          • +
        + + + +
          +
        • +

          convertShape

          +
          public SchemaDocument convertShape​(Shape shape)
          +
          Perform the conversion of a single shape. + +

          The root shape of the created document is set to the given shape. + No schema extensions are added to the converted schema. This + conversion also doesn't take the shape predicate or private + controls into account.

          +
          +
          Parameters:
          +
          shape - Shape to convert.
          +
          Returns:
          +
          Returns the created SchemaDocument.
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jsonschema/JsonSchemaMapper.html b/javadoc/1.47.0/software/amazon/smithy/jsonschema/JsonSchemaMapper.html new file mode 100644 index 00000000000..e2c19f2a06b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jsonschema/JsonSchemaMapper.html @@ -0,0 +1,333 @@ + + + + + +JsonSchemaMapper (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jsonschema
    +

    Interface JsonSchemaMapper

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getOrder

          +
          default byte getOrder()
          +
          Gets the sort order of the plugin from -128 to 127. + +

          Plugins are applied according to this sort order. Lower values + are executed before higher values (for example, -128 comes before 0, + comes before 127). Plugins default to 0, which is the middle point + between the minimum and maximum order values.

          +
          +
          Returns:
          +
          Returns the sort order, defaulting to 0.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          updateSchema

          +
          default Schema.Builder updateSchema​(Shape shape,
+                                    Schema.Builder schemaBuilder,
+                                    JsonSchemaConfig config)
          +
          Updates a schema builder, and is not recommended. Use + updateSchema(JsonSchemaMapperContext, Schema.Builder) instead. + + If not implemented, this method will default to a no-op. + + This method is not deprecated for backwards-compatibility.
          +
          +
          Parameters:
          +
          shape - Shape used for the conversion.
          +
          schemaBuilder - Schema builder to update.
          +
          config - JSON Schema config.
          +
          Returns:
          +
          Returns an updated schema builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jsonschema/JsonSchemaMapperContext.html b/javadoc/1.47.0/software/amazon/smithy/jsonschema/JsonSchemaMapperContext.html new file mode 100644 index 00000000000..043af1016a5 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jsonschema/JsonSchemaMapperContext.html @@ -0,0 +1,314 @@ + + + + + +JsonSchemaMapperContext (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jsonschema
    +

    Class JsonSchemaMapperContext

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.jsonschema.JsonSchemaMapperContext
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class JsonSchemaMapperContext
+extends java.lang.Object
      +
      Context for a JSON schema mapping.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        JsonSchemaConfiggetConfig() +
        Gets the JSON schema configuration object.
        +
        ModelgetModel() +
        Gets the Smithy model being converted.
        +
        ShapegetShape() +
        Gets the Smithy shape being mapped.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + +
          +
        • +

          getModel

          +
          public Model getModel()
          +
          Gets the Smithy model being converted.
          +
          +
          Returns:
          +
          Returns the Smithy model.
          +
          +
          • +
        + + + +
          +
        • +

          getShape

          +
          public Shape getShape()
          +
          Gets the Smithy shape being mapped.
          +
          +
          Returns:
          +
          Returns the Smithy shape.
          +
          +
          • +
        + + + +
          +
        • +

          getConfig

          +
          public JsonSchemaConfig getConfig()
          +
          Gets the JSON schema configuration object.
          +
          +
          Returns:
          +
          Returns the JSON schema config object.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jsonschema/JsonSchemaVersion.html b/javadoc/1.47.0/software/amazon/smithy/jsonschema/JsonSchemaVersion.html new file mode 100644 index 00000000000..b0cacd84852 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jsonschema/JsonSchemaVersion.html @@ -0,0 +1,409 @@ + + + + + +JsonSchemaVersion (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jsonschema
    +

    Enum JsonSchemaVersion

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Enum<JsonSchemaVersion>
        • +
      • +
          +
        • software.amazon.smithy.jsonschema.JsonSchemaVersion
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable, java.lang.Comparable<JsonSchemaVersion>
      +
      +
      +
      public enum JsonSchemaVersion
+extends java.lang.Enum<JsonSchemaVersion>
      +
      Configures the schema version to use when converting Smithy shapes to JSON Schema.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        DRAFT07 
        DRAFT2020_12 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.lang.StringgetLocation() 
        java.lang.StringtoString() 
        static JsonSchemaVersionvalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static JsonSchemaVersion[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static JsonSchemaVersion[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (JsonSchemaVersion c : JsonSchemaVersion.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static JsonSchemaVersion valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Enum<JsonSchemaVersion>
          +
          +
          • +
        + + + +
          +
        • +

          getLocation

          +
          public java.lang.String getLocation()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jsonschema/PropertyNamingStrategy.html b/javadoc/1.47.0/software/amazon/smithy/jsonschema/PropertyNamingStrategy.html new file mode 100644 index 00000000000..f66f1d24503 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jsonschema/PropertyNamingStrategy.html @@ -0,0 +1,313 @@ + + + + + +PropertyNamingStrategy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jsonschema
    +

    Interface PropertyNamingStrategy

    +
    +
    +
    +
      +
    • +
      +
      Functional Interface:
      +
      This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
      +
      +
      +
      @FunctionalInterface
+public interface PropertyNamingStrategy
      +
      Determines the field/property/member name of a member in an object.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          toPropertyName

          +
          java.lang.String toPropertyName​(Shape containingShape,
+                                MemberShape member,
+                                JsonSchemaConfig config)
          +
          Determine the member name of the member.
          +
          +
          Parameters:
          +
          containingShape - Shape that contains the member.
          +
          member - Member shape to compute the member name of.
          +
          config - Config to use.
          +
          Returns:
          +
          Returns the computed member name.
          +
          +
          • +
        + + + +
          +
        • +

          createMemberNameStrategy

          +
          static PropertyNamingStrategy createMemberNameStrategy()
          +
          Creates a naming strategy that just uses the member name as-is.
          +
          +
          Returns:
          +
          Returns the created strategy.
          +
          +
          • +
        + + + +
          +
        • +

          createDefaultStrategy

          +
          static PropertyNamingStrategy createDefaultStrategy()
          +
          Creates a default strategy that first checks for jsonName then + falls back to the member name.
          +
          +
          Returns:
          +
          Returns the created strategy.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jsonschema/Schema.Builder.html b/javadoc/1.47.0/software/amazon/smithy/jsonschema/Schema.Builder.html new file mode 100644 index 00000000000..e115f68e0b2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jsonschema/Schema.Builder.html @@ -0,0 +1,959 @@ + + + + + +Schema.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jsonschema
    +

    Class Schema.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.jsonschema.Schema.Builder
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      SmithyBuilder<Schema>
      +
      +
      +
      Enclosing class:
      +
      Schema
      +
      +
      +
      public static final class Schema.Builder
+extends java.lang.Object
+implements SmithyBuilder<Schema>
      +
      Abstract class used to build Schema components.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public Schema build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Specified by:
          +
          build in interface SmithyBuilder<Schema>
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        + + + + + + + + + + + + + + + +
          +
        • +

          enumValues

          +
          public Schema.Builder enumValues​(java.util.Collection<java.lang.String> enumValues)
          +
          • +
        + + + +
          +
        • +

          intEnumValues

          +
          public Schema.Builder intEnumValues​(java.util.Collection<java.lang.Integer> intEnumValues)
          +
          • +
        + + + + + + + +
          +
        • +

          multipleOf

          +
          public Schema.Builder multipleOf​(java.lang.Number multipleOf)
          +
          • +
        + + + +
          +
        • +

          maximum

          +
          public Schema.Builder maximum​(java.lang.Number maximum)
          +
          • +
        + + + +
          +
        • +

          exclusiveMaximum

          +
          public Schema.Builder exclusiveMaximum​(java.lang.Number exclusiveMaximum)
          +
          • +
        + + + +
          +
        • +

          minimum

          +
          public Schema.Builder minimum​(java.lang.Number minimum)
          +
          • +
        + + + +
          +
        • +

          exclusiveMinimum

          +
          public Schema.Builder exclusiveMinimum​(java.lang.Number exclusiveMinimum)
          +
          • +
        + + + +
          +
        • +

          maxLength

          +
          public Schema.Builder maxLength​(java.lang.Long maxLength)
          +
          • +
        + + + +
          +
        • +

          minLength

          +
          public Schema.Builder minLength​(java.lang.Long minLength)
          +
          • +
        + + + +
          +
        • +

          pattern

          +
          public Schema.Builder pattern​(java.lang.String pattern)
          +
          • +
        + + + + + + + +
          +
        • +

          maxItems

          +
          public Schema.Builder maxItems​(java.lang.Integer maxItems)
          +
          • +
        + + + +
          +
        • +

          minItems

          +
          public Schema.Builder minItems​(java.lang.Integer minItems)
          +
          • +
        + + + +
          +
        • +

          uniqueItems

          +
          public Schema.Builder uniqueItems​(boolean uniqueItems)
          +
          • +
        + + + +
          +
        • +

          maxProperties

          +
          public Schema.Builder maxProperties​(java.lang.Integer maxProperties)
          +
          • +
        + + + +
          +
        • +

          minProperties

          +
          public Schema.Builder minProperties​(java.lang.Integer minProperties)
          +
          • +
        + + + +
          +
        • +

          required

          +
          public Schema.Builder required​(java.util.Collection<java.lang.String> required)
          +
          • +
        + + + +
          +
        • +

          properties

          +
          public Schema.Builder properties​(java.util.Map<java.lang.String,​Schema> properties)
          +
          • +
        + + + + + + + +
          +
        • +

          removeProperty

          +
          public Schema.Builder removeProperty​(java.lang.String key)
          +
          • +
        + + + +
          +
        • +

          additionalProperties

          +
          public Schema.Builder additionalProperties​(Schema additionalProperties)
          +
          • +
        + + + + + + + +
          +
        • +

          patternProperties

          +
          public Schema.Builder patternProperties​(java.util.Map<java.lang.String,​Schema> patternProperties)
          +
          • +
        + + + +
          +
        • +

          putPatternProperty

          +
          public Schema.Builder putPatternProperty​(java.lang.String key,
+                                         Schema value)
          +
          • +
        + + + +
          +
        • +

          removePatternProperty

          +
          public Schema.Builder removePatternProperty​(java.lang.String key)
          +
          • +
        + + + + + + + + + + + + + + + + + + + +
          +
        • +

          title

          +
          public Schema.Builder title​(java.lang.String title)
          +
          • +
        + + + +
          +
        • +

          description

          +
          public Schema.Builder description​(java.lang.String description)
          +
          • +
        + + + +
          +
        • +

          getFormat

          +
          public java.util.Optional<java.lang.String> getFormat()
          +
          • +
        + + + +
          +
        • +

          format

          +
          public Schema.Builder format​(java.lang.String format)
          +
          • +
        + + + +
          +
        • +

          readOnly

          +
          public Schema.Builder readOnly​(boolean readOnly)
          +
          • +
        + + + +
          +
        • +

          writeOnly

          +
          public Schema.Builder writeOnly​(boolean writeOnly)
          +
          • +
        + + + +
          +
        • +

          comment

          +
          public Schema.Builder comment​(java.lang.String comment)
          +
          • +
        + + + +
          +
        • +

          contentEncoding

          +
          public Schema.Builder contentEncoding​(java.lang.String contentEncoding)
          +
          • +
        + + + +
          +
        • +

          contentMediaType

          +
          public Schema.Builder contentMediaType​(java.lang.String contentMediaType)
          +
          • +
        + + + + + + + +
          +
        • +

          extensions

          +
          public Schema.Builder extensions​(java.util.Map<java.lang.String,​Node> extensions)
          +
          • +
        + + + +
          +
        • +

          putExtension

          +
          public Schema.Builder putExtension​(java.lang.String key,
+                                   ToNode value)
          +
          • +
        + + + +
          +
        • +

          removeExtension

          +
          public Schema.Builder removeExtension​(java.lang.String key)
          +
          • +
        + + + +
          +
        • +

          disableProperty

          +
          public Schema.Builder disableProperty​(java.lang.String propertyName)
          +
          Disables a specific JSON schema property by name.
          +
          +
          Parameters:
          +
          propertyName - Property name to remove (e.g., "propertyNames").
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jsonschema/Schema.html b/javadoc/1.47.0/software/amazon/smithy/jsonschema/Schema.html new file mode 100644 index 00000000000..c1b470f1c9b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jsonschema/Schema.html @@ -0,0 +1,1008 @@ + + + + + +Schema (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jsonschema
    +

    Class Schema

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.jsonschema.Schema
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getRef

          +
          public java.util.Optional<java.lang.String> getRef()
          +
          • +
        + + + +
          +
        • +

          getType

          +
          public java.util.Optional<java.lang.String> getType()
          +
          • +
        + + + +
          +
        • +

          getEnumValues

          +
          public java.util.Optional<java.util.Collection<java.lang.String>> getEnumValues()
          +
          • +
        + + + +
          +
        • +

          getIntEnumValues

          +
          public java.util.Optional<java.util.Collection<java.lang.Integer>> getIntEnumValues()
          +
          • +
        + + + +
          +
        • +

          getConstValue

          +
          public java.util.Optional<Node> getConstValue()
          +
          • +
        + + + +
          +
        • +

          getDefaultValue

          +
          public java.util.Optional<Node> getDefaultValue()
          +
          • +
        + + + +
          +
        • +

          getMultipleOf

          +
          public java.util.Optional<java.lang.Number> getMultipleOf()
          +
          • +
        + + + +
          +
        • +

          getMaximum

          +
          public java.util.Optional<java.lang.Number> getMaximum()
          +
          • +
        + + + +
          +
        • +

          getExclusiveMaximum

          +
          public java.util.Optional<java.lang.Number> getExclusiveMaximum()
          +
          • +
        + + + +
          +
        • +

          getMinimum

          +
          public java.util.Optional<java.lang.Number> getMinimum()
          +
          • +
        + + + +
          +
        • +

          getExclusiveMinimum

          +
          public java.util.Optional<java.lang.Number> getExclusiveMinimum()
          +
          • +
        + + + +
          +
        • +

          getMaxLength

          +
          public java.util.Optional<java.lang.Long> getMaxLength()
          +
          • +
        + + + +
          +
        • +

          getMinLength

          +
          public java.util.Optional<java.lang.Long> getMinLength()
          +
          • +
        + + + +
          +
        • +

          getPattern

          +
          public java.util.Optional<java.lang.String> getPattern()
          +
          • +
        + + + +
          +
        • +

          getItems

          +
          public java.util.Optional<Schema> getItems()
          +
          • +
        + + + +
          +
        • +

          getMaxItems

          +
          public java.util.Optional<java.lang.Integer> getMaxItems()
          +
          • +
        + + + +
          +
        • +

          getMinItems

          +
          public java.util.Optional<java.lang.Integer> getMinItems()
          +
          • +
        + + + +
          +
        • +

          getUniqueItems

          +
          public boolean getUniqueItems()
          +
          • +
        + + + +
          +
        • +

          getMaxProperties

          +
          public java.util.Optional<java.lang.Integer> getMaxProperties()
          +
          • +
        + + + +
          +
        • +

          getMinProperties

          +
          public java.util.Optional<java.lang.Integer> getMinProperties()
          +
          • +
        + + + +
          +
        • +

          getRequired

          +
          public java.util.Collection<java.lang.String> getRequired()
          +
          • +
        + + + +
          +
        • +

          getProperties

          +
          public java.util.Map<java.lang.String,​Schema> getProperties()
          +
          • +
        + + + +
          +
        • +

          getProperty

          +
          public java.util.Optional<Schema> getProperty​(java.lang.String key)
          +
          • +
        + + + +
          +
        • +

          getAdditionalProperties

          +
          public java.util.Optional<Schema> getAdditionalProperties()
          +
          • +
        + + + +
          +
        • +

          getPropertyNames

          +
          public java.util.Optional<Schema> getPropertyNames()
          +
          • +
        + + + +
          +
        • +

          getPatternProperties

          +
          public java.util.Map<java.lang.String,​Schema> getPatternProperties()
          +
          • +
        + + + +
          +
        • +

          getAllOf

          +
          public java.util.List<Schema> getAllOf()
          +
          • +
        + + + +
          +
        • +

          getAnyOf

          +
          public java.util.List<Schema> getAnyOf()
          +
          • +
        + + + +
          +
        • +

          getOneOf

          +
          public java.util.List<Schema> getOneOf()
          +
          • +
        + + + +
          +
        • +

          getNot

          +
          public java.util.Optional<Schema> getNot()
          +
          • +
        + + + +
          +
        • +

          getTitle

          +
          public java.util.Optional<java.lang.String> getTitle()
          +
          • +
        + + + +
          +
        • +

          getDescription

          +
          public java.util.Optional<java.lang.String> getDescription()
          +
          • +
        + + + +
          +
        • +

          getFormat

          +
          public java.util.Optional<java.lang.String> getFormat()
          +
          • +
        + + + +
          +
        • +

          getReadOnly

          +
          public boolean getReadOnly()
          +
          • +
        + + + +
          +
        • +

          getWriteOnly

          +
          public boolean getWriteOnly()
          +
          • +
        + + + +
          +
        • +

          getComment

          +
          public java.util.Optional<java.lang.String> getComment()
          +
          • +
        + + + +
          +
        • +

          getExamples

          +
          public java.util.Optional<Node> getExamples()
          +
          • +
        + + + +
          +
        • +

          getContentEncoding

          +
          public java.util.Optional<java.lang.String> getContentEncoding()
          +
          • +
        + + + +
          +
        • +

          getContentMediaType

          +
          public java.util.Optional<java.lang.String> getContentMediaType()
          +
          • +
        + + + +
          +
        • +

          getExtension

          +
          public java.util.Optional<ToNode> getExtension​(java.lang.String key)
          +
          • +
        + + + +
          +
        • +

          getAllExtensions

          +
          public java.util.Map<java.lang.String,​ToNode> getAllExtensions()
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          selectSchema

          +
          public java.util.Optional<Schema> selectSchema​(java.lang.String... segments)
          +
          Selects a nested schema using a variadic list of property names + to descend into. + +

          For example, this method can be used to get the items schema nested + inside of an array inside of an object: + + 

          
+ Schema itemsSchema = schema.selectSchema("properties", "foo", "items").get();
+
          +
          +
          Parameters:
          +
          segments - The properties names to retrieve.
          +
          Returns:
          +
          Returns the selected Schema.
          +
          +
          • +
        + + + +
          +
        • +

          toBuilder

          +
          public Schema.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<Schema>
          +
          Returns:
          +
          a builder for type T
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jsonschema/SchemaDocument.Builder.html b/javadoc/1.47.0/software/amazon/smithy/jsonschema/SchemaDocument.Builder.html new file mode 100644 index 00000000000..92ffbe2ea4d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jsonschema/SchemaDocument.Builder.html @@ -0,0 +1,427 @@ + + + + + +SchemaDocument.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jsonschema
    +

    Class SchemaDocument.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.jsonschema.SchemaDocument.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public SchemaDocument build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Specified by:
          +
          build in interface SmithyBuilder<SchemaDocument>
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        + + + +
          +
        • +

          idKeyword

          +
          public SchemaDocument.Builder idKeyword​(java.lang.String idKeyword)
          +
          Sets the "$id" keyword.
          +
          +
          Parameters:
          +
          idKeyword - ID keyword URI to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          schemaKeyword

          +
          public SchemaDocument.Builder schemaKeyword​(java.lang.String schemaKeyword)
          +
          Sets the "$schema" keyword.
          +
          +
          Parameters:
          +
          schemaKeyword - Schema keyword URI to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          rootSchema

          +
          public SchemaDocument.Builder rootSchema​(Schema rootSchema)
          +
          Sets the root schema.
          +
          +
          Parameters:
          +
          rootSchema - Root schema of the document.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          putDefinition

          +
          public SchemaDocument.Builder putDefinition​(java.lang.String name,
+                                            Schema schema)
          +
          Adds a scheme definition to the builder.
          +
          +
          Parameters:
          +
          name - Name of the schema.
          +
          schema - Schema to associate to the name.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          removeDefinition

          +
          public SchemaDocument.Builder removeDefinition​(java.lang.String name)
          +
          Removes a schema definition by name.
          +
          +
          Parameters:
          +
          name - Name of the schema to remove.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          extensions

          +
          public SchemaDocument.Builder extensions​(ObjectNode extensions)
          +
          Adds custom key-value pairs to the resulting JSON Schema document.
          +
          +
          Parameters:
          +
          extensions - Extensions to apply.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jsonschema/SchemaDocument.html b/javadoc/1.47.0/software/amazon/smithy/jsonschema/SchemaDocument.html new file mode 100644 index 00000000000..c7a4ffbbaea --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jsonschema/SchemaDocument.html @@ -0,0 +1,553 @@ + + + + + +SchemaDocument (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jsonschema
    +

    Class SchemaDocument

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.jsonschema.SchemaDocument
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static class SchemaDocument.Builder +
        Builds a JSON Schema document.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static SchemaDocument.Builderbuilder() +
        Returns a builder used to create a SchemaDocument.
        +
        booleanequals​(java.lang.Object o) 
        java.util.Optional<Schema>getDefinition​(java.lang.String pointer) +
        Gets a schema definition from the "definitions" map using a JSON pointer.
        +
        java.util.Map<java.lang.String,​Schema>getDefinitions() +
        Gets all of the schema definitions defined in the "definitions" map.
        +
        java.util.Optional<Node>getExtension​(java.lang.String key) +
        Gets an extension value by name.
        +
        ObjectNodegetExtensions() +
        Gets all extensions of the schema document.
        +
        java.util.Optional<java.lang.String>getIdKeyword() +
        Gets the "$id" keyword of the document.
        +
        SchemagetRootSchema() +
        Gets the root schema definition.
        +
        java.util.Optional<java.lang.String>getSchemaKeyword() +
        Gets the "$schema" keyword of the document.
        +
        inthashCode() 
        SchemaDocument.BuildertoBuilder() +
        Take this object and create a builder that contains all of the + current property values of this object.
        +
        NodetoNode() +
        Converts a value to a Node.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getRootSchema

          +
          public Schema getRootSchema()
          +
          Gets the root schema definition.
          +
          +
          Returns:
          +
          Returns the root schema.
          +
          See Also:
          +
          Root schema
          +
          +
          • +
        + + + +
          +
        • +

          getIdKeyword

          +
          public java.util.Optional<java.lang.String> getIdKeyword()
          +
          Gets the "$id" keyword of the document.
          +
          +
          Returns:
          +
          Returns the optionally defined $id.
          +
          See Also:
          +
          $id
          +
          +
          • +
        + + + +
          +
        • +

          getSchemaKeyword

          +
          public java.util.Optional<java.lang.String> getSchemaKeyword()
          +
          Gets the "$schema" keyword of the document.
          +
          +
          Returns:
          +
          Returns the optionally defined $schema.
          +
          See Also:
          +
          $schema
          +
          +
          • +
        + + + +
          +
        • +

          getDefinition

          +
          public java.util.Optional<Schema> getDefinition​(java.lang.String pointer)
          +
          Gets a schema definition from the "definitions" map using a JSON pointer. + +

          The "root" schema is returned if pointer is an empty string.

          +
          +
          Parameters:
          +
          pointer - JSON Schema pointer to retrieve.
          +
          Returns:
          +
          Returns the optionally found schema definition.
          +
          +
          • +
        + + + +
          +
        • +

          getDefinitions

          +
          public java.util.Map<java.lang.String,​Schema> getDefinitions()
          +
          Gets all of the schema definitions defined in the "definitions" map.
          +
          +
          Returns:
          +
          Returns the defined schema definitions.
          +
          See Also:
          +
          Schema reuse with "definitions"
          +
          +
          • +
        + + + +
          +
        • +

          getExtension

          +
          public java.util.Optional<Node> getExtension​(java.lang.String key)
          +
          Gets an extension value by name.
          +
          +
          Parameters:
          +
          key - Name of the extension to retrieve.
          +
          Returns:
          +
          Returns the extension object.
          +
          +
          • +
        + + + +
          +
        • +

          getExtensions

          +
          public ObjectNode getExtensions()
          +
          Gets all extensions of the schema document.
          +
          +
          Returns:
          +
          Returns the extensions added to the schema.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jsonschema/SmithyJsonSchemaException.html b/javadoc/1.47.0/software/amazon/smithy/jsonschema/SmithyJsonSchemaException.html new file mode 100644 index 00000000000..29a1bd32145 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jsonschema/SmithyJsonSchemaException.html @@ -0,0 +1,315 @@ + + + + + +SmithyJsonSchemaException (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.jsonschema
    +

    Class SmithyJsonSchemaException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Throwable
        • +
      • +
          +
        • java.lang.Exception
          • +
        • +
            +
          • java.lang.RuntimeException
            • +
          • +
              +
            • software.amazon.smithy.jsonschema.SmithyJsonSchemaException
              • +
            +
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      Direct Known Subclasses:
      +
      ConflictingShapeNameException
      +
      +
      +
      public class SmithyJsonSchemaException
+extends java.lang.RuntimeException
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          SmithyJsonSchemaException

          +
          public SmithyJsonSchemaException​(java.lang.String message)
          +
          • +
        + + + +
          +
        • +

          SmithyJsonSchemaException

          +
          public SmithyJsonSchemaException​(java.lang.String message,
+                                 java.lang.Throwable cause)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jsonschema/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/jsonschema/package-summary.html new file mode 100644 index 00000000000..09acc957332 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jsonschema/package-summary.html @@ -0,0 +1,279 @@ + + + + + +software.amazon.smithy.jsonschema (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.jsonschema

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/jsonschema/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/jsonschema/package-tree.html new file mode 100644 index 00000000000..f37b9d1654f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/jsonschema/package-tree.html @@ -0,0 +1,208 @@ + + + + + +software.amazon.smithy.jsonschema Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.jsonschema

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +

    Enum Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/AbbreviationNameValidator.Config.html b/javadoc/1.47.0/software/amazon/smithy/linters/AbbreviationNameValidator.Config.html new file mode 100644 index 00000000000..2fdbb7210c0 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/AbbreviationNameValidator.Config.html @@ -0,0 +1,330 @@ + + + + + +AbbreviationNameValidator.Config (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.linters
    +

    Class AbbreviationNameValidator.Config

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.linters.AbbreviationNameValidator.Config
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      AbbreviationNameValidator
      +
      +
      +
      public static final class AbbreviationNameValidator.Config
+extends java.lang.Object
      +
      AbbreviationName configuration settings.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Config() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.util.List<java.lang.String>getAllowedAbbreviations() +
        A list of abbreviation strings to permit.
        +
        voidsetAllowedAbbreviations​(java.util.List<java.lang.String> allowedAbbreviations) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Config

          +
          public Config()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getAllowedAbbreviations

          +
          public java.util.List<java.lang.String> getAllowedAbbreviations()
          +
          A list of abbreviation strings to permit.
          +
          +
          Returns:
          +
          Returns the allowed abbreviations.
          +
          +
          • +
        + + + +
          +
        • +

          setAllowedAbbreviations

          +
          public void setAllowedAbbreviations​(java.util.List<java.lang.String> allowedAbbreviations)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/AbbreviationNameValidator.Provider.html b/javadoc/1.47.0/software/amazon/smithy/linters/AbbreviationNameValidator.Provider.html new file mode 100644 index 00000000000..9f50e636970 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/AbbreviationNameValidator.Provider.html @@ -0,0 +1,303 @@ + + + + + +AbbreviationNameValidator.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.linters
    +

    Class AbbreviationNameValidator.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/AbbreviationNameValidator.html b/javadoc/1.47.0/software/amazon/smithy/linters/AbbreviationNameValidator.html new file mode 100644 index 00000000000..0ee393af692 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/AbbreviationNameValidator.html @@ -0,0 +1,339 @@ + + + + + +AbbreviationNameValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.linters
    +

    Class AbbreviationNameValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class AbbreviationNameValidator
+extends AbstractValidator
      +
      Emits a validation event if shapes or member names do not use strict + camelCasing (e.g., XmlRequest is preferred over XMLRequest).
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/CamelCaseValidator.Config.html b/javadoc/1.47.0/software/amazon/smithy/linters/CamelCaseValidator.Config.html new file mode 100644 index 00000000000..0913f250d25 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/CamelCaseValidator.Config.html @@ -0,0 +1,332 @@ + + + + + +CamelCaseValidator.Config (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.linters
    +

    Class CamelCaseValidator.Config

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.linters.CamelCaseValidator.Config
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      CamelCaseValidator
      +
      +
      +
      public static final class CamelCaseValidator.Config
+extends java.lang.Object
      +
      CamelCase configuration settings.
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/CamelCaseValidator.MemberNameHandling.html b/javadoc/1.47.0/software/amazon/smithy/linters/CamelCaseValidator.MemberNameHandling.html new file mode 100644 index 00000000000..cc867e18bd3 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/CamelCaseValidator.MemberNameHandling.html @@ -0,0 +1,402 @@ + + + + + +CamelCaseValidator.MemberNameHandling (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.linters
    +

    Enum CamelCaseValidator.MemberNameHandling

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        AUTO +
        Member names are serialized using either all lower camel or all upper camel, but not a mixture.
        +
        LOWER +
        Member names are serialized using lower camel case (e.g., fooBar).
        +
        UPPER +
        Member names are serialized using upper camel case (e.g., FooBar).
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static CamelCaseValidator.MemberNameHandlingvalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static CamelCaseValidator.MemberNameHandling[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static CamelCaseValidator.MemberNameHandling[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (CamelCaseValidator.MemberNameHandling c : CamelCaseValidator.MemberNameHandling.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static CamelCaseValidator.MemberNameHandling valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/CamelCaseValidator.Provider.html b/javadoc/1.47.0/software/amazon/smithy/linters/CamelCaseValidator.Provider.html new file mode 100644 index 00000000000..08ba36c8ff8 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/CamelCaseValidator.Provider.html @@ -0,0 +1,303 @@ + + + + + +CamelCaseValidator.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.linters
    +

    Class CamelCaseValidator.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/CamelCaseValidator.html b/javadoc/1.47.0/software/amazon/smithy/linters/CamelCaseValidator.html new file mode 100644 index 00000000000..60830178eef --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/CamelCaseValidator.html @@ -0,0 +1,344 @@ + + + + + +CamelCaseValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.linters
    +

    Class CamelCaseValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class CamelCaseValidator
+extends AbstractValidator
      +
      Emits a validation event if shapes at a specific location do not match the + desired camel casing format.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/InputOutputStructureReuseValidator.Provider.html b/javadoc/1.47.0/software/amazon/smithy/linters/InputOutputStructureReuseValidator.Provider.html new file mode 100644 index 00000000000..6943b745c2c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/InputOutputStructureReuseValidator.Provider.html @@ -0,0 +1,303 @@ + + + + + +InputOutputStructureReuseValidator.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.linters
    +

    Class InputOutputStructureReuseValidator.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/InputOutputStructureReuseValidator.html b/javadoc/1.47.0/software/amazon/smithy/linters/InputOutputStructureReuseValidator.html new file mode 100644 index 00000000000..5fe689a6305 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/InputOutputStructureReuseValidator.html @@ -0,0 +1,372 @@ + + + + + +InputOutputStructureReuseValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.linters
    +

    Class InputOutputStructureReuseValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class InputOutputStructureReuseValidator
+extends AbstractValidator
      +
      Validates that all operations define input and output structures that are marked + with the input and output traits.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          InputOutputStructureReuseValidator

          +
          public InputOutputStructureReuseValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/MissingClientOptionalTrait.Config.html b/javadoc/1.47.0/software/amazon/smithy/linters/MissingClientOptionalTrait.Config.html new file mode 100644 index 00000000000..11ab399b96f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/MissingClientOptionalTrait.Config.html @@ -0,0 +1,371 @@ + + + + + +MissingClientOptionalTrait.Config (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.linters
    +

    Class MissingClientOptionalTrait.Config

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.linters.MissingClientOptionalTrait.Config
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      MissingClientOptionalTrait
      +
      +
      +
      public static final class MissingClientOptionalTrait.Config
+extends java.lang.Object
      +
      MissingClientOptionalTrait configuration settings.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Config() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        booleanonRequiredOrDefault() +
        Whether clientOptional is required for all members marked as required or default.
        +
        voidonRequiredOrDefault​(boolean onDefault) 
        booleanonRequiredStructureOrUnion() +
        Whether clientOptional is required for members marked as required that + target structures or unions (shapes with no zero value, meaning it's + impossible to later remove the required trait and replace it with the + default trait).
        +
        voidonRequiredStructureOrUnion​(boolean onRequiredStructuresOrUnion) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Config

          +
          public Config()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          onRequiredStructureOrUnion

          +
          public boolean onRequiredStructureOrUnion()
          +
          Whether clientOptional is required for members marked as required that + target structures or unions (shapes with no zero value, meaning it's + impossible to later remove the required trait and replace it with the + default trait).
          +
          +
          Returns:
          +
          Returns true if required.
          +
          +
          • +
        + + + +
          +
        • +

          onRequiredStructureOrUnion

          +
          public void onRequiredStructureOrUnion​(boolean onRequiredStructuresOrUnion)
          +
          • +
        + + + +
          +
        • +

          onRequiredOrDefault

          +
          public boolean onRequiredOrDefault()
          +
          Whether clientOptional is required for all members marked as required or default.
          +
          +
          Returns:
          +
          Returns true if required.
          +
          +
          • +
        + + + +
          +
        • +

          onRequiredOrDefault

          +
          public void onRequiredOrDefault​(boolean onDefault)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/MissingClientOptionalTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/linters/MissingClientOptionalTrait.Provider.html new file mode 100644 index 00000000000..a44db5e07c8 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/MissingClientOptionalTrait.Provider.html @@ -0,0 +1,303 @@ + + + + + +MissingClientOptionalTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.linters
    +

    Class MissingClientOptionalTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/MissingClientOptionalTrait.html b/javadoc/1.47.0/software/amazon/smithy/linters/MissingClientOptionalTrait.html new file mode 100644 index 00000000000..efe562c8122 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/MissingClientOptionalTrait.html @@ -0,0 +1,379 @@ + + + + + +MissingClientOptionalTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.linters
    +

    Class MissingClientOptionalTrait

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class MissingClientOptionalTrait
+extends AbstractValidator
      +
      Validates that the clientOptional trait is applied based on the rules + defined in the validator.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/MissingPaginatedTraitValidator.Config.html b/javadoc/1.47.0/software/amazon/smithy/linters/MissingPaginatedTraitValidator.Config.html new file mode 100644 index 00000000000..9199c88a22d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/MissingPaginatedTraitValidator.Config.html @@ -0,0 +1,434 @@ + + + + + +MissingPaginatedTraitValidator.Config (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.linters
    +

    Class MissingPaginatedTraitValidator.Config

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.linters.MissingPaginatedTraitValidator.Config
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      MissingPaginatedTraitValidator
      +
      +
      +
      public static final class MissingPaginatedTraitValidator.Config
+extends java.lang.Object
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Config

          +
          public Config()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getVerbsRequirePagination

          +
          public java.util.Set<java.lang.String> getVerbsRequirePagination()
          +
          • +
        + + + +
          +
        • +

          setVerbsRequirePagination

          +
          public void setVerbsRequirePagination​(java.util.Set<java.lang.String> verbsRequirePagination)
          +
          Sets the list of verbs that require pagination.
          +
          +
          Parameters:
          +
          verbsRequirePagination - Operation verbs that require pagination.
          +
          +
          • +
        + + + +
          +
        • +

          getVerbsSuggestPagination

          +
          public java.util.Set<java.lang.String> getVerbsSuggestPagination()
          +
          • +
        + + + +
          +
        • +

          setVerbsSuggestPagination

          +
          public void setVerbsSuggestPagination​(java.util.Set<java.lang.String> verbsSuggestPagination)
          +
          Sets the verbs that suggest the operation should be paginated.
          +
          +
          Parameters:
          +
          verbsSuggestPagination - Operation verbs that suggest pagination.
          +
          +
          • +
        + + + +
          +
        • +

          getInputMembersRequirePagination

          +
          public java.util.Set<java.lang.String> getInputMembersRequirePagination()
          +
          • +
        + + + +
          +
        • +

          setInputMembersRequirePagination

          +
          public void setInputMembersRequirePagination​(java.util.Set<java.lang.String> inputMembersRequirePagination)
          +
          Sets the input member names that indicate an operation requires pagination.
          +
          +
          Parameters:
          +
          inputMembersRequirePagination - Input member names.
          +
          +
          • +
        + + + +
          +
        • +

          getOutputMembersRequirePagination

          +
          public java.util.Set<java.lang.String> getOutputMembersRequirePagination()
          +
          • +
        + + + +
          +
        • +

          setOutputMembersRequirePagination

          +
          public void setOutputMembersRequirePagination​(java.util.Set<java.lang.String> outputMembersRequirePagination)
          +
          Sets the output member names that indicate the operation requires pagination.
          +
          +
          Parameters:
          +
          outputMembersRequirePagination - Output member names.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/MissingPaginatedTraitValidator.Provider.html b/javadoc/1.47.0/software/amazon/smithy/linters/MissingPaginatedTraitValidator.Provider.html new file mode 100644 index 00000000000..87fb38dd3e6 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/MissingPaginatedTraitValidator.Provider.html @@ -0,0 +1,303 @@ + + + + + +MissingPaginatedTraitValidator.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.linters
    +

    Class MissingPaginatedTraitValidator.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/MissingPaginatedTraitValidator.html b/javadoc/1.47.0/software/amazon/smithy/linters/MissingPaginatedTraitValidator.html new file mode 100644 index 00000000000..91182b5ab13 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/MissingPaginatedTraitValidator.html @@ -0,0 +1,350 @@ + + + + + +MissingPaginatedTraitValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.linters
    +

    Class MissingPaginatedTraitValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class MissingPaginatedTraitValidator
+extends AbstractValidator
      +
      Checks if an operation should be paginated but is not. + +
        +
      1. Skip operations that are paginated
        2. +
      2. Emit if an operation verb matches one of the + verbsRequirePagination values
        3. +
      3. Emit if an operation input member name matches one of the + inputMembersRequirePagination values
        4. +
      4. Emit if an operation output member name matches one of the + outputMembersRequirePagination values
        5. +
      5. Skip if the operation has no output
        6. +
      6. Emit if the operation verb matches one of the + verbsSuggestPagination and there's a top-level output + member that targets a list.
        7. +
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/MissingSensitiveTraitValidator.Config.html b/javadoc/1.47.0/software/amazon/smithy/linters/MissingSensitiveTraitValidator.Config.html new file mode 100644 index 00000000000..286323d1045 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/MissingSensitiveTraitValidator.Config.html @@ -0,0 +1,351 @@ + + + + + +MissingSensitiveTraitValidator.Config (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.linters
    +

    Class MissingSensitiveTraitValidator.Config

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.linters.MissingSensitiveTraitValidator.Config
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      MissingSensitiveTraitValidator
      +
      +
      +
      public static final class MissingSensitiveTraitValidator.Config
+extends java.lang.Object
      +
      MissingSensitiveTrait configuration.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Config() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        booleangetExcludeDefaults() 
        java.util.List<java.lang.String>getTerms() 
        voidsetExcludeDefaults​(boolean excludeDefaults) 
        voidsetTerms​(java.util.List<java.lang.String> terms) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Config

          +
          public Config()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getTerms

          +
          public java.util.List<java.lang.String> getTerms()
          +
          • +
        + + + +
          +
        • +

          setTerms

          +
          public void setTerms​(java.util.List<java.lang.String> terms)
          +
          • +
        + + + +
          +
        • +

          getExcludeDefaults

          +
          public boolean getExcludeDefaults()
          +
          • +
        + + + +
          +
        • +

          setExcludeDefaults

          +
          public void setExcludeDefaults​(boolean excludeDefaults)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/MissingSensitiveTraitValidator.Provider.html b/javadoc/1.47.0/software/amazon/smithy/linters/MissingSensitiveTraitValidator.Provider.html new file mode 100644 index 00000000000..89eff810976 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/MissingSensitiveTraitValidator.Provider.html @@ -0,0 +1,303 @@ + + + + + +MissingSensitiveTraitValidator.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.linters
    +

    Class MissingSensitiveTraitValidator.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/MissingSensitiveTraitValidator.html b/javadoc/1.47.0/software/amazon/smithy/linters/MissingSensitiveTraitValidator.html new file mode 100644 index 00000000000..0092bbad592 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/MissingSensitiveTraitValidator.html @@ -0,0 +1,339 @@ + + + + + +MissingSensitiveTraitValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.linters
    +

    Class MissingSensitiveTraitValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class MissingSensitiveTraitValidator
+extends AbstractValidator
      +

      Validates that shapes and members that possibly contain sensitive data are marked with the sensitive trait.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Finds shapes without the sensitive trait that possibly contain sensitive data, + based on the shape/member name and the list of key words and phrases.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          list of violation events
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/NoninclusiveTermsValidator.Config.html b/javadoc/1.47.0/software/amazon/smithy/linters/NoninclusiveTermsValidator.Config.html new file mode 100644 index 00000000000..4005edf696f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/NoninclusiveTermsValidator.Config.html @@ -0,0 +1,351 @@ + + + + + +NoninclusiveTermsValidator.Config (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.linters
    +

    Class NoninclusiveTermsValidator.Config

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.linters.NoninclusiveTermsValidator.Config
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      NoninclusiveTermsValidator
      +
      +
      +
      public static final class NoninclusiveTermsValidator.Config
+extends java.lang.Object
      +
      NoninclusiveTermsValidator configuration.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Config() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        booleangetExcludeDefaults() 
        java.util.Map<java.lang.String,​java.util.List<java.lang.String>>getTerms() 
        voidsetExcludeDefaults​(boolean excludeDefaults) 
        voidsetTerms​(java.util.Map<java.lang.String,​java.util.List<java.lang.String>> terms) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Config

          +
          public Config()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getTerms

          +
          public java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getTerms()
          +
          • +
        + + + +
          +
        • +

          setTerms

          +
          public void setTerms​(java.util.Map<java.lang.String,​java.util.List<java.lang.String>> terms)
          +
          • +
        + + + +
          +
        • +

          getExcludeDefaults

          +
          public boolean getExcludeDefaults()
          +
          • +
        + + + +
          +
        • +

          setExcludeDefaults

          +
          public void setExcludeDefaults​(boolean excludeDefaults)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/NoninclusiveTermsValidator.Provider.html b/javadoc/1.47.0/software/amazon/smithy/linters/NoninclusiveTermsValidator.Provider.html new file mode 100644 index 00000000000..dd65894dec5 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/NoninclusiveTermsValidator.Provider.html @@ -0,0 +1,303 @@ + + + + + +NoninclusiveTermsValidator.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.linters
    +

    Class NoninclusiveTermsValidator.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/NoninclusiveTermsValidator.html b/javadoc/1.47.0/software/amazon/smithy/linters/NoninclusiveTermsValidator.html new file mode 100644 index 00000000000..8d8542a085c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/NoninclusiveTermsValidator.html @@ -0,0 +1,340 @@ + + + + + +NoninclusiveTermsValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.linters
    +

    Class NoninclusiveTermsValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class NoninclusiveTermsValidator
+extends AbstractValidator
      +

      Validates that all shape names and values do not contain non-inclusive terms.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Runs a full text scan on a given model and stores the resulting TextOccurrences objects. + + Namespaces are checked against a global set per model.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          a list of ValidationEvents found by the implementer of getValidationEvents per the + TextOccurrences provided by this traversal.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/RepeatedShapeNameValidator.Config.html b/javadoc/1.47.0/software/amazon/smithy/linters/RepeatedShapeNameValidator.Config.html new file mode 100644 index 00000000000..1eafc998089 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/RepeatedShapeNameValidator.Config.html @@ -0,0 +1,322 @@ + + + + + +RepeatedShapeNameValidator.Config (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.linters
    +

    Class RepeatedShapeNameValidator.Config

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.linters.RepeatedShapeNameValidator.Config
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      RepeatedShapeNameValidator
      +
      +
      +
      public static final class RepeatedShapeNameValidator.Config
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Config() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        booleangetExactMatch() 
        voidsetExactMatch​(boolean exactMatch) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Config

          +
          public Config()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getExactMatch

          +
          public boolean getExactMatch()
          +
          • +
        + + + +
          +
        • +

          setExactMatch

          +
          public void setExactMatch​(boolean exactMatch)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/RepeatedShapeNameValidator.Provider.html b/javadoc/1.47.0/software/amazon/smithy/linters/RepeatedShapeNameValidator.Provider.html new file mode 100644 index 00000000000..2a5d3bc9242 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/RepeatedShapeNameValidator.Provider.html @@ -0,0 +1,303 @@ + + + + + +RepeatedShapeNameValidator.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.linters
    +

    Class RepeatedShapeNameValidator.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/RepeatedShapeNameValidator.html b/javadoc/1.47.0/software/amazon/smithy/linters/RepeatedShapeNameValidator.html new file mode 100644 index 00000000000..059baf45118 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/RepeatedShapeNameValidator.html @@ -0,0 +1,337 @@ + + + + + +RepeatedShapeNameValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.linters
    +

    Class RepeatedShapeNameValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class RepeatedShapeNameValidator
+extends AbstractValidator
      +
      Validates that structure members and union member names do not + repeat their shape name as prefixes of their member or tag names.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/ReservedWordsValidator.Config.html b/javadoc/1.47.0/software/amazon/smithy/linters/ReservedWordsValidator.Config.html new file mode 100644 index 00000000000..6c130105d0a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/ReservedWordsValidator.Config.html @@ -0,0 +1,330 @@ + + + + + +ReservedWordsValidator.Config (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.linters
    +

    Class ReservedWordsValidator.Config

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.linters.ReservedWordsValidator.Config
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      ReservedWordsValidator
      +
      +
      +
      public static final class ReservedWordsValidator.Config
+extends java.lang.Object
      +
      ReservedWords validator configuration.
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/ReservedWordsValidator.Provider.html b/javadoc/1.47.0/software/amazon/smithy/linters/ReservedWordsValidator.Provider.html new file mode 100644 index 00000000000..ced1a4a4dab --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/ReservedWordsValidator.Provider.html @@ -0,0 +1,303 @@ + + + + + +ReservedWordsValidator.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.linters
    +

    Class ReservedWordsValidator.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/ReservedWordsValidator.ReservedWords.html b/javadoc/1.47.0/software/amazon/smithy/linters/ReservedWordsValidator.ReservedWords.html new file mode 100644 index 00000000000..163f5e0c63b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/ReservedWordsValidator.ReservedWords.html @@ -0,0 +1,382 @@ + + + + + +ReservedWordsValidator.ReservedWords (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.linters
    +

    Class ReservedWordsValidator.ReservedWords

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.linters.ReservedWordsValidator.ReservedWords
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      ReservedWordsValidator
      +
      +
      +
      public static final class ReservedWordsValidator.ReservedWords
+extends java.lang.Object
      +
      A single reserved words configuration.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        ReservedWords() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidsetReason​(java.lang.String reason) +
        Sets the reason for why the words are reserved.
        +
        voidsetSelector​(Selector selector) +
        Sets the selector to use for determining which shapes to validate.
        +
        voidsetTerms​(java.util.List<java.lang.String> terms) +
        Sets the list of reserved word terms to match based on word boundaries.
        +
        voidsetWords​(java.util.List<java.lang.String> words) +
        Sets the list of reserved word definitions.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          ReservedWords

          +
          public ReservedWords()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setWords

          +
          public void setWords​(java.util.List<java.lang.String> words)
          +
          Sets the list of reserved word definitions. + +

          Each word must be a valid word. The word cannot equal "*", and if present, + "*", must appear at the start or end of the word.

          +
          +
          Parameters:
          +
          words - Words to set.
          +
          +
          • +
        + + + +
          +
        • +

          setTerms

          +
          public void setTerms​(java.util.List<java.lang.String> terms)
          +
          Sets the list of reserved word terms to match based on word boundaries.
          +
          +
          Parameters:
          +
          terms - Terms to set.
          +
          +
          • +
        + + + +
          +
        • +

          setSelector

          +
          public void setSelector​(Selector selector)
          +
          Sets the selector to use for determining which shapes to validate.
          +
          +
          Parameters:
          +
          selector - Selector to set.
          +
          +
          • +
        + + + +
          +
        • +

          setReason

          +
          public void setReason​(java.lang.String reason)
          +
          Sets the reason for why the words are reserved.
          +
          +
          Parameters:
          +
          reason - Reason to set.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/ReservedWordsValidator.html b/javadoc/1.47.0/software/amazon/smithy/linters/ReservedWordsValidator.html new file mode 100644 index 00000000000..182cbb8eab5 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/ReservedWordsValidator.html @@ -0,0 +1,364 @@ + + + + + +ReservedWordsValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.linters
    +

    Class ReservedWordsValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class ReservedWordsValidator
+extends AbstractValidator
      +
      Emits validation events for a configuration of reserved words. + +

      This validator accepts the following optional configuration options: + +

        +
      • reserved: ([object]) A list of reserved word configuration + objects as follows: +
          +
        • words: ([string]) A list of words that are + case-insensitively reserved. Leading and trailing wildcards + ("*") are supported. +
        • terms: ([string]) A list of word boundary terms to test.
          • +
        • selector: (string) Specifies a selector for this + configuration. Defaults to validating all shapes, including + member names. +
        • reason: (string) A reason to display for why this set of + words is reserved. +
        +
        • +
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/ShouldHaveUsedTimestampValidator.Config.html b/javadoc/1.47.0/software/amazon/smithy/linters/ShouldHaveUsedTimestampValidator.Config.html new file mode 100644 index 00000000000..52ba3ec4203 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/ShouldHaveUsedTimestampValidator.Config.html @@ -0,0 +1,331 @@ + + + + + +ShouldHaveUsedTimestampValidator.Config (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.linters
    +

    Class ShouldHaveUsedTimestampValidator.Config

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.linters.ShouldHaveUsedTimestampValidator.Config
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Config() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.util.List<java.util.regex.Pattern>getAdditionalPatterns() 
        voidsetAdditionalPatterns​(java.util.List<java.util.regex.Pattern> additionalPatterns) +
        Sets a list of additional regular expression patterns that indicate a + value carries a timestamp.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Config

          +
          public Config()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setAdditionalPatterns

          +
          public void setAdditionalPatterns​(java.util.List<java.util.regex.Pattern> additionalPatterns)
          +
          Sets a list of additional regular expression patterns that indicate a + value carries a timestamp.
          +
          +
          Parameters:
          +
          additionalPatterns - Additional patterns to add.
          +
          +
          • +
        + + + +
          +
        • +

          getAdditionalPatterns

          +
          public java.util.List<java.util.regex.Pattern> getAdditionalPatterns()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/ShouldHaveUsedTimestampValidator.Provider.html b/javadoc/1.47.0/software/amazon/smithy/linters/ShouldHaveUsedTimestampValidator.Provider.html new file mode 100644 index 00000000000..bbc7ac07081 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/ShouldHaveUsedTimestampValidator.Provider.html @@ -0,0 +1,303 @@ + + + + + +ShouldHaveUsedTimestampValidator.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.linters
    +

    Class ShouldHaveUsedTimestampValidator.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/ShouldHaveUsedTimestampValidator.html b/javadoc/1.47.0/software/amazon/smithy/linters/ShouldHaveUsedTimestampValidator.html new file mode 100644 index 00000000000..70266889117 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/ShouldHaveUsedTimestampValidator.html @@ -0,0 +1,357 @@ + + + + + +ShouldHaveUsedTimestampValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.linters
    +

    Class ShouldHaveUsedTimestampValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class ShouldHaveUsedTimestampValidator
+extends AbstractValidator
      +

      Validates that shapes that have names that appear to be time values are + actually modeled with a timestamp shape. + +

      This validator will check the name of string, integer, float, and long + shapes to see if they should have been TimestampShape. + It also scans structure members and union members. It uses the member name + and ensures the member targets a timestamp shape. + +

      When considering if a name indicates a possible timestamp, the name must + have one of the following qualities: + +

        +
      • Contains the string "timestamp"
        • +
      • Begins or Ends with the word "time"
        • +
      • Begins or Ends with the word "date"
        • +
      • Ends with the word "at"
        • +
      • Ends with the word "on"
        • +
      + +

      When checking for one of the above words, the first character may be + upper or lower-cased. Words a separated by underscores or a pair of + lower-then-upper-cased characters, i.e. wordWord.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/StandardOperationVerbValidator.Config.html b/javadoc/1.47.0/software/amazon/smithy/linters/StandardOperationVerbValidator.Config.html new file mode 100644 index 00000000000..e0e458e9ef7 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/StandardOperationVerbValidator.Config.html @@ -0,0 +1,400 @@ + + + + + +StandardOperationVerbValidator.Config (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.linters
    +

    Class StandardOperationVerbValidator.Config

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.linters.StandardOperationVerbValidator.Config
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      StandardOperationVerbValidator
      +
      +
      +
      public static final class StandardOperationVerbValidator.Config
+extends java.lang.Object
      +
      StandardOperationVerb configuration settings.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Config() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.util.List<java.lang.String>getPrefixes() 
        java.util.Map<java.lang.String,​java.util.List<java.lang.String>>getSuggestAlternatives() 
        java.util.List<java.lang.String>getVerbs() 
        voidsetPrefixes​(java.util.List<java.lang.String> prefixes) +
        Sets the list of acceptable verb prefixed (e.g., Batch).
        +
        voidsetSuggestAlternatives​(java.util.Map<java.lang.String,​java.util.List<java.lang.String>> suggestAlternatives) +
        Sets a map of invalid verbs to suggested alternatives.
        +
        voidsetVerbs​(java.util.List<java.lang.String> verbs) +
        Sets the list of standard operation verbs.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Config

          +
          public Config()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getVerbs

          +
          public java.util.List<java.lang.String> getVerbs()
          +
          • +
        + + + +
          +
        • +

          setVerbs

          +
          public void setVerbs​(java.util.List<java.lang.String> verbs)
          +
          Sets the list of standard operation verbs.
          +
          +
          Parameters:
          +
          verbs - Verbs to allow.
          +
          +
          • +
        + + + +
          +
        • +

          getPrefixes

          +
          public java.util.List<java.lang.String> getPrefixes()
          +
          • +
        + + + +
          +
        • +

          setPrefixes

          +
          public void setPrefixes​(java.util.List<java.lang.String> prefixes)
          +
          Sets the list of acceptable verb prefixed (e.g., Batch).
          +
          +
          Parameters:
          +
          prefixes - The list of verb prefixes.
          +
          +
          • +
        + + + +
          +
        • +

          getSuggestAlternatives

          +
          public java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getSuggestAlternatives()
          +
          • +
        + + + +
          +
        • +

          setSuggestAlternatives

          +
          public void setSuggestAlternatives​(java.util.Map<java.lang.String,​java.util.List<java.lang.String>> suggestAlternatives)
          +
          Sets a map of invalid verbs to suggested alternatives.
          +
          +
          Parameters:
          +
          suggestAlternatives - Alternative verb suggestions.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/StandardOperationVerbValidator.Provider.html b/javadoc/1.47.0/software/amazon/smithy/linters/StandardOperationVerbValidator.Provider.html new file mode 100644 index 00000000000..476852060bd --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/StandardOperationVerbValidator.Provider.html @@ -0,0 +1,303 @@ + + + + + +StandardOperationVerbValidator.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.linters
    +

    Class StandardOperationVerbValidator.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/StandardOperationVerbValidator.html b/javadoc/1.47.0/software/amazon/smithy/linters/StandardOperationVerbValidator.html new file mode 100644 index 00000000000..0448636378c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/StandardOperationVerbValidator.html @@ -0,0 +1,345 @@ + + + + + +StandardOperationVerbValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.linters
    +

    Class StandardOperationVerbValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class StandardOperationVerbValidator
+extends AbstractValidator
      +

      Validates that operation shape names start with standard verbs. + +

      Looks at each operation shape name and determines if the first + word in the shape name is one of the pre-defined allowed verbs. + +

      If the verb is a key in the map of verbs that have recommended + alternatives, then the event that is emitted contains the list of + alternate verbs to use.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/StutteredShapeNameValidator.Provider.html b/javadoc/1.47.0/software/amazon/smithy/linters/StutteredShapeNameValidator.Provider.html new file mode 100644 index 00000000000..aa2e946caf4 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/StutteredShapeNameValidator.Provider.html @@ -0,0 +1,303 @@ + + + + + +StutteredShapeNameValidator.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.linters
    +

    Class StutteredShapeNameValidator.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/StutteredShapeNameValidator.html b/javadoc/1.47.0/software/amazon/smithy/linters/StutteredShapeNameValidator.html new file mode 100644 index 00000000000..2b4063db224 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/StutteredShapeNameValidator.html @@ -0,0 +1,379 @@ + + + + + +StutteredShapeNameValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.linters
    +

    Class StutteredShapeNameValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      @Deprecated
+public final class StutteredShapeNameValidator
+extends AbstractValidator
      +
      Deprecated.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          StutteredShapeNameValidator

          +
          public StutteredShapeNameValidator()
          +
          Deprecated.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Deprecated.
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/linters/package-summary.html new file mode 100644 index 00000000000..43e61dae6a5 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/package-summary.html @@ -0,0 +1,359 @@ + + + + + +software.amazon.smithy.linters (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.linters

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/linters/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/linters/package-tree.html new file mode 100644 index 00000000000..30938112418 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/linters/package-tree.html @@ -0,0 +1,217 @@ + + + + + +software.amazon.smithy.linters Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.linters

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Enum Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/FromSourceLocation.html b/javadoc/1.47.0/software/amazon/smithy/model/FromSourceLocation.html new file mode 100644 index 00000000000..026633c93ba --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/FromSourceLocation.html @@ -0,0 +1,290 @@ + + + + + +FromSourceLocation (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model
    +

    Interface FromSourceLocation

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getSourceLocation

          +
          default SourceLocation getSourceLocation()
          +
          Gets the source location of a value.
          +
          +
          Returns:
          +
          Returns the source location of the value.
          +
          +
          • +
        + + + +
          +
        • +

          compare

          +
          static int compare​(FromSourceLocation s1,
+                   FromSourceLocation s2)
          +
          Compares two FromSourceLocations.
          +
          +
          Parameters:
          +
          s1 - the first FromSourceLocation to compare.
          +
          s2 - the second FromSourceLocation to compare.
          +
          Returns:
          +
          the value 0 if s1 == s2; a value less than 0 if s1 < s2; and a value greater than 0 if s1 > s2.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/Model.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/Model.Builder.html new file mode 100644 index 00000000000..7e6697ec4e4 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/Model.Builder.html @@ -0,0 +1,493 @@ + + + + + +Model.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model
    +

    Class Model.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.Model.Builder
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      SmithyBuilder<Model>
      +
      +
      +
      Enclosing class:
      +
      Model
      +
      +
      +
      public static final class Model.Builder
+extends java.lang.Object
+implements SmithyBuilder<Model>
      +
      Builder used to create a Model.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          metadata

          +
          public Model.Builder metadata​(java.util.Map<java.lang.String,​Node> metadata)
          +
          • +
        + + + +
          +
        • +

          putMetadataProperty

          +
          public Model.Builder putMetadataProperty​(java.lang.String key,
+                                         Node value)
          +
          • +
        + + + +
          +
        • +

          removeMetadataProperty

          +
          public Model.Builder removeMetadataProperty​(java.lang.String key)
          +
          • +
        + + + + + + + +
          +
        • +

          addShape

          +
          public Model.Builder addShape​(Shape shape)
          +
          Add a shape to the builder. + +

          MemberShape shapes are not added to the model directly. + They must be added by adding their containing shapes (e.g., to add a + list member, you must add the list shape that contains it). Any member + shape provided to any of the methods used to add shapes to the + model are ignored.

          +
          +
          Parameters:
          +
          shape - Shape to add.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          addShapes

          +
          public Model.Builder addShapes​(Model model)
          +
          Adds the shapes of another model to the builder.
          +
          +
          Parameters:
          +
          model - Model to add shapes from.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          addShapes

          +
          public <S extends Shape> Model.Builder addShapes​(java.util.Collection<S> shapes)
          +
          Adds a collection of shapes to the builder.
          +
          +
          Type Parameters:
          +
          S - Type of shape being added.
          +
          Parameters:
          +
          shapes - Collection of Shapes to add.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          addShapes

          +
          public Model.Builder addShapes​(Shape... shapes)
          +
          Adds a variadic list of shapes.
          +
          +
          Parameters:
          +
          shapes - Shapes to add.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          removeShape

          +
          public Model.Builder removeShape​(ShapeId shapeId)
          +
          Removes a shape from the builder by ID. + +

          Members of shapes are automatically removed when their + containing shape is removed.

          +
          +
          Parameters:
          +
          shapeId - Shape to remove.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          getCurrentShapes

          +
          public java.util.Map<ShapeId,​Shape> getCurrentShapes()
          +
          Gets an immutable view of the current shapes in the builder. + +

          The returned view may not be updated as shapes are added to the builder.

          +
          +
          Returns:
          +
          Returns the current shapes in the builder.
          +
          +
          • +
        + + + +
          +
        • +

          build

          +
          public Model build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Specified by:
          +
          build in interface SmithyBuilder<Model>
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/Model.html b/javadoc/1.47.0/software/amazon/smithy/model/Model.html new file mode 100644 index 00000000000..f75313fe772 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/Model.html @@ -0,0 +1,1956 @@ + + + + + +Model (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model
    +

    Class Model

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.Model
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ToSmithyBuilder<Model>
      +
      +
      +
      public final class Model
+extends java.lang.Object
+implements ToSmithyBuilder<Model>
      +
      A Smithy model that contains shapes, traits, metadata, and various + computed information used to interpret the model.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          MODEL_VERSION

          +
          public static final java.lang.String MODEL_VERSION
          +
          Specifies the highest supported version of the IDL.
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          builder

          +
          public static Model.Builder builder()
          +
          Builds an explicitly configured Smithy model. + +

          Note that the builder does not validate the correctness of the + model. Use the assembler() method to build and + validate a model.

          +
          +
          Returns:
          +
          Returns a model builder.
          +
          See Also:
          +
          assembler()
          +
          +
          • +
        + + + +
          +
        • +

          assembler

          +
          public static ModelAssembler assembler()
          +
          Assembles and validates a Smithy model from files, nodes, and other + disparate sources.
          +
          +
          Returns:
          +
          Returns a model assembler.
          +
          +
          • +
        + + + +
          +
        • +

          assembler

          +
          public static ModelAssembler assembler​(java.lang.ClassLoader classLoader)
          +
          Creates a ModelAssembler that is configured to discover traits, + validators, and built-in validators using the given + ClassLoader.
          +
          +
          Parameters:
          +
          classLoader - Class loader used to discover services.
          +
          Returns:
          +
          Returns a model assembler.
          +
          +
          • +
        + + + +
          +
        • +

          getMetadataProperty

          +
          public java.util.Optional<Node> getMetadataProperty​(java.lang.String name)
          +
          Gets a metadata property by namespace and name.
          +
          +
          Parameters:
          +
          name - Name of the property to retrieve.
          +
          Returns:
          +
          Returns the optional property.
          +
          +
          • +
        + + + +
          +
        • +

          getMetadata

          +
          public java.util.Map<java.lang.String,​Node> getMetadata()
          +
          +
          Returns:
          +
          Gets the unmodifiable metadata of the model across all + namespaces.
          +
          +
          • +
        + + + +
          +
        • +

          getTraitDefinition

          +
          public java.util.Optional<TraitDefinition> getTraitDefinition​(ToShapeId traitId)
          +
          Gets the trait definition of a specific trait shape ID.
          +
          +
          Parameters:
          +
          traitId - ID of the shape to get the trait definition of.
          +
          Returns:
          +
          Returns the optionally found trait definition.
          +
          +
          • +
        + + + +
          +
        • +

          getShapesWithTrait

          +
          public java.util.Set<Shape> getShapesWithTrait​(ToShapeId trait)
          +
          Gets a set of shapes in the model marked with a specific trait.
          +
          +
          Parameters:
          +
          trait - Trait shape ID to look for on shapes.
          +
          Returns:
          +
          Returns the immutable set of matching shapes.
          +
          +
          • +
        + + + +
          +
        • +

          getShapeIds

          +
          public java.util.Set<ShapeId> getShapeIds()
          +
          Gets the immutable set of ShapeId in the model.
          +
          +
          Returns:
          +
          Returns the shape IDs.
          +
          +
          • +
        + + + +
          +
        • +

          getShapesWithTrait

          +
          public java.util.Set<Shape> getShapesWithTrait​(java.lang.Class<? extends Trait> trait)
          +
          Gets a set of shapes in the model marked with a specific trait. + +

          The result is an exact match on trait classes and does not utilize + any kind of polymorphic instance of checks.

          +
          +
          Parameters:
          +
          trait - Trait class to look for on shapes.
          +
          Returns:
          +
          Returns the immutable set of matching shapes.
          +
          +
          • +
        + + + +
          +
        • +

          getBigDecimalShapes

          +
          public java.util.Set<BigDecimalShape> getBigDecimalShapes()
          +
          Gets an immutable set of all bigDecimals in the Model.
          +
          +
          Returns:
          +
          Returns the Set of bigDecimalss.
          +
          +
          • +
        + + + +
          +
        • +

          getBigDecimalShapesWithTrait

          +
          public java.util.Set<BigDecimalShape> getBigDecimalShapesWithTrait​(java.lang.Class<? extends Trait> trait)
          +
          Gets an immutable set of all bigDecimals in the Model that have a specific trait.
          +
          +
          Parameters:
          +
          trait - The exact trait class to look for on shapes.
          +
          Returns:
          +
          Returns the set of bigdecimals that have a specific trait.
          +
          +
          • +
        + + + +
          +
        • +

          getBigIntegerShapes

          +
          public java.util.Set<BigIntegerShape> getBigIntegerShapes()
          +
          Gets an immutable set of all bigIntegers in the Model.
          +
          +
          Returns:
          +
          Returns the Set of bigIntegerss.
          +
          +
          • +
        + + + +
          +
        • +

          getBigIntegerShapesWithTrait

          +
          public java.util.Set<BigIntegerShape> getBigIntegerShapesWithTrait​(java.lang.Class<? extends Trait> trait)
          +
          Gets an immutable set of all bigIntegers in the Model that have a specific trait.
          +
          +
          Parameters:
          +
          trait - The exact trait class to look for on shapes.
          +
          Returns:
          +
          Returns the set of bigIntegerss that have a specific trait.
          +
          +
          • +
        + + + +
          +
        • +

          getBlobShapes

          +
          public java.util.Set<BlobShape> getBlobShapes()
          +
          Gets an immutable set of all blobs in the Model.
          +
          +
          Returns:
          +
          Returns the Set of blobs.
          +
          +
          • +
        + + + +
          +
        • +

          getBlobShapesWithTrait

          +
          public java.util.Set<BlobShape> getBlobShapesWithTrait​(java.lang.Class<? extends Trait> trait)
          +
          Gets an immutable set of all blobs in the Model that have a specific trait.
          +
          +
          Parameters:
          +
          trait - The exact trait class to look for on shapes.
          +
          Returns:
          +
          Returns the set of blobs that have a specific trait.
          +
          +
          • +
        + + + +
          +
        • +

          getBooleanShapes

          +
          public java.util.Set<BooleanShape> getBooleanShapes()
          +
          Gets an immutable set of all booleans in the Model.
          +
          +
          Returns:
          +
          Returns the Set of booleans.
          +
          +
          • +
        + + + +
          +
        • +

          getBooleanShapesWithTrait

          +
          public java.util.Set<BooleanShape> getBooleanShapesWithTrait​(java.lang.Class<? extends Trait> trait)
          +
          Gets an immutable set of all booleans in the Model that have a specific trait.
          +
          +
          Parameters:
          +
          trait - The exact trait class to look for on shapes.
          +
          Returns:
          +
          Returns the set of booleans that have a specific trait.
          +
          +
          • +
        + + + +
          +
        • +

          getByteShapes

          +
          public java.util.Set<ByteShape> getByteShapes()
          +
          Gets an immutable set of all bytes in the Model.
          +
          +
          Returns:
          +
          Returns the Set of bytes.
          +
          +
          • +
        + + + +
          +
        • +

          getByteShapesWithTrait

          +
          public java.util.Set<ByteShape> getByteShapesWithTrait​(java.lang.Class<? extends Trait> trait)
          +
          Gets an immutable set of all bytes in the Model that have a specific trait.
          +
          +
          Parameters:
          +
          trait - The exact trait class to look for on shapes.
          +
          Returns:
          +
          Returns the set of bytes that have a specific trait.
          +
          +
          • +
        + + + +
          +
        • +

          getDocumentShapes

          +
          public java.util.Set<DocumentShape> getDocumentShapes()
          +
          Gets an immutable set of all documents in the Model.
          +
          +
          Returns:
          +
          Returns the Set of documents.
          +
          +
          • +
        + + + +
          +
        • +

          getDocumentShapesWithTrait

          +
          public java.util.Set<DocumentShape> getDocumentShapesWithTrait​(java.lang.Class<? extends Trait> trait)
          +
          Gets an immutable set of all documents in the Model that have a specific trait.
          +
          +
          Parameters:
          +
          trait - The exact trait class to look for on shapes.
          +
          Returns:
          +
          Returns the set of documents that have a specific trait.
          +
          +
          • +
        + + + +
          +
        • +

          getDoubleShapes

          +
          public java.util.Set<DoubleShape> getDoubleShapes()
          +
          Gets an immutable set of all doubles in the Model.
          +
          +
          Returns:
          +
          Returns the Set of doubles.
          +
          +
          • +
        + + + +
          +
        • +

          getDoubleShapesWithTrait

          +
          public java.util.Set<DoubleShape> getDoubleShapesWithTrait​(java.lang.Class<? extends Trait> trait)
          +
          Gets an immutable set of all doubles in the Model that have a specific trait.
          +
          +
          Parameters:
          +
          trait - The exact trait class to look for on shapes.
          +
          Returns:
          +
          Returns the set of doubles that have a specific trait.
          +
          +
          • +
        + + + +
          +
        • +

          getFloatShapes

          +
          public java.util.Set<FloatShape> getFloatShapes()
          +
          Gets an immutable set of all floats in the Model.
          +
          +
          Returns:
          +
          Returns the Set of floats.
          +
          +
          • +
        + + + +
          +
        • +

          getFloatShapesWithTrait

          +
          public java.util.Set<FloatShape> getFloatShapesWithTrait​(java.lang.Class<? extends Trait> trait)
          +
          Gets an immutable set of all floats in the Model that have a specific trait.
          +
          +
          Parameters:
          +
          trait - The exact trait class to look for on shapes.
          +
          Returns:
          +
          Returns the set of floats that have a specific trait.
          +
          +
          • +
        + + + +
          +
        • +

          getIntegerShapes

          +
          public java.util.Set<IntegerShape> getIntegerShapes()
          +
          Gets an immutable set of all integers in the Model.
          +
          +
          Returns:
          +
          Returns the Set of integers.
          +
          +
          • +
        + + + +
          +
        • +

          getIntegerShapesWithTrait

          +
          public java.util.Set<IntegerShape> getIntegerShapesWithTrait​(java.lang.Class<? extends Trait> trait)
          +
          Gets an immutable set of all integers in the Model that have a specific trait.
          +
          +
          Parameters:
          +
          trait - The exact trait class to look for on shapes.
          +
          Returns:
          +
          Returns the set of integers that have a specific trait.
          +
          +
          • +
        + + + +
          +
        • +

          getIntEnumShapes

          +
          public java.util.Set<IntEnumShape> getIntEnumShapes()
          +
          Gets an immutable set of all intEnums in the Model.
          +
          +
          Returns:
          +
          Returns the Set of intEnums.
          +
          +
          • +
        + + + +
          +
        • +

          getIntEnumShapesWithTrait

          +
          public java.util.Set<IntEnumShape> getIntEnumShapesWithTrait​(java.lang.Class<? extends Trait> trait)
          +
          Gets an immutable set of all intEnums in the Model that have a specific trait.
          +
          +
          Parameters:
          +
          trait - The exact trait class to look for on shapes.
          +
          Returns:
          +
          Returns the set of intEnums that have a specific trait.
          +
          +
          • +
        + + + +
          +
        • +

          getListShapes

          +
          public java.util.Set<ListShape> getListShapes()
          +
          Gets an immutable set of all lists in the Model.
          +
          +
          Returns:
          +
          Returns the Set of lists.
          +
          +
          • +
        + + + +
          +
        • +

          getListShapesWithTrait

          +
          public java.util.Set<ListShape> getListShapesWithTrait​(java.lang.Class<? extends Trait> trait)
          +
          Gets an immutable set of all lists in the Model that have a specific trait.
          +
          +
          Parameters:
          +
          trait - The exact trait class to look for on shapes.
          +
          Returns:
          +
          Returns the set of lists that have a specific trait.
          +
          +
          • +
        + + + +
          +
        • +

          getLongShapes

          +
          public java.util.Set<LongShape> getLongShapes()
          +
          Gets an immutable set of all longs in the Model.
          +
          +
          Returns:
          +
          Returns the Set of longs.
          +
          +
          • +
        + + + +
          +
        • +

          getLongShapesWithTrait

          +
          public java.util.Set<LongShape> getLongShapesWithTrait​(java.lang.Class<? extends Trait> trait)
          +
          Gets an immutable set of all longs in the Model that have a specific trait.
          +
          +
          Parameters:
          +
          trait - The exact trait class to look for on shapes.
          +
          Returns:
          +
          Returns the set of longs that have a specific trait.
          +
          +
          • +
        + + + +
          +
        • +

          getMapShapes

          +
          public java.util.Set<MapShape> getMapShapes()
          +
          Gets an immutable set of all maps in the Model.
          +
          +
          Returns:
          +
          Returns the Set of maps.
          +
          +
          • +
        + + + +
          +
        • +

          getMapShapesWithTrait

          +
          public java.util.Set<MapShape> getMapShapesWithTrait​(java.lang.Class<? extends Trait> trait)
          +
          Gets an immutable set of all maps in the Model that have a specific trait.
          +
          +
          Parameters:
          +
          trait - The exact trait class to look for on shapes.
          +
          Returns:
          +
          Returns the set of maps that have a specific trait.
          +
          +
          • +
        + + + +
          +
        • +

          getMemberShapes

          +
          public java.util.Set<MemberShape> getMemberShapes()
          +
          Gets an immutable set of all members in the Model.
          +
          +
          Returns:
          +
          Returns the Set of members.
          +
          +
          • +
        + + + +
          +
        • +

          getMemberShapesWithTrait

          +
          public java.util.Set<MemberShape> getMemberShapesWithTrait​(java.lang.Class<? extends Trait> trait)
          +
          Gets an immutable set of all members in the Model that have a specific trait.
          +
          +
          Parameters:
          +
          trait - The exact trait class to look for on shapes.
          +
          Returns:
          +
          Returns the set of members that have a specific trait.
          +
          +
          • +
        + + + +
          +
        • +

          getOperationShapes

          +
          public java.util.Set<OperationShape> getOperationShapes()
          +
          Gets an immutable set of all operations in the Model.
          +
          +
          Returns:
          +
          Returns the Set of operations.
          +
          +
          • +
        + + + +
          +
        • +

          getOperationShapesWithTrait

          +
          public java.util.Set<OperationShape> getOperationShapesWithTrait​(java.lang.Class<? extends Trait> trait)
          +
          Gets an immutable set of all operations in the Model that have a specific trait.
          +
          +
          Parameters:
          +
          trait - The exact trait class to look for on shapes.
          +
          Returns:
          +
          Returns the set of operations that have a specific trait.
          +
          +
          • +
        + + + +
          +
        • +

          getResourceShapes

          +
          public java.util.Set<ResourceShape> getResourceShapes()
          +
          Gets an immutable set of all resources in the Model.
          +
          +
          Returns:
          +
          Returns the Set of resources.
          +
          +
          • +
        + + + +
          +
        • +

          getResourceShapesWithTrait

          +
          public java.util.Set<ResourceShape> getResourceShapesWithTrait​(java.lang.Class<? extends Trait> trait)
          +
          Gets an immutable set of all resources in the Model that have a specific trait.
          +
          +
          Parameters:
          +
          trait - The exact trait class to look for on shapes.
          +
          Returns:
          +
          Returns the set of resources that have a specific trait.
          +
          +
          • +
        + + + +
          +
        • +

          getServiceShapes

          +
          public java.util.Set<ServiceShape> getServiceShapes()
          +
          Gets an immutable set of all services in the Model.
          +
          +
          Returns:
          +
          Returns the Set of services.
          +
          +
          • +
        + + + +
          +
        • +

          getServiceShapesWithTrait

          +
          public java.util.Set<ServiceShape> getServiceShapesWithTrait​(java.lang.Class<? extends Trait> trait)
          +
          Gets an immutable set of all services in the Model that have a specific trait.
          +
          +
          Parameters:
          +
          trait - The exact trait class to look for on shapes.
          +
          Returns:
          +
          Returns the set of services that have a specific trait.
          +
          +
          • +
        + + + +
          +
        • +

          getSetShapes

          +
          @Deprecated
+public java.util.Set<SetShape> getSetShapes()
          +
          Deprecated.
          +
          Gets an immutable set of all sets in the Model.
          +
          +
          Returns:
          +
          Returns the Set of sets.
          +
          +
          • +
        + + + +
          +
        • +

          getSetShapesWithTrait

          +
          @Deprecated
+public java.util.Set<SetShape> getSetShapesWithTrait​(java.lang.Class<? extends Trait> trait)
          +
          Deprecated.
          +
          Gets an immutable set of all sets in the Model that have a specific trait.
          +
          +
          Parameters:
          +
          trait - The exact trait class to look for on shapes.
          +
          Returns:
          +
          Returns the set of sets that have a specific trait.
          +
          +
          • +
        + + + +
          +
        • +

          getShortShapes

          +
          public java.util.Set<ShortShape> getShortShapes()
          +
          Gets an immutable set of all shorts in the Model.
          +
          +
          Returns:
          +
          Returns the Set of shorts.
          +
          +
          • +
        + + + +
          +
        • +

          getShortShapesWithTrait

          +
          public java.util.Set<ShortShape> getShortShapesWithTrait​(java.lang.Class<? extends Trait> trait)
          +
          Gets an immutable set of all shorts in the Model that have a specific trait.
          +
          +
          Parameters:
          +
          trait - The exact trait class to look for on shapes.
          +
          Returns:
          +
          Returns the set of shorts that have a specific trait.
          +
          +
          • +
        + + + +
          +
        • +

          getStringShapes

          +
          public java.util.Set<StringShape> getStringShapes()
          +
          Gets an immutable set of all strings in the Model.
          +
          +
          Returns:
          +
          Returns the Set of strings.
          +
          +
          • +
        + + + +
          +
        • +

          getStringShapesWithTrait

          +
          public java.util.Set<StringShape> getStringShapesWithTrait​(java.lang.Class<? extends Trait> trait)
          +
          Gets an immutable set of all strings in the Model that have a specific trait.
          +
          +
          Parameters:
          +
          trait - The exact trait class to look for on shapes.
          +
          Returns:
          +
          Returns the set of strings that have a specific trait.
          +
          +
          • +
        + + + +
          +
        • +

          getEnumShapes

          +
          public java.util.Set<EnumShape> getEnumShapes()
          +
          Gets an immutable set of all enums in the Model.
          +
          +
          Returns:
          +
          Returns the Set of enums.
          +
          +
          • +
        + + + +
          +
        • +

          getEnumShapesWithTrait

          +
          public java.util.Set<EnumShape> getEnumShapesWithTrait​(java.lang.Class<? extends Trait> trait)
          +
          Gets an immutable set of all enums in the Model that have a specific trait.
          +
          +
          Parameters:
          +
          trait - The exact trait class to look for on shapes.
          +
          Returns:
          +
          Returns the set of enums that have a specific trait.
          +
          +
          • +
        + + + +
          +
        • +

          getStructureShapes

          +
          public java.util.Set<StructureShape> getStructureShapes()
          +
          Gets an immutable set of all structures in the Model.
          +
          +
          Returns:
          +
          Returns the Set of structures.
          +
          +
          • +
        + + + +
          +
        • +

          getStructureShapesWithTrait

          +
          public java.util.Set<StructureShape> getStructureShapesWithTrait​(java.lang.Class<? extends Trait> trait)
          +
          Gets an immutable set of all structures in the Model that have a specific trait.
          +
          +
          Parameters:
          +
          trait - The exact trait class to look for on shapes.
          +
          Returns:
          +
          Returns the set of structures that have a specific trait.
          +
          +
          • +
        + + + +
          +
        • +

          getTimestampShapes

          +
          public java.util.Set<TimestampShape> getTimestampShapes()
          +
          Gets an immutable set of all timestamps in the Model.
          +
          +
          Returns:
          +
          Returns the Set of timestamps.
          +
          +
          • +
        + + + +
          +
        • +

          getTimestampShapesWithTrait

          +
          public java.util.Set<TimestampShape> getTimestampShapesWithTrait​(java.lang.Class<? extends Trait> trait)
          +
          Gets an immutable set of all timestamps in the Model that have a specific trait.
          +
          +
          Parameters:
          +
          trait - The exact trait class to look for on shapes.
          +
          Returns:
          +
          Returns the set of timestamps that have a specific trait.
          +
          +
          • +
        + + + +
          +
        • +

          getUnionShapes

          +
          public java.util.Set<UnionShape> getUnionShapes()
          +
          Gets an immutable set of all unions in the Model.
          +
          +
          Returns:
          +
          Returns the Set of unions.
          +
          +
          • +
        + + + +
          +
        • +

          getUnionShapesWithTrait

          +
          public java.util.Set<UnionShape> getUnionShapesWithTrait​(java.lang.Class<? extends Trait> trait)
          +
          Gets an immutable set of all unions in the Model that have a specific trait.
          +
          +
          Parameters:
          +
          trait - The exact trait class to look for on shapes.
          +
          Returns:
          +
          Returns the set of unions that have a specific trait.
          +
          +
          • +
        + + + +
          +
        • +

          getAppliedTraits

          +
          public java.util.Set<ShapeId> getAppliedTraits()
          +
          Gets a set of every trait shape ID that is used in the model.
          +
          +
          Returns:
          +
          Returns the shape IDs of traits used in the model.
          +
          +
          • +
        + + + +
          +
        • +

          isTraitApplied

          +
          public boolean isTraitApplied​(java.lang.Class<? extends Trait> trait)
          +
          Returns true if the given trait shape ID was used in the model.
          +
          +
          Parameters:
          +
          trait - The trait class to check.
          +
          Returns:
          +
          Returns true if the trait was used in the model.
          +
          +
          • +
        + + + +
          +
        • +

          getShape

          +
          public java.util.Optional<Shape> getShape​(ShapeId id)
          +
          Attempts to retrieve a Shape by ShapeId.
          +
          +
          Parameters:
          +
          id - Shape to retrieve by ID.
          +
          Returns:
          +
          Returns the optional shape.
          +
          +
          • +
        + + + +
          +
        • +

          expectShape

          +
          public Shape expectShape​(ShapeId id)
          +
          Attempts to retrieve a Shape by ShapeId and + throws if not found.
          +
          +
          Parameters:
          +
          id - Shape to retrieve by ID.
          +
          Returns:
          +
          Returns the shape.
          +
          Throws:
          +
          ExpectationNotMetException - if the shape is not found.
          +
          +
          • +
        + + + +
          +
        • +

          expectShape

          +
          public <T extends Shape> T expectShape​(ShapeId id,
+                                       java.lang.Class<T> type)
          +
          Attempts to retrieve a Shape by ShapeId and + throws if not found or if the shape is not of the expected type.
          +
          +
          Type Parameters:
          +
          T - Expected shape type.
          +
          Parameters:
          +
          id - Shape to retrieve by ID.
          +
          type - Shape type to expect and convert to.
          +
          Returns:
          +
          Returns the shape.
          +
          Throws:
          +
          ExpectationNotMetException - if the shape is not found or is not the expected type.
          +
          +
          • +
        + + + +
          +
        • +

          shapes

          +
          public java.util.stream.Stream<Shape> shapes()
          +
          Gets a stream of Shapes in the index.
          +
          +
          Returns:
          +
          Returns a stream of shapes.
          +
          +
          • +
        + + + +
          +
        • +

          shapes

          +
          public <T extends Shape> java.util.stream.Stream<T> shapes​(java.lang.Class<T> shapeType)
          +
          Gets a stream of shapes in the index of a specific type T. + +

          The provided shapeType class must exactly match the class of a + shape in the model in order to be returned from this method; + that is, the provided class must be a concrete subclass of + Shape and not an abstract class like NumberShape.

          +
          +
          Type Parameters:
          +
          T - Shape type to stream from the index.
          +
          Parameters:
          +
          shapeType - Shape type T to retrieve.
          +
          Returns:
          +
          A stream of shapes of T matching shapeType.
          +
          +
          • +
        + + + +
          +
        • +

          toSet

          +
          public <T extends Shape> java.util.Set<T> toSet​(java.lang.Class<T> shapeType)
          +
          Gets an immutable Set of shapes of a specific type.
          +
          +
          Type Parameters:
          +
          T - Shape type to get from the index.
          +
          Parameters:
          +
          shapeType - Type of shape to get a set of.
          +
          Returns:
          +
          Returns an unmodifiable set of shapes.
          +
          +
          • +
        + + + +
          +
        • +

          toSet

          +
          public java.util.Set<Shape> toSet()
          +
          Converts the model to an immutable Set of shapes.
          +
          +
          Returns:
          +
          Returns an unmodifiable set of shapes.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object other)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toBuilder

          +
          public Model.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<Model>
          +
          Returns:
          +
          a builder for type T
          +
          +
          • +
        + + + +
          +
        • +

          getKnowledge

          +
          @Deprecated
+public <T extends KnowledgeIndex> T getKnowledge​(java.lang.Class<T> type)
          +
          Deprecated.
          +
          This method is deprecated. Use the of method of the + KnowledgeIndex you wish to create instead.
          +
          +
          Type Parameters:
          +
          T - The type of knowledge index to retrieve.
          +
          Parameters:
          +
          type - Type of knowledge index to retrieve.
          +
          Returns:
          +
          Returns the computed knowledge index.
          +
          +
          • +
        + + + +
          +
        • +

          getKnowledge

          +
          public <T extends KnowledgeIndex> T getKnowledge​(java.lang.Class<T> type,
+                                                 java.util.function.Function<Model,​T> constructor)
          +
          Gets a computed "knowledge index" of a specific type for the model + and caches it for subsequent retrieval. + +

          This method should not typically be called directly because + KnowledgeIndex classes should all provide a public static of + method that accepts a Model and returns an instance of the + index by invoking getKnowledge. + +

          If a KnowledgeIndex of the given type has not yet been + computed, one will be created using the provided constructor + function that accepts a Model. Computed knowledge indexes are + cached and returned on subsequent retrievals.

          +
          +
          Type Parameters:
          +
          T - The type of knowledge index to retrieve.
          +
          Parameters:
          +
          type - Type of knowledge index to retrieve.
          +
          constructor - The method used to create type.
          +
          Returns:
          +
          Returns the computed knowledge index.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/SourceException.html b/javadoc/1.47.0/software/amazon/smithy/model/SourceException.html new file mode 100644 index 00000000000..0a20e412474 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/SourceException.html @@ -0,0 +1,392 @@ + + + + + +SourceException (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model
    +

    Class SourceException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Throwable
        • +
      • +
          +
        • java.lang.Exception
          • +
        • +
            +
          • java.lang.RuntimeException
            • +
          • +
              +
            • software.amazon.smithy.model.SourceException
              • +
            +
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.lang.StringgetMessageWithoutLocation() +
        Retrieves the message for this exception without the appended source + location.
        +
        SourceLocationgetSourceLocation() +
        Gets the source location of a value.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          SourceException

          +
          public SourceException​(java.lang.String message,
+                       FromSourceLocation sourceLocation,
+                       java.lang.Throwable cause)
          +
          • +
        + + + +
          +
        • +

          SourceException

          +
          public SourceException​(java.lang.String message,
+                       FromSourceLocation sourceLocation)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getMessageWithoutLocation

          +
          public java.lang.String getMessageWithoutLocation()
          +
          Retrieves the message for this exception without the appended source + location.
          +
          +
          Returns:
          +
          The trimmed message.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/SourceLocation.html b/javadoc/1.47.0/software/amazon/smithy/model/SourceLocation.html new file mode 100644 index 00000000000..70b357d309c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/SourceLocation.html @@ -0,0 +1,526 @@ + + + + + +SourceLocation (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model
    +

    Class SourceLocation

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.SourceLocation
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          SourceLocation

          +
          public SourceLocation​(java.lang.String filename,
+                      int line,
+                      int column)
          +
          • +
        + + + +
          +
        • +

          SourceLocation

          +
          public SourceLocation​(java.lang.String filename)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          none

          +
          public static SourceLocation none()
          +
          Creates an empty source location.
          +
          +
          Returns:
          +
          Returns the empty location.
          +
          +
          • +
        + + + +
          +
        • +

          getFilename

          +
          public java.lang.String getFilename()
          +
          +
          Returns:
          +
          Returns the source location filename.
          +
          +
          • +
        + + + +
          +
        • +

          getLine

          +
          public int getLine()
          +
          +
          Returns:
          +
          Returns the line number from which the component originated.
          +
          +
          • +
        + + + +
          +
        • +

          getColumn

          +
          public int getColumn()
          +
          +
          Returns:
          +
          Returns the column from which the component originated.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object other)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          compareTo

          +
          public int compareTo​(SourceLocation o)
          +
          +
          Specified by:
          +
          compareTo in interface java.lang.Comparable<SourceLocation>
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/knowledge/BottomUpIndex.html b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/BottomUpIndex.html new file mode 100644 index 00000000000..355cf023ec9 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/BottomUpIndex.html @@ -0,0 +1,397 @@ + + + + + +BottomUpIndex (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.knowledge
    +

    Class BottomUpIndex

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.knowledge.BottomUpIndex
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      KnowledgeIndex
      +
      +
      +
      public final class BottomUpIndex
+extends java.lang.Object
+implements KnowledgeIndex
      +
      Computes all of the parent shapes of resources and operations from the bottom-up.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          BottomUpIndex

          +
          public BottomUpIndex​(Model model)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getAllParents

          +
          public java.util.List<EntityShape> getAllParents​(ToShapeId service,
+                                                 ToShapeId operationOrResource)
          +
          Gets all of the parents of an operation or resource within a service. + +

          The returned list contains each EntityShape parent (a resource or + service shape). The first element in the list is the direct parent of the + resource/operation, followed by that resource's parent, until finally the last + element in the list is always a ServiceShape.

          +
          +
          Parameters:
          +
          service - Service to query.
          +
          operationOrResource - The operation or resource for which to find the parents.
          +
          Returns:
          +
          Returns the parents of the resource.
          +
          +
          • +
        + + + +
          +
        • +

          getEntityBinding

          +
          public java.util.Optional<EntityShape> getEntityBinding​(ToShapeId service,
+                                                        ToShapeId operationOrResource)
          +
          Gets the direct parent of an operation or resource.
          +
          +
          Parameters:
          +
          service - Service closure to query.
          +
          operationOrResource - The operation or resource to query.
          +
          Returns:
          +
          Returns the optionally found parent, a resource or service shape.
          +
          +
          • +
        + + + +
          +
        • +

          getResourceBinding

          +
          public java.util.Optional<ResourceShape> getResourceBinding​(ToShapeId service,
+                                                            ToShapeId operationOrResource)
          +
          Gets the direct parent resource of an operation or resource if and only if + the given resource or operation is bound to a resource and not bound to a + service.
          +
          +
          Parameters:
          +
          service - Service closure to query.
          +
          operationOrResource - The operation or resource to query.
          +
          Returns:
          +
          Returns the optionally found parent resource.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/knowledge/BoxIndex.html b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/BoxIndex.html new file mode 100644 index 00000000000..bdd07ad1d61 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/BoxIndex.html @@ -0,0 +1,366 @@ + + + + + +BoxIndex (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.knowledge
    +

    Class BoxIndex

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      KnowledgeIndex
      +
      +
      +
      @Deprecated
+public final class BoxIndex
+extends NullableIndex
      +
      Deprecated.
      +
      An index that checks if a shape can be set to null. + +

      This index is deprecated in favor of NullableIndex.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          BoxIndex

          +
          public BoxIndex​(Model model)
          +
          Deprecated.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          of

          +
          public static BoxIndex of​(Model model)
          +
          Deprecated.
          +
          • +
        + + + +
          +
        • +

          isBoxed

          +
          @Deprecated
+public boolean isBoxed​(ToShapeId shape)
          +
          Deprecated.
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/knowledge/EventStreamIndex.html b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/EventStreamIndex.html new file mode 100644 index 00000000000..991b568ce6a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/EventStreamIndex.html @@ -0,0 +1,371 @@ + + + + + +EventStreamIndex (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.knowledge
    +

    Class EventStreamIndex

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.knowledge.EventStreamIndex
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      KnowledgeIndex
      +
      +
      +
      public final class EventStreamIndex
+extends java.lang.Object
+implements KnowledgeIndex
      +
      Index of operation shapes to event stream information. + +

      This knowledge index provides information about event streams in + operations, including the input/output member that contains an + event stream, the shape targeted by this member, and any additional + input/output members that form the initial message.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          EventStreamIndex

          +
          public EventStreamIndex​(Model model)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getInputInfo

          +
          public java.util.Optional<EventStreamInfo> getInputInfo​(ToShapeId operationShape)
          +
          Get event stream information for the input of an operation. + +

          No result is returned if the provided operation shape does not + exist, if the targeted shape is not an operation, if the operation + does not contain an input structure or if the input structure does + not contain an input event stream.

          +
          +
          Parameters:
          +
          operationShape - Operation or shape ID to retrieve information for.
          +
          Returns:
          +
          Returns the optionally found input event stream information.
          +
          +
          • +
        + + + +
          +
        • +

          getOutputInfo

          +
          public java.util.Optional<EventStreamInfo> getOutputInfo​(ToShapeId operationShape)
          +
          Get event stream information for the output of an operation. + +

          No result is returned if the provided operation shape does not + exist, if the targeted shape is not an operation, if the operation + does not contain an output structure or if the output structure does + not contain an output event stream.

          +
          +
          Parameters:
          +
          operationShape - Operation or shape ID to retrieve information for.
          +
          Returns:
          +
          Returns the optionally found output event stream information.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/knowledge/EventStreamInfo.html b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/EventStreamInfo.html new file mode 100644 index 00000000000..be71d24a8dc --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/EventStreamInfo.html @@ -0,0 +1,520 @@ + + + + + +EventStreamInfo (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.knowledge
    +

    Class EventStreamInfo

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.knowledge.EventStreamInfo
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class EventStreamInfo
+extends java.lang.Object
      +
      Contains extracted event stream information.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        booleanequals​(java.lang.Object o) 
        java.util.Map<java.lang.String,​StructureShape>getEvents() +
        Gets all of the event stream events of the event stream.
        +
        MemberShapegetEventStreamMember() +
        Gets the top-level input or output member that targets the + event stream.
        +
        ShapegetEventStreamTarget() +
        Gets the shape that is streamed over the event stream.
        +
        java.util.Map<java.lang.String,​MemberShape>getInitialMessageMembers() +
        Gets the initial message members that form the initial-request + or initial-response of the event stream.
        +
        java.util.Map<java.lang.String,​Shape>getInitialMessageTargets() +
        Gets the shapes targeted by the initial message members that are + not the target of an event stream.
        +
        OperationShapegetOperation() +
        Gets the operation associated with this data.
        +
        StreamingTraitgetStreamingTrait() +
        Gets the event stream trait.
        +
        StructureShapegetStructure() +
        Gets the input or output structure of the data.
        +
        inthashCode() 
        booleanhasInitialMessage() +
        Returns true if the event stream has an initial-message, meaning + there are top-level members of the input or output of the operation + that are not the event stream member.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getOperation

          +
          public OperationShape getOperation()
          +
          Gets the operation associated with this data.
          +
          +
          Returns:
          +
          Returns the associated operation.
          +
          +
          • +
        + + + +
          +
        • +

          getStreamingTrait

          +
          public StreamingTrait getStreamingTrait()
          +
          Gets the event stream trait.
          +
          +
          Returns:
          +
          Returns the event stream trait.
          +
          +
          • +
        + + + +
          +
        • +

          getStructure

          +
          public StructureShape getStructure()
          +
          Gets the input or output structure of the data.
          +
          +
          Returns:
          +
          Returns the structure.
          +
          +
          • +
        + + + +
          +
        • +

          getEventStreamMember

          +
          public MemberShape getEventStreamMember()
          +
          Gets the top-level input or output member that targets the + event stream.
          +
          +
          Returns:
          +
          Returns the member.
          +
          +
          • +
        + + + +
          +
        • +

          getEventStreamTarget

          +
          public Shape getEventStreamTarget()
          +
          Gets the shape that is streamed over the event stream. + +

          If the target shape is a structure, then the event stream + is a single-event event stream that streams events of a single + shape. If the target shape is a union, then the event stream is + a multi-event event stream that streams one or more named events + of various structure shapes.

          +
          +
          Returns:
          +
          Returns a structure or union shape.
          +
          +
          • +
        + + + +
          +
        • +

          getInitialMessageMembers

          +
          public java.util.Map<java.lang.String,​MemberShape> getInitialMessageMembers()
          +
          Gets the initial message members that form the initial-request + or initial-response of the event stream. + +

          The initial message members are the members of the input or + output of an operation that are not the target of an event stream. + +

          The returned map is a map of member names to + MemberShapes. Use getInitialMessageTargets() to get + a mapping of member names to the shapes targeted by a member. + + 

          
+ EventStreamIndex index = EventStreamIndex.of(model);
+ EventStreamInfo info = index.getInputInfo(myShapeId);
+
+ for (MemberShape member : info.getInitialMessageMembers()) {
+     System.out.println("Initial message member: " + member);
+ }
+
          +
          +
          Returns:
          +
          Returns the initial event members (if any).
          +
          +
          • +
        + + + +
          +
        • +

          getInitialMessageTargets

          +
          public java.util.Map<java.lang.String,​Shape> getInitialMessageTargets()
          +
          Gets the shapes targeted by the initial message members that are + not the target of an event stream. + +

          The returned map contains the same information as + getInitialMessageMembers() except each value is the shape + targeted by the member.

          +
          +
          Returns:
          +
          Returns the shapes targeted by the initial message members.
          +
          See Also:
          +
          getInitialMessageMembers()
          +
          +
          • +
        + + + +
          +
        • +

          hasInitialMessage

          +
          public boolean hasInitialMessage()
          +
          Returns true if the event stream has an initial-message, meaning + there are top-level members of the input or output of the operation + that are not the event stream member.
          +
          +
          Returns:
          +
          Returns true if there is an initial message.
          +
          +
          • +
        + + + +
          +
        • +

          getEvents

          +
          public java.util.Map<java.lang.String,​StructureShape> getEvents()
          +
          Gets all of the event stream events of the event stream. + +

          The returned map is a mapping of the event name to the event. + For multi-event event streams, the name of hte event is the member + name of the multi-event union. For single-event event streams, + the name of the event is the name of the input or output structure + member referenced by the event stream trait.

          +
          +
          Returns:
          +
          Returns a map of event stream events.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/knowledge/HttpBinding.Location.html b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/HttpBinding.Location.html new file mode 100644 index 00000000000..2af3a0527ba --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/HttpBinding.Location.html @@ -0,0 +1,472 @@ + + + + + +HttpBinding.Location (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.knowledge
    +

    Enum HttpBinding.Location

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Enum<HttpBinding.Location>
        • +
      • +
          +
        • software.amazon.smithy.model.knowledge.HttpBinding.Location
          • +
        +
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static HttpBinding.LocationvalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static HttpBinding.Location[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static HttpBinding.Location[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (HttpBinding.Location c : HttpBinding.Location.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static HttpBinding.Location valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/knowledge/HttpBinding.html b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/HttpBinding.html new file mode 100644 index 00000000000..9c6a6eca9f5 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/HttpBinding.html @@ -0,0 +1,400 @@ + + + + + +HttpBinding (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.knowledge
    +

    Class HttpBinding

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.knowledge.HttpBinding
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class HttpBinding
+extends java.lang.Object
      +
      Defines an HTTP message member binding.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getMemberName

          +
          public java.lang.String getMemberName()
          +
          • +
        + + + + + + + +
          +
        • +

          getLocationName

          +
          public java.lang.String getLocationName()
          +
          • +
        + + + +
          +
        • +

          getBindingTrait

          +
          public java.util.Optional<Trait> getBindingTrait()
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object other)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/knowledge/HttpBindingIndex.html b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/HttpBindingIndex.html new file mode 100644 index 00000000000..1ba494c58c3 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/HttpBindingIndex.html @@ -0,0 +1,738 @@ + + + + + +HttpBindingIndex (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.knowledge
    +

    Class HttpBindingIndex

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.knowledge.HttpBindingIndex
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      KnowledgeIndex
      +
      +
      +
      public final class HttpBindingIndex
+extends java.lang.Object
+implements KnowledgeIndex
      +
      Computes and indexes the explicit and implicit HTTP bindings of a model. + +

      This index makes it easy to understand how members of the input or output + of a request/response are bound to an HTTP message by providing all of the + bindings in the model as a normalized HttpBinding object. This can be + used to validate the bindings of an operation, generate code to [de]serialize + shapes, diff models to ensure backward compatibility at the wire level, etc. + +

      This index does not perform validation of the underlying model.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpBindingIndex

          +
          public HttpBindingIndex​(Model model)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          hasHttpRequestBindings

          +
          public static boolean hasHttpRequestBindings​(Shape shape)
          +
          Returns true if a shape has any HTTP request trait bindings.
          +
          +
          Parameters:
          +
          shape - Shape to check.
          +
          Returns:
          +
          Returns true if the shape is bound to an HTTP header, + payload, prefix headers, query string, or label.
          +
          +
          • +
        + + + +
          +
        • +

          hasHttpResponseBindings

          +
          public static boolean hasHttpResponseBindings​(Shape shape)
          +
          Returns true if a shape has any HTTP response trait bindings.
          +
          +
          Parameters:
          +
          shape - Shape to check.
          +
          Returns:
          +
          Returns true if the shape is bound to an HTTP header, + payload, of prefix headers.
          +
          +
          • +
        + + + +
          +
        • +

          getResponseCode

          +
          public int getResponseCode​(ToShapeId shapeOrId)
          +
          Gets the computed status code of an operation or error structure.
          +
          +
          Parameters:
          +
          shapeOrId - Operation or error structure shape ID.
          +
          Returns:
          +
          Returns the computed HTTP status code.
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if the given shape is not an operation + or an error structure.
          +
          +
          • +
        + + + +
          +
        • +

          getRequestBindings

          +
          public java.util.Map<java.lang.String,​HttpBinding> getRequestBindings​(ToShapeId operationShapeOrId)
          +
          Gets the request bindings of an operation as a map of member name to + the binding.
          +
          +
          Parameters:
          +
          operationShapeOrId - Operation to get the request bindings for.
          +
          Returns:
          +
          Map of unmodifiable bindings.
          +
          +
          • +
        + + + +
          +
        • +

          getRequestBindings

          +
          public java.util.List<HttpBinding> getRequestBindings​(ToShapeId operationShapeOrId,
+                                                      HttpBinding.Location requestLocation)
          +
          Gets the request bindings of an operation as a map of member name to + the binding for a specific location type.
          +
          +
          Parameters:
          +
          operationShapeOrId - Operation to get the request bindings for.
          +
          requestLocation - Location of the binding.
          +
          Returns:
          +
          Map of unmodifiable bindings.
          +
          +
          • +
        + + + +
          +
        • +

          getResponseBindings

          +
          public java.util.Map<java.lang.String,​HttpBinding> getResponseBindings​(ToShapeId shapeOrId)
          +
          Gets the computed HTTP message response bindings for an operation + or structure with an error trait.
          +
          +
          Parameters:
          +
          shapeOrId - Operation or error structure shape or ID.
          +
          Returns:
          +
          Map of unmodifiable bindings.
          +
          +
          • +
        + + + +
          +
        • +

          getResponseBindings

          +
          public java.util.List<HttpBinding> getResponseBindings​(ToShapeId shapeOrId,
+                                                       HttpBinding.Location bindingLocation)
          +
          Gets the computed HTTP message response bindings for an operation + or structure with an error trait for a specific binding type.
          +
          +
          Parameters:
          +
          shapeOrId - Operation or error structure shape or ID.
          +
          bindingLocation - Binding location type.
          +
          Returns:
          +
          List of found bindings.
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if the given shape is not an operation + or error structure.
          +
          +
          • +
        + + + +
          +
        • +

          determineTimestampFormat

          +
          public TimestampFormatTrait.Format determineTimestampFormat​(ToShapeId member,
+                                                            HttpBinding.Location location,
+                                                            TimestampFormatTrait.Format defaultFormat)
          +
          Determines the appropriate timestamp format for a member shape bound to + a specific location.
          +
          +
          Parameters:
          +
          member - Member to derive the timestamp format.
          +
          location - Location the member is bound to.
          +
          defaultFormat - The format to use for the body or a default.
          +
          Returns:
          +
          Returns the determined timestamp format.
          +
          +
          • +
        + + + +
          +
        • +

          determineRequestContentType

          +
          public java.util.Optional<java.lang.String> determineRequestContentType​(ToShapeId operation,
+                                                                        java.lang.String documentContentType)
          +
          Returns the expected request Content-Type of the given operation. + +

          See determineRequestContentType(ToShapeId, String, String) + for documentation on how the content-type is resolved.

          +
          +
          Parameters:
          +
          operation - Operation to determine the content-type of.
          +
          documentContentType - Content-Type to use for protocol documents.
          +
          Returns:
          +
          Returns the optionally resolved content-type of the request.
          +
          +
          • +
        + + + +
          +
        • +

          determineRequestContentType

          +
          public java.util.Optional<java.lang.String> determineRequestContentType​(ToShapeId operation,
+                                                                        java.lang.String documentContentType,
+                                                                        java.lang.String eventStreamContentType)
          +
          Returns the expected request Content-Type of the given operation. + +

          If members are sent in the "document" body, then the default + documentContentType value is returned. If a member is bound + to the payload, then the following checks are made: + +

            +
          • If the payload has the StreamingTrait, then the + eventStreamContentType is returned.
            • +
          • If the targeted shape is a structure or document type, then + the documentContentType is returned.
            • +
          • If the targeted shape has the MediaTypeTrait, then + the value of the trait is returned.
            • +
          • If the targeted shape is a blob, then "application/octet-stream" + is returned.
            • +
          • If the targeted shape is a string, then "text/plain" is + returned.
            • +
          + +

          If no members are sent in the payload, an empty Optional is + returned.

          +
          +
          Parameters:
          +
          operation - Operation to determine the content-type of.
          +
          documentContentType - Content-Type to use for protocol documents.
          +
          eventStreamContentType - Content-Type to use for event streams.
          +
          Returns:
          +
          Returns the optionally resolved content-type of the request.
          +
          +
          • +
        + + + +
          +
        • +

          determineResponseContentType

          +
          public java.util.Optional<java.lang.String> determineResponseContentType​(ToShapeId operationOrError,
+                                                                         java.lang.String documentContentType)
          +
          Returns the expected response Content-Type of the given operation + or error. + +

          See determineResponseContentType(ToShapeId, String, String) + for documentation on how the content-type is resolved.

          +
          +
          Parameters:
          +
          operationOrError - Operation or error to determine the content-type of.
          +
          documentContentType - Content-Type to use for protocol documents.
          +
          Returns:
          +
          Returns the optionally resolved content-type of the response.
          +
          +
          • +
        + + + +
          +
        • +

          determineResponseContentType

          +
          public java.util.Optional<java.lang.String> determineResponseContentType​(ToShapeId operationOrError,
+                                                                         java.lang.String documentContentType,
+                                                                         java.lang.String eventStreamContentType)
          +
          Returns the expected response Content-Type of the given operation + or error. + +

          If members are sent in the "document" body, then the default + documentContentType value is returned. If a member is bound + to the payload, then the following checks are made: + +

            +
          • If the payload has the StreamingTrait, then the + eventStreamContentType is returned.
            • +
          • If the targeted shape is a structure or document type, then + the documentContentType is returned.
            • +
          • If the targeted shape has the MediaTypeTrait, then + the value of the trait is returned.
            • +
          • If the targeted shape is a blob, then "application/octet-stream" + is returned.
            • +
          • If the targeted shape is a string, then "text/plain" is + returned.
            • +
          + +

          If no members are sent in the payload, an empty Optional is + returned.

          +
          +
          Parameters:
          +
          operationOrError - Operation or error to determine the content-type of.
          +
          documentContentType - Content-Type to use for protocol documents.
          +
          eventStreamContentType - Content-Type used for event streams.
          +
          Returns:
          +
          Returns the optionally resolved content-type of the response.
          +
          +
          • +
        + + + +
          +
        • +

          hasRequestBody

          +
          public boolean hasRequestBody​(ToShapeId operation)
          +
          Returns true if the request has a modeled body.
          +
          +
          Parameters:
          +
          operation - Operation to check.
          +
          Returns:
          +
          Returns true if the operation has document or payload bindings.
          +
          +
          • +
        + + + +
          +
        • +

          hasResponseBody

          +
          public boolean hasResponseBody​(ToShapeId operation)
          +
          Returns true if the response has a modeled body.
          +
          +
          Parameters:
          +
          operation - Operation to check.
          +
          Returns:
          +
          Returns true if the operation has document or payload bindings.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/knowledge/IdentifierBindingIndex.BindingType.html b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/IdentifierBindingIndex.BindingType.html new file mode 100644 index 00000000000..6bb323feff8 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/IdentifierBindingIndex.BindingType.html @@ -0,0 +1,402 @@ + + + + + +IdentifierBindingIndex.BindingType (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.knowledge
    +

    Enum IdentifierBindingIndex.BindingType

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        COLLECTION +
        Indicates that the operation is bound to a resource as a collection operation.
        +
        INSTANCE +
        Indicates that the operation is bound to a resource as an instance operation.
        +
        NONE +
        Indicates that the operation is not bound to a resource.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static IdentifierBindingIndex.BindingTypevalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static IdentifierBindingIndex.BindingType[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static IdentifierBindingIndex.BindingType[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (IdentifierBindingIndex.BindingType c : IdentifierBindingIndex.BindingType.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static IdentifierBindingIndex.BindingType valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/knowledge/IdentifierBindingIndex.html b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/IdentifierBindingIndex.html new file mode 100644 index 00000000000..0d274b63b29 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/IdentifierBindingIndex.html @@ -0,0 +1,455 @@ + + + + + +IdentifierBindingIndex (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    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.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          IdentifierBindingIndex

          +
          public IdentifierBindingIndex​(Model model)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          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.
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/knowledge/KnowledgeIndex.html b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/KnowledgeIndex.html new file mode 100644 index 00000000000..fc57f2022b4 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/KnowledgeIndex.html @@ -0,0 +1,230 @@ + + + + + +KnowledgeIndex (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.knowledge
    +

    Interface KnowledgeIndex

    +
    +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/knowledge/NeighborProviderIndex.html b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/NeighborProviderIndex.html new file mode 100644 index 00000000000..bae188d9281 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/NeighborProviderIndex.html @@ -0,0 +1,394 @@ + + + + + +NeighborProviderIndex (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.knowledge
    +

    Class NeighborProviderIndex

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.knowledge.NeighborProviderIndex
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      KnowledgeIndex
      +
      +
      +
      public final class NeighborProviderIndex
+extends java.lang.Object
+implements KnowledgeIndex
      +
      Provides a cache of precomputed neighbors for models.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          NeighborProviderIndex

          +
          public NeighborProviderIndex​(Model model)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getProvider

          +
          public NeighborProvider getProvider()
          +
          Gets the precomputed neighbor provider.
          +
          +
          Returns:
          +
          Returns the provider.
          +
          +
          • +
        + + + +
          +
        • +

          getProviderWithTraitRelationships

          +
          public NeighborProvider getProviderWithTraitRelationships()
          +
          Gets the neighbor provider that includes trait relationships.
          +
          +
          Returns:
          +
          Returns the provider.
          +
          +
          • +
        + + + +
          +
        • +

          getReverseProvider

          +
          public NeighborProvider getReverseProvider()
          +
          Gets a reversed, bottom up neighbor provider.
          +
          +
          Returns:
          +
          Returns the reversed neighbor provider.
          +
          +
          • +
        + + + +
          +
        • +

          getReverseProviderWithTraitRelationships

          +
          public NeighborProvider getReverseProviderWithTraitRelationships()
          +
          Gets a reversed, bottom up neighbor provider that includes reverse traits.
          +
          +
          Returns:
          +
          Returns the reversed neighbor provider with reverse traits.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/knowledge/NullableIndex.CheckMode.html b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/NullableIndex.CheckMode.html new file mode 100644 index 00000000000..19264e4287f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/NullableIndex.CheckMode.html @@ -0,0 +1,462 @@ + + + + + +NullableIndex.CheckMode (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.knowledge
    +

    Enum NullableIndex.CheckMode

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Enum<NullableIndex.CheckMode>
        • +
      • +
          +
        • software.amazon.smithy.model.knowledge.NullableIndex.CheckMode
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable, java.lang.Comparable<NullableIndex.CheckMode>
      +
      +
      +
      Enclosing class:
      +
      NullableIndex
      +
      +
      +
      public static enum NullableIndex.CheckMode
+extends java.lang.Enum<NullableIndex.CheckMode>
      +
      Defines the type of model consumer to assume when determining if + a member should be considered nullable or always present.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        CLIENT +
        A client, or any other kind of non-authoritative model consumer + that must honor the InputTrait and ClientOptionalTrait.
        +
        CLIENT_CAREFUL +
        Like CLIENT mode, but will treat all members that target + structures and unions as optional because these members can never + transition to optional using a default trait.
        +
        CLIENT_ZERO_VALUE_V1 +
        Evaluates only default traits on members that are set to their zero value based on Smithy + IDL 1.0 semantics (that is, only looks at shapes that had a zero value in Smithy v1, including byte, + short, integer, long, float, double, and boolean.
        +
        CLIENT_ZERO_VALUE_V1_NO_INPUT +
        Evaluates only default traits on members that are set to their zero value based on Smithy + IDL 1.0 semantics (that is, only looks at shapes that had a zero value in Smithy v1, including byte, + short, integer, long, float, double, and boolean.
        +
        SERVER +
        A server, or any other kind of authoritative model consumer + that does not honor the InputTrait and ClientOptionalTrait.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static NullableIndex.CheckModevalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static NullableIndex.CheckMode[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + + + + + +
          +
        • +

          CLIENT_CAREFUL

          +
          public static final NullableIndex.CheckMode CLIENT_CAREFUL
          +
          Like CLIENT mode, but will treat all members that target + structures and unions as optional because these members can never + transition to optional using a default trait.
          +
          • +
        + + + +
          +
        • +

          CLIENT_ZERO_VALUE_V1

          +
          public static final NullableIndex.CheckMode CLIENT_ZERO_VALUE_V1
          +
          Evaluates only default traits on members that are set to their zero value based on Smithy + IDL 1.0 semantics (that is, only looks at shapes that had a zero value in Smithy v1, including byte, + short, integer, long, float, double, and boolean. If a member is marked with addedDefault or with + clientOptional or is in an input structure, then the member is always considered nullable.
          +
          • +
        + + + +
          +
        • +

          CLIENT_ZERO_VALUE_V1_NO_INPUT

          +
          public static final NullableIndex.CheckMode CLIENT_ZERO_VALUE_V1_NO_INPUT
          +
          Evaluates only default traits on members that are set to their zero value based on Smithy + IDL 1.0 semantics (that is, only looks at shapes that had a zero value in Smithy v1, including byte, + short, integer, long, float, double, and boolean. If a member is marked with addedDefault or with + clientOptional, then the member is always considered nullable.
          +
          • +
        + + + +
          +
        • +

          SERVER

          +
          public static final NullableIndex.CheckMode SERVER
          +
          A server, or any other kind of authoritative model consumer + that does not honor the InputTrait and ClientOptionalTrait. + +

          This mode should only be used for model consumers that have + perfect knowledge of the model because they are built and deployed + in lock-step with model updates. A client does not have perfect + knowledge of a model because it has to be generated, deployed, + and then migrated to when model updates are released. However, a + server is required to be updated in order to implement newly added + model components.

          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static NullableIndex.CheckMode[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (NullableIndex.CheckMode c : NullableIndex.CheckMode.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static NullableIndex.CheckMode valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/knowledge/NullableIndex.html b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/NullableIndex.html new file mode 100644 index 00000000000..6d63aff4118 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/NullableIndex.html @@ -0,0 +1,491 @@ + + + + + +NullableIndex (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.knowledge
    +

    Class NullableIndex

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.knowledge.NullableIndex
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      KnowledgeIndex
      +
      +
      +
      Direct Known Subclasses:
      +
      BoxIndex
      +
      +
      +
      public class NullableIndex
+extends java.lang.Object
+implements KnowledgeIndex
      +
      An index that checks if a member is nullable.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          NullableIndex

          +
          public NullableIndex​(Model model)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + +
          +
        • +

          isMemberNullable

          +
          public boolean isMemberNullable​(MemberShape member,
+                                NullableIndex.CheckMode checkMode)
          +
          Checks if a member is nullable using v2 nullability rules. + +

          A checkMode parameter is required to declare what kind of + model consumer is checking if the member is optional. The authoritative + consumers like servers do not need to honor the InputTrait or + ClientOptionalTrait, while non-authoritative consumers like clients + must honor these traits.

          +
          +
          Parameters:
          +
          member - Member to check.
          +
          checkMode - The mode used when checking if the member is considered nullable.
          +
          Returns:
          +
          Returns true if the member is optional.
          +
          +
          • +
        + + + +
          +
        • +

          isNullable

          +
          @Deprecated
+public final boolean isNullable​(ToShapeId shapeId)
          +
          Deprecated.
          +
          Checks if the given shape is optional using Smithy IDL 1.0 semantics. + +

          This method does not return the same values that are returned by + isMemberNullable(MemberShape). This method uses 1.0 model + semantics and attempts to detect when a model has been passed though + model assembler upgrades to provide the most accurate v1 nullability + result. + +

          Use isMemberNullable(MemberShape) to check using Smithy + IDL 2.0 semantics that take required, default, and other traits + into account with no special 1.0 handling.

          +
          +
          Parameters:
          +
          shapeId - Shape or shape ID to check.
          +
          Returns:
          +
          Returns true if the shape is nullable.
          +
          +
          • +
        + + + +
          +
        • +

          isShapeSetToDefaultZeroValueInV1

          +
          public static boolean isShapeSetToDefaultZeroValueInV1​(MemberShape member,
+                                                       Shape target)
          +
          Detects if the given member is configured to use the zero value for the target shape + using Smithy 1.0 semantics (that is, it targets a number shape other than bigInteger + or bigDecimal and set to 0; or it targets a boolean shape and is set to false).
          +
          +
          Parameters:
          +
          member - Member to check.
          +
          target - Shape target to check.
          +
          Returns:
          +
          Returns true if the member has a default trait set to a v1 zero value.
          +
          +
          • +
        + + + +
          +
        • +

          isDefaultZeroValueOfTypeInV1

          +
          public static boolean isDefaultZeroValueOfTypeInV1​(Node defaultValue,
+                                                   ShapeType targetType)
          +
          Detects if the given node value equals the default value of the given shape type + based on Smithy 1.0 semantics.
          +
          +
          Parameters:
          +
          defaultValue - Value to check.
          +
          targetType - Shape type to check against.
          +
          Returns:
          +
          Returns true if the value is the v1 zero value of the type.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/knowledge/OperationIndex.html b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/OperationIndex.html new file mode 100644 index 00000000000..ea5f5859b6f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/OperationIndex.html @@ -0,0 +1,715 @@ + + + + + +OperationIndex (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.knowledge
    +

    Class OperationIndex

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.knowledge.OperationIndex
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      KnowledgeIndex
      +
      +
      +
      public final class OperationIndex
+extends java.lang.Object
+implements KnowledgeIndex
      +
      Index of operation IDs to their resolved input, output, and error + structures. + +

      This index performs no validation that the input, output, and + errors actually reference valid structures. Such operation inputs, + outputs, and errors may be discarded as if they do not exist.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          OperationIndex

          +
          public OperationIndex​(Model model)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getInput

          +
          public java.util.Optional<StructureShape> getInput​(ToShapeId operation)
          +
          Gets the optional input structure of an operation, and returns an + empty optional if the input targets smithy.api#Unit.
          +
          +
          Parameters:
          +
          operation - Operation to get the input structure of.
          +
          Returns:
          +
          Returns the optional operation input structure.
          +
          +
          • +
        + + + +
          +
        • +

          getInputShape

          +
          public java.util.Optional<StructureShape> getInputShape​(ToShapeId operation)
          +
          Gets the optional input structure of an operation. + +

          Operations in the model always have input. This operation will + only return an empty optional if the given operation shape cannot + be found in the model or if it is not an operation shape.

          +
          +
          Parameters:
          +
          operation - Operation to get the input structure of.
          +
          Returns:
          +
          Returns the optional operation input structure.
          +
          +
          • +
        + + + +
          +
        • +

          expectInputShape

          +
          public StructureShape expectInputShape​(ToShapeId operation)
          +
          Gets the input shape of an operation, and returns Smithy's Unit type + trait if the operation has no meaningful input. + +

          In general, this method should be used instead of + getInputShape(ToShapeId) when getting the input of operations + that are known to exist.

          +
          +
          Parameters:
          +
          operation - Operation to get the input of.
          +
          Returns:
          +
          Returns the input shape of the operation.
          +
          Throws:
          +
          ExpectationNotMetException - if the operation shape cannot be found.
          +
          +
          • +
        + + + +
          +
        • +

          getInputMembers

          +
          public java.util.Map<java.lang.String,​MemberShape> getInputMembers​(ToShapeId operation)
          +
          Gets the input members of an operation as a map of member names + to MemberShape. + +

          The return map is ordered using the same order defined in + the model. If the operation has no input, an empty map is returned.

          +
          +
          Parameters:
          +
          operation - Operation to get the input members of.
          +
          Returns:
          +
          Returns the map of members, or an empty map.
          +
          +
          • +
        + + + +
          +
        • +

          isInputStructure

          +
          public boolean isInputStructure​(ToShapeId structureId)
          +
          Returns true if the given structure is used as input by any + operation in the model or is marked with the input trait.
          +
          +
          Parameters:
          +
          structureId - Structure to check.
          +
          Returns:
          +
          Returns true if the structure is used as input.
          +
          +
          • +
        + + + +
          +
        • +

          getInputBindings

          +
          public java.util.Set<OperationShape> getInputBindings​(ToShapeId input)
          +
          Gets all the operations that bind the given shape as input.
          +
          +
          Parameters:
          +
          input - The structure that may be used as input.
          +
          Returns:
          +
          Returns a set of operations that bind the given input shape.
          +
          +
          • +
        + + + +
          +
        • +

          getOutput

          +
          public java.util.Optional<StructureShape> getOutput​(ToShapeId operation)
          +
          Gets the optional output structure of an operation, and returns an + empty optional if the output targets smithy.api#Unit.
          +
          +
          Parameters:
          +
          operation - Operation to get the output structure of.
          +
          Returns:
          +
          Returns the optional operation output structure.
          +
          +
          • +
        + + + +
          +
        • +

          getOutputShape

          +
          public java.util.Optional<StructureShape> getOutputShape​(ToShapeId operation)
          +
          Gets the optional output structure of an operation. + +

          Operations in the model always have output. This operation will + only return an empty optional if the given operation shape cannot + be found in the model or if it is not an operation shape.

          +
          +
          Parameters:
          +
          operation - Operation to get the output structure of.
          +
          Returns:
          +
          Returns the optional operation output structure.
          +
          +
          • +
        + + + +
          +
        • +

          expectOutputShape

          +
          public StructureShape expectOutputShape​(ToShapeId operation)
          +
          Gets the output shape of an operation, and returns Smithy's unit type + trait if the operation has no meaningful output. + +

          In general, this method should be used instead of + getOutputShape(ToShapeId) when getting the output of operations + that are known to exist.

          +
          +
          Parameters:
          +
          operation - Operation to get the output of.
          +
          Returns:
          +
          Returns the output shape of the operation.
          +
          Throws:
          +
          ExpectationNotMetException - if the operation shape cannot be found.
          +
          +
          • +
        + + + +
          +
        • +

          getOutputMembers

          +
          public java.util.Map<java.lang.String,​MemberShape> getOutputMembers​(ToShapeId operation)
          +
          Gets the output members of an operation as a map of member names + to MemberShape. + +

          The return map is ordered using the same order defined in + the model. If the operation has no output, an empty map is returned.

          +
          +
          Parameters:
          +
          operation - Operation to get the output members of.
          +
          Returns:
          +
          Returns the map of members, or an empty map.
          +
          +
          • +
        + + + +
          +
        • +

          isOutputStructure

          +
          public boolean isOutputStructure​(ToShapeId structureId)
          +
          Returns true if the given structure is used as output by any + operation in the model or is marked with the output trait.
          +
          +
          Parameters:
          +
          structureId - Structure to check.
          +
          Returns:
          +
          Returns true if the structure is used as output.
          +
          +
          • +
        + + + +
          +
        • +

          getOutputBindings

          +
          public java.util.Set<OperationShape> getOutputBindings​(ToShapeId output)
          +
          Gets all the operations that bind the given shape as output.
          +
          +
          Parameters:
          +
          output - The structure that may be used as output.
          +
          Returns:
          +
          Returns a set of operations that bind the given output shape.
          +
          +
          • +
        + + + +
          +
        • +

          getErrors

          +
          public java.util.List<StructureShape> getErrors​(ToShapeId operation)
          +
          Gets the list of error structures defined on an operation. + +

          An empty list is returned if the operation is not found or + has no errors.

          +
          +
          Parameters:
          +
          operation - Operation to get the errors of.
          +
          Returns:
          +
          Returns the list of error structures, or an empty list.
          +
          See Also:
          +
          to get errors that inherit from a service.
          +
          +
          • +
        + + + +
          +
        • +

          getErrors

          +
          public java.util.List<StructureShape> getErrors​(ToShapeId service,
+                                                ToShapeId operation)
          +
          Gets the list of error structures defined on an operation, + including any common errors inherited from a service shape. + +

          An empty list is returned if the operation is not found or + has no errors.

          +
          +
          Parameters:
          +
          service - Service shape to inherit common errors from.
          +
          operation - Operation to get the errors of.
          +
          Returns:
          +
          Returns the list of error structures, or an empty list.
          +
          +
          • +
        + + + +
          +
        • +

          getErrorBindings

          +
          public java.util.Set<Shape> getErrorBindings​(ToShapeId error)
          +
          Gets all the operations and services that bind the given shape as an error.
          +
          +
          Parameters:
          +
          error - The structure that may be used as an error.
          +
          Returns:
          +
          Returns a set of operations and services that bind the given error shape.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/knowledge/PaginatedIndex.html b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/PaginatedIndex.html new file mode 100644 index 00000000000..0cd47bbe96a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/PaginatedIndex.html @@ -0,0 +1,334 @@ + + + + + +PaginatedIndex (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.knowledge
    +

    Class PaginatedIndex

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.knowledge.PaginatedIndex
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      KnowledgeIndex
      +
      +
      +
      public final class PaginatedIndex
+extends java.lang.Object
+implements KnowledgeIndex
      +
      Index of operation shapes to paginated trait information. + +

      This index makes it easy to slice up paginated operations and + get the resolved members. This index performs some basic validation + of the paginated trait like ensuring that the operation has input + and output, and that the members defined in the paginated trait can + be found in the input or output of the operation. Additional + validation is performed in the PaginatedTraitValidator + (which makes use of this index).

      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/knowledge/PaginationInfo.html b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/PaginationInfo.html new file mode 100644 index 00000000000..0a997f89131 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/PaginationInfo.html @@ -0,0 +1,450 @@ + + + + + +PaginationInfo (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.knowledge
    +

    Class PaginationInfo

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.knowledge.PaginationInfo
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class PaginationInfo
+extends java.lang.Object
      +
      Resolved and valid pagination information about an operation in a service.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + + + + + + + + + +
          +
        • +

          getPaginatedTrait

          +
          public PaginatedTrait getPaginatedTrait()
          +
          Gets the paginated trait of the operation merged with the service.
          +
          +
          Returns:
          +
          Returns the resolved paginated trait.
          +
          +
          • +
        + + + +
          +
        • +

          getInputTokenMember

          +
          public MemberShape getInputTokenMember()
          +
          • +
        + + + + + + + +
          +
        • +

          getOutputTokenMemberPath

          +
          public java.util.List<MemberShape> getOutputTokenMemberPath()
          +
          Get the resolved output path identifiers as a list of MemberShape.
          +
          +
          Returns:
          +
          A list of MemberShape.
          +
          +
          • +
        + + + +
          +
        • +

          getItemsMember

          +
          @Deprecated
+public java.util.Optional<MemberShape> getItemsMember()
          +
          Deprecated. +
          See getItemsMemberPath() to retrieve the full path.
          +
          +
          +
          Returns:
          +
          the last MemberShape of the items path.
          +
          +
          • +
        + + + +
          +
        • +

          getItemsMemberPath

          +
          public java.util.List<MemberShape> getItemsMemberPath()
          +
          Get the resolved items path identifiers as a list of MemberShape.
          +
          +
          Returns:
          +
          A list of MemberShape.
          +
          +
          • +
        + + + +
          +
        • +

          getPageSizeMember

          +
          public java.util.Optional<MemberShape> getPageSizeMember()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/knowledge/PropertyBindingIndex.html b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/PropertyBindingIndex.html new file mode 100644 index 00000000000..0ca03275653 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/PropertyBindingIndex.html @@ -0,0 +1,395 @@ + + + + + +PropertyBindingIndex (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.knowledge
    +

    Class PropertyBindingIndex

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.knowledge.PropertyBindingIndex
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      KnowledgeIndex
      +
      +
      +
      public final class PropertyBindingIndex
+extends java.lang.Object
+implements KnowledgeIndex
      +
      Index of member shape to associated resource property information.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getPropertyName

          +
          public java.util.Optional<java.lang.String> getPropertyName​(ShapeId memberShapeId)
          +
          Gets the property name for a given member shape. Returns empty optional if the + member shape does not correspond to a property.
          +
          +
          Parameters:
          +
          memberShapeId - the ShapeId of the member shape to get the property name for.
          +
          Returns:
          +
          the property name for a given member shape if there is one.
          +
          +
          • +
        + + + +
          +
        • +

          isMemberShapeProperty

          +
          public boolean isMemberShapeProperty​(MemberShape memberShape)
          +
          Returns true if a member shape positively maps to a property. + + {@see PropertyBindingIndex#getPropertyName(ShapeId)} will return a non-empty Optional if this method + returns true.
          +
          +
          Parameters:
          +
          memberShape - the member shape to check
          +
          Returns:
          +
          true if member shape maps to a property on the given resource
          +
          +
          • +
        + + + +
          +
        • +

          getOutputPropertiesShape

          +
          public StructureShape getOutputPropertiesShape​(OperationShape operation)
          +
          Resolves and returns the output shape of an operation that contains the + top-level resource bound properties. Handles adjustments made with
          +
          +
          Parameters:
          +
          operation - operation to retrieve output properties shape for.
          +
          Returns:
          +
          the output shape of an operation that contains top-level resource + properties.
          +
          +
          • +
        + + + +
          +
        • +

          getInputPropertiesShape

          +
          public StructureShape getInputPropertiesShape​(OperationShape operation)
          +
          Resolves and returns the input shape of an operation that contains the + top-level resource bound properties. Handles adjustments made with
          +
          +
          Parameters:
          +
          operation - operation to retrieve output properties shape for
          +
          Returns:
          +
          the input shape of an operation that contains top-level resource + properties.
          +
          +
          • +
        + + + +
          +
        • +

          doesMemberShapeRequireProperty

          +
          public boolean doesMemberShapeRequireProperty​(MemberShape memberShape)
          +
          Returns true if member is required to have an associated property mapping.
          +
          +
          Parameters:
          +
          memberShape - the member shape to check
          +
          Returns:
          +
          True if input/output member is required to have a property mapping.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/knowledge/ServiceIndex.AuthSchemeMode.html b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/ServiceIndex.AuthSchemeMode.html new file mode 100644 index 00000000000..bb3f5196c0a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/ServiceIndex.AuthSchemeMode.html @@ -0,0 +1,390 @@ + + + + + +ServiceIndex.AuthSchemeMode (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.knowledge
    +

    Enum ServiceIndex.AuthSchemeMode

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        MODELED +
        Use only the modeled auth schemes.
        +
        NO_AUTH_AWARE +
        Use the modeled auth schemes, as well as the synthetic NoAuthTrait where applicable.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static ServiceIndex.AuthSchemeModevalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static ServiceIndex.AuthSchemeMode[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + + + + + +
          +
        • +

          NO_AUTH_AWARE

          +
          public static final ServiceIndex.AuthSchemeMode NO_AUTH_AWARE
          +
          Use the modeled auth schemes, as well as the synthetic NoAuthTrait where applicable. + +

          The Smithy Reference Architecture recommends using the smithy.api#noAuth auth scheme to represent + no authentication which is available as the NoAuthTrait.

          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static ServiceIndex.AuthSchemeMode[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (ServiceIndex.AuthSchemeMode c : ServiceIndex.AuthSchemeMode.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static ServiceIndex.AuthSchemeMode valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/knowledge/ServiceIndex.html b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/ServiceIndex.html new file mode 100644 index 00000000000..564957562e6 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/ServiceIndex.html @@ -0,0 +1,559 @@ + + + + + +ServiceIndex (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.knowledge
    +

    Class ServiceIndex

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.knowledge.ServiceIndex
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      KnowledgeIndex
      +
      +
      +
      public final class ServiceIndex
+extends java.lang.Object
+implements KnowledgeIndex
      +
      An index that resolves service protocols and auth schemes. + +

      This index can be used to get all of the protocol traits applied to + a service, to get all of the auth defining traits applied to a service, + to get the effective authentication schemes of a service, and to get the + effective authentication schemes of an operation bound within the + closure of a service.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ServiceIndex

          +
          public ServiceIndex​(Model model)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getProtocols

          +
          public java.util.Map<ShapeId,​Trait> getProtocols​(ToShapeId service)
          +
          Get all protocol traits attached to a service. + +

          A protocol trait is a trait that is marked with + the smithy.api#protocolDefinition trait. + +

          An empty map is returned if service cannot be found in the + model or is not a service shape.

          +
          +
          Parameters:
          +
          service - Service to get the protocols of.
          +
          Returns:
          +
          Returns a map of the protocol trait ID to the trait.
          +
          +
          • +
        + + + +
          +
        • +

          getAuthSchemes

          +
          public java.util.Map<ShapeId,​Trait> getAuthSchemes​(ToShapeId service)
          +
          Get all auth defining traits attached to a service or operation. + +

          An auth defining trait is a trait that is marked with + the smithy.api#authDefinition trait. + +

          The returned map is ordered alphabetically by absolute shape ID. + +

          An empty map is returned if id cannot be found in the + model or is not a service shape.

          +
          +
          Parameters:
          +
          service - Service to get the auth schemes of.
          +
          Returns:
          +
          Returns a map of the trait shape ID to the auth trait itself.
          +
          +
          • +
        + + + +
          +
        • +

          getEffectiveAuthSchemes

          +
          public java.util.Map<ShapeId,​Trait> getEffectiveAuthSchemes​(ToShapeId service)
          +
          Gets a list of effective authentication schemes applied to a service. + +

          An effective authentication scheme is derived from the + smithy.api#auth trait and the auth defining traits applied + to a service. If the service has the smithy.api#auth trait, + then a map is returned that contains the traits applied to the service + that matches the values in the auth trait. If no auth trait is applied, + then all of the auth defining traits on the service are returned. + +

          The returned map is provided in the same order as the values in the + auth trait if an auth trait is present, otherwise the result + returned is ordered alphabetically by absolute shape ID. + +

          An empty map is returned if service cannot be found in the + model or is not a service shape.

          +
          +
          Parameters:
          +
          service - Service to get the effective authentication schemes of.
          +
          Returns:
          +
          Returns a map of the trait shape ID to the auth trait itself.
          +
          +
          • +
        + + + +
          +
        • +

          getEffectiveAuthSchemes

          +
          public java.util.Map<ShapeId,​Trait> getEffectiveAuthSchemes​(ToShapeId service,
+                                                                  ServiceIndex.AuthSchemeMode authSchemeMode)
          +
          Gets a list of effective authentication schemes applied to a service, based on the AuthSchemeMode. + +

          If AuthSchemeMode is MODELED, which is the default, the behavior is same as + getEffectiveAuthSchemes(ToShapeId). + +

          If AuthSchemeMode is NO_AUTH_AWARE, the behavior is same, except that if the service has no effective + auth schemes, instead of an empty map, it returns the smithy.api#noAuth auth scheme. It avoids having to + special case handling an empty result. The returned map will always contain at least 1 entry.

          +
          +
          Parameters:
          +
          service - Service to get the effective authentication schemes of.
          +
          authSchemeMode - AuthSchemeMode to determine which authentication schemes to include.
          +
          Returns:
          +
          Returns a map of the trait shape ID to the auth trait itself.
          +
          +
          • +
        + + + +
          +
        • +

          getEffectiveAuthSchemes

          +
          public java.util.Map<ShapeId,​Trait> getEffectiveAuthSchemes​(ToShapeId service,
+                                                                  ToShapeId operation)
          +
          Gets a list of effective authentication schemes applied to an operation + bound within a service. + +

          If the given operation defines that smithy.api#auth trait, + then a map is returned that consists of the traits applied to the + service that match the values of the smithy.api#auth trait. If + the operation does not define an smithy.api#auth trait, then + the effective auth schemes of the service is returned (that is, the + return value of getEffectiveAuthSchemes(ToShapeId)). + +

          The returned map is provided in the same order as the values in the + auth trait if an auth trait is present, otherwise the result + returned is ordered alphabetically by absolute shape ID. + +

          An empty map is returned if service shape cannot be found + in the model or is not a service shape. An empty map is returned if + operation cannot be found in the model or is not an operation + shape.

          +
          +
          Parameters:
          +
          service - Service the operation is within.
          +
          operation - Operation to get the effective authentication schemes of.
          +
          Returns:
          +
          Returns a map of the trait shape ID to the auth trait itself.
          +
          +
          • +
        + + + +
          +
        • +

          getEffectiveAuthSchemes

          +
          public java.util.Map<ShapeId,​Trait> getEffectiveAuthSchemes​(ToShapeId service,
+                                                                  ToShapeId operation,
+                                                                  ServiceIndex.AuthSchemeMode authSchemeMode)
          +
          Gets a list of effective authentication schemes applied to an operation + bound within a service, based on the AuthSchemeMode. + +

          If AuthSchemeMode is MODELED, which is the default, the behavior is same as + getEffectiveAuthSchemes(ToShapeId, ToShapeId). + +

          If AuthSchemeMode is NO_AUTH_AWARE, the behavior is same, with the following differences: + If the operation has no effective auth schemes, instead of an empty map, it returns the smithy.api#noAuth + auth scheme. + If the operation has the smithy.api#optionalAuth trait, it adds smithy.api#noAuth to the end. + +

          Using NO_AUTH_AWARE accounts for smithy.api#optionalAuth and avoids having to special case + handling an empty result. The returned map will always contain at least 1 entry. + +

          The smithy.api#noAuth scheme, if present, is always the last scheme.

          +
          +
          Parameters:
          +
          service - Service the operation is within.
          +
          operation - Operation to get the effective authentication schemes of.
          +
          authSchemeMode - AuthSchemeMode to determine which authentication schemes to include.
          +
          Returns:
          +
          Returns a map of the trait shape ID to the auth trait itself.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/knowledge/TextIndex.html b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/TextIndex.html new file mode 100644 index 00000000000..954b73e364c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/TextIndex.html @@ -0,0 +1,324 @@ + + + + + +TextIndex (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.knowledge
    +

    Class TextIndex

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.knowledge.TextIndex
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      KnowledgeIndex
      +
      +
      +
      public final class TextIndex
+extends java.lang.Object
+implements KnowledgeIndex
      +
      Index containing the full set of TextInstances associated with a model.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          TextIndex

          +
          public TextIndex​(Model model)
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/knowledge/TextInstance.TextLocationType.html b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/TextInstance.TextLocationType.html new file mode 100644 index 00000000000..4124ccb1391 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/TextInstance.TextLocationType.html @@ -0,0 +1,394 @@ + + + + + +TextInstance.TextLocationType (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.knowledge
    +

    Enum TextInstance.TextLocationType

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static TextInstance.TextLocationTypevalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static TextInstance.TextLocationType[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static TextInstance.TextLocationType[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (TextInstance.TextLocationType c : TextInstance.TextLocationType.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static TextInstance.TextLocationType valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/knowledge/TextInstance.html b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/TextInstance.html new file mode 100644 index 00000000000..b8dfaa3cb12 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/TextInstance.html @@ -0,0 +1,382 @@ + + + + + +TextInstance (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.knowledge
    +

    Class TextInstance

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.knowledge.TextInstance
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class TextInstance
+extends java.lang.Object
      +
      Contains information about text that occurs in the Smithy IDL written by the owner, + inluding location metadata.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static class TextInstance.TextLocationType +
        Enum type indicating what kind of location in the model associated text appeared in.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        TextInstance.TextLocationTypegetLocationType() +
        Retrieves the type of TextLocationType associated with the text.
        +
        ShapegetShape() +
        Gets the shape associated with the text.
        +
        java.lang.StringgetText() +
        Retrieves the text content of the TextInstance.
        +
        TraitgetTrait() +
        Gets the trait associated with the text.
        +
        java.util.List<java.lang.String>getTraitPropertyPath() +
        Gets the ordered path components within a trait's value the text is associated with.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + +
          +
        • +

          getLocationType

          +
          public TextInstance.TextLocationType getLocationType()
          +
          Retrieves the type of TextLocationType associated with the text.
          +
          +
          Returns:
          +
          Returns the TextLocationType.
          +
          +
          • +
        + + + +
          +
        • +

          getText

          +
          public java.lang.String getText()
          +
          Retrieves the text content of the TextInstance.
          +
          +
          Returns:
          +
          Returns the model text.
          +
          +
          • +
        + + + +
          +
        • +

          getShape

          +
          public Shape getShape()
          +
          Gets the shape associated with the text.
          +
          +
          Returns:
          +
          Returns the shape if the text is associated with one. Otherwise, returns null.
          +
          +
          • +
        + + + +
          +
        • +

          getTrait

          +
          public Trait getTrait()
          +
          Gets the trait associated with the text.
          +
          +
          Returns:
          +
          Returns the trait if the text is associated with one. Otherwise, returns null.
          +
          +
          • +
        + + + +
          +
        • +

          getTraitPropertyPath

          +
          public java.util.List<java.lang.String> getTraitPropertyPath()
          +
          Gets the ordered path components within a trait's value the text is associated with.
          +
          +
          Returns:
          +
          Returns the property path if the text is associated with a trait's value.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/knowledge/TopDownIndex.html b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/TopDownIndex.html new file mode 100644 index 00000000000..07bcedce1d0 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/TopDownIndex.html @@ -0,0 +1,357 @@ + + + + + +TopDownIndex (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.knowledge
    +

    Class TopDownIndex

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.knowledge.TopDownIndex
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      KnowledgeIndex
      +
      +
      +
      public final class TopDownIndex
+extends java.lang.Object
+implements KnowledgeIndex
      +
      Provides top-down access to all resources and operations contained within a + service or resource closure.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          TopDownIndex

          +
          public TopDownIndex​(Model model)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getContainedOperations

          +
          public java.util.Set<OperationShape> getContainedOperations​(ToShapeId entity)
          +
          Get all operations in service or resource closure.
          +
          +
          Parameters:
          +
          entity - Service or resource shape ID.
          +
          Returns:
          +
          Returns all operations in the service closure.
          +
          +
          • +
        + + + +
          +
        • +

          getContainedResources

          +
          public java.util.Set<ResourceShape> getContainedResources​(ToShapeId entity)
          +
          Get all resources in a service or resource closure.
          +
          +
          Parameters:
          +
          entity - Service or resource shape ID.
          +
          Returns:
          +
          Returns all resources in the service closure.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/knowledge/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/package-summary.html new file mode 100644 index 00000000000..ca0d6ed37c8 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/package-summary.html @@ -0,0 +1,321 @@ + + + + + +software.amazon.smithy.model.knowledge (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.model.knowledge

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/knowledge/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/package-tree.html new file mode 100644 index 00000000000..4a22d4cf9bb --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/knowledge/package-tree.html @@ -0,0 +1,204 @@ + + + + + +software.amazon.smithy.model.knowledge Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.model.knowledge

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +

    Enum Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/loader/IdlToken.html b/javadoc/1.47.0/software/amazon/smithy/model/loader/IdlToken.html new file mode 100644 index 00000000000..52999047783 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/loader/IdlToken.html @@ -0,0 +1,705 @@ + + + + + +IdlToken (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.loader
    +

    Enum IdlToken

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Enum<IdlToken>
        • +
      • +
          +
        • software.amazon.smithy.model.loader.IdlToken
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable, java.lang.Comparable<IdlToken>
      +
      +
      +
      public enum IdlToken
+extends java.lang.Enum<IdlToken>
      +
      Represents a parsed token from the Smithy IDL.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + +
          +
        • +

          SPACE

          +
          public static final IdlToken SPACE
          +
          • +
        + + + +
          +
        • +

          NEWLINE

          +
          public static final IdlToken NEWLINE
          +
          • +
        + + + +
          +
        • +

          COMMA

          +
          public static final IdlToken COMMA
          +
          • +
        + + + +
          +
        • +

          COMMENT

          +
          public static final IdlToken COMMENT
          +
          • +
        + + + +
          +
        • +

          DOC_COMMENT

          +
          public static final IdlToken DOC_COMMENT
          +
          • +
        + + + +
          +
        • +

          AT

          +
          public static final IdlToken AT
          +
          • +
        + + + +
          +
        • +

          STRING

          +
          public static final IdlToken STRING
          +
          • +
        + + + +
          +
        • +

          TEXT_BLOCK

          +
          public static final IdlToken TEXT_BLOCK
          +
          • +
        + + + +
          +
        • +

          COLON

          +
          public static final IdlToken COLON
          +
          • +
        + + + +
          +
        • +

          WALRUS

          +
          public static final IdlToken WALRUS
          +
          • +
        + + + +
          +
        • +

          IDENTIFIER

          +
          public static final IdlToken IDENTIFIER
          +
          • +
        + + + +
          +
        • +

          DOT

          +
          public static final IdlToken DOT
          +
          • +
        + + + +
          +
        • +

          POUND

          +
          public static final IdlToken POUND
          +
          • +
        + + + +
          +
        • +

          DOLLAR

          +
          public static final IdlToken DOLLAR
          +
          • +
        + + + +
          +
        • +

          NUMBER

          +
          public static final IdlToken NUMBER
          +
          • +
        + + + +
          +
        • +

          LBRACE

          +
          public static final IdlToken LBRACE
          +
          • +
        + + + +
          +
        • +

          RBRACE

          +
          public static final IdlToken RBRACE
          +
          • +
        + + + +
          +
        • +

          LBRACKET

          +
          public static final IdlToken LBRACKET
          +
          • +
        + + + +
          +
        • +

          RBRACKET

          +
          public static final IdlToken RBRACKET
          +
          • +
        + + + +
          +
        • +

          LPAREN

          +
          public static final IdlToken LPAREN
          +
          • +
        + + + +
          +
        • +

          RPAREN

          +
          public static final IdlToken RPAREN
          +
          • +
        + + + +
          +
        • +

          EQUAL

          +
          public static final IdlToken EQUAL
          +
          • +
        + + + +
          +
        • +

          EOF

          +
          public static final IdlToken EOF
          +
          • +
        + + + +
          +
        • +

          ERROR

          +
          public static final IdlToken ERROR
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static IdlToken[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (IdlToken c : IdlToken.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static IdlToken valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getDebug

          +
          public java.lang.String getDebug()
          +
          • +
        + + + +
          +
        • +

          getDebug

          +
          public java.lang.String getDebug​(java.lang.CharSequence lexeme)
          +
          • +
        + + + +
          +
        • +

          isWhitespace

          +
          public boolean isWhitespace()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/loader/IdlTokenizer.html b/javadoc/1.47.0/software/amazon/smithy/model/loader/IdlTokenizer.html new file mode 100644 index 00000000000..e6c42de00a7 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/loader/IdlTokenizer.html @@ -0,0 +1,740 @@ + + + + + +IdlTokenizer (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.loader
    +

    Interface IdlTokenizer

    +
    +
    +
    +
      +
    • +
      +
      All Superinterfaces:
      +
      java.util.Iterator<IdlToken>
      +
      +
      +
      public interface IdlTokenizer
+extends java.util.Iterator<IdlToken>
      +
      Iterates over a Smithy IDL model as a series of tokens.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Abstract Methods Default Methods 
        Modifier and TypeMethodDescription
        static IdlTokenizercreate​(java.lang.CharSequence model) +
        Create a tokenizer for the given model.
        +
        static IdlTokenizercreate​(java.lang.String filename, + java.lang.CharSequence model) +
        Create a tokenizer for the given filename and model.
        +
        default voidexpect​(IdlToken token) +
        Assert that the current token is token.
        +
        default IdlTokenexpect​(IdlToken... tokens) +
        Assert that the current token is one of tokens.
        +
        intgetColumn() +
        Get the current column number of the tokenizer, starting at 1.
        +
        IdlTokengetCurrentToken() +
        Get the current IdlToken.
        +
        intgetCurrentTokenColumn() +
        Get the column of the current token.
        +
        intgetCurrentTokenEnd() +
        Get the end position of the curren token.
        +
        java.lang.StringgetCurrentTokenError() +
        If the current token is an error, get the error message associated with the token.
        +
        default java.lang.CharSequencegetCurrentTokenLexeme() +
        Get the lexeme of the current token.
        +
        intgetCurrentTokenLine() +
        Get the line of the current token.
        +
        default SourceLocationgetCurrentTokenLocation() +
        Get the source location of the current token.
        +
        java.lang.NumbergetCurrentTokenNumberValue() +
        If the current token is a number, get the associated parsed number.
        +
        default intgetCurrentTokenSpan() +
        Get the length of the current token.
        +
        intgetCurrentTokenStart() +
        Get the start position of the current token.
        +
        java.lang.CharSequencegetCurrentTokenStringSlice() +
        If the current token is a string or text block, get the parsed content as a CharSequence.
        +
        intgetLine() +
        Get the current line number of the tokenizer, starting at 1.
        +
        java.lang.CharSequencegetModel() +
        Get the model being tokenized.
        +
        default java.lang.CharSequencegetModel​(int start, + int end) +
        Get a borrowed slice of the model being tokenized.
        +
        intgetPosition() +
        Get the current position of the tokenizer.
        +
        java.lang.StringgetSourceFilename() +
        Get the filename of the content being tokenized.
        +
        default booleanisCurrentLexeme​(java.lang.CharSequence chars) +
        Test if the current token lexeme is equal to the give chars.
        +
        +
          +
        • + + +

          Methods inherited from interface java.util.Iterator

          +forEachRemaining, hasNext, next, remove
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          create

          +
          static IdlTokenizer create​(java.lang.CharSequence model)
          +
          Create a tokenizer for the given model.
          +
          +
          Parameters:
          +
          model - IDL model contents to parse.
          +
          Returns:
          +
          Returns the tokenizer.
          +
          +
          • +
        + + + +
          +
        • +

          create

          +
          static IdlTokenizer create​(java.lang.String filename,
+                           java.lang.CharSequence model)
          +
          Create a tokenizer for the given filename and model.
          +
          +
          Parameters:
          +
          filename - Filename being parsed.
          +
          model - IDL model contents to parse.
          +
          Returns:
          +
          Returns the tokenizer.
          +
          +
          • +
        + + + +
          +
        • +

          getSourceFilename

          +
          java.lang.String getSourceFilename()
          +
          Get the filename of the content being tokenized.
          +
          +
          Returns:
          +
          Returns the filename used in source locations.
          +
          +
          • +
        + + + +
          +
        • +

          getModel

          +
          java.lang.CharSequence getModel()
          +
          Get the model being tokenized.
          +
          +
          Returns:
          +
          Returns the model.
          +
          +
          • +
        + + + +
          +
        • +

          getModel

          +
          default java.lang.CharSequence getModel​(int start,
+                                        int end)
          +
          Get a borrowed slice of the model being tokenized.
          +
          +
          Parameters:
          +
          start - Start position to get, inclusive.
          +
          end - End position to stop at, exclusive.
          +
          Returns:
          +
          Returns the slice.
          +
          +
          • +
        + + + +
          +
        • +

          getPosition

          +
          int getPosition()
          +
          Get the current position of the tokenizer.
          +
          +
          Returns:
          +
          Returns the absolute position.
          +
          +
          • +
        + + + +
          +
        • +

          getLine

          +
          int getLine()
          +
          Get the current line number of the tokenizer, starting at 1.
          +
          +
          Returns:
          +
          Get the current line number.
          +
          +
          • +
        + + + +
          +
        • +

          getColumn

          +
          int getColumn()
          +
          Get the current column number of the tokenizer, starting at 1.
          +
          +
          Returns:
          +
          Get the current column number.
          +
          +
          • +
        + + + +
          +
        • +

          getCurrentToken

          +
          IdlToken getCurrentToken()
          +
          Get the current IdlToken.
          +
          +
          Returns:
          +
          Return the current token type.
          +
          +
          • +
        + + + +
          +
        • +

          getCurrentTokenLine

          +
          int getCurrentTokenLine()
          +
          Get the line of the current token.
          +
          +
          Returns:
          +
          Return the line of the current token.
          +
          +
          • +
        + + + +
          +
        • +

          getCurrentTokenColumn

          +
          int getCurrentTokenColumn()
          +
          Get the column of the current token.
          +
          +
          Returns:
          +
          Return the column of the current token.
          +
          +
          • +
        + + + +
          +
        • +

          getCurrentTokenStart

          +
          int getCurrentTokenStart()
          +
          Get the start position of the current token.
          +
          +
          Returns:
          +
          Return the 0-based start position of the current token.
          +
          +
          • +
        + + + +
          +
        • +

          getCurrentTokenEnd

          +
          int getCurrentTokenEnd()
          +
          Get the end position of the curren token.
          +
          +
          Returns:
          +
          Return the 0-based end position of the current token.
          +
          +
          • +
        + + + +
          +
        • +

          getCurrentTokenSpan

          +
          default int getCurrentTokenSpan()
          +
          Get the length of the current token.
          +
          +
          Returns:
          +
          Return the current token span.
          +
          +
          • +
        + + + +
          +
        • +

          getCurrentTokenLocation

          +
          default SourceLocation getCurrentTokenLocation()
          +
          Get the source location of the current token.
          +
          +
          Returns:
          +
          Return the current token source location.
          +
          +
          • +
        + + + +
          +
        • +

          getCurrentTokenLexeme

          +
          default java.lang.CharSequence getCurrentTokenLexeme()
          +
          Get the lexeme of the current token.
          +
          +
          Returns:
          +
          Returns the lexeme of the current token.
          +
          +
          • +
        + + + +
          +
        • +

          getCurrentTokenStringSlice

          +
          java.lang.CharSequence getCurrentTokenStringSlice()
          +
          If the current token is a string or text block, get the parsed content as a CharSequence. + If the current token is an identifier, the lexeme of the identifier is returned.
          +
          +
          Returns:
          +
          Returns the parsed string content associated with the current token.
          +
          Throws:
          +
          ModelSyntaxException - if the current token is not a string, text block, or identifier.
          +
          +
          • +
        + + + +
          +
        • +

          getCurrentTokenNumberValue

          +
          java.lang.Number getCurrentTokenNumberValue()
          +
          If the current token is a number, get the associated parsed number.
          +
          +
          Returns:
          +
          Returns the parsed number associated with the current token.
          +
          Throws:
          +
          ModelSyntaxException - if the current token is not a number.
          +
          +
          • +
        + + + +
          +
        • +

          getCurrentTokenError

          +
          java.lang.String getCurrentTokenError()
          +
          If the current token is an error, get the error message associated with the token.
          +
          +
          Returns:
          +
          Returns the associated error message.
          +
          Throws:
          +
          ModelSyntaxException - if the current token is not an error.
          +
          +
          • +
        + + + +
          +
        • +

          expect

          +
          default void expect​(IdlToken token)
          +
          Assert that the current token is token. + +

          The tokenizer is not advanced after validating the current token.

          +
          +
          Parameters:
          +
          token - Token to expect.
          +
          Throws:
          +
          ModelSyntaxException - if the current token is unexpected.
          +
          +
          • +
        + + + +
          +
        • +

          expect

          +
          default IdlToken expect​(IdlToken... tokens)
          +
          Assert that the current token is one of tokens. + +

          The tokenizer is not advanced after validating the current token.

          +
          +
          Parameters:
          +
          tokens - Assert that the current token is one of these tokens.
          +
          Returns:
          +
          Returns the current token.
          +
          Throws:
          +
          ModelSyntaxException - if the current token is unexpected.
          +
          +
          • +
        + + + +
          +
        • +

          isCurrentLexeme

          +
          default boolean isCurrentLexeme​(java.lang.CharSequence chars)
          +
          Test if the current token lexeme is equal to the give chars.
          +
          +
          Parameters:
          +
          chars - Characters to compare the current lexeme against.
          +
          Returns:
          +
          Returns true if the current lexeme is equal to chars.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/loader/ModelAssembler.html b/javadoc/1.47.0/software/amazon/smithy/model/loader/ModelAssembler.html new file mode 100644 index 00000000000..5a5af838d62 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/loader/ModelAssembler.html @@ -0,0 +1,979 @@ + + + + + +ModelAssembler (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.loader
    +

    Class ModelAssembler

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.loader.ModelAssembler
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class ModelAssembler
+extends java.lang.Object
      +
      Assembles and validates a Model from documents, files, shapes, and + other sources. + +

      Validation vents are aggregated into a Set to ensure that + duplicate events are not emitted. + +

      Smithy models found on the class path can be discovered using + model discovery. Model discovery must be explicitly requested of + a ModelAssembler by invoking discoverModels() or + discoverModels(ClassLoader).

      +
      +
      See Also:
      +
      Model.assembler()
      +
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ALLOW_UNKNOWN_TRAITS

          +
          public static final java.lang.String ALLOW_UNKNOWN_TRAITS
          +
          Allow unknown traits rather than fail.
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        + + + +
          +
        • +

          DISABLE_JAR_CACHE

          +
          public static final java.lang.String DISABLE_JAR_CACHE
          +
          Sets URLConnection.setUseCaches(boolean) to false. + +

          When running in a build environment, using caches can cause exceptions + like `java.util.zip.ZipException: ZipFile invalid LOC header (bad signature)` + because a previously loaded JAR might change between builds. The + "assembler.disableJarCache" setting should be set to true when embedding + Smithy into an environment where this can occur.

          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ModelAssembler

          +
          public ModelAssembler()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          copy

          +
          public ModelAssembler copy()
          +
          Creates a copy of the current model assembler.
          +
          +
          Returns:
          +
          Returns the created model assembler copy.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          traitFactory

          +
          public ModelAssembler traitFactory​(TraitFactory traitFactory)
          +
          Uses a custom TraitFactory to resolve and configure traits.
          +
          +
          Parameters:
          +
          traitFactory - Trait factory to use instead of the default.
          +
          Returns:
          +
          Returns the assembler.
          +
          +
          • +
        + + + +
          +
        • +

          validatorFactory

          +
          public ModelAssembler validatorFactory​(ValidatorFactory validatorFactory)
          +
          Sets a custom ValidatorFactory used to dynamically resolve + validator definitions. + +

          Note that if you do not provide an explicit validatorFactory, a + default factory is utilized that uses service discovery.

          +
          +
          Parameters:
          +
          validatorFactory - Validator factory to use.
          +
          Returns:
          +
          Returns the assembler.
          +
          +
          • +
        + + + +
          +
        • +

          addValidator

          +
          public ModelAssembler addValidator​(Validator validator)
          +
          Registers a validator to be used when validating the model.
          +
          +
          Parameters:
          +
          validator - Validator to register.
          +
          Returns:
          +
          Returns the assembler.
          +
          +
          • +
        + + + +
          +
        • +

          addUnparsedModel

          +
          public ModelAssembler addUnparsedModel​(java.lang.String sourceLocation,
+                                       java.lang.String model)
          +
          Adds a string containing an unparsed model to the assembler. + +

          The provided sourceLocation string must end with + ".json" or ".smithy" to be parsed correctly.

          +
          +
          Parameters:
          +
          sourceLocation - Source location to assume for the unparsed content.
          +
          model - Unparsed model source.
          +
          Returns:
          +
          Returns the assembler.
          +
          +
          • +
        + + + +
          +
        • +

          addDocumentNode

          +
          public ModelAssembler addDocumentNode​(Node document)
          +
          Adds a parsed JSON model file as a Node to the assembler.
          +
          +
          Parameters:
          +
          document - Parsed document node to add.
          +
          Returns:
          +
          Returns the assembler.
          +
          +
          • +
        + + + +
          +
        • +

          addImport

          +
          public ModelAssembler addImport​(java.lang.String importPath)
          +
          Adds an import to the assembler.
          +
          +
          Parameters:
          +
          importPath - Import path to add.
          +
          Returns:
          +
          Returns the assembler.
          +
          See Also:
          +
          addImport(Path)
          +
          +
          • +
        + + + +
          +
        • +

          addImport

          +
          public ModelAssembler addImport​(java.nio.file.Path importPath)
          +
          Adds an import to the assembler. + +

          If a directory is found, all ".json" and ".ion" files that contain + a "smithy" key-value pair found in the directory and any subdirectories + are imported into the model.

          +
          +
          Parameters:
          +
          importPath - Import path to add.
          +
          Returns:
          +
          Returns the assembler.
          +
          +
          • +
        + + + +
          +
        • +

          addImport

          +
          public ModelAssembler addImport​(java.net.URL url)
          +
          Adds an import to the assembler from a URL. + +

          The provided URL can point to a .json model, .smithy model, or + a .jar file that contains Smithy models. + + 

          + 
+ Model model = Model.assembler()
+      .addImport(getClass().getClassLoader().getResource("model.json"))
+      .assemble()
+      .unwrap();
+ 
+
          +
          +
          Parameters:
          +
          url - Resource URL to load and add.
          +
          Returns:
          +
          Returns the assembler.
          +
          +
          • +
        + + + +
          +
        • +

          disablePrelude

          +
          public ModelAssembler disablePrelude()
          +
          Disables automatically loading the prelude models.
          +
          +
          Returns:
          +
          Returns the assembler.
          +
          +
          • +
        + + + +
          +
        • +

          addShape

          +
          public ModelAssembler addShape​(Shape shape)
          +
          Explicitly injects a shape into the assembled model.
          +
          +
          Parameters:
          +
          shape - Shape to add.
          +
          Returns:
          +
          Returns the assembler.
          +
          +
          • +
        + + + +
          +
        • +

          addShapes

          +
          public ModelAssembler addShapes​(Shape... shapes)
          +
          Explicitly injects multiple shapes into the assembled model.
          +
          +
          Parameters:
          +
          shapes - Shapes to add.
          +
          Returns:
          +
          Returns the assembler.
          +
          +
          • +
        + + + +
          +
        • +

          addTrait

          +
          public ModelAssembler addTrait​(ShapeId target,
+                               Trait trait)
          +
          Explicitly adds a trait to a shape in the assembled model.
          +
          +
          Parameters:
          +
          target - Shape to add the trait to.
          +
          trait - Trait to add.
          +
          Returns:
          +
          Returns the assembler.
          +
          +
          • +
        + + + +
          +
        • +

          addModel

          +
          public ModelAssembler addModel​(Model model)
          +
          Merges a loaded model into the model assembler.
          +
          +
          Parameters:
          +
          model - Model to merge in.
          +
          Returns:
          +
          Returns the model assembler.
          +
          +
          • +
        + + + +
          +
        • +

          putMetadata

          +
          public ModelAssembler putMetadata​(java.lang.String name,
+                                  Node value)
          +
          Adds metadata to the model.
          +
          +
          Parameters:
          +
          name - Metadata key to set.
          +
          value - Metadata value to set.
          +
          Returns:
          +
          Returns the model assembler.
          +
          +
          • +
        + + + +
          +
        • +

          discoverModels

          +
          public ModelAssembler discoverModels​(java.lang.ClassLoader loader)
          +
          Discovers models by merging in all models returns by ModelDiscovery + manifests using the provided ClassLoader.
          +
          +
          Parameters:
          +
          loader - Class loader to use to discover models.
          +
          Returns:
          +
          Returns the model assembler.
          +
          +
          • +
        + + + +
          +
        • +

          discoverModels

          +
          public ModelAssembler discoverModels()
          +
          Discovers models by merging in all models returns by ModelDiscovery + manifests using the thread context ClassLoader.
          +
          +
          Returns:
          +
          Returns the model assembler.
          +
          +
          • +
        + + + +
          +
        • +

          putProperty

          +
          public ModelAssembler putProperty​(java.lang.String setting,
+                                  java.lang.Object value)
          +
          Puts a configuration property on the ModelAssembler. + +

          Any number of properties can be given to the model assembler to + affect how models are loaded. Some properties like ALLOW_UNKNOWN_TRAITS + are built-in properties, while other properties can be custom + properties that are specific to certain ModelLoader + implementations. + +

          The following example configures the ModelAssembler to emit warnings + for unknown traits rather than fail: + + 

          
+ ModelAssembler assembler = Model.assembler();
+ assembler.putProperty(ModelAssembler.ALLOW_UNKNOWN_TRAITS, true);
+
          +
          +
          Parameters:
          +
          setting - Name of the property to put.
          +
          value - Value to set for the property.
          +
          Returns:
          +
          Returns the assembler.
          +
          +
          • +
        + + + +
          +
        • +

          removeProperty

          +
          public ModelAssembler removeProperty​(java.lang.String setting)
          +
          Removes a setting from the ModelAssembler.
          +
          +
          Parameters:
          +
          setting - Setting to remove.
          +
          Returns:
          +
          Returns the assembler.
          +
          +
          • +
        + + + +
          +
        • +

          disableValidation

          +
          public ModelAssembler disableValidation()
          +
          Disables additional validation of the model.
          +
          +
          Returns:
          +
          Returns the assembler.
          +
          +
          • +
        + + + +
          +
        • +

          validationEventListener

          +
          public ModelAssembler validationEventListener​(java.util.function.Consumer<ValidationEvent> eventListener)
          +
          Sets a listener that is invoked each time a ValidationEvent is encountered + while loading and validating the model. + +

          The consumer could be invoked simultaneously by multiple threads. It's + up to the consumer to perform any necessary synchronization. If a validator + or decorator throws, then there is no guarantee that all validation events + are emitted to the listener.

          +
          +
          Parameters:
          +
          eventListener - Listener invoked for each ValidationEvent.
          +
          Returns:
          +
          Returns the assembler.
          +
          +
          • +
        + + + +
          +
        • +

          assemble

          +
          public ValidatedResult<Model> assemble()
          +
          Assembles the model and returns the validated result.
          +
          +
          Returns:
          +
          Returns the validated result that optionally contains a Model + and validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/loader/ModelDiscovery.html b/javadoc/1.47.0/software/amazon/smithy/model/loader/ModelDiscovery.html new file mode 100644 index 00000000000..9f4c54f6ad9 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/loader/ModelDiscovery.html @@ -0,0 +1,440 @@ + + + + + +ModelDiscovery (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.loader
    +

    Class ModelDiscovery

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.loader.ModelDiscovery
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class ModelDiscovery
+extends java.lang.Object
      +
      Discovers Smithy models by finding all META-INF/smithy/manifest + files on the class path and loading all of the newline separated relative + model files referenced from the manifest. + +

      The URLs discovered through model discovery are imported into a + ModelAssembler when ModelAssembler.discoverModels(java.lang.ClassLoader) is + called, providing a mechanism for discovering Smithy models on the + classpath at runtime. + +

      The format of a META-INF/smithy/manifest file is a newline + separated UTF-8 text file in which each line is a resource that is + relative to the manifest file. A line is considered to be terminated + by any one of a line feed ('\n'), a carriage return ('\r'), a carriage + return followed immediately by a line feed, or by reaching the end-of-file + (EOF). The resources referenced by a manifest are loaded by resolving the + relative resource against the URL that contains each META-INF/smithy/manifest + file found using ClassLoader.getResources(java.lang.String). + +

      The following restrictions and interpretations apply to the names of + model resources that can be placed on manifest lines: + +

        +
      • Empty lines are ignored.
        • +
      • Lines that start with a number sign (#) are comments and are ignored.
        • +
      • Lines must contain only ASCII characters
        • +
      • Lines must not start with "/" or end with "/". Models are resolved + as relative resources to the manifest URL and expected to be + contained within the same JAR/JMOD as the manifest.
        • +
      • Lines must not contain empty segments (//).
        • +
      • Lines must not contain dot-dot segments (..).
        • +
      • Lines must not contain dot segments (/./) (./).
        • +
      • Lines must not contain spaces ( ) or tabs (\t).
        • +
      • Lines must not contain a backslash (\).
        • +
      • Lines must not contain a question mark (?).
        • +
      • Lines must not contain a percent sign (%).
        • +
      • Lines must not contain an asterisk (*).
        • +
      • Lines must not contain a colon (:).
        • +
      • Lines must not contain a vertical bar (|).
        • +
      • Lines must not contain a quote (") or (').
        • +
      • Lines must not contain greater than (>) or less than (<) signs.
        • +
      • Lines must not contain pound signs (#).
        • +
      + +

      For example, given the following META-INF/smithy/manifest file + discovered at jar:file:///C:/foo/baz/bar.jar!/META-INF/smithy/manifest + on the class path, + + 

      + smithy.example.traits.smithy
+ foo/another.file.smithy
+
      + +

      Smithy will attempt to discover the following models: + +

        +
      • jar:file:///C:/foo/baz/bar.jar!/META-INF/smithy/smithy.example.traits.smithy
        • +
      • jar:file:///C:/foo/baz/bar.jar!/META-INF/smithy/foo/another.file.smithy
        • +
      + +

      Models defined in META-INF/smithy should be named after the + namespace that is defined within the file. Files that define multiple + namespaces are free to use whatever naming scheming they choose, but + model files should be globally unique in an application.

      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static java.net.URLcreateSmithyJarManifestUrl​(java.lang.String fileOrUrl) +
        Creates a URL that points to the Smithy manifest file of a JAR.
        +
        static java.util.List<java.net.URL>findModels() +
        Finds Smithy models using the thread context ClassLoader.
        +
        static java.util.List<java.net.URL>findModels​(java.lang.ClassLoader loader) +
        Finds Smithy models using the given ClassLoader.
        +
        static java.util.List<java.net.URL>findModels​(java.net.URL jarManifestUrl) +
        Parse the Smithy models from the given URL that points to a Smithy + manifest file in a JAR.
        +
        static java.lang.StringgetSmithyModelPathFromJarUrl​(java.net.URL modelUrl) +
        Extracts the relative name of a Smithy model from a URL that points to + a Smithy model returned from findModels().
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + +
          +
        • +

          findModels

          +
          public static java.util.List<java.net.URL> findModels()
          +
          Finds Smithy models using the thread context ClassLoader.
          +
          +
          Returns:
          +
          Returns the URLs of each model referenced by manifests.
          +
          +
          • +
        + + + +
          +
        • +

          findModels

          +
          public static java.util.List<java.net.URL> findModels​(java.lang.ClassLoader loader)
          +
          Finds Smithy models using the given ClassLoader.
          +
          +
          Parameters:
          +
          loader - ClassLoader used to discover models.
          +
          Returns:
          +
          Returns the URLs of each model referenced by manifests.
          +
          +
          • +
        + + + +
          +
        • +

          findModels

          +
          public static java.util.List<java.net.URL> findModels​(java.net.URL jarManifestUrl)
          +
          Parse the Smithy models from the given URL that points to a Smithy + manifest file in a JAR. + +

          The provided URL is expected to point to a manifest stored in JAR + (e.g., "jar:file:/example.jar!/META-INF/smithy/manifest).

          +
          +
          Parameters:
          +
          jarManifestUrl - Manifest URL to parse line by line.
          +
          Returns:
          +
          Returns the URLs of each model referenced by the manifest.
          +
          +
          • +
        + + + +
          +
        • +

          getSmithyModelPathFromJarUrl

          +
          public static java.lang.String getSmithyModelPathFromJarUrl​(java.net.URL modelUrl)
          +
          Extracts the relative name of a Smithy model from a URL that points to + a Smithy model returned from findModels(). + +

          For example, given "jar:file:/example.jar!/META-INF/smithy/example.json", + this method will return "example.json".

          +
          +
          Parameters:
          +
          modelUrl - Model URL to get the name from.
          +
          Returns:
          +
          Returns the extracted name.
          +
          +
          • +
        + + + +
          +
        • +

          createSmithyJarManifestUrl

          +
          public static java.net.URL createSmithyJarManifestUrl​(java.lang.String fileOrUrl)
          +
          Creates a URL that points to the Smithy manifest file of a JAR. + +

          The provided fileOrUrl string can be an absolute path + to a file, (e.g., "/foo/baz.jar"), a file URL (e.g., "file:/baz.jar"), + or a JAR URL (e.g., "jar:file:/baz.jar").

          +
          +
          Parameters:
          +
          fileOrUrl - Filename or URL that points to a JAR.
          +
          Returns:
          +
          Returns the computed URL.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/loader/ModelImportException.html b/javadoc/1.47.0/software/amazon/smithy/model/loader/ModelImportException.html new file mode 100644 index 00000000000..5d10d344f6c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/loader/ModelImportException.html @@ -0,0 +1,312 @@ + + + + + +ModelImportException (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.loader
    +

    Class ModelImportException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Throwable
        • +
      • +
          +
        • java.lang.Exception
          • +
        • +
            +
          • java.lang.RuntimeException
            • +
          • +
              +
            • software.amazon.smithy.model.loader.ModelImportException
              • +
            +
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      public class ModelImportException
+extends java.lang.RuntimeException
      +
      Exception thrown when a model fails to be imported.
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        ModelImportException​(java.lang.String message) 
        ModelImportException​(java.lang.String message, + java.lang.Throwable cause) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ModelImportException

          +
          public ModelImportException​(java.lang.String message)
          +
          • +
        + + + +
          +
        • +

          ModelImportException

          +
          public ModelImportException​(java.lang.String message,
+                            java.lang.Throwable cause)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/loader/ModelManifestException.html b/javadoc/1.47.0/software/amazon/smithy/model/loader/ModelManifestException.html new file mode 100644 index 00000000000..9a25db06530 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/loader/ModelManifestException.html @@ -0,0 +1,311 @@ + + + + + +ModelManifestException (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.loader
    +

    Class ModelManifestException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Throwable
        • +
      • +
          +
        • java.lang.Exception
          • +
        • +
            +
          • java.lang.RuntimeException
            • +
          • +
              +
            • software.amazon.smithy.model.loader.ModelManifestException
              • +
            +
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      public class ModelManifestException
+extends java.lang.RuntimeException
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ModelManifestException

          +
          public ModelManifestException​(java.lang.String message,
+                              java.lang.Throwable parent)
          +
          • +
        + + + +
          +
        • +

          ModelManifestException

          +
          public ModelManifestException​(java.lang.String message)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/loader/ModelSyntaxException.html b/javadoc/1.47.0/software/amazon/smithy/model/loader/ModelSyntaxException.html new file mode 100644 index 00000000000..c90b027c196 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/loader/ModelSyntaxException.html @@ -0,0 +1,392 @@ + + + + + +ModelSyntaxException (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.loader
    +

    Class ModelSyntaxException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        ShapeIdtoShapeId() 
        + +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ModelSyntaxException

          +
          public ModelSyntaxException​(java.lang.String message,
+                            int line,
+                            int column)
          +
          • +
        + + + +
          +
        • +

          ModelSyntaxException

          +
          public ModelSyntaxException​(java.lang.String message,
+                            java.lang.String filename,
+                            int line,
+                            int column)
          +
          • +
        + + + +
          +
        • +

          ModelSyntaxException

          +
          public ModelSyntaxException​(java.lang.String message,
+                            FromSourceLocation sourceLocation)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          toShapeId

          +
          public ShapeId toShapeId()
          +
          +
          Specified by:
          +
          toShapeId in interface ToShapeId
          +
          Returns:
          +
          Returns the shape ID of an object.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/loader/ParserUtils.html b/javadoc/1.47.0/software/amazon/smithy/model/loader/ParserUtils.html new file mode 100644 index 00000000000..bd2ef84ca11 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/loader/ParserUtils.html @@ -0,0 +1,584 @@ + + + + + +ParserUtils (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.loader
    +

    Class ParserUtils

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.loader.ParserUtils
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class ParserUtils
+extends java.lang.Object
      +
      Utility methods that act on a SimpleParser and parse + Smithy grammar productions.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static voidconsumeIdentifier​(SimpleParser parser) +
        Expects and skips over a Smithy identifier production.
        +
        static voidconsumeNamespace​(SimpleParser parser) +
        Expects and consumes a valid Smithy shape ID namespace.
        +
        static booleanisAlphabetic​(char c) +
        Returns true if the given character is an alphabetic character + A-Z, a-z.
        +
        static booleanisAlphabetic​(int c) +
        Returns true if the given character is an alphabetic character + A-Z, a-z.
        +
        static booleanisDigit​(char c) +
        Returns true if the given value is a digit 0-9.
        +
        static booleanisDigit​(int c) +
        Returns true if the given value is a digit 0-9.
        +
        static booleanisIdentifierStart​(char c) +
        Returns true if the given character is allowed to start an identifier.
        +
        static booleanisIdentifierStart​(int c) +
        Returns true if the given character is allowed to start an identifier.
        +
        static booleanisValidIdentifierCharacter​(char c) +
        Returns true if the given character is allowed in an identifier.
        +
        static booleanisValidIdentifierCharacter​(int c) +
        Returns true if the given character is allowed in an identifier.
        +
        static java.lang.StringparseIdentifier​(SimpleParser parser) +
        Expects and returns a parsed Smithy identifier production.
        +
        static java.lang.StringparseNumber​(SimpleParser parser) +
        Parses a Smithy number production into a string.
        +
        static java.lang.StringparseRootShapeId​(SimpleParser parser) +
        Expects and returns a parsed absolute Smithy Shape ID that + does not include a member.
        +
        static java.lang.StringparseShapeId​(SimpleParser parser) +
        Expects and returns a parsed relative or absolute Smithy Shape ID.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + +
          +
        • +

          parseNumber

          +
          public static java.lang.String parseNumber​(SimpleParser parser)
          +
          Parses a Smithy number production into a string. + + 
          -?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?
          +
          +
          Parameters:
          +
          parser - Parser to consume tokens from.
          +
          Returns:
          +
          Returns the parsed number lexeme.
          +
          +
          • +
        + + + +
          +
        • +

          parseIdentifier

          +
          public static java.lang.String parseIdentifier​(SimpleParser parser)
          +
          Expects and returns a parsed Smithy identifier production.
          +
          +
          Parameters:
          +
          parser - Parser to consume tokens from.
          +
          Returns:
          +
          Returns the parsed identifier.
          +
          +
          • +
        + + + +
          +
        • +

          parseRootShapeId

          +
          public static java.lang.String parseRootShapeId​(SimpleParser parser)
          +
          Expects and returns a parsed absolute Smithy Shape ID that + does not include a member.
          +
          +
          Parameters:
          +
          parser - Parser to consume tokens from.
          +
          Returns:
          +
          Returns the parsed Shape ID as a string.
          +
          +
          • +
        + + + +
          +
        • +

          parseShapeId

          +
          public static java.lang.String parseShapeId​(SimpleParser parser)
          +
          Expects and returns a parsed relative or absolute Smithy Shape ID.
          +
          +
          Parameters:
          +
          parser - Parser to consume tokens from.
          +
          Returns:
          +
          Returns the parsed Shape ID as a string.
          +
          +
          • +
        + + + +
          +
        • +

          consumeNamespace

          +
          public static void consumeNamespace​(SimpleParser parser)
          +
          Expects and consumes a valid Smithy shape ID namespace.
          +
          +
          Parameters:
          +
          parser - Parser to consume tokens from.
          +
          +
          • +
        + + + +
          +
        • +

          consumeIdentifier

          +
          public static void consumeIdentifier​(SimpleParser parser)
          +
          Expects and skips over a Smithy identifier production. + + 
          +     identifier       = identifier_start *identifier_chars
+     identifier_start = *"_" ALPHA
+     identifier_chars = ALPHA / DIGIT / "_"
+
          +
          +
          Parameters:
          +
          parser - Parser to consume tokens from.
          +
          +
          • +
        + + + +
          +
        • +

          isValidIdentifierCharacter

          +
          public static boolean isValidIdentifierCharacter​(char c)
          +
          Returns true if the given character is allowed in an identifier.
          +
          +
          Parameters:
          +
          c - Character to check.
          +
          Returns:
          +
          Returns true if the character is allowed in an identifier.
          +
          +
          • +
        + + + +
          +
        • +

          isValidIdentifierCharacter

          +
          public static boolean isValidIdentifierCharacter​(int c)
          +
          Returns true if the given character is allowed in an identifier.
          +
          +
          Parameters:
          +
          c - Character to check.
          +
          Returns:
          +
          Returns true if the character is allowed in an identifier.
          +
          +
          • +
        + + + +
          +
        • +

          isIdentifierStart

          +
          public static boolean isIdentifierStart​(char c)
          +
          Returns true if the given character is allowed to start an identifier.
          +
          +
          Parameters:
          +
          c - Character to check.
          +
          Returns:
          +
          Returns true if the character can start an identifier.
          +
          +
          • +
        + + + +
          +
        • +

          isIdentifierStart

          +
          public static boolean isIdentifierStart​(int c)
          +
          Returns true if the given character is allowed to start an identifier.
          +
          +
          Parameters:
          +
          c - Character to check.
          +
          Returns:
          +
          Returns true if the character can start an identifier.
          +
          +
          • +
        + + + +
          +
        • +

          isDigit

          +
          public static boolean isDigit​(char c)
          +
          Returns true if the given value is a digit 0-9.
          +
          +
          Parameters:
          +
          c - Character to check.
          +
          Returns:
          +
          Returns true if the character is a digit.
          +
          +
          • +
        + + + +
          +
        • +

          isDigit

          +
          public static boolean isDigit​(int c)
          +
          Returns true if the given value is a digit 0-9.
          +
          +
          Parameters:
          +
          c - Character to check.
          +
          Returns:
          +
          Returns true if the character is a digit.
          +
          +
          • +
        + + + +
          +
        • +

          isAlphabetic

          +
          public static boolean isAlphabetic​(char c)
          +
          Returns true if the given character is an alphabetic character + A-Z, a-z. This is a stricter version of Character.isAlphabetic(int).
          +
          +
          Parameters:
          +
          c - Character to check.
          +
          Returns:
          +
          Returns true if the character is an alphabetic character.
          +
          +
          • +
        + + + +
          +
        • +

          isAlphabetic

          +
          public static boolean isAlphabetic​(int c)
          +
          Returns true if the given character is an alphabetic character + A-Z, a-z. This is a stricter version of Character.isAlphabetic(int).
          +
          +
          Parameters:
          +
          c - Character to check.
          +
          Returns:
          +
          Returns true if the character is an alphabetic character.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/loader/Prelude.html b/javadoc/1.47.0/software/amazon/smithy/model/loader/Prelude.html new file mode 100644 index 00000000000..4c95d0b4cfc --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/loader/Prelude.html @@ -0,0 +1,359 @@ + + + + + +Prelude (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.loader
    +

    Class Prelude

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.loader.Prelude
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class Prelude
+extends java.lang.Object
      +
      Represents the prelude model available to every Smithy model. + +

      The prelude consists of public prelude shapes like + smithy.api#String and traits that are available to + all models like box and required. + +

      A key design requirement of the prelude is that it cannot require a + loaded prelude model in order to reason about the prelude as this would + result in infinite recursion while loading the prelude model.

      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        static java.lang.StringNAMESPACE +
        The Smithy prelude namespace.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static booleanisPreludeShape​(ToShapeId id) +
        Checks if the given shape ID is defined by the prelude.
        +
        static booleanisPublicPreludeShape​(ToShapeId id) +
        Checks if the given shape is a public shape or trait defined by the + prelude.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Field Detail

        + + + +
          +
        • +

          NAMESPACE

          +
          public static final java.lang.String NAMESPACE
          +
          The Smithy prelude namespace.
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          isPreludeShape

          +
          public static boolean isPreludeShape​(ToShapeId id)
          +
          Checks if the given shape ID is defined by the prelude. + +

          Specifically, this checks if the namespace of the provided shape ID + is equal to smithy.api.

          +
          +
          Parameters:
          +
          id - Shape ID to check.
          +
          Returns:
          +
          Returns true if the shape is a prelude shape.
          +
          +
          • +
        + + + +
          +
        • +

          isPublicPreludeShape

          +
          public static boolean isPublicPreludeShape​(ToShapeId id)
          +
          Checks if the given shape is a public shape or trait defined by the + prelude.
          +
          +
          Parameters:
          +
          id - Shape to check.
          +
          Returns:
          +
          Returns true if the shape is a public prelude shape.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/loader/StringTable.html b/javadoc/1.47.0/software/amazon/smithy/model/loader/StringTable.html new file mode 100644 index 00000000000..b822dc266dc --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/loader/StringTable.html @@ -0,0 +1,346 @@ + + + + + +StringTable (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.loader
    +

    Class StringTable

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.loader.StringTable
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.util.function.Function<java.lang.CharSequence,​java.lang.String>
      +
      +
      +
      public final class StringTable
+extends java.lang.Object
+implements java.util.function.Function<java.lang.CharSequence,​java.lang.String>
      +
      This is a simple, not thread-safe, caching string table that converts CharSequence to String objects. + +

      The implementation uses an FNV-1a hash, and collisions simply overwrite the previously cached value.

      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        StringTable() +
        Create a string table with 2048 entries.
        +
        StringTable​(int sizeBits) +
        Create a string table with a specific number of entries.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.lang.Stringapply​(java.lang.CharSequence chars) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

          Methods inherited from interface java.util.function.Function

          +andThen, compose
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          StringTable

          +
          public StringTable()
          +
          Create a string table with 2048 entries.
          +
          • +
        + + + +
          +
        • +

          StringTable

          +
          public StringTable​(int sizeBits)
          +
          Create a string table with a specific number of entries.
          +
          +
          Parameters:
          +
          sizeBits - Size of the table based on bit shifting (e.g., 1 -> 2, 2 -> 4, ..., 10 -> 1024, 11 -> 2048).
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          apply

          +
          public java.lang.String apply​(java.lang.CharSequence chars)
          +
          +
          Specified by:
          +
          apply in interface java.util.function.Function<java.lang.CharSequence,​java.lang.String>
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/loader/TopologicalShapeSort.CycleException.html b/javadoc/1.47.0/software/amazon/smithy/model/loader/TopologicalShapeSort.CycleException.html new file mode 100644 index 00000000000..dd48fc109c1 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/loader/TopologicalShapeSort.CycleException.html @@ -0,0 +1,366 @@ + + + + + +TopologicalShapeSort.CycleException (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.loader
    +

    Class TopologicalShapeSort.CycleException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Throwable
        • +
      • +
          +
        • java.lang.Exception
          • +
        • +
            +
          • java.lang.RuntimeException
            • +
          • +
              +
            • software.amazon.smithy.model.loader.TopologicalShapeSort.CycleException
              • +
            +
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      Enclosing class:
      +
      TopologicalShapeSort
      +
      +
      +
      public static final class TopologicalShapeSort.CycleException
+extends java.lang.RuntimeException
      +
      Thrown when cycles exist between shapes.
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        CycleException​(java.util.Set<ShapeId> unresolved, + java.util.List<ShapeId> resolved) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.util.List<ShapeId>getResolved() 
        java.util.Set<ShapeId>getUnresolved() +
        Gets the entire set of shapes that could not be resolved.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CycleException

          +
          public CycleException​(java.util.Set<ShapeId> unresolved,
+                      java.util.List<ShapeId> resolved)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getUnresolved

          +
          public java.util.Set<ShapeId> getUnresolved()
          +
          Gets the entire set of shapes that could not be resolved.
          +
          +
          Returns:
          +
          Returns the set of unresolved shapes.
          +
          +
          • +
        + + + +
          +
        • +

          getResolved

          +
          public java.util.List<ShapeId> getResolved()
          +
          +
          Returns:
          +
          Returns the set of resolved shapes.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/loader/TopologicalShapeSort.html b/javadoc/1.47.0/software/amazon/smithy/model/loader/TopologicalShapeSort.html new file mode 100644 index 00000000000..e6ec36f6405 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/loader/TopologicalShapeSort.html @@ -0,0 +1,387 @@ + + + + + +TopologicalShapeSort (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.loader
    +

    Class TopologicalShapeSort

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.loader.TopologicalShapeSort
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class TopologicalShapeSort
+extends java.lang.Object
      +
      Topologically sorts shapes based on their dependencies (i.e., mixins). + +

      While this class is reusable, it is also stateful; shapes and edges + are enqueued, and when sorted, all shapes and edges are dequeued.

      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static class TopologicalShapeSort.CycleException +
        Thrown when cycles exist between shapes.
        +
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.util.List<ShapeId>dequeueSortedShapes() +
        Sort the shapes and returns the ordered list of shape IDs.
        +
        voidenqueue​(Shape shape) +
        Add a shape to the sort queue, and automatically extract dependencies.
        +
        voidenqueue​(ShapeId shape, + java.util.Collection<ShapeId> dependencies) +
        Add a shape to the sort queue, and provide an explicit dependencies list.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          TopologicalShapeSort

          +
          public TopologicalShapeSort()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          enqueue

          +
          public void enqueue​(Shape shape)
          +
          Add a shape to the sort queue, and automatically extract dependencies.
          +
          +
          Parameters:
          +
          shape - Shape to add.
          +
          +
          • +
        + + + +
          +
        • +

          enqueue

          +
          public void enqueue​(ShapeId shape,
+                    java.util.Collection<ShapeId> dependencies)
          +
          Add a shape to the sort queue, and provide an explicit dependencies list.
          +
          +
          Parameters:
          +
          shape - Shape to add.
          +
          dependencies - Dependencies of the shape.
          +
          +
          • +
        + + + +
          +
        • +

          dequeueSortedShapes

          +
          public java.util.List<ShapeId> dequeueSortedShapes()
          +
          Sort the shapes and returns the ordered list of shape IDs.
          +
          +
          Returns:
          +
          Returns the topologically sorted list of shape IDs.
          +
          Throws:
          +
          TopologicalShapeSort.CycleException - if cycles exist between shapes.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/loader/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/model/loader/package-summary.html new file mode 100644 index 00000000000..a7479706c3d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/loader/package-summary.html @@ -0,0 +1,267 @@ + + + + + +software.amazon.smithy.model.loader (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.model.loader

    +
    +
    +
      +
    • + + + + + + + + + + + + +
      Interface Summary 
      InterfaceDescription
      IdlTokenizer +
      Iterates over a Smithy IDL model as a series of tokens.
      +
      +
      • +
    • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      ModelAssembler +
      Assembles and validates a Model from documents, files, shapes, and + other sources.
      +
      ModelDiscovery +
      Discovers Smithy models by finding all META-INF/smithy/manifest + files on the class path and loading all of the newline separated relative + model files referenced from the manifest.
      +
      ParserUtils +
      Utility methods that act on a SimpleParser and parse + Smithy grammar productions.
      +
      Prelude +
      Represents the prelude model available to every Smithy model.
      +
      StringTable +
      This is a simple, not thread-safe, caching string table that converts CharSequence to String objects.
      +
      TopologicalShapeSort +
      Topologically sorts shapes based on their dependencies (i.e., mixins).
      +
      +
      • +
    • + + + + + + + + + + + + +
      Enum Summary 
      EnumDescription
      IdlToken +
      Represents a parsed token from the Smithy IDL.
      +
      +
      • +
    • + + + + + + + + + + + + + + + + + + + + + + + + +
      Exception Summary 
      ExceptionDescription
      ModelImportException +
      Exception thrown when a model fails to be imported.
      +
      ModelManifestException 
      ModelSyntaxException +
      Thrown when the syntax of the IDL is invalid.
      +
      TopologicalShapeSort.CycleException +
      Thrown when cycles exist between shapes.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/loader/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/model/loader/package-tree.html new file mode 100644 index 00000000000..18f8a88ad2c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/loader/package-tree.html @@ -0,0 +1,210 @@ + + + + + +software.amazon.smithy.model.loader Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.model.loader

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    +
      +
    • java.util.Iterator<E> + +
      • +
    +
    +
    +

    Enum Hierarchy

    +
      +
    • java.lang.Object +
        +
      • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) +
          +
        • software.amazon.smithy.model.loader.IdlToken
          • +
        +
        • +
      +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/loader/sourcecontext/SourceContextLoader.Line.html b/javadoc/1.47.0/software/amazon/smithy/model/loader/sourcecontext/SourceContextLoader.Line.html new file mode 100644 index 00000000000..96bf51daca3 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/loader/sourcecontext/SourceContextLoader.Line.html @@ -0,0 +1,395 @@ + + + + + +SourceContextLoader.Line (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.loader.sourcecontext
    +

    Class SourceContextLoader.Line

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.loader.sourcecontext.SourceContextLoader.Line
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing interface:
      +
      SourceContextLoader
      +
      +
      +
      public static final class SourceContextLoader.Line
+extends java.lang.Object
      +
      A pair of line numbers to the contents of lines.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Line​(int lineNumber, + java.lang.CharSequence content) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        booleanequals​(java.lang.Object o) 
        java.lang.CharSequencegetContent() +
        Returns the content as a CharSequence.
        +
        intgetLineNumber() +
        Get the line number of the line, starting at 1.
        +
        inthashCode() 
        java.lang.StringtoString() 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Line

          +
          public Line​(int lineNumber,
+            java.lang.CharSequence content)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getLineNumber

          +
          public int getLineNumber()
          +
          Get the line number of the line, starting at 1.
          +
          +
          Returns:
          +
          Returns the 1-based line number.
          +
          +
          • +
        + + + +
          +
        • +

          getContent

          +
          public java.lang.CharSequence getContent()
          +
          Returns the content as a CharSequence. + +

          CharSequence is used here to allow implementations to potentially use things like CharBuffer slices.

          +
          +
          Returns:
          +
          The content of the line.
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/loader/sourcecontext/SourceContextLoader.html b/javadoc/1.47.0/software/amazon/smithy/model/loader/sourcecontext/SourceContextLoader.html new file mode 100644 index 00000000000..098c4996709 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/loader/sourcecontext/SourceContextLoader.html @@ -0,0 +1,335 @@ + + + + + +SourceContextLoader (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.loader.sourcecontext
    +

    Interface SourceContextLoader

    +
    +
    +
    +
      +
    • +
      +
      public interface SourceContextLoader
      +
      Loads lines of text from source location files to display in things like error messages.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          loadContext

          +
          java.util.Collection<SourceContextLoader.Line> loadContext​(FromSourceLocation location)
          +
          Attempts to load a file and return contextual source lines for the given source location.
          +
          +
          Parameters:
          +
          location - Source location to load.
          +
          Returns:
          +
          Returns the loaded source lines.
          +
          +
          • +
        + + + +
          +
        • +

          createLineBasedLoader

          +
          static SourceContextLoader createLineBasedLoader​(int defaultCodeLines)
          +
          Load context and include defaultCodeLines lines leading up to the target line.
          +
          +
          Parameters:
          +
          defaultCodeLines - Number of leading lines to include leading up to the target. Must be greater than 0.
          +
          Returns:
          +
          Returns the loader.
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if defaultCodeLines is less than 1.
          +
          +
          • +
        + + + +
          +
        • +

          createModelAwareLoader

          +
          static SourceContextLoader createModelAwareLoader​(Model model,
+                                                  int defaultCodeLinesHint)
          +
          Load context and include the most relevant information possible based on the kind of FromSourceLocation.
          +
          +
          Parameters:
          +
          defaultCodeLinesHint - Limits the number of context lines in some cases. Must be greater than 0.
          +
          Returns:
          +
          Returns the loader.
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if defaultCodeLinesHint is less than 1.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/loader/sourcecontext/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/model/loader/sourcecontext/package-summary.html new file mode 100644 index 00000000000..9e50d7db652 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/loader/sourcecontext/package-summary.html @@ -0,0 +1,183 @@ + + + + + +software.amazon.smithy.model.loader.sourcecontext (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.model.loader.sourcecontext

    +
    +
    +
      +
    • + + + + + + + + + + + + +
      Interface Summary 
      InterfaceDescription
      SourceContextLoader +
      Loads lines of text from source location files to display in things like error messages.
      +
      +
      • +
    • + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      SourceContextLoader.Line +
      A pair of line numbers to the contents of lines.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/loader/sourcecontext/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/model/loader/sourcecontext/package-tree.html new file mode 100644 index 00000000000..0990e79b7d9 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/loader/sourcecontext/package-tree.html @@ -0,0 +1,167 @@ + + + + + +software.amazon.smithy.model.loader.sourcecontext Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.model.loader.sourcecontext

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/neighbor/NeighborProvider.html b/javadoc/1.47.0/software/amazon/smithy/model/neighbor/NeighborProvider.html new file mode 100644 index 00000000000..6575757d31e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/neighbor/NeighborProvider.html @@ -0,0 +1,467 @@ + + + + + +NeighborProvider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.neighbor
    +

    Interface NeighborProvider

    +
    +
    +
    +
      +
    • +
      +
      Functional Interface:
      +
      This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
      +
      +
      +
      @FunctionalInterface
+public interface NeighborProvider
      +
      Provides the neighbor relationships for a given shape.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getNeighbors

          +
          java.util.List<Relationship> getNeighbors​(Shape shape)
          +
          Gets the neighbor relationships of a shape.
          +
          +
          Parameters:
          +
          shape - Shape to get neighbors for.
          +
          Returns:
          +
          Returns the found neighbors.
          +
          +
          • +
        + + + +
          +
        • +

          of

          +
          static NeighborProvider of​(Model model)
          +
          Creates a default NeighborProvider for the given model.
          +
          +
          Parameters:
          +
          model - Model to create a neighbor provider for.
          +
          Returns:
          +
          Returns the created neighbor provider.
          +
          +
          • +
        + + + +
          +
        • +

          precomputed

          +
          static NeighborProvider precomputed​(Model model)
          +
          Creates a NeighborProvider that precomputes the neighbors of a model.
          +
          +
          Parameters:
          +
          model - Model to create a neighbor provider for.
          +
          Returns:
          +
          Returns the created neighbor provider.
          +
          +
          • +
        + + + +
          +
        • +

          withTraitRelationships

          +
          static NeighborProvider withTraitRelationships​(Model model,
+                                               NeighborProvider neighborProvider)
          +
          Creates a NeighborProvider that includes RelationshipType.TRAIT + relationships.
          +
          +
          Parameters:
          +
          model - Model to use to look up trait shapes.
          +
          neighborProvider - Provider to wrap.
          +
          Returns:
          +
          Returns the created neighbor provider.
          +
          +
          • +
        + + + +
          +
        • +

          withIdRefRelationships

          +
          static NeighborProvider withIdRefRelationships​(Model model,
+                                               NeighborProvider neighborProvider)
          +
          Creates a NeighborProvider that includes RelationshipType.ID_REF + relationships.
          +
          +
          Parameters:
          +
          model - Model to use to look up shapes referenced by IdRefTrait.
          +
          neighborProvider - Provider to wrap.
          +
          Returns:
          +
          Returns the created neighbor provider.
          +
          +
          • +
        + + + +
          +
        • +

          precomputed

          +
          static NeighborProvider precomputed​(Model model,
+                                    NeighborProvider provider)
          +
          Creates a NeighborProvider that precomputes the neighbors of a model.
          +
          +
          Parameters:
          +
          model - Model to create a neighbor provider for.
          +
          provider - Provider to use when precomputing.
          +
          Returns:
          +
          Returns the created neighbor provider.
          +
          +
          • +
        + + + +
          +
        • +

          reverse

          +
          static NeighborProvider reverse​(Model model)
          +
          Returns a NeighborProvider that returns relationships that point at a + given shape rather than relationships that the given shape points at.
          +
          +
          Parameters:
          +
          model - Model to build reverse relationships from.
          +
          Returns:
          +
          Returns the reverse neighbor provider.
          +
          +
          • +
        + + + +
          +
        • +

          reverse

          +
          static NeighborProvider reverse​(Model model,
+                                NeighborProvider forwardProvider)
          +
          Returns a NeighborProvider that returns relationships that point at a + given shape rather than relationships that the given shape points at.
          +
          +
          Parameters:
          +
          model - Model to build reverse relationships from.
          +
          forwardProvider - The forward directed neighbor provider to grab relationships from.
          +
          Returns:
          +
          Returns the reverse neighbor provider.
          +
          +
          • +
        + + + +
          +
        • +

          cached

          +
          static NeighborProvider cached​(NeighborProvider provider)
          +
          Caches the results of calling a delegate provider.
          +
          +
          Parameters:
          +
          provider - Provider to delegate to and cache.
          +
          Returns:
          +
          Returns the thread-safe caching neighbor provider.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/neighbor/Relationship.html b/javadoc/1.47.0/software/amazon/smithy/model/neighbor/Relationship.html new file mode 100644 index 00000000000..d3c9d2cc33c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/neighbor/Relationship.html @@ -0,0 +1,531 @@ + + + + + +Relationship (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.neighbor
    +

    Class Relationship

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.neighbor.Relationship
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class Relationship
+extends java.lang.Object
      +
      Represent a direct relationship between two shapes. + +

      A relationship is a connection between two shapes. See + RelationshipType for documentation on the possible + types of relationships.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          create

          +
          public static Relationship create​(Shape shape,
+                                  RelationshipType relationshipType,
+                                  Shape neighborShape)
          +
          Constructs a valid shape relationship where the neighbor is present.
          +
          +
          Parameters:
          +
          shape - The shape the relationship originates from.
          +
          relationshipType - The relationshipType of relationship.
          +
          neighborShape - The shape the relationship targets.
          +
          Returns:
          +
          Returns the created Relationship.
          +
          +
          • +
        + + + +
          +
        • +

          createInvalid

          +
          public static Relationship createInvalid​(Shape shape,
+                                         RelationshipType relationshipType,
+                                         ShapeId neighborShapeId)
          +
          Constructs an invalid shape relationship where the neighbor is not present.
          +
          +
          Parameters:
          +
          shape - The shape the relationship originates from.
          +
          relationshipType - The relationshipType of relationship.
          +
          neighborShapeId - The shape the relationship targets.
          +
          Returns:
          +
          Returns the created Relationship.
          +
          +
          • +
        + + + +
          +
        • +

          getShape

          +
          public Shape getShape()
          +
          Gets the starting shape in the relationship.
          +
          +
          Returns:
          +
          Returns the shape the relationship is from.
          +
          +
          • +
        + + + +
          +
        • +

          getRelationshipType

          +
          public RelationshipType getRelationshipType()
          +
          Gets the relationship type.
          +
          +
          Returns:
          +
          Returns the relationship type.
          +
          +
          • +
        + + + +
          +
        • +

          getNeighborShapeId

          +
          public ShapeId getNeighborShapeId()
          +
          Gets the shape id of the neighbor shape.
          +
          +
          Returns:
          +
          Returns the shape id of the neighbor shape.
          +
          +
          • +
        + + + +
          +
        • +

          getNeighborShape

          +
          public java.util.Optional<Shape> getNeighborShape()
          +
          Gets the optional neighbor shape; the neighbor shape may be empty + when the neighbor shape id was not in the model.
          +
          +
          Returns:
          +
          Returns the optional neighbor shape.
          +
          +
          • +
        + + + +
          +
        • +

          expectNeighborShape

          +
          public Shape expectNeighborShape()
          +
          Gets the neighbor shape or throws if it doesn't exist.
          +
          +
          Returns:
          +
          Returns the neighbor shape.
          +
          Throws:
          +
          ExpectationNotMetException - if the neighbor is missing.
          +
          +
          • +
        + + + +
          +
        • +

          getSelectorLabel

          +
          public java.util.Optional<java.lang.String> getSelectorLabel()
          +
          Gets the token that is used in Selector expressions when + referring to the relationship or an empty Optional if this + relationship is not used in a selector.
          +
          +
          Returns:
          +
          Returns the optionally present selector token for this relationship.
          +
          +
          • +
        + + + +
          +
        • +

          getDirection

          +
          public RelationshipDirection getDirection()
          +
          Gets the direction of the relationship. + +

          A RelationshipDirection.DIRECTED direction is formed from a shape + that defines a reference to another shape (for example, when a resource + defines operations or resources it contains). + +

          A RelationshipDirection.INVERTED relationship is a relationship + from a shape to a shape that defines a relationship to it. The target + of such a relationship doesn't define the relationship, but is the + target of the relationship.

          +
          +
          Returns:
          +
          Returns the direction of the relationship.
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object other)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/neighbor/RelationshipDirection.html b/javadoc/1.47.0/software/amazon/smithy/model/neighbor/RelationshipDirection.html new file mode 100644 index 00000000000..696dcdfbb9c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/neighbor/RelationshipDirection.html @@ -0,0 +1,389 @@ + + + + + +RelationshipDirection (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.neighbor
    +

    Enum RelationshipDirection

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Enum<RelationshipDirection>
        • +
      • +
          +
        • software.amazon.smithy.model.neighbor.RelationshipDirection
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable, java.lang.Comparable<RelationshipDirection>
      +
      +
      +
      public enum RelationshipDirection
+extends java.lang.Enum<RelationshipDirection>
      +
      Defines the directionality of a relationship.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        DIRECTED +
        A directed relationship that goes from a shape to a shape that it + references.
        +
        INVERTED +
        The relationship goes from a shape to the shape that defines a + directed relationship to the shape.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static RelationshipDirectionvalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static RelationshipDirection[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static RelationshipDirection[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (RelationshipDirection c : RelationshipDirection.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static RelationshipDirection valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/neighbor/RelationshipType.html b/javadoc/1.47.0/software/amazon/smithy/model/neighbor/RelationshipType.html new file mode 100644 index 00000000000..58c885b0f05 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/neighbor/RelationshipType.html @@ -0,0 +1,1027 @@ + + + + + +RelationshipType (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.neighbor
    +

    Enum RelationshipType

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Enum<RelationshipType>
        • +
      • +
          +
        • software.amazon.smithy.model.neighbor.RelationshipType
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable, java.lang.Comparable<RelationshipType>
      +
      +
      +
      public enum RelationshipType
+extends java.lang.Enum<RelationshipType>
      +
      Defines the relationship types between neighboring shapes.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        BOUND +
        Deprecated.
        +
        COLLECTION_OPERATION +
        A collection operation relationship exists between a resource and the + operations bound to the resource in the "collectionOperations" property.
        +
        CREATE +
        Relationships that exist between a resource and the create lifecycle + operation.
        +
        DELETE +
        Relationships that exist between a resource and the delete lifecycle + operation.
        +
        ENUM_MEMBER +
        Relationships that exist on enum shapes to their + member shapes.
        +
        ERROR +
        Relationships that exist on operation shapes.
        +
        ID_REF +
        Relationships that exist between a shape and another shape referenced by an + IdRefTrait.
        +
        IDENTIFIER +
        Relationships that exist between a member and + the shapes that are referenced by its identifiers property.
        +
        INPUT +
        Relationships that exist on operation shapes.
        +
        INSTANCE_OPERATION +
        Deprecated.
        +
        INT_ENUM_MEMBER +
        Relationships that exist on intEnum shapes to their + member shapes.
        +
        LIST +
        Relationships that exist between a resource and the list lifecycle + operation.
        +
        LIST_MEMBER +
        Relationships that exist on list shapes to their + member shapes.
        +
        MAP_KEY +
        Relationships that exist on map shapes.
        +
        MAP_VALUE +
        Relationships that exist on map shapes.
        +
        MEMBER_CONTAINER +
        Relationships exist on member shapes.
        +
        MEMBER_TARGET +
        Relationships exist on member shapes.
        +
        MIXIN +
        Relationship that exists between a structure or union and a mixin applied + to the shape.
        +
        OPERATION +
        An operation relationship exists between a service and the operations + bound to the service in the "operations" property, and between a + resource and the operations bound to the resource in the + "operations", "collectionOperations", and lifecycle properties.
        +
        OUTPUT +
        Relationships that exist on operation shapes.
        +
        PROPERTY +
        Relationships that exist between a member and + the shapes that are referenced by its properties property.
        +
        PUT +
        Relationships that exist between a resource and the put lifecycle + operation.
        +
        READ +
        Relationships that exist between a resource and the get lifecycle + operation.
        +
        RESOURCE +
        A resource relationship exists between a service or resource and the + resources bound through the "resources" property.
        +
        SET_MEMBER +
        Deprecated.
        +
        STRUCTURE_MEMBER +
        Relationships that exist on structure shapes.
        +
        TRAIT +
        Relationships that exist between a shape and traits bound to the + shape.
        +
        UNION_MEMBER +
        Relationships that exist on union + shapes.
        +
        UPDATE +
        Relationships that exist between a resource and the update lifecycle + operation.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        RelationshipDirectiongetDirection() +
        Gets the direction of the relationship.
        +
        java.util.Optional<java.lang.String>getSelectorLabel() +
        Gets the token that is used in Selector expressions when + referring to the relationship or an empty Optional if this + relationship is not used directly in a selector.
        +
        booleanisCollectionOperationBinding() +
        Returns true if relationship connects a resource to a collection operation.
        +
        booleanisInstanceOperationBinding() +
        Returns true if relationship connects a resource to an instance operation.
        +
        booleanisMemberBinding() +
        Checks if the given relationship connects a container shape to a member.
        +
        booleanisOperationBinding() +
        Checks if the binding is to an operation (create|read|update|delete|put|list|operation|collectionOperation).
        +
        static RelationshipTypevalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static RelationshipType[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + +
          +
        • +

          RESOURCE

          +
          public static final RelationshipType RESOURCE
          +
          A resource relationship exists between a service or resource and the + resources bound through the "resources" property.
          +
          • +
        + + + +
          +
        • +

          OPERATION

          +
          public static final RelationshipType OPERATION
          +
          An operation relationship exists between a service and the operations + bound to the service in the "operations" property, and between a + resource and the operations bound to the resource in the + "operations", "collectionOperations", and lifecycle properties.
          +
          • +
        + + + +
          +
        • +

          COLLECTION_OPERATION

          +
          public static final RelationshipType COLLECTION_OPERATION
          +
          A collection operation relationship exists between a resource and the + operations bound to the resource in the "collectionOperations" property.
          +
          • +
        + + + +
          +
        • +

          INSTANCE_OPERATION

          +
          @Deprecated
+public static final RelationshipType INSTANCE_OPERATION
          +
          Deprecated.
          +
          • +
        + + + +
          +
        • +

          BOUND

          +
          @Deprecated
+public static final RelationshipType BOUND
          +
          Deprecated.
          +
          • +
        + + + +
          +
        • +

          PUT

          +
          public static final RelationshipType PUT
          +
          Relationships that exist between a resource and the put lifecycle + operation.
          +
          • +
        + + + +
          +
        • +

          CREATE

          +
          public static final RelationshipType CREATE
          +
          Relationships that exist between a resource and the create lifecycle + operation.
          +
          • +
        + + + +
          +
        • +

          READ

          +
          public static final RelationshipType READ
          +
          Relationships that exist between a resource and the get lifecycle + operation.
          +
          • +
        + + + +
          +
        • +

          UPDATE

          +
          public static final RelationshipType UPDATE
          +
          Relationships that exist between a resource and the update lifecycle + operation.
          +
          • +
        + + + +
          +
        • +

          DELETE

          +
          public static final RelationshipType DELETE
          +
          Relationships that exist between a resource and the delete lifecycle + operation.
          +
          • +
        + + + +
          +
        • +

          LIST

          +
          public static final RelationshipType LIST
          +
          Relationships that exist between a resource and the list lifecycle + operation.
          +
          • +
        + + + +
          +
        • +

          IDENTIFIER

          +
          public static final RelationshipType IDENTIFIER
          +
          Relationships that exist between a member and + the shapes that are referenced by its identifiers property.
          +
          • +
        + + + +
          +
        • +

          PROPERTY

          +
          public static final RelationshipType PROPERTY
          +
          Relationships that exist between a member and + the shapes that are referenced by its properties property.
          +
          • +
        + + + +
          +
        • +

          MEMBER_CONTAINER

          +
          public static final RelationshipType MEMBER_CONTAINER
          +
          Relationships exist on member shapes. The subject + of the relationship is the member shape, and the neighbor is the + aggregate shape that contains the member.
          +
          • +
        + + + +
          +
        • +

          MEMBER_TARGET

          +
          public static final RelationshipType MEMBER_TARGET
          +
          Relationships exist on member shapes. The subject + of the relationship is the member shape, and the neighbor is the shape + that the member targets.
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          ERROR

          +
          public static final RelationshipType ERROR
          +
          Relationships that exist on operation shapes. + They reference structure shapes that can be + returned from the operation.
          +
          • +
        + + + + + + + + + + + + + + + +
          +
        • +

          SET_MEMBER

          +
          @Deprecated
+public static final RelationshipType SET_MEMBER
          +
          Deprecated.
          +
          Relationships that exist on set shapes to their + member shapes.
          +
          • +
        + + + +
          +
        • +

          MAP_KEY

          +
          public static final RelationshipType MAP_KEY
          +
          Relationships that exist on map shapes. They reference + member shapes that define the key type for the map.
          +
          • +
        + + + +
          +
        • +

          MAP_VALUE

          +
          public static final RelationshipType MAP_VALUE
          +
          Relationships that exist on map shapes. They + reference member shapes that define the value type + for the map.
          +
          • +
        + + + +
          +
        • +

          STRUCTURE_MEMBER

          +
          public static final RelationshipType STRUCTURE_MEMBER
          +
          Relationships that exist on structure shapes. + They reference member shapes that define the + attributes of a structure.
          +
          • +
        + + + +
          +
        • +

          UNION_MEMBER

          +
          public static final RelationshipType UNION_MEMBER
          +
          Relationships that exist on union + shapes. They reference the member shapes that define + the members of the union.
          +
          • +
        + + + + + + + +
          +
        • +

          MIXIN

          +
          public static final RelationshipType MIXIN
          +
          Relationship that exists between a structure or union and a mixin applied + to the shape.
          +
          • +
        + + + +
          +
        • +

          ID_REF

          +
          public static final RelationshipType ID_REF
          +
          Relationships that exist between a shape and another shape referenced by an + IdRefTrait. + +

          This relationship is formed by applying a trait with a value containing a + reference to another ShapeId. For + example: + 

          + {@code
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static RelationshipType[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (RelationshipType c : RelationshipType.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static RelationshipType valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getSelectorLabel

          +
          public java.util.Optional<java.lang.String> getSelectorLabel()
          +
          Gets the token that is used in Selector expressions when + referring to the relationship or an empty Optional if this + relationship is not used directly in a selector.
          +
          +
          Returns:
          +
          Returns the optionally present selector token for this relationship.
          +
          +
          • +
        + + + +
          +
        • +

          getDirection

          +
          public RelationshipDirection getDirection()
          +
          Gets the direction of the relationship. + +

          A RelationshipDirection.DIRECTED direction is formed from a shape + that defines a reference to another shape (for example, when a resource + defines operations or resources it contains). + +

          A RelationshipDirection.INVERTED relationship is a relationship + from a shape to a shape that defines a relationship to it. The target + of such a relationship doesn't define the relationship, but is the + target of the relationship.

          +
          +
          Returns:
          +
          Returns the direction of the relationship.
          +
          +
          • +
        + + + +
          +
        • +

          isMemberBinding

          +
          public boolean isMemberBinding()
          +
          Checks if the given relationship connects a container shape to a member.
          +
          +
          Returns:
          +
          Returns true if a member.
          +
          +
          • +
        + + + +
          +
        • +

          isOperationBinding

          +
          public boolean isOperationBinding()
          +
          Checks if the binding is to an operation (create|read|update|delete|put|list|operation|collectionOperation).
          +
          +
          Returns:
          +
          Returns true if the binding is for any kind of operation binding.
          +
          +
          • +
        + + + +
          +
        • +

          isInstanceOperationBinding

          +
          public boolean isInstanceOperationBinding()
          +
          Returns true if relationship connects a resource to an instance operation.
          +
          +
          Returns:
          +
          True if an instance operation.
          +
          +
          • +
        + + + +
          +
        • +

          isCollectionOperationBinding

          +
          public boolean isCollectionOperationBinding()
          +
          Returns true if relationship connects a resource to a collection operation.
          +
          +
          Returns:
          +
          True if a collection operation.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/neighbor/UnreferencedShapes.html b/javadoc/1.47.0/software/amazon/smithy/model/neighbor/UnreferencedShapes.html new file mode 100644 index 00000000000..a8a691da2e3 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/neighbor/UnreferencedShapes.html @@ -0,0 +1,368 @@ + + + + + +UnreferencedShapes (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.neighbor
    +

    Class UnreferencedShapes

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.neighbor.UnreferencedShapes
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class UnreferencedShapes
+extends java.lang.Object
      +
      Finds shapes that are not connected to a "root" shape, are not trait definitions, are not referenced by trait + definitions, and are not referenced in trait values through + IdRefTrait. + +

      The "root" shapes defaults to all service shapes in the model. You can customize this by providing a selector + that considers every matching shape a root shape. For example, a model might consider all shapes marked with + a trait called "root" to be a root shape. + +

      Prelude shapes are never considered unreferenced.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          UnreferencedShapes

          +
          public UnreferencedShapes​(java.util.function.Predicate<Shape> keepFilter,
+                          Selector rootShapeSelector)
          +
          +
          Parameters:
          +
          keepFilter - Predicate that if matched keeps a shape from being unreferenced.
          +
          rootShapeSelector - Selector that returns the root shapes to traverse from (defaults to all services).
          +
          +
          • +
        + + + +
          +
        • +

          UnreferencedShapes

          +
          public UnreferencedShapes()
          +
          • +
        + + + +
          +
        • +

          UnreferencedShapes

          +
          public UnreferencedShapes​(Selector selector)
          +
          • +
        + + + +
          +
        • +

          UnreferencedShapes

          +
          public UnreferencedShapes​(java.util.function.Predicate<Shape> keepFilter)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          compute

          +
          public java.util.Set<Shape> compute​(Model model)
          +
          Gets the set of shapes that are unreferenced.
          +
          +
          Parameters:
          +
          model - Model to compute from.
          +
          Returns:
          +
          Returns the unreferenced shapes.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/neighbor/UnreferencedTraitDefinitions.html b/javadoc/1.47.0/software/amazon/smithy/model/neighbor/UnreferencedTraitDefinitions.html new file mode 100644 index 00000000000..b14b71ea880 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/neighbor/UnreferencedTraitDefinitions.html @@ -0,0 +1,324 @@ + + + + + +UnreferencedTraitDefinitions (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.neighbor
    +

    Class UnreferencedTraitDefinitions

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.neighbor.UnreferencedTraitDefinitions
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class UnreferencedTraitDefinitions
+extends java.lang.Object
      +
      Finds trait definitions that are not connected to a service shape. + +

      Prelude traits are never considered unreferenced.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          UnreferencedTraitDefinitions

          +
          public UnreferencedTraitDefinitions()
          +
          • +
        + + + +
          +
        • +

          UnreferencedTraitDefinitions

          +
          public UnreferencedTraitDefinitions​(java.util.function.Predicate<Shape> keepFilter)
          +
          +
          Parameters:
          +
          keepFilter - Predicate that if matched keeps a trait definition from being unreferenced.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          compute

          +
          public java.util.Set<Shape> compute​(Model model)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/neighbor/Walker.html b/javadoc/1.47.0/software/amazon/smithy/model/neighbor/Walker.html new file mode 100644 index 00000000000..9d00836f76f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/neighbor/Walker.html @@ -0,0 +1,476 @@ + + + + + +Walker (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.neighbor
    +

    Class Walker

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.neighbor.Walker
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class Walker
+extends java.lang.Object
      +
      Walks connected shapes within a Model. + +

      Any shape that is connected to another shape is "walked". A single + shape can have multiple relationships to the same shape. For example, + a resource can have both a "get" and a "child" relationship to an + operation; however, the referenced operation will appear only once + in the walker output. + +

      Only shapes form a connected graph. Relationships created by traits + are not traversed by the walker.

      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.util.Iterator<Shape>iterateShapes​(Shape shape) +
        Lazily iterates over all of the relationships in the closure of + the given shape, including the given shape.
        +
        java.util.Iterator<Shape>iterateShapes​(Shape shape, + java.util.function.Predicate<Relationship> predicate) +
        Lazily iterates over all of the unique shapes in the closure of + the given shape, including the given shape.
        +
        java.util.Set<ShapeId>walkShapeIds​(Shape shape) +
        Walks connected shapes in the model, returning their IDs in a set.
        +
        java.util.Set<ShapeId>walkShapeIds​(Shape shape, + java.util.function.Predicate<Relationship> predicate) +
        Walks connected shapes in the model (including the given shape), + and returns a set of shape IDs.
        +
        java.util.Set<Shape>walkShapes​(Shape shape) +
        Walks connected shapes in the model, returning them in a set.
        +
        java.util.Set<Shape>walkShapes​(Shape shape, + java.util.function.Predicate<Relationship> predicate) +
        Walks connected shapes in the model (including the given shape), + and returns them in a set.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Walker

          +
          public Walker​(Model model)
          +
          +
          Parameters:
          +
          model - Model to traverse.
          +
          +
          • +
        + + + +
          +
        • +

          Walker

          +
          public Walker​(NeighborProvider provider)
          +
          +
          Parameters:
          +
          provider - Neighbor provider used to traverse relationships.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          walkShapes

          +
          public java.util.Set<Shape> walkShapes​(Shape shape)
          +
          Walks connected shapes in the model, returning them in a set.
          +
          +
          Parameters:
          +
          shape - The shape to start the traversal from.
          +
          Returns:
          +
          Returns a set of connected shapes.
          +
          +
          • +
        + + + +
          +
        • +

          walkShapes

          +
          public java.util.Set<Shape> walkShapes​(Shape shape,
+                                       java.util.function.Predicate<Relationship> predicate)
          +
          Walks connected shapes in the model (including the given shape), + and returns them in a set.
          +
          +
          Parameters:
          +
          shape - The shape to start the traversal from.
          +
          predicate - Predicate used to prevent traversing relationships.
          +
          Returns:
          +
          Returns a set of connected shapes.
          +
          +
          • +
        + + + +
          +
        • +

          walkShapeIds

          +
          public java.util.Set<ShapeId> walkShapeIds​(Shape shape)
          +
          Walks connected shapes in the model, returning their IDs in a set.
          +
          +
          Parameters:
          +
          shape - The shape to start the traversal from.
          +
          Returns:
          +
          Returns a set of connected shape IDs.
          +
          +
          • +
        + + + +
          +
        • +

          walkShapeIds

          +
          public java.util.Set<ShapeId> walkShapeIds​(Shape shape,
+                                           java.util.function.Predicate<Relationship> predicate)
          +
          Walks connected shapes in the model (including the given shape), + and returns a set of shape IDs.
          +
          +
          Parameters:
          +
          shape - The shape to start the traversal from.
          +
          predicate - Predicate used to prevent traversing relationships.
          +
          Returns:
          +
          Returns a set of connected shape IDs.
          +
          +
          • +
        + + + +
          +
        • +

          iterateShapes

          +
          public java.util.Iterator<Shape> iterateShapes​(Shape shape)
          +
          Lazily iterates over all of the relationships in the closure of + the given shape, including the given shape.
          +
          +
          Parameters:
          +
          shape - Shape to find the closure of.
          +
          Returns:
          +
          Returns an iterator of shapes connected to shape.
          +
          +
          • +
        + + + +
          +
        • +

          iterateShapes

          +
          public java.util.Iterator<Shape> iterateShapes​(Shape shape,
+                                               java.util.function.Predicate<Relationship> predicate)
          +
          Lazily iterates over all of the unique shapes in the closure of + the given shape, including the given shape.
          +
          +
          Parameters:
          +
          shape - Shape to find the closure of.
          +
          predicate - Predicate used to short-circuit relationship branches.
          +
          Returns:
          +
          Returns an iterator of shapes connected to shape.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/neighbor/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/model/neighbor/package-summary.html new file mode 100644 index 00000000000..9bf1cf7ed30 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/neighbor/package-summary.html @@ -0,0 +1,226 @@ + + + + + +software.amazon.smithy.model.neighbor (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.model.neighbor

    +
    +
    +
      +
    • + + + + + + + + + + + + +
      Interface Summary 
      InterfaceDescription
      NeighborProvider +
      Provides the neighbor relationships for a given shape.
      +
      +
      • +
    • + + + + + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      Relationship +
      Represent a direct relationship between two shapes.
      +
      UnreferencedShapes +
      Finds shapes that are not connected to a "root" shape, are not trait definitions, are not referenced by trait + definitions, and are not referenced in trait values through + IdRefTrait.
      +
      UnreferencedTraitDefinitions +
      Finds trait definitions that are not connected to a service shape.
      +
      Walker +
      Walks connected shapes within a Model.
      +
      +
      • +
    • + + + + + + + + + + + + + + + + +
      Enum Summary 
      EnumDescription
      RelationshipDirection +
      Defines the directionality of a relationship.
      +
      RelationshipType +
      Defines the relationship types between neighboring shapes.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/neighbor/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/model/neighbor/package-tree.html new file mode 100644 index 00000000000..94695a5f671 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/neighbor/package-tree.html @@ -0,0 +1,185 @@ + + + + + +software.amazon.smithy.model.neighbor Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.model.neighbor

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +

    Enum Hierarchy

    +
      +
    • java.lang.Object +
        +
      • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
        • +
      +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/node/ArrayNode.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/node/ArrayNode.Builder.html new file mode 100644 index 00000000000..1c44f464ccf --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/node/ArrayNode.Builder.html @@ -0,0 +1,386 @@ + + + + + +ArrayNode.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.node
    +

    Class ArrayNode.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.node.ArrayNode.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/node/ArrayNode.html b/javadoc/1.47.0/software/amazon/smithy/model/node/ArrayNode.html new file mode 100644 index 00000000000..e14cbb57e90 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/node/ArrayNode.html @@ -0,0 +1,822 @@ + + + + + +ArrayNode (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.node
    +

    Class ArrayNode

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ArrayNode

          +
          public ArrayNode​(java.util.List<Node> elements,
+                 SourceLocation sourceLocation)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + +
          +
        • +

          iterator

          +
          public java.util.Iterator<Node> iterator()
          +
          +
          Specified by:
          +
          iterator in interface java.lang.Iterable<Node>
          +
          +
          • +
        + + + +
          +
        • +

          getType

          +
          public NodeType getType()
          +
          Description copied from class: Node
          +
          Gets the type of the node.
          +
          +
          Specified by:
          +
          getType in class Node
          +
          Returns:
          +
          Returns the node type.
          +
          +
          • +
        + + + +
          +
        • +

          accept

          +
          public <R> R accept​(NodeVisitor<R> visitor)
          +
          Description copied from class: Node
          +
          Accepts a visitor with the node.
          +
          +
          Specified by:
          +
          accept in class Node
          +
          Type Parameters:
          +
          R - visitor return type.
          +
          Parameters:
          +
          visitor - Visitor to dispatch to.
          +
          Returns:
          +
          Returns the accepted result.
          +
          +
          • +
        + + + +
          +
        • +

          expectArrayNode

          +
          public ArrayNode expectArrayNode​(java.lang.String errorMessage)
          +
          Description copied from class: Node
          +
          Casts the current node to an ArrayNode, throwing + ExpectationNotMetException when the node is the wrong type.
          +
          +
          Overrides:
          +
          expectArrayNode in class Node
          +
          Parameters:
          +
          errorMessage - Error message to use if the node is of the wrong type.
          +
          Returns:
          +
          Returns an array node.
          +
          +
          • +
        + + + +
          +
        • +

          expectArrayNode

          +
          public ArrayNode expectArrayNode​(java.util.function.Supplier<java.lang.String> errorMessage)
          +
          Description copied from class: Node
          +
          Casts the current node to an ArrayNode, throwing + ExpectationNotMetException when the node is the wrong type.
          +
          +
          Overrides:
          +
          expectArrayNode in class Node
          +
          Parameters:
          +
          errorMessage - Error message supplier.
          +
          Returns:
          +
          Returns an array node.
          +
          +
          • +
        + + + +
          +
        • +

          asArrayNode

          +
          public java.util.Optional<ArrayNode> asArrayNode()
          +
          Description copied from class: Node
          +
          Gets the node as an ArrayNode if it is an array.
          +
          +
          Overrides:
          +
          asArrayNode in class Node
          +
          Returns:
          +
          Returns the optional array node.
          +
          +
          • +
        + + + +
          +
        • +

          getElements

          +
          public java.util.List<Node> getElements()
          +
          Gets the list of nodes.
          +
          +
          Returns:
          +
          Returns a list of nodes.
          +
          +
          • +
        + + + +
          +
        • +

          get

          +
          public java.util.Optional<Node> get​(int index)
          +
          Gets a node from the given index.
          +
          +
          Parameters:
          +
          index - Index of the value to get.
          +
          Returns:
          +
          Returns an optional node at the given index.
          +
          +
          • +
        + + + +
          +
        • +

          isEmpty

          +
          public boolean isEmpty()
          +
          Returns true if the array node is empty.
          +
          +
          Returns:
          +
          Returns true if the array node is empty.
          +
          +
          • +
        + + + +
          +
        • +

          size

          +
          public int size()
          +
          Returns the number of elements in the array node.
          +
          +
          Returns:
          +
          Returns the number of elements in the array node.
          +
          +
          • +
        + + + +
          +
        • +

          withValue

          +
          public ArrayNode withValue​(Node node)
          +
          Copies the values from the current array node, adding the given node, + returning them in a new ArrayNode.
          +
          +
          Parameters:
          +
          node - The node to add.
          +
          Returns:
          +
          Returns a new array node.
          +
          +
          • +
        + + + +
          +
        • +

          getElementsAs

          +
          public <T extends Node> java.util.List<T> getElementsAs​(java.lang.Class<T> type)
          +
          Gets the elements of the array as a list of a specific type of + Node.
          +
          +
          Type Parameters:
          +
          T - Type of Node to expect in each position.
          +
          Parameters:
          +
          type - Type of Node to expect in each position.
          +
          Returns:
          +
          Returns the List of the specified type.
          +
          Throws:
          +
          ExpectationNotMetException - if the list contains elements of a different type.
          +
          +
          • +
        + + + +
          +
        • +

          getElementsAs

          +
          public <T,​K extends Node> java.util.List<T> getElementsAs​(java.util.function.Function<K,​T> f)
          +
          Gets the elements of the ArrayNode as a specific type by applying + a mapping function to each node. + +

          Each Node is cast to K and then mapped with the provided + function to return type T. + + 

          
+ ArrayNode array = Node.fromStrings("foo", "baz", "bar");
+ List<String> strings = array.getElementsAs(StringNode::getValue);
+
          +
          +
          Type Parameters:
          +
          K - Expected Node type.
          +
          T - Mapping function return value.
          +
          Parameters:
          +
          f - Mapping function that takes K and return T.
          +
          Returns:
          +
          Returns the List of type T.
          +
          Throws:
          +
          ExpectationNotMetException - if the list contains elements of a different type than K.
          +
          +
          • +
        + + + +
          +
        • +

          merge

          +
          public ArrayNode merge​(ArrayNode other)
          +
          Merges two ArrayNodes into a new ArrayNode. + +

          If the current node has a source location, it is applied to the + result. Otherwise, the source location of other is applied + to the result.

          +
          +
          Parameters:
          +
          other - Node to merge with.
          +
          Returns:
          +
          Returns a new merged array node.
          +
          +
          • +
        + + + +
          +
        • +

          collect

          +
          public static <T extends ToNode> java.util.stream.Collector<T,​java.util.List<Node>,​ArrayNode> collect()
          +
          +
          Type Parameters:
          +
          T - Type of value in the collection.
          +
          Returns:
          +
          Creates a collector that create an ArrayNode.
          +
          +
          • +
        + + + +
          +
        • +

          collect

          +
          public static <T extends ToNode> java.util.stream.Collector<T,​java.util.List<Node>,​ArrayNode> collect​(SourceLocation sloc)
          +
          +
          Type Parameters:
          +
          T - Type of value in the collection.
          +
          Parameters:
          +
          sloc - Source location to use on the created node.
          +
          Returns:
          +
          Creates a collector that create an ArrayNode.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object other)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/node/BooleanNode.html b/javadoc/1.47.0/software/amazon/smithy/model/node/BooleanNode.html new file mode 100644 index 00000000000..96e41b05881 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/node/BooleanNode.html @@ -0,0 +1,533 @@ + + + + + +BooleanNode (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.node
    +

    Class BooleanNode

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      FromSourceLocation, ToNode
      +
      +
      +
      public final class BooleanNode
+extends Node
      +
      Represents a boolean node.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          BooleanNode

          +
          public BooleanNode​(boolean value,
+                   SourceLocation sourceLocation)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getValue

          +
          public boolean getValue()
          +
          Gets the true or false value of the boolean node.
          +
          +
          Returns:
          +
          Returns true or false.
          +
          +
          • +
        + + + +
          +
        • +

          getType

          +
          public NodeType getType()
          +
          Description copied from class: Node
          +
          Gets the type of the node.
          +
          +
          Specified by:
          +
          getType in class Node
          +
          Returns:
          +
          Returns the node type.
          +
          +
          • +
        + + + +
          +
        • +

          accept

          +
          public <R> R accept​(NodeVisitor<R> visitor)
          +
          Description copied from class: Node
          +
          Accepts a visitor with the node.
          +
          +
          Specified by:
          +
          accept in class Node
          +
          Type Parameters:
          +
          R - visitor return type.
          +
          Parameters:
          +
          visitor - Visitor to dispatch to.
          +
          Returns:
          +
          Returns the accepted result.
          +
          +
          • +
        + + + +
          +
        • +

          expectBooleanNode

          +
          public BooleanNode expectBooleanNode​(java.lang.String errorMessage)
          +
          Description copied from class: Node
          +
          Casts the current node to a BooleanNode, throwing + ExpectationNotMetException when the node is the wrong type.
          +
          +
          Overrides:
          +
          expectBooleanNode in class Node
          +
          Parameters:
          +
          errorMessage - Error message to use if the node is of the wrong type.
          +
          Returns:
          +
          Returns a boolean node.
          +
          +
          • +
        + + + +
          +
        • +

          expectBooleanNode

          +
          public BooleanNode expectBooleanNode​(java.util.function.Supplier<java.lang.String> errorMessage)
          +
          Description copied from class: Node
          +
          Casts the current node to a BooleanNode, throwing + ExpectationNotMetException when the node is the wrong type.
          +
          +
          Overrides:
          +
          expectBooleanNode in class Node
          +
          Parameters:
          +
          errorMessage - Error message supplier.
          +
          Returns:
          +
          Returns a boolean node.
          +
          +
          • +
        + + + +
          +
        • +

          asBooleanNode

          +
          public java.util.Optional<BooleanNode> asBooleanNode()
          +
          Description copied from class: Node
          +
          Gets the node as an BooleanNode if it is an boolean.
          +
          +
          Overrides:
          +
          asBooleanNode in class Node
          +
          Returns:
          +
          Returns the optional BooleanNode.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object other)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/node/ExpectationNotMetException.html b/javadoc/1.47.0/software/amazon/smithy/model/node/ExpectationNotMetException.html new file mode 100644 index 00000000000..d1acf8ff819 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/node/ExpectationNotMetException.html @@ -0,0 +1,312 @@ + + + + + +ExpectationNotMetException (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.node
    +

    Class ExpectationNotMetException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable, FromSourceLocation
      +
      +
      +
      public class ExpectationNotMetException
+extends SourceException
      +
      Thrown by Node methods that expect a node to be of a particular + type or to have a particular member.
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ExpectationNotMetException

          +
          public ExpectationNotMetException​(java.lang.String message,
+                                  FromSourceLocation fromSourceLocation)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/node/Node.NonNumericFloat.html b/javadoc/1.47.0/software/amazon/smithy/model/node/Node.NonNumericFloat.html new file mode 100644 index 00000000000..671cf654d18 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/node/Node.NonNumericFloat.html @@ -0,0 +1,453 @@ + + + + + +Node.NonNumericFloat (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.node
    +

    Enum Node.NonNumericFloat

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Enum<Node.NonNumericFloat>
        • +
      • +
          +
        • software.amazon.smithy.model.node.Node.NonNumericFloat
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable, java.lang.Comparable<Node.NonNumericFloat>
      +
      +
      +
      Enclosing class:
      +
      Node
      +
      +
      +
      public static enum Node.NonNumericFloat
+extends java.lang.Enum<Node.NonNumericFloat>
      +
      Non-numeric values for floats and doubles.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static Node.NonNumericFloat[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (Node.NonNumericFloat c : Node.NonNumericFloat.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static Node.NonNumericFloat valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getStringRepresentation

          +
          public java.lang.String getStringRepresentation()
          +
          +
          Returns:
          +
          The string representation of this non-numeric float.
          +
          +
          • +
        + + + +
          +
        • +

          stringRepresentations

          +
          public static java.util.Set<java.lang.String> stringRepresentations()
          +
          +
          Returns:
          +
          All the possible string representations of non-numeric floats.
          +
          +
          • +
        + + + +
          +
        • +

          fromStringRepresentation

          +
          public static java.util.Optional<Node.NonNumericFloat> fromStringRepresentation​(java.lang.String value)
          +
          Convert a string value into a NonNumericFloat.
          +
          +
          Parameters:
          +
          value - A string representation of a non-numeric float value.
          +
          Returns:
          +
          A NonNumericFloat that represents the given string value or empty if there is no associated value.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/node/Node.html b/javadoc/1.47.0/software/amazon/smithy/model/node/Node.html new file mode 100644 index 00000000000..e1617605481 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/node/Node.html @@ -0,0 +1,1780 @@ + + + + + +Node (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.node
    +

    Class Node

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.node.Node
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          parse

          +
          public static Node parse​(java.lang.String json)
          +
          Attempts to parse the given JSON string and return a Node.
          +
          +
          Parameters:
          +
          json - JSON text to parse.
          +
          Returns:
          +
          Returns the parsed Node on success.
          +
          Throws:
          +
          ModelSyntaxException - if the JSON text is invalid.
          +
          +
          • +
        + + + +
          +
        • +

          parse

          +
          public static Node parse​(java.lang.String json,
+                         java.lang.String file)
          +
          Attempts to parse the given JSON string and File Name and return a Node.
          +
          +
          Parameters:
          +
          json - JSON text to parse.
          +
          file - Filename corresponding to json text
          +
          Returns:
          +
          Returns the parsed Node on success.
          +
          Throws:
          +
          ModelSyntaxException - if the JSON text is invalid.
          +
          +
          • +
        + + + +
          +
        • +

          parse

          +
          public static Node parse​(java.io.InputStream json)
          +
          Attempts to parse the given JSON input stream and returns a Node.
          +
          +
          Parameters:
          +
          json - JSON input stream to parse. The input stream is closed + automatically when the content is fully parsed.
          +
          Returns:
          +
          Returns the parsed Node on success.
          +
          Throws:
          +
          ModelSyntaxException - if the JSON text is invalid.
          +
          +
          • +
        + + + +
          +
        • +

          parse

          +
          public static Node parse​(java.io.InputStream json,
+                         java.lang.String file)
          +
          Attempts to parse the given JSON input stream and returns a Node.
          +
          +
          Parameters:
          +
          json - JSON input stream to parse. The input stream is closed + automatically when the content is fully parsed.
          +
          file - Filename corresponding to json text
          +
          Returns:
          +
          Returns the parsed Node on success.
          +
          Throws:
          +
          ModelSyntaxException - if the JSON text is invalid.
          +
          +
          • +
        + + + +
          +
        • +

          parseJsonWithComments

          +
          public static Node parseJsonWithComments​(java.lang.String json,
+                                         java.lang.String file)
          +
          Attempts to parse the given JSON string and File Name and return a Node. + +

          This parser allows for comments in the JSON.

          +
          +
          Parameters:
          +
          json - JSON text to parse.
          +
          file - Filename corresponding to json text
          +
          Returns:
          +
          Returns the parsed Node on success.
          +
          Throws:
          +
          ModelSyntaxException - if the JSON text is invalid.
          +
          +
          • +
        + + + +
          +
        • +

          parseJsonWithComments

          +
          public static Node parseJsonWithComments​(java.lang.String json)
          +
          Attempts to parse the given JSON string and return a Node. + +

          This parser allows for comments in the JSON.

          +
          +
          Parameters:
          +
          json - JSON text to parse.
          +
          Returns:
          +
          Returns the parsed Node on success.
          +
          Throws:
          +
          ModelSyntaxException - if the JSON text is invalid.
          +
          +
          • +
        + + + +
          +
        • +

          prettyPrintJson

          +
          public static java.lang.String prettyPrintJson​(Node node)
          +
          Writes the contents of a Node to a pretty-printed JSON string.
          +
          +
          Parameters:
          +
          node - Node to write.
          +
          Returns:
          +
          Returns the serialized Node.
          +
          +
          • +
        + + + +
          +
        • +

          prettyPrintJson

          +
          public static java.lang.String prettyPrintJson​(Node node,
+                                               java.lang.String indentString)
          +
          Writes the contents of a Node to a pretty-printed JSON string.
          +
          +
          Parameters:
          +
          node - Node to write.
          +
          indentString - String to use for indention.
          +
          Returns:
          +
          Returns the serialized Node.
          +
          +
          • +
        + + + +
          +
        • +

          printJson

          +
          public static java.lang.String printJson​(Node node)
          +
          Writes the contents of a Node to a non-pretty-printed JSON string.
          +
          +
          Parameters:
          +
          node - Node to write.
          +
          Returns:
          +
          Returns the serialized Node.
          +
          +
          • +
        + + + +
          +
        • +

          from

          +
          public static StringNode from​(java.lang.String value)
          +
          Create a StringNode from a String value.
          +
          +
          Parameters:
          +
          value - Value to create a node from.
          +
          Returns:
          +
          Returns the created StringNode.
          +
          +
          • +
        + + + +
          +
        • +

          from

          +
          public static NumberNode from​(java.lang.Number number)
          +
          Create a NumberNode from a Number value.
          +
          +
          Parameters:
          +
          number - Value to create a node from.
          +
          Returns:
          +
          Returns the created NumberNode.
          +
          +
          • +
        + + + +
          +
        • +

          from

          +
          public static BooleanNode from​(boolean value)
          +
          Create a BooleanNode from a boolean value.
          +
          +
          Parameters:
          +
          value - Value to create a node from.
          +
          Returns:
          +
          Returns the created BooleanNode.
          +
          +
          • +
        + + + +
          +
        • +

          from

          +
          public static Node from​(ToNode value)
          +
          Create a Node from a potentially null ToNode value.
          +
          +
          Parameters:
          +
          value - Value to create a node from.
          +
          Returns:
          +
          Returns the created Node.
          +
          +
          • +
        + + + +
          +
        • +

          fromNodes

          +
          public static ArrayNode fromNodes​(java.util.List<? extends Node> values)
          +
          Creates an ArrayNode from a Collection of Node values.
          +
          +
          Parameters:
          +
          values - String values to add to the ArrayNode.
          +
          Returns:
          +
          Returns the created ArrayNode.
          +
          +
          • +
        + + + +
          +
        • +

          fromNodes

          +
          public static ArrayNode fromNodes​(Node... values)
          +
          Creates an ArrayNode from a variadic list of Node values.
          +
          +
          Parameters:
          +
          values - String values to add to the ArrayNode.
          +
          Returns:
          +
          Returns the created ArrayNode.
          +
          +
          • +
        + + + +
          +
        • +

          fromStrings

          +
          public static ArrayNode fromStrings​(java.util.Collection<java.lang.String> values)
          +
          Creates an ArrayNode from a Collection of String values.
          +
          +
          Parameters:
          +
          values - String values to add to the ArrayNode.
          +
          Returns:
          +
          Returns the created ArrayNode.
          +
          +
          • +
        + + + +
          +
        • +

          fromStrings

          +
          public static ArrayNode fromStrings​(java.lang.String... values)
          +
          Creates an ArrayNode from a variadic list of String values.
          +
          +
          Parameters:
          +
          values - String values to add to the ArrayNode.
          +
          Returns:
          +
          Returns the created ArrayNode.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          objectNode

          +
          public static ObjectNode objectNode()
          +
          Creates an empty ObjectNode.
          +
          +
          Returns:
          +
          Returns the ObjectNode.
          +
          +
          • +
        + + + +
          +
        • +

          objectNode

          +
          public static ObjectNode objectNode​(java.util.Map<StringNode,​Node> values)
          +
          Creates an ObjectNode from the given map of Nodes.
          +
          +
          Parameters:
          +
          values - Values to add to the object node.
          +
          Returns:
          +
          Returns the created ObjectNode.
          +
          +
          • +
        + + + +
          +
        • +

          arrayNode

          +
          public static ArrayNode arrayNode()
          +
          Creates an empty ArrayNode.
          +
          +
          Returns:
          +
          Returns the ArrayNode.
          +
          +
          • +
        + + + +
          +
        • +

          arrayNode

          +
          public static ArrayNode arrayNode​(Node... nodes)
          +
          Creates an ArrayNode from a variadic list of Nodes.
          +
          +
          Parameters:
          +
          nodes - Nodes to add to the array.
          +
          Returns:
          +
          Returns the created ArrayNode.
          +
          +
          • +
        + + + +
          +
        • +

          nullNode

          +
          public static NullNode nullNode()
          +
          Creates a NullNode.
          +
          +
          Returns:
          +
          Returns the NullNode.
          +
          +
          • +
        + + + +
          +
        • +

          loadArrayOfString

          +
          public static java.util.List<java.lang.String> loadArrayOfString​(java.lang.String descriptor,
+                                                                 Node node)
          +
          Expects an array of strings and returns the loaded strings.
          +
          +
          Parameters:
          +
          descriptor - Name of the property being loaded.
          +
          node - Node to load.
          +
          Returns:
          +
          Returns the loaded strings.
          +
          Throws:
          +
          SourceException - on error.
          +
          +
          • +
        + + + +
          +
        • +

          assertEquals

          +
          public static void assertEquals​(ToNode actual,
+                                ToNode expected)
          +
          Testing helper used to compare two Nodes for equivalence. + +

          Compares two Node values and throws if they aren't equal. The + thrown exception contains a message that shows the differences + between the two Nodes as returned by diff(ToNode, ToNode).

          +
          +
          Parameters:
          +
          actual - Node to use as the starting node.
          +
          expected - Node to compare against.
          +
          Throws:
          +
          ExpectationNotMetException - if the nodes are not equivalent.
          +
          +
          • +
        + + + +
          +
        • +

          diff

          +
          public static java.util.List<java.lang.String> diff​(ToNode actual,
+                                                    ToNode expected)
          +
          Computes the differences between two Nodes as a String.
          +
          +
          Parameters:
          +
          actual - Node to use as the starting node.
          +
          expected - Node to compare against.
          +
          Returns:
          +
          Returns the differences as a String.
          +
          +
          • +
        + + + +
          +
        • +

          getType

          +
          public abstract NodeType getType()
          +
          Gets the type of the node.
          +
          +
          Returns:
          +
          Returns the node type.
          +
          +
          • +
        + + + +
          +
        • +

          accept

          +
          public abstract <R> R accept​(NodeVisitor<R> visitor)
          +
          Accepts a visitor with the node.
          +
          +
          Type Parameters:
          +
          R - visitor return type.
          +
          Parameters:
          +
          visitor - Visitor to dispatch to.
          +
          Returns:
          +
          Returns the accepted result.
          +
          +
          • +
        + + + +
          +
        • +

          isObjectNode

          +
          public final boolean isObjectNode()
          +
          Checks if this node is an object type.
          +
          +
          Returns:
          +
          Returns true if this node is an object type.
          +
          +
          • +
        + + + +
          +
        • +

          isArrayNode

          +
          public final boolean isArrayNode()
          +
          Checks if this node is an array type.
          +
          +
          Returns:
          +
          Returns true if this node is an array type.
          +
          +
          • +
        + + + +
          +
        • +

          isStringNode

          +
          public final boolean isStringNode()
          +
          Checks if this node is a string type.
          +
          +
          Returns:
          +
          Returns true if this node is a string type.
          +
          +
          • +
        + + + +
          +
        • +

          isNumberNode

          +
          public final boolean isNumberNode()
          +
          Checks if this node is a number type.
          +
          +
          Returns:
          +
          Returns true if this node is a number type.
          +
          +
          • +
        + + + +
          +
        • +

          isBooleanNode

          +
          public final boolean isBooleanNode()
          +
          Checks if this node is a boolean type.
          +
          +
          Returns:
          +
          Returns true if this node is a boolean type.
          +
          +
          • +
        + + + +
          +
        • +

          isNullNode

          +
          public final boolean isNullNode()
          +
          Checks if this node is a null type.
          +
          +
          Returns:
          +
          Returns true if this node is a null type.
          +
          +
          • +
        + + + +
          +
        • +

          asObjectNode

          +
          public java.util.Optional<ObjectNode> asObjectNode()
          +
          Gets the node as an ObjectNode if it is an object.
          +
          +
          Returns:
          +
          Returns the optional object node.
          +
          +
          • +
        + + + +
          +
        • +

          asArrayNode

          +
          public java.util.Optional<ArrayNode> asArrayNode()
          +
          Gets the node as an ArrayNode if it is an array.
          +
          +
          Returns:
          +
          Returns the optional array node.
          +
          +
          • +
        + + + +
          +
        • +

          asStringNode

          +
          public java.util.Optional<StringNode> asStringNode()
          +
          Gets the node as an StringNode if it is an string.
          +
          +
          Returns:
          +
          Returns the optional StringNode.
          +
          +
          • +
        + + + +
          +
        • +

          asBooleanNode

          +
          public java.util.Optional<BooleanNode> asBooleanNode()
          +
          Gets the node as an BooleanNode if it is an boolean.
          +
          +
          Returns:
          +
          Returns the optional BooleanNode.
          +
          +
          • +
        + + + +
          +
        • +

          asNumberNode

          +
          public java.util.Optional<NumberNode> asNumberNode()
          +
          Gets the node as an NumberNode if it is an number.
          +
          +
          Returns:
          +
          Returns the optional NumberNode.
          +
          +
          • +
        + + + +
          +
        • +

          asNullNode

          +
          public java.util.Optional<NullNode> asNullNode()
          +
          Gets the node as an NullNode if it is a null.
          +
          +
          Returns:
          +
          Returns the optional NullNode.
          +
          +
          • +
        + + + +
          +
        • +

          expectObjectNode

          +
          public final ObjectNode expectObjectNode()
          +
          Casts the current node to an ObjectNode.
          +
          +
          Returns:
          +
          Returns an object node.
          +
          Throws:
          +
          ExpectationNotMetException - when the node is not an ObjectNode.
          +
          +
          • +
        + + + +
          +
        • +

          expectObjectNode

          +
          public ObjectNode expectObjectNode​(java.lang.String message)
          +
          Casts the current node to an ObjectNode, throwing + ExpectationNotMetException when the node is the wrong type.
          +
          +
          Parameters:
          +
          message - Error message to use if the node is of the wrong type.
          +
          Returns:
          +
          Returns an object node.
          +
          Throws:
          +
          ExpectationNotMetException - when the node is not an ObjectNode.
          +
          +
          • +
        + + + +
          +
        • +

          expectObjectNode

          +
          public ObjectNode expectObjectNode​(java.util.function.Supplier<java.lang.String> message)
          +
          Casts the current node to an ObjectNode, throwing + ExpectationNotMetException when the node is the wrong type.
          +
          +
          Parameters:
          +
          message - Error message supplier.
          +
          Returns:
          +
          Returns an object node.
          +
          Throws:
          +
          ExpectationNotMetException - when the node is not an ObjectNode.
          +
          +
          • +
        + + + +
          +
        • +

          expectArrayNode

          +
          public final ArrayNode expectArrayNode()
          +
          Casts the current node to an ArrayNode.
          +
          +
          Returns:
          +
          Returns an array node.
          +
          Throws:
          +
          ExpectationNotMetException - when the node is not an ArrayNode.
          +
          +
          • +
        + + + +
          +
        • +

          expectArrayNode

          +
          public ArrayNode expectArrayNode​(java.lang.String message)
          +
          Casts the current node to an ArrayNode, throwing + ExpectationNotMetException when the node is the wrong type.
          +
          +
          Parameters:
          +
          message - Error message to use if the node is of the wrong type.
          +
          Returns:
          +
          Returns an array node.
          +
          Throws:
          +
          ExpectationNotMetException - when the node is the wrong type.
          +
          +
          • +
        + + + +
          +
        • +

          expectArrayNode

          +
          public ArrayNode expectArrayNode​(java.util.function.Supplier<java.lang.String> message)
          +
          Casts the current node to an ArrayNode, throwing + ExpectationNotMetException when the node is the wrong type.
          +
          +
          Parameters:
          +
          message - Error message supplier.
          +
          Returns:
          +
          Returns an array node.
          +
          Throws:
          +
          ExpectationNotMetException - when the node is the wrong type.
          +
          +
          • +
        + + + +
          +
        • +

          expectStringNode

          +
          public final StringNode expectStringNode()
          +
          Casts the current node to a StringNode.
          +
          +
          Returns:
          +
          Returns a string node.
          +
          Throws:
          +
          ExpectationNotMetException - when the node is the wrong type.
          +
          +
          • +
        + + + +
          +
        • +

          expectStringNode

          +
          public StringNode expectStringNode​(java.lang.String message)
          +
          Casts the current node to a StringNode, throwing + ExpectationNotMetException when the node is the wrong type.
          +
          +
          Parameters:
          +
          message - Error message to use if the node is of the wrong type.
          +
          Returns:
          +
          Returns a string node.
          +
          Throws:
          +
          ExpectationNotMetException - when the node is the wrong type.
          +
          +
          • +
        + + + +
          +
        • +

          expectStringNode

          +
          public StringNode expectStringNode​(java.util.function.Supplier<java.lang.String> message)
          +
          Casts the current node to a StringNode, throwing + ExpectationNotMetException when the node is the wrong type.
          +
          +
          Parameters:
          +
          message - Error message supplier.
          +
          Returns:
          +
          Returns a string node.
          +
          Throws:
          +
          ExpectationNotMetException - when the node is the wrong type.
          +
          +
          • +
        + + + +
          +
        • +

          expectNumberNode

          +
          public final NumberNode expectNumberNode()
          +
          Casts the current node to a NumberNode.
          +
          +
          Returns:
          +
          Returns a number node.
          +
          Throws:
          +
          ExpectationNotMetException - when the node is the wrong type.
          +
          +
          • +
        + + + +
          +
        • +

          expectNumberNode

          +
          public NumberNode expectNumberNode​(java.lang.String message)
          +
          Casts the current node to a NumberNode, throwing + ExpectationNotMetException when the node is the wrong type.
          +
          +
          Parameters:
          +
          message - Error message to use if the node is of the wrong type.
          +
          Returns:
          +
          Returns a number node.
          +
          Throws:
          +
          ExpectationNotMetException - when the node is the wrong type.
          +
          +
          • +
        + + + +
          +
        • +

          expectNumberNode

          +
          public NumberNode expectNumberNode​(java.util.function.Supplier<java.lang.String> message)
          +
          Casts the current node to a NumberNode, throwing + ExpectationNotMetException when the node is the wrong type.
          +
          +
          Parameters:
          +
          message - Error message supplier.
          +
          Returns:
          +
          Returns a number node.
          +
          Throws:
          +
          ExpectationNotMetException - when the node is the wrong type.
          +
          +
          • +
        + + + +
          +
        • +

          expectBooleanNode

          +
          public final BooleanNode expectBooleanNode()
          +
          Casts the current node to a BooleanNode.
          +
          +
          Returns:
          +
          Returns a boolean node.
          +
          Throws:
          +
          ExpectationNotMetException - when the node is the wrong type.
          +
          +
          • +
        + + + +
          +
        • +

          expectBooleanNode

          +
          public BooleanNode expectBooleanNode​(java.lang.String message)
          +
          Casts the current node to a BooleanNode, throwing + ExpectationNotMetException when the node is the wrong type.
          +
          +
          Parameters:
          +
          message - Error message to use if the node is of the wrong type.
          +
          Returns:
          +
          Returns a boolean node.
          +
          Throws:
          +
          ExpectationNotMetException - when the node is the wrong type.
          +
          +
          • +
        + + + +
          +
        • +

          expectBooleanNode

          +
          public BooleanNode expectBooleanNode​(java.util.function.Supplier<java.lang.String> message)
          +
          Casts the current node to a BooleanNode, throwing + ExpectationNotMetException when the node is the wrong type.
          +
          +
          Parameters:
          +
          message - Error message supplier.
          +
          Returns:
          +
          Returns a boolean node.
          +
          Throws:
          +
          ExpectationNotMetException - when the node is the wrong type.
          +
          +
          • +
        + + + +
          +
        • +

          expectNullNode

          +
          public final NullNode expectNullNode()
          +
          Casts the current node to a NullNode.
          +
          +
          Returns:
          +
          Returns a null node.
          +
          Throws:
          +
          ExpectationNotMetException - when the node is the wrong type.
          +
          +
          • +
        + + + +
          +
        • +

          expectNullNode

          +
          public NullNode expectNullNode​(java.lang.String message)
          +
          Casts the current node to a NullNode, throwing + ExpectationNotMetException when the node is the wrong type.
          +
          +
          Parameters:
          +
          message - Error message to use if the node is of the wrong type.
          +
          Returns:
          +
          Returns a null node.
          +
          Throws:
          +
          ExpectationNotMetException - when the node is the wrong type.
          +
          +
          • +
        + + + +
          +
        • +

          expectNullNode

          +
          public NullNode expectNullNode​(java.util.function.Supplier<java.lang.String> message)
          +
          Casts the current node to a NullNode, throwing + ExpectationNotMetException when the node is the wrong type.
          +
          +
          Parameters:
          +
          message - Error message supplier.
          +
          Returns:
          +
          Returns a null node.
          +
          Throws:
          +
          ExpectationNotMetException - when the node is the wrong type.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          toNode

          +
          public final Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          withDeepSortedKeys

          +
          public final Node withDeepSortedKeys()
          +
          Returns a node with sorted keys and sorted keys of all nested object + nodes.
          +
          +
          Returns:
          +
          Returns the node in which all object nodes have sorted keys.
          +
          +
          • +
        + + + +
          +
        • +

          withDeepSortedKeys

          +
          public final Node withDeepSortedKeys​(java.util.Comparator<StringNode> keyComparator)
          +
          Returns a node with sorted keys and sorted keys of all nested object + nodes using a custom comparator.
          +
          +
          Parameters:
          +
          keyComparator - Compares keys.
          +
          Returns:
          +
          Returns the node in which all object nodes have sorted keys.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/node/NodeDeserializationException.html b/javadoc/1.47.0/software/amazon/smithy/model/node/NodeDeserializationException.html new file mode 100644 index 00000000000..bb643a57006 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/node/NodeDeserializationException.html @@ -0,0 +1,328 @@ + + + + + +NodeDeserializationException (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.node
    +

    Class NodeDeserializationException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          NodeDeserializationException

          +
          public NodeDeserializationException​(java.lang.String message,
+                                    SourceLocation sourceLocation)
          +
          • +
        + + + +
          +
        • +

          NodeDeserializationException

          +
          public NodeDeserializationException​(java.lang.String message,
+                                    SourceLocation sourceLocation,
+                                    java.lang.Throwable previous)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/node/NodeMapper.WhenMissing.html b/javadoc/1.47.0/software/amazon/smithy/model/node/NodeMapper.WhenMissing.html new file mode 100644 index 00000000000..a83917b6062 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/node/NodeMapper.WhenMissing.html @@ -0,0 +1,433 @@ + + + + + +NodeMapper.WhenMissing (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.node
    +

    Enum NodeMapper.WhenMissing

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable, java.lang.Comparable<NodeMapper.WhenMissing>
      +
      +
      +
      Enclosing class:
      +
      NodeMapper
      +
      +
      +
      public static enum NodeMapper.WhenMissing
+extends java.lang.Enum<NodeMapper.WhenMissing>
      +
      Specifies the behavior of the mapper when attempting to deserialize an unknown property.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        FAIL +
        Throws an exception when attempting to deserialize an unknown property.
        +
        IGNORE +
        Ignores unknown properties.
        +
        WARN +
        Warns when attempting to deserialize an unknown property.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
        Modifier and TypeMethodDescription
        abstract voidhandle​(java.lang.reflect.Type into, + java.lang.String pointer, + java.lang.String property, + Node value) +
        Invoked when an object property cannot be deserialized.
        +
        static NodeMapper.WhenMissingvalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static NodeMapper.WhenMissing[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static NodeMapper.WhenMissing[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (NodeMapper.WhenMissing c : NodeMapper.WhenMissing.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static NodeMapper.WhenMissing valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          handle

          +
          public abstract void handle​(java.lang.reflect.Type into,
+                            java.lang.String pointer,
+                            java.lang.String property,
+                            Node value)
          +
          Invoked when an object property cannot be deserialized.
          +
          +
          Parameters:
          +
          into - The value type being created.
          +
          pointer - The JSON pointer to the type from the original node.
          +
          property - The property that was unknown to the type.
          +
          value - The Node being deserialized.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/node/NodeMapper.html b/javadoc/1.47.0/software/amazon/smithy/model/node/NodeMapper.html new file mode 100644 index 00000000000..31abeaadb0d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/node/NodeMapper.html @@ -0,0 +1,841 @@ + + + + + +NodeMapper (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.node
    +

    Class NodeMapper

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.node.NodeMapper
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class NodeMapper
+extends java.lang.Object
      +
      Serializes and deserializes Smithy Node values to/from objects. + +

      This class does not serialize a Node value as a JSON + string. It converts Java Object values to and from Node values. + Use Node.printJson(Node) to serialize JSON strings from a + Node value. + +

      When stable, we may add the ability to add custom serializers and + deserializers. Until then, there is no way to customize the serialization + and deserialization rules.

      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static class NodeMapper.WhenMissing +
        Specifies the behavior of the mapper when attempting to deserialize an unknown property.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        NodeMapper() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        <T> Tdeserialize​(Node value, + java.lang.Class<T> into) +
        Deserialize a Node value into an instance of T.
        +
        <T extends java.util.Collection<?>,​U,​V extends java.util.Collection<? extends U>>
        V        		deserializeCollection​(Node value, + java.lang.Class<T> into, + java.lang.Class<U> members) +
        Deserialize a Node value into a Collection T of U members.
        +
        <T> TdeserializeInto​(Node value, + T objectToMutate) +
        Invokes setters on the given objectToMutate from the provided + Node.
        +
        <T extends java.util.Map<?,​?>,​U,​V extends java.util.Map<java.lang.String,​? extends U>>
        V        		deserializeMap​(Node value, + java.lang.Class<T> into, + java.lang.Class<U> members) +
        Deserialize a Node value into a Map T + with String keys and U values.
        +
        voiddisableFromNodeForClass​(java.lang.reflect.Type type) +
        Disables the use of fromNode method for a specific class + when deserializing the class.
        +
        voiddisableToNodeForClass​(java.lang.reflect.Type type) +
        Disables the use of the toNode method for a specific class + when serializing the class as a POJO.
        +
        voidenableFromNodeForClass​(java.lang.reflect.Type type) +
        Enables the use of the FromNode method for a specific class + when deserializing the class.
        +
        voidenableToNodeForClass​(java.lang.reflect.Type type) +
        Enables the use of the toNode method for a specific class + when serializing the class as a POJO.
        +
        java.util.Set<java.lang.reflect.Type>getDisableFromNode() +
        Gets the set of classes where fromNode is disabled.
        +
        java.util.Set<java.lang.reflect.Type>getDisableToNode() +
        Gets the set of classes where toNode is disabled.
        +
        booleangetOmitEmptyValues() +
        Gets whether or not false, empty arrays, and empty objects are omitted from + serialized POJOs.
        +
        booleangetSerializeNullValues() 
        NodeMapper.WhenMissinggetWhenMissingSetter() 
        Nodeserialize​(java.lang.Object object) +
        Serializes the given object as a Node.
        +
        voidsetOmitEmptyValues​(boolean omitEmptyValues) +
        Gets whether or not false, empty arrays, and empty objects are omitted from serialized POJOs.
        +
        voidsetSerializeNullValues​(boolean serializeNullValues) +
        Specifies if null values returned from getters are serialized.
        +
        voidsetWhenMissingSetter​(NodeMapper.WhenMissing whenMissing) +
        Sets the behavior of the deserializer when a setting is missing.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          NodeMapper

          +
          public NodeMapper()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          setSerializeNullValues

          +
          public void setSerializeNullValues​(boolean serializeNullValues)
          +
          Specifies if null values returned from getters are serialized.
          +
          +
          Parameters:
          +
          serializeNullValues - Set to true to serialize null values.
          +
          +
          • +
        + + + +
          +
        • +

          getSerializeNullValues

          +
          public boolean getSerializeNullValues()
          +
          +
          Returns:
          +
          Gets whether or not null values are serialized.
          +
          +
          • +
        + + + +
          +
        • +

          setWhenMissingSetter

          +
          public void setWhenMissingSetter​(NodeMapper.WhenMissing whenMissing)
          +
          Sets the behavior of the deserializer when a setting is missing.
          +
          +
          Parameters:
          +
          whenMissing - Behavior when a property is not matched to a setter.
          +
          +
          • +
        + + + +
          +
        • +

          getWhenMissingSetter

          +
          public NodeMapper.WhenMissing getWhenMissingSetter()
          +
          +
          Returns:
          +
          Gets the behavior of the deserializer when a setting is missing.
          +
          +
          • +
        + + + +
          +
        • +

          disableToNodeForClass

          +
          public void disableToNodeForClass​(java.lang.reflect.Type type)
          +
          Disables the use of the toNode method for a specific class + when serializing the class as a POJO. + +

          This method disables a specific concrete class and does not + disable subclasses or implementations of an interface. + +

          This is useful when using the NodeMapper inside of a toNode + implementation.

          +
          +
          Parameters:
          +
          type - Class to disable the toNode method serialization for.
          +
          +
          • +
        + + + +
          +
        • +

          enableToNodeForClass

          +
          public void enableToNodeForClass​(java.lang.reflect.Type type)
          +
          Enables the use of the toNode method for a specific class + when serializing the class as a POJO.
          +
          +
          Parameters:
          +
          type - Class to enable the toNode method serialization for.
          +
          +
          • +
        + + + +
          +
        • +

          getDisableToNode

          +
          public java.util.Set<java.lang.reflect.Type> getDisableToNode()
          +
          Gets the set of classes where toNode is disabled.
          +
          +
          Returns:
          +
          Returns the disabled classes.
          +
          +
          • +
        + + + +
          +
        • +

          disableFromNodeForClass

          +
          public void disableFromNodeForClass​(java.lang.reflect.Type type)
          +
          Disables the use of fromNode method for a specific class + when deserializing the class. + +

          This method disables a specific concrete class and does not + disable subclasses or implementations of an interface. + +

          This is useful when using the NodeMapper inside of a fromNode + implementation.

          +
          +
          Parameters:
          +
          type - Class to disable the fromNode method deserialization for.
          +
          +
          • +
        + + + +
          +
        • +

          enableFromNodeForClass

          +
          public void enableFromNodeForClass​(java.lang.reflect.Type type)
          +
          Enables the use of the FromNode method for a specific class + when deserializing the class.
          +
          +
          Parameters:
          +
          type - Class to enable the fromNode method deserialization for.
          +
          +
          • +
        + + + +
          +
        • +

          getDisableFromNode

          +
          public java.util.Set<java.lang.reflect.Type> getDisableFromNode()
          +
          Gets the set of classes where fromNode is disabled.
          +
          +
          Returns:
          +
          Returns the disabled classes.
          +
          +
          • +
        + + + +
          +
        • +

          getOmitEmptyValues

          +
          public boolean getOmitEmptyValues()
          +
          Gets whether or not false, empty arrays, and empty objects are omitted from + serialized POJOs.
          +
          +
          Returns:
          +
          Returns true if empty arrays and POJOs returned from POJO getters are omitted.
          +
          +
          • +
        + + + +
          +
        • +

          setOmitEmptyValues

          +
          public void setOmitEmptyValues​(boolean omitEmptyValues)
          +
          Gets whether or not false, empty arrays, and empty objects are omitted from serialized POJOs.
          +
          +
          Parameters:
          +
          omitEmptyValues - Set to true if false, empty arrays, and objects returned from POJO getters are omitted.
          +
          +
          • +
        + + + +
          +
        • +

          serialize

          +
          public Node serialize​(java.lang.Object object)
          +
          Serializes the given object as a Node. + +

          This method is able to serialize the following types in the + given evaluation order: + +

            +
          1. A null value is serialized as a NullNode if getSerializeNullValues() + returns true. +
            2. +
          2. Instances of ToNode will return the result of calling ToNode.toNode(). +
            3. +
          3. Instances of Optional will serialize a NullNode when the Optional is empty, or + the result of serializing the value contained in the Optional when present. +
            4. +
          4. String value is serialized as a StringNode. +
            5. +
          5. Boolean value or boolean is serialized as a BooleanNode. +
            6. +
          6. Any instance of Number value is serialized as a NumberNode. +
            7. +
          7. The toString method is called when URL, URI, Pattern, and + Path are serialized. +
            8. +
          8. A File is serialized by serializing the string value of File.toURI(). +
            9. +
          9. Enum value is serialized as a StringNode by calling its toString method. +
          10. ShapeId is serialized as a StringNode that contains the absolute shape ID. +
            11. +
          11. Any instance of a Map is supported as long as the key and value of the map are both + supported types (note that Map keys must serialize as StringNode). A Map is converted to + an ObjectNode. +
            12. +
          12. Any instance of a Iterable is supported as long as the value contained in the + Iterable is a supported type. An Iterable is converted to an ArrayNode. + An Iterable broadly covers many Java types, including Collection. +
            13. +
          13. Primitive arrays are converted to an ArrayNode if and only if the values contained in the + array are one of the supported types supported by the serializer. +
            14. +
          14. Finally, an object is serialized using Bean style semantics; any public getter + (get* or is* method with no arguments) is invoked and it's return value is put in the ObjectNode. + Each property of the Bean recursively invokes the serializer and must be one of the supported types. + Properties associated with a getter that are marked as transient are not serialized (where an + "association" is defined as a class field with the same lowercase name as the suffix of the getter + method). For example, given a method "getFoo", both "foo" and "Foo" are checked as associated + property names. +
            15. +
          +
          +
          Parameters:
          +
          object - Object to serialize.
          +
          Returns:
          +
          Returns the serialized Node.
          +
          Throws:
          +
          NodeSerializationException - on error.
          +
          +
          • +
        + + + +
          +
        • +

          deserialize

          +
          public <T> T deserialize​(Node value,
+                         java.lang.Class<T> into)
          +
          Deserialize a Node value into an instance of T. + +

          This method can deserialize various kinds of values depending on the given + node type and the target type: + +

            +
          1. null
            2. +
          2. String
            3. +
          3. Primitive and boxed booleans
            4. +
          4. Primitive and boxed Number types
            5. +
          5. Lists and Sets of any support value
            6. +
          6. Maps with String keys and values of any supported type
            7. +
          7. Direct Node to Node conversions.
            8. +
          8. Any object that has a public static fromNode method that accepts a + Node and returns an instance of the object.
            9. +
          9. Strings are deserialized to enums by finding the first enum value that has a toString + method that matches the string value.
            10. +
          10. Built-in support for URI, URL, Pattern, Path, and File
            11. +
          11. When deserializing an object, any target object that provides a public static method named + builder that returns an instance of SmithyBuilder is invoked, and the builder is then + mutated using bean like setters (with an optional "set") prefix, until finally, the build method is + called and its result is returned.
            12. +
          12. When deserializing an object, the last thing tried is to find a public, zero-arg constructor, + and then the object is mutated using bean-style setter conventions for each key-value pair.
            13. +
          13. NodeMapper does not support non-static inner classes, classes with generic parameters, or + generic arrays. Support for these may be added in the future.
            14. +
          + +

          Objects with a public method named sourceLocation or setSourceLocation + are invoked and provided the source location of the deserialized value.

          +
          +
          Type Parameters:
          +
          T - Type of value to create.
          +
          Parameters:
          +
          value - Value to deserialize.
          +
          into - Class to create.
          +
          Returns:
          +
          Returns the created value.
          +
          Throws:
          +
          NodeDeserializationException - on error.
          +
          See Also:
          +
          deserializeCollection(Node, Class, Class), +deserializeMap(Node, Class, Class)
          +
          +
          • +
        + + + + + +
          +
        • +

          deserializeInto

          +
          public <T> T deserializeInto​(Node value,
+                             T objectToMutate)
          +
          Invokes setters on the given objectToMutate from the provided + Node.
          +
          +
          Type Parameters:
          +
          T - The value to mutate using Bean style setters.
          +
          Parameters:
          +
          value - Value to deserialize.
          +
          objectToMutate - Object to mutate and populate from the node.
          +
          Returns:
          +
          Returns the passed in value.
          +
          Throws:
          +
          NodeDeserializationException - on error.
          +
          +
          • +
        + + + +
          +
        • +

          deserializeCollection

          +
          public <T extends java.util.Collection<?>,​U,​V extends java.util.Collection<? extends U>> V deserializeCollection​(Node value,
+                                                                                                                             java.lang.Class<T> into,
+                                                                                                                             java.lang.Class<U> members)
          +
          Deserialize a Node value into a Collection T of U members. + +

          This method is necessary because of Java's runtime type erasure.

          +
          +
          Type Parameters:
          +
          T - Type of collection value to create.
          +
          U - Type contained within the collection.
          +
          V - Returned collection type.
          +
          Parameters:
          +
          value - Value to deserialize.
          +
          into - Collection class to create.
          +
          members - The collection's parametric type.
          +
          Returns:
          +
          Returns the created collection.
          +
          Throws:
          +
          NodeDeserializationException - on error.
          +
          See Also:
          +
          deserialize(Node, Class)
          +
          +
          • +
        + + + +
          +
        • +

          deserializeMap

          +
          public <T extends java.util.Map<?,​?>,​U,​V extends java.util.Map<java.lang.String,​? extends U>> V deserializeMap​(Node value,
+                                                                                                                                       java.lang.Class<T> into,
+                                                                                                                                       java.lang.Class<U> members)
          +
          Deserialize a Node value into a Map T + with String keys and U values. + +

          This method is necessary because of Java's runtime type erasure.

          +
          +
          Type Parameters:
          +
          T - Type of map value to create.
          +
          U - Type contained within the map values.
          +
          V - Returned map type.
          +
          Parameters:
          +
          value - Value to deserialize.
          +
          into - Map class to create.
          +
          members - The maps's parametric type.
          +
          Returns:
          +
          Returns the created map.
          +
          Throws:
          +
          NodeDeserializationException - on error.
          +
          See Also:
          +
          deserialize(Node, Class)
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/node/NodePointer.html b/javadoc/1.47.0/software/amazon/smithy/model/node/NodePointer.html new file mode 100644 index 00000000000..5eda0192707 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/node/NodePointer.html @@ -0,0 +1,529 @@ + + + + + +NodePointer (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.node
    +

    Class NodePointer

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.node.NodePointer
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class NodePointer
+extends java.lang.Object
      +
      JSON Pointer abstraction over Smithy Node values. + +

      A parsed JSON pointer can get a value from a Node by pointer and + perform JSON-patch like operations like adding a value to a specific + pointer target.

      +
      +
      See Also:
      +
      RFC 6902
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        NodeaddValue​(Node container, + Node value) +
        Adds or replaces a value in container at the + JSON pointer location.
        +
        NodeaddWithIntermediateValues​(Node container, + Node value) +
        Adds or replaces a value in container at the + JSON pointer location.
        +
        static NodePointerempty() +
        Gets an empty Node pointer.
        +
        booleanequals​(java.lang.Object other) 
        static NodePointerfromNode​(Node node) +
        Creates a NodePointer from a Node value.
        +
        java.util.List<java.lang.String>getParts() +
        Gets the parsed parts of the pointer.
        +
        NodegetValue​(Node container) +
        Gets a value from a container shape at the pointer location.
        +
        inthashCode() 
        static NodePointerparse​(java.lang.String pointer) +
        Parses a JSON pointer.
        +
        java.lang.StringtoString() 
        static java.lang.Stringunescape​(java.lang.String pointerPart) +
        Unescapes special JSON pointer cases.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          empty

          +
          public static NodePointer empty()
          +
          Gets an empty Node pointer.
          +
          +
          Returns:
          +
          Returns a node pointer with a value of "".
          +
          +
          • +
        + + + +
          +
        • +

          fromNode

          +
          public static NodePointer fromNode​(Node node)
          +
          Creates a NodePointer from a Node value.
          +
          +
          Parameters:
          +
          node - Node value to parse.
          +
          Returns:
          +
          Returns the parsed NodePointer.
          +
          Throws:
          +
          ExpectationNotMetException - if the pointer cannot be parsed.
          +
          +
          • +
        + + + +
          +
        • +

          unescape

          +
          public static java.lang.String unescape​(java.lang.String pointerPart)
          +
          Unescapes special JSON pointer cases.
          +
          +
          Parameters:
          +
          pointerPart - Pointer to unescape.
          +
          Returns:
          +
          Returns the unescaped pointer.
          +
          +
          • +
        + + + +
          +
        • +

          parse

          +
          public static NodePointer parse​(java.lang.String pointer)
          +
          Parses a JSON pointer. + +

          A JSON pointer that starts with "#/" is treated as "/". JSON + pointers must start with "#/" or "/" to be parsed correctly.

          +
          +
          Parameters:
          +
          pointer - JSON pointer to parse.
          +
          Returns:
          +
          Returns the parsed pointer.
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if the pointer does not start with slash (/).
          +
          +
          • +
        + + + +
          +
        • +

          getParts

          +
          public java.util.List<java.lang.String> getParts()
          +
          Gets the parsed parts of the pointer.
          +
          +
          Returns:
          +
          Returns the immutable pointer parts.
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object other)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public Node getValue​(Node container)
          +
          Gets a value from a container shape at the pointer location. + +

          When the pointer is "", then provided value is returned. When + the pointer is "/", a root object key value of "" is returned. When + an invalid property or array index is accessed, a NullNode + is returned. "-" can be used to access the last element of an array. + Any error like accessing an object key from an array or attempting + to access an invalid array index will return a NullNode.

          +
          +
          Parameters:
          +
          container - Node value container to extract a value from.
          +
          Returns:
          +
          Returns the extracted value or a NullNode if not found.
          +
          +
          • +
        + + + +
          +
        • +

          addValue

          +
          public Node addValue​(Node container,
+                     Node value)
          +
          Adds or replaces a value in container at the + JSON pointer location. + +

          When the JSON pointer is "", the entire document is replaced with the + given value. "-" can be used to access the last element of an array + or to add an element to the end of an array. Any error like adding + an object key to an array or attempting to access an invalid array + segment will log a warning and return the given value as-is.

          +
          +
          Parameters:
          +
          container - Node to update.
          +
          value - Value to update or replace.
          +
          Returns:
          +
          Returns a representation of container with the updated value.
          +
          +
          • +
        + + + +
          +
        • +

          addWithIntermediateValues

          +
          public Node addWithIntermediateValues​(Node container,
+                                      Node value)
          +
          Adds or replaces a value in container at the + JSON pointer location. + +

          When the JSON pointer is "", the entire document is replaced with the + given value. "-" can be used to access the last element of an array + or to add an element to the end of an array. Unlike addValue(Node, Node), + attempting to add a property to a non-existent object will create a + new object and continue adding to the created result.

          +
          +
          Parameters:
          +
          container - Node to update.
          +
          value - Value to update or replace.
          +
          Returns:
          +
          Returns a representation of container with the updated value.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/node/NodeSerializationException.html b/javadoc/1.47.0/software/amazon/smithy/model/node/NodeSerializationException.html new file mode 100644 index 00000000000..4cc11d210b7 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/node/NodeSerializationException.html @@ -0,0 +1,312 @@ + + + + + +NodeSerializationException (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.node
    +

    Class NodeSerializationException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Throwable
        • +
      • +
          +
        • java.lang.Exception
          • +
        • +
            +
          • java.lang.RuntimeException
            • +
          • +
              +
            • software.amazon.smithy.model.node.NodeSerializationException
              • +
            +
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      public class NodeSerializationException
+extends java.lang.RuntimeException
      +
      Exception encountered during serialization.
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          NodeSerializationException

          +
          public NodeSerializationException​(java.lang.String message)
          +
          • +
        + + + +
          +
        • +

          NodeSerializationException

          +
          public NodeSerializationException​(java.lang.String message,
+                                  java.lang.Throwable previous)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/node/NodeType.html b/javadoc/1.47.0/software/amazon/smithy/model/node/NodeType.html new file mode 100644 index 00000000000..37542e9dc21 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/node/NodeType.html @@ -0,0 +1,468 @@ + + + + + +NodeType (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.node
    +

    Enum NodeType

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Enum<NodeType>
        • +
      • +
          +
        • software.amazon.smithy.model.node.NodeType
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable, java.lang.Comparable<NodeType>
      +
      +
      +
      public enum NodeType
+extends java.lang.Enum<NodeType>
      +
      The set of possible node types.
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
        Modifier and TypeMethodDescription
        abstract java.lang.Class<? extends Node>getNodeClass() +
        Gets the Node class associated with the type.
        +
        java.lang.StringtoString() 
        static NodeTypevalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static NodeType[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + +
          +
        • +

          OBJECT

          +
          public static final NodeType OBJECT
          +
          • +
        + + + +
          +
        • +

          ARRAY

          +
          public static final NodeType ARRAY
          +
          • +
        + + + +
          +
        • +

          STRING

          +
          public static final NodeType STRING
          +
          • +
        + + + +
          +
        • +

          NUMBER

          +
          public static final NodeType NUMBER
          +
          • +
        + + + +
          +
        • +

          BOOLEAN

          +
          public static final NodeType BOOLEAN
          +
          • +
        + + + +
          +
        • +

          NULL

          +
          public static final NodeType NULL
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static NodeType[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (NodeType c : NodeType.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static NodeType valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Enum<NodeType>
          +
          +
          • +
        + + + +
          +
        • +

          getNodeClass

          +
          public abstract java.lang.Class<? extends Node> getNodeClass()
          +
          Gets the Node class associated with the type.
          +
          +
          Returns:
          +
          Returns the Node class.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/node/NodeVisitor.Default.html b/javadoc/1.47.0/software/amazon/smithy/model/node/NodeVisitor.Default.html new file mode 100644 index 00000000000..6154b577806 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/node/NodeVisitor.Default.html @@ -0,0 +1,501 @@ + + + + + +NodeVisitor.Default (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.node
    +

    Class NodeVisitor.Default<R>

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.node.NodeVisitor.Default<R>
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Type Parameters:
      +
      R - Return type.
      +
      +
      +
      All Implemented Interfaces:
      +
      NodeVisitor<R>
      +
      +
      +
      Enclosing interface:
      +
      NodeVisitor<R>
      +
      +
      +
      public abstract static class NodeVisitor.Default<R>
+extends java.lang.Object
+implements NodeVisitor<R>
      +
      Creates NodeVisitor that return a default value when necessary + when visiting nodes.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Default

          +
          public Default()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getDefault

          +
          protected abstract R getDefault​(Node node)
          +
          Returns a default value for any unhandled node.
          +
          +
          Parameters:
          +
          node - Node that is being visited.
          +
          Returns:
          +
          Return value.
          +
          +
          • +
        + + + +
          +
        • +

          arrayNode

          +
          public R arrayNode​(ArrayNode node)
          +
          Description copied from interface: NodeVisitor
          +
          Visits an array node.
          +
          +
          Specified by:
          +
          arrayNode in interface NodeVisitor<R>
          +
          Parameters:
          +
          node - Node to visit.
          +
          Returns:
          +
          Return value of the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          booleanNode

          +
          public R booleanNode​(BooleanNode node)
          +
          Description copied from interface: NodeVisitor
          +
          Visits a boolean node.
          +
          +
          Specified by:
          +
          booleanNode in interface NodeVisitor<R>
          +
          Parameters:
          +
          node - Node to visit.
          +
          Returns:
          +
          Return value of the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          nullNode

          +
          public R nullNode​(NullNode node)
          +
          Description copied from interface: NodeVisitor
          +
          Visits a null node.
          +
          +
          Specified by:
          +
          nullNode in interface NodeVisitor<R>
          +
          Parameters:
          +
          node - Node to visit.
          +
          Returns:
          +
          Return value of the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          numberNode

          +
          public R numberNode​(NumberNode node)
          +
          Description copied from interface: NodeVisitor
          +
          Visits a number node.
          +
          +
          Specified by:
          +
          numberNode in interface NodeVisitor<R>
          +
          Parameters:
          +
          node - Node to visit.
          +
          Returns:
          +
          Return value of the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          objectNode

          +
          public R objectNode​(ObjectNode node)
          +
          Description copied from interface: NodeVisitor
          +
          Visits an object node.
          +
          +
          Specified by:
          +
          objectNode in interface NodeVisitor<R>
          +
          Parameters:
          +
          node - Node to visit.
          +
          Returns:
          +
          Return value of the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          stringNode

          +
          public R stringNode​(StringNode node)
          +
          Description copied from interface: NodeVisitor
          +
          Visits a string node.
          +
          +
          Specified by:
          +
          stringNode in interface NodeVisitor<R>
          +
          Parameters:
          +
          node - Node to visit.
          +
          Returns:
          +
          Return value of the visitor.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/node/NodeVisitor.html b/javadoc/1.47.0/software/amazon/smithy/model/node/NodeVisitor.html new file mode 100644 index 00000000000..36cf72e2eba --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/node/NodeVisitor.html @@ -0,0 +1,407 @@ + + + + + +NodeVisitor (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.node
    +

    Interface NodeVisitor<R>

    +
    +
    +
    +
      +
    • +
      +
      Type Parameters:
      +
      R - Return type of the visitor.
      +
      +
      +
      All Known Implementing Classes:
      +
      NodeVisitor.Default
      +
      +
      +
      public interface NodeVisitor<R>
      +
      Node visitor interface.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          arrayNode

          +
          R arrayNode​(ArrayNode node)
          +
          Visits an array node.
          +
          +
          Parameters:
          +
          node - Node to visit.
          +
          Returns:
          +
          Return value of the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          booleanNode

          +
          R booleanNode​(BooleanNode node)
          +
          Visits a boolean node.
          +
          +
          Parameters:
          +
          node - Node to visit.
          +
          Returns:
          +
          Return value of the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          nullNode

          +
          R nullNode​(NullNode node)
          +
          Visits a null node.
          +
          +
          Parameters:
          +
          node - Node to visit.
          +
          Returns:
          +
          Return value of the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          numberNode

          +
          R numberNode​(NumberNode node)
          +
          Visits a number node.
          +
          +
          Parameters:
          +
          node - Node to visit.
          +
          Returns:
          +
          Return value of the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          objectNode

          +
          R objectNode​(ObjectNode node)
          +
          Visits an object node.
          +
          +
          Parameters:
          +
          node - Node to visit.
          +
          Returns:
          +
          Return value of the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          stringNode

          +
          R stringNode​(StringNode node)
          +
          Visits a string node.
          +
          +
          Parameters:
          +
          node - Node to visit.
          +
          Returns:
          +
          Return value of the visitor.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/node/NullNode.html b/javadoc/1.47.0/software/amazon/smithy/model/node/NullNode.html new file mode 100644 index 00000000000..c57c0b87998 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/node/NullNode.html @@ -0,0 +1,510 @@ + + + + + +NullNode (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.node
    +

    Class NullNode

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getType

          +
          public NodeType getType()
          +
          Description copied from class: Node
          +
          Gets the type of the node.
          +
          +
          Specified by:
          +
          getType in class Node
          +
          Returns:
          +
          Returns the node type.
          +
          +
          • +
        + + + +
          +
        • +

          accept

          +
          public <R> R accept​(NodeVisitor<R> visitor)
          +
          Description copied from class: Node
          +
          Accepts a visitor with the node.
          +
          +
          Specified by:
          +
          accept in class Node
          +
          Type Parameters:
          +
          R - visitor return type.
          +
          Parameters:
          +
          visitor - Visitor to dispatch to.
          +
          Returns:
          +
          Returns the accepted result.
          +
          +
          • +
        + + + +
          +
        • +

          expectNullNode

          +
          public NullNode expectNullNode​(java.lang.String errorMessage)
          +
          Description copied from class: Node
          +
          Casts the current node to a NullNode, throwing + ExpectationNotMetException when the node is the wrong type.
          +
          +
          Overrides:
          +
          expectNullNode in class Node
          +
          Parameters:
          +
          errorMessage - Error message to use if the node is of the wrong type.
          +
          Returns:
          +
          Returns a null node.
          +
          +
          • +
        + + + +
          +
        • +

          expectNullNode

          +
          public NullNode expectNullNode​(java.util.function.Supplier<java.lang.String> errorMessage)
          +
          Description copied from class: Node
          +
          Casts the current node to a NullNode, throwing + ExpectationNotMetException when the node is the wrong type.
          +
          +
          Overrides:
          +
          expectNullNode in class Node
          +
          Parameters:
          +
          errorMessage - Error message supplier.
          +
          Returns:
          +
          Returns a null node.
          +
          +
          • +
        + + + +
          +
        • +

          asNullNode

          +
          public java.util.Optional<NullNode> asNullNode()
          +
          Description copied from class: Node
          +
          Gets the node as an NullNode if it is a null.
          +
          +
          Overrides:
          +
          asNullNode in class Node
          +
          Returns:
          +
          Returns the optional NullNode.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object other)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/node/NumberNode.html b/javadoc/1.47.0/software/amazon/smithy/model/node/NumberNode.html new file mode 100644 index 00000000000..cfaf1a0dd34 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/node/NumberNode.html @@ -0,0 +1,698 @@ + + + + + +NumberNode (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.node
    +

    Class NumberNode

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      FromSourceLocation, ToNode
      +
      +
      +
      public final class NumberNode
+extends Node
      +
      Represents a number node. Number nodes contain a Number value. + +

      Number nodes contain a value. You can inspect its type by calling + isNaturalNumber() or isFloatingPointNumber(). Natural + numbers are positive, or negative numbers without a decimal part.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          NumberNode

          +
          public NumberNode​(java.lang.Number value,
+                  SourceLocation sourceLocation)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getValue

          +
          public java.lang.Number getValue()
          +
          Gets the number value.
          +
          +
          Returns:
          +
          Returns a number.
          +
          +
          • +
        + + + +
          +
        • +

          asBigDecimal

          +
          public java.util.Optional<java.math.BigDecimal> asBigDecimal()
          +
          Gets the number value as a BigDecimal if possible. + +

          NaN and infinite numbers will return an empty Optional.

          +
          +
          Returns:
          +
          Returns the BigDecimal value of the wrapped number.
          +
          +
          • +
        + + + +
          +
        • +

          isNaturalNumber

          +
          @Deprecated
+public boolean isNaturalNumber()
          +
          Deprecated.
          +
          • +
        + + + +
          +
        • +

          isNegative

          +
          public boolean isNegative()
          +
          Check the value is negative, including negative infinity. + +

          Any number >= 0, +Infinity, and NaN return false.

          +
          +
          Returns:
          +
          Return true if negative.
          +
          +
          • +
        + + + +
          +
        • +

          isFloatingPointNumber

          +
          public boolean isFloatingPointNumber()
          +
          Returns true if the node contains a floating point number.
          +
          +
          Returns:
          +
          Returns true if the node contains a floating point number.
          +
          +
          • +
        + + + +
          +
        • +

          isNaN

          +
          public boolean isNaN()
          +
          Returns true if the number is a floating point NaN.
          +
          +
          Returns:
          +
          Return true if NaN.
          +
          +
          • +
        + + + +
          +
        • +

          isInfinite

          +
          public boolean isInfinite()
          +
          Returns true if the number is infinite.
          +
          +
          Returns:
          +
          Return true if infinite.
          +
          +
          • +
        + + + +
          +
        • +

          getType

          +
          public NodeType getType()
          +
          Description copied from class: Node
          +
          Gets the type of the node.
          +
          +
          Specified by:
          +
          getType in class Node
          +
          Returns:
          +
          Returns the node type.
          +
          +
          • +
        + + + +
          +
        • +

          accept

          +
          public <R> R accept​(NodeVisitor<R> visitor)
          +
          Description copied from class: Node
          +
          Accepts a visitor with the node.
          +
          +
          Specified by:
          +
          accept in class Node
          +
          Type Parameters:
          +
          R - visitor return type.
          +
          Parameters:
          +
          visitor - Visitor to dispatch to.
          +
          Returns:
          +
          Returns the accepted result.
          +
          +
          • +
        + + + +
          +
        • +

          expectNumberNode

          +
          public NumberNode expectNumberNode​(java.lang.String errorMessage)
          +
          Description copied from class: Node
          +
          Casts the current node to a NumberNode, throwing + ExpectationNotMetException when the node is the wrong type.
          +
          +
          Overrides:
          +
          expectNumberNode in class Node
          +
          Parameters:
          +
          errorMessage - Error message to use if the node is of the wrong type.
          +
          Returns:
          +
          Returns a number node.
          +
          +
          • +
        + + + +
          +
        • +

          expectNumberNode

          +
          public NumberNode expectNumberNode​(java.util.function.Supplier<java.lang.String> errorMessage)
          +
          Description copied from class: Node
          +
          Casts the current node to a NumberNode, throwing + ExpectationNotMetException when the node is the wrong type.
          +
          +
          Overrides:
          +
          expectNumberNode in class Node
          +
          Parameters:
          +
          errorMessage - Error message supplier.
          +
          Returns:
          +
          Returns a number node.
          +
          +
          • +
        + + + +
          +
        • +

          asNumberNode

          +
          public java.util.Optional<NumberNode> asNumberNode()
          +
          Description copied from class: Node
          +
          Gets the node as an NumberNode if it is an number.
          +
          +
          Overrides:
          +
          asNumberNode in class Node
          +
          Returns:
          +
          Returns the optional NumberNode.
          +
          +
          • +
        + + + +
          +
        • +

          isZero

          +
          public boolean isZero()
          +
          Returns true if the value of the number contained in the number node is zero, + accounting for float, double, bigInteger, bigDecimal, and other numeric types + (e.g., 0, 0.0, etc). + +

          Note that -0 and +0 are considered 0. However, NaN is not considered zero. + When unknown number types are encountered, this method will return true if the + toString of the given number returns "0", or "0.0". Other kinds of unknown + number types will be treated like a double. + +

          Double and float comparisons to zero are exact and use no rounding. The majority + of values seen by this method come from models that use "0" or "0.0". However, + we can improve this in the future with some kind of epsilon if the need arises.

          +
          +
          Returns:
          +
          Returns true if set to zero.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object other)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/node/ObjectNode.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/node/ObjectNode.Builder.html new file mode 100644 index 00000000000..7ac88cd2710 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/node/ObjectNode.Builder.html @@ -0,0 +1,442 @@ + + + + + +ObjectNode.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.node
    +

    Class ObjectNode.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.node.ObjectNode.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/node/ObjectNode.html b/javadoc/1.47.0/software/amazon/smithy/model/node/ObjectNode.html new file mode 100644 index 00000000000..732cf478c26 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/node/ObjectNode.html @@ -0,0 +1,1900 @@ + + + + + +ObjectNode (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.node
    +

    Class ObjectNode

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          fromStringMap

          +
          public static ObjectNode fromStringMap​(java.util.Map<java.lang.String,​java.lang.String> map)
          +
          • +
        + + + + + + + +
          +
        • +

          getType

          +
          public NodeType getType()
          +
          Description copied from class: Node
          +
          Gets the type of the node.
          +
          +
          Specified by:
          +
          getType in class Node
          +
          Returns:
          +
          Returns the node type.
          +
          +
          • +
        + + + +
          +
        • +

          accept

          +
          public <R> R accept​(NodeVisitor<R> visitor)
          +
          Description copied from class: Node
          +
          Accepts a visitor with the node.
          +
          +
          Specified by:
          +
          accept in class Node
          +
          Type Parameters:
          +
          R - visitor return type.
          +
          Parameters:
          +
          visitor - Visitor to dispatch to.
          +
          Returns:
          +
          Returns the accepted result.
          +
          +
          • +
        + + + +
          +
        • +

          expectObjectNode

          +
          public ObjectNode expectObjectNode​(java.lang.String errorMessage)
          +
          Description copied from class: Node
          +
          Casts the current node to an ObjectNode, throwing + ExpectationNotMetException when the node is the wrong type.
          +
          +
          Overrides:
          +
          expectObjectNode in class Node
          +
          Parameters:
          +
          errorMessage - Error message to use if the node is of the wrong type.
          +
          Returns:
          +
          Returns an object node.
          +
          +
          • +
        + + + +
          +
        • +

          expectObjectNode

          +
          public ObjectNode expectObjectNode​(java.util.function.Supplier<java.lang.String> errorMessage)
          +
          Description copied from class: Node
          +
          Casts the current node to an ObjectNode, throwing + ExpectationNotMetException when the node is the wrong type.
          +
          +
          Overrides:
          +
          expectObjectNode in class Node
          +
          Parameters:
          +
          errorMessage - Error message supplier.
          +
          Returns:
          +
          Returns an object node.
          +
          +
          • +
        + + + +
          +
        • +

          asObjectNode

          +
          public java.util.Optional<ObjectNode> asObjectNode()
          +
          Description copied from class: Node
          +
          Gets the node as an ObjectNode if it is an object.
          +
          +
          Overrides:
          +
          asObjectNode in class Node
          +
          Returns:
          +
          Returns the optional object node.
          +
          +
          • +
        + + + + + +
          +
        • +

          withMember

          +
          public <T extends ToNode> ObjectNode withMember​(StringNode key,
+                                                T value)
          +
          Constructs a new object node with the given member added.
          +
          +
          Type Parameters:
          +
          T - Type of the value member to add.
          +
          Parameters:
          +
          key - Name of the member to add.
          +
          value - Value of the member to add.
          +
          Returns:
          +
          Returns a new object node.
          +
          +
          • +
        + + + + + +
          +
        • +

          withMember

          +
          public <T extends ToNode> ObjectNode withMember​(java.lang.String key,
+                                                T value)
          +
          Constructs a new object node with the given member added.
          +
          +
          Type Parameters:
          +
          T - Type of the value member to add.
          +
          Parameters:
          +
          key - Name of the member to add as a string.
          +
          value - Value of the member to add.
          +
          Returns:
          +
          Returns a new object node.
          +
          +
          • +
        + + + +
          +
        • +

          withMember

          +
          public ObjectNode withMember​(java.lang.String key,
+                             java.lang.String value)
          +
          Constructs a new object node with the given member added.
          +
          +
          Parameters:
          +
          key - Name of the member to add as a string.
          +
          value - Value of the member to add.
          +
          Returns:
          +
          Returns a new object node.
          +
          +
          • +
        + + + +
          +
        • +

          withMember

          +
          public ObjectNode withMember​(java.lang.String key,
+                             boolean value)
          +
          Constructs a new object node with the given member added.
          +
          +
          Parameters:
          +
          key - Name of the member to add as a string.
          +
          value - Value of the member to add.
          +
          Returns:
          +
          Returns a new object node.
          +
          +
          • +
        + + + +
          +
        • +

          withMember

          +
          public ObjectNode withMember​(java.lang.String key,
+                             java.lang.Number value)
          +
          Constructs a new object node with the given member added.
          +
          +
          Parameters:
          +
          key - Name of the member to add as a string.
          +
          value - Value of the member to add.
          +
          Returns:
          +
          Returns a new object node.
          +
          +
          • +
        + + + +
          +
        • +

          withOptionalMember

          +
          public <T extends ToNode> ObjectNode withOptionalMember​(java.lang.String key,
+                                                        java.util.Optional<T> value)
          +
          Adds a member to a new ObjectNode if the provided value is present.
          +
          +
          Type Parameters:
          +
          T - Type of the value member to add.
          +
          Parameters:
          +
          key - Key to set if value is present.
          +
          value - Value that may be present.
          +
          Returns:
          +
          Returns an object with the optionally added member.
          +
          +
          • +
        + + + +
          +
        • +

          withoutMember

          +
          public ObjectNode withoutMember​(java.lang.String memberName)
          +
          Constructs a new object node from the current node, but without + the named member.
          +
          +
          Parameters:
          +
          memberName - Name of a member that should be omitted.
          +
          Returns:
          +
          Returns a new object node.
          +
          +
          • +
        + + + +
          +
        • +

          getMembers

          +
          public java.util.Map<StringNode,​Node> getMembers()
          +
          Gets the map of members.
          +
          +
          Returns:
          +
          Returns a map of nodes.
          +
          +
          • +
        + + + +
          +
        • +

          containsMember

          +
          public boolean containsMember​(java.lang.String memberName)
          +
          Checks if the given member name exists in the ObjectNode.
          +
          +
          Parameters:
          +
          memberName - Member name to check.
          +
          Returns:
          +
          Returns true if this member is in the ObjectNode.
          +
          +
          • +
        + + + +
          +
        • +

          getMember

          +
          public java.util.Optional<Node> getMember​(java.lang.String memberName)
          +
          Gets the member with the given name.
          +
          +
          Parameters:
          +
          memberName - Name of the member to get.
          +
          Returns:
          +
          Returns the optional node with the given member name.
          +
          +
          • +
        + + + +
          +
        • +

          getMembersByPrefix

          +
          public java.util.Map<java.lang.String,​Node> getMembersByPrefix​(java.lang.String prefix)
          +
          Gets a map of all members where the key starts with the given prefix.
          +
          +
          Parameters:
          +
          prefix - Prefix to search for in keys.
          +
          Returns:
          +
          Returns the map of matching members.
          +
          +
          • +
        + + + +
          +
        • +

          getStringMap

          +
          public java.util.Map<java.lang.String,​Node> getStringMap()
          +
          Gets an immutable Map<String, Node> that represents the ObjectNode.
          +
          +
          Returns:
          +
          Returns the immutable map.
          +
          +
          • +
        + + + +
          +
        • +

          getStringMember

          +
          public java.util.Optional<StringNode> getStringMember​(java.lang.String memberName)
          +
          Gets the member with the given name, and if present, expects it to + be a string.
          +
          +
          Parameters:
          +
          memberName - Name of the member to get.
          +
          Returns:
          +
          Returns the optional node with the given member name.
          +
          Throws:
          +
          ExpectationNotMetException - if the member is not a string.
          +
          +
          • +
        + + + +
          +
        • +

          getStringMemberOrDefault

          +
          public java.lang.String getStringMemberOrDefault​(java.lang.String memberName,
+                                                 java.lang.String defaultValue)
          +
          Gets the member with the given name, and if present, expects it to + be a string, otherwise returns the default value.
          +
          +
          Parameters:
          +
          memberName - Name of the member to get.
          +
          defaultValue - Default string value to return if the member is not present.
          +
          Returns:
          +
          Returns a String value contained in the String node or the default value.
          +
          Throws:
          +
          ExpectationNotMetException - if the member is not a string.
          +
          +
          • +
        + + + +
          +
        • +

          getNumberMember

          +
          public java.util.Optional<NumberNode> getNumberMember​(java.lang.String memberName)
          +
          Gets the member with the given name, and if present, expects it to + be a number.
          +
          +
          Parameters:
          +
          memberName - Name of the member to get.
          +
          Returns:
          +
          Returns the optional node with the given member name.
          +
          Throws:
          +
          ExpectationNotMetException - if the member is not a number.
          +
          +
          • +
        + + + +
          +
        • +

          getNumberMemberOrDefault

          +
          public java.lang.Number getNumberMemberOrDefault​(java.lang.String memberName,
+                                                 java.lang.Number defaultValue)
          +
          Gets the member with the given name, and if present, expects it to + be a number, otherwise returns the default value.
          +
          +
          Parameters:
          +
          memberName - Name of the member to get.
          +
          defaultValue - Default value to return if a member is not found.
          +
          Returns:
          +
          Returns the Number value or a default value.
          +
          Throws:
          +
          ExpectationNotMetException - if the member is not a number.
          +
          +
          • +
        + + + +
          +
        • +

          getArrayMember

          +
          public java.util.Optional<ArrayNode> getArrayMember​(java.lang.String memberName)
          +
          Gets the member with the given name, and if present, expects it to + be an array.
          +
          +
          Parameters:
          +
          memberName - Name of the member to get.
          +
          Returns:
          +
          Returns the optional node with the given member name.
          +
          Throws:
          +
          ExpectationNotMetException - if the member is not an array.
          +
          +
          • +
        + + + +
          +
        • +

          getObjectMember

          +
          public java.util.Optional<ObjectNode> getObjectMember​(java.lang.String memberName)
          +
          Gets the member with the given name, and if present, expects it to + be an object.
          +
          +
          Parameters:
          +
          memberName - Name of the member to get.
          +
          Returns:
          +
          Returns the optional node with the given member name.
          +
          Throws:
          +
          ExpectationNotMetException - if the member is not an object.
          +
          +
          • +
        + + + +
          +
        • +

          getBooleanMember

          +
          public java.util.Optional<BooleanNode> getBooleanMember​(java.lang.String memberName)
          +
          Gets the member with the given name, and if present, expects it to + be a boolean.
          +
          +
          Parameters:
          +
          memberName - Name of the member to get.
          +
          Returns:
          +
          Returns the optional node with the given member name.
          +
          Throws:
          +
          ExpectationNotMetException - if the member is not a boolean.
          +
          +
          • +
        + + + +
          +
        • +

          getBooleanMemberOrDefault

          +
          public java.lang.Boolean getBooleanMemberOrDefault​(java.lang.String memberName,
+                                                   java.lang.Boolean defaultValue)
          +
          Gets the member with the given name, and if present, expects it to + be a boolean, otherwise returns a default value.
          +
          +
          Parameters:
          +
          memberName - Name of the member to get.
          +
          defaultValue - Default value to return if not present.
          +
          Returns:
          +
          Returns the boolean value or a default value.
          +
          Throws:
          +
          ExpectationNotMetException - if the member is not a boolean.
          +
          +
          • +
        + + + +
          +
        • +

          getBooleanMemberOrDefault

          +
          public boolean getBooleanMemberOrDefault​(java.lang.String memberName)
          +
          Gets the member with the given name, and if present, expects it to + be a boolean, otherwise returns false.
          +
          +
          Parameters:
          +
          memberName - Name of the member to get.
          +
          Returns:
          +
          Returns the boolean value or false if not found.
          +
          Throws:
          +
          ExpectationNotMetException - if the member is found and not a boolean.
          +
          +
          • +
        + + + +
          +
        • +

          expectMember

          +
          public Node expectMember​(java.lang.String name)
          +
          Gets the member with the given name.
          +
          +
          Parameters:
          +
          name - Name of the member to get.
          +
          Returns:
          +
          Returns the node with the given member name.
          +
          Throws:
          +
          java.lang.IllegalArgumentException - when memberName is null.
          +
          ExpectationNotMetException - when memberName is not + present in the members map.
          +
          +
          • +
        + + + +
          +
        • +

          expectMember

          +
          public Node expectMember​(java.lang.String name,
+                         java.lang.String errorMessage)
          +
          Gets the member with the given name, throwing + ExpectationNotMetException when the member is not present.
          +
          +
          Parameters:
          +
          name - Name of the member to get.
          +
          errorMessage - The error message to use if the expectation is not met.
          +
          Returns:
          +
          Returns the node with the given member name.
          +
          Throws:
          +
          ExpectationNotMetException - when memberName is not + present in the members map.
          +
          +
          • +
        + + + +
          +
        • +

          expectMember

          +
          public Node expectMember​(java.lang.String name,
+                         java.util.function.Supplier<java.lang.String> errorMessage)
          +
          Gets the member with the given name, throwing + ExpectationNotMetException when the member is not present.
          +
          +
          Parameters:
          +
          name - Name of the member to get.
          +
          errorMessage - Error message supplier.
          +
          Returns:
          +
          Returns the node with the given member name.
          +
          Throws:
          +
          ExpectationNotMetException - when memberName is not + present in the members map.
          +
          +
          • +
        + + + +
          +
        • +

          expectArrayMember

          +
          public ArrayNode expectArrayMember​(java.lang.String name)
          +
          Gets a member and requires it to be an array.
          +
          +
          Parameters:
          +
          name - Name of the member to get.
          +
          Returns:
          +
          Returns the node with the given member name.
          +
          Throws:
          +
          ExpectationNotMetException - when not present or not an array.
          +
          +
          • +
        + + + +
          +
        • +

          expectBooleanMember

          +
          public BooleanNode expectBooleanMember​(java.lang.String name)
          +
          Gets a member and requires it to be a boolean.
          +
          +
          Parameters:
          +
          name - Name of the member to get.
          +
          Returns:
          +
          Returns the node with the given member name.
          +
          Throws:
          +
          ExpectationNotMetException - when not present or not a boolean.
          +
          +
          • +
        + + + +
          +
        • +

          expectNullMember

          +
          public NullNode expectNullMember​(java.lang.String name)
          +
          Gets a member and requires it to be a null.
          +
          +
          Parameters:
          +
          name - Name of the member to get.
          +
          Returns:
          +
          Returns the node with the given member name.
          +
          Throws:
          +
          ExpectationNotMetException - when not present or not a null.
          +
          +
          • +
        + + + +
          +
        • +

          expectNumberMember

          +
          public NumberNode expectNumberMember​(java.lang.String name)
          +
          Gets a member and requires it to be a number.
          +
          +
          Parameters:
          +
          name - Name of the member to get.
          +
          Returns:
          +
          Returns the node with the given member name.
          +
          Throws:
          +
          ExpectationNotMetException - when not present or not a number.
          +
          +
          • +
        + + + +
          +
        • +

          expectObjectMember

          +
          public ObjectNode expectObjectMember​(java.lang.String name)
          +
          Gets a member and requires it to be an object.
          +
          +
          Parameters:
          +
          name - Name of the member to get.
          +
          Returns:
          +
          Returns the node with the given member name.
          +
          Throws:
          +
          ExpectationNotMetException - when not present or not an object.
          +
          +
          • +
        + + + +
          +
        • +

          expectStringMember

          +
          public StringNode expectStringMember​(java.lang.String name)
          +
          Gets a member and requires it to be a string.
          +
          +
          Parameters:
          +
          name - Name of the member to get.
          +
          Returns:
          +
          Returns the node with the given member name.
          +
          Throws:
          +
          ExpectationNotMetException - when not present or not a string.
          +
          +
          • +
        + + + +
          +
        • +

          expectNoAdditionalProperties

          +
          public ObjectNode expectNoAdditionalProperties​(java.util.Collection<java.lang.String> allowedProperties)
          +
          Ensures that there are no additional properties other than the + provided member names.
          +
          +
          Parameters:
          +
          allowedProperties - Properties that may exist.
          +
          Returns:
          +
          Returns self
          +
          Throws:
          +
          ExpectationNotMetException - if other properties are found.
          +
          +
          • +
        + + + +
          +
        • +

          warnIfAdditionalProperties

          +
          public ObjectNode warnIfAdditionalProperties​(java.util.Collection<java.lang.String> allowedProperties)
          +
          Warns if unknown properties are found in object.
          +
          +
          Parameters:
          +
          allowedProperties - Properties that may exist.
          +
          Returns:
          +
          Returns self
          +
          +
          • +
        + + + +
          +
        • +

          expectMember

          +
          public <T> ObjectNode expectMember​(java.lang.String key,
+                                   java.util.function.Function<Node,​T> mapper,
+                                   java.util.function.Consumer<T> consumer)
          +
          Requires that the key member is present, passes the value through the given mapper, and then + passes the mapped value to consumer.
          +
          +
          Type Parameters:
          +
          T - Mapped value type.
          +
          Parameters:
          +
          key - Key to get from the object.
          +
          mapper - Mapping function used to convert the node value.
          +
          consumer - Consumer to pass the found value to.
          +
          Returns:
          +
          Returns the node.
          +
          +
          • +
        + + + +
          +
        • +

          getMember

          +
          public <T> ObjectNode getMember​(java.lang.String key,
+                                java.util.function.Function<Node,​T> mapper,
+                                java.util.function.Consumer<T> consumer)
          +
          The same as expectMember(String, Function, Consumer), but the member is optional.
          +
          +
          Type Parameters:
          +
          T - Mapped value type.
          +
          Parameters:
          +
          key - Key to get from the object.
          +
          mapper - Mapping function used to convert the node value.
          +
          consumer - Consumer to pass the found value to.
          +
          Returns:
          +
          Returns the node.
          +
          +
          • +
        + + + +
          +
        • +

          expectObjectMember

          +
          public ObjectNode expectObjectMember​(java.lang.String name,
+                                     java.util.function.Consumer<ObjectNode> consumer)
          +
          Gets a member and requires it to be an object.
          +
          +
          Parameters:
          +
          name - Name of the member to get.
          +
          consumer - Consumer that accepts the object member.
          +
          Returns:
          +
          Returns the node.
          +
          Throws:
          +
          ExpectationNotMetException - when not present or not an object.
          +
          +
          • +
        + + + +
          +
        • +

          getObjectMember

          +
          public ObjectNode getObjectMember​(java.lang.String memberName,
+                                  java.util.function.Consumer<ObjectNode> consumer)
          +
          Gets the member with the given name, and if present, expects it to be an object.
          +
          +
          Parameters:
          +
          memberName - Name of the member to get.
          +
          consumer - Consumer that accepts the member if found.
          +
          Returns:
          +
          Returns the node.
          +
          Throws:
          +
          ExpectationNotMetException - if the member is not an object.
          +
          +
          • +
        + + + +
          +
        • +

          expectStringMember

          +
          public ObjectNode expectStringMember​(java.lang.String key,
+                                     java.util.function.Consumer<java.lang.String> consumer)
          +
          Requires that key exists, is a string, and passes the value to consumer.
          +
          +
          Parameters:
          +
          key - Key to retrieve.
          +
          consumer - Consumer that accepts the string value.
          +
          Returns:
          +
          Returns the node.
          +
          +
          • +
        + + + +
          +
        • +

          getStringMember

          +
          public ObjectNode getStringMember​(java.lang.String key,
+                                  java.util.function.Consumer<java.lang.String> consumer)
          +
          The same as expectStringMember(String, Consumer) but the member is optional.
          +
          +
          Parameters:
          +
          key - Key to retrieve.
          +
          consumer - Consumer that accepts the string value.
          +
          Returns:
          +
          Returns the node.
          +
          +
          • +
        + + + +
          +
        • +

          expectBooleanMember

          +
          public ObjectNode expectBooleanMember​(java.lang.String key,
+                                      java.util.function.Consumer<java.lang.Boolean> consumer)
          +
          Requires that key exists, is a boolean, and passes the value to consumer.
          +
          +
          Parameters:
          +
          key - Key to retrieve.
          +
          consumer - Consumer that accepts the boolean value.
          +
          Returns:
          +
          Returns the node.
          +
          +
          • +
        + + + +
          +
        • +

          getBooleanMember

          +
          public ObjectNode getBooleanMember​(java.lang.String key,
+                                   java.util.function.Consumer<java.lang.Boolean> consumer)
          +
          The same as expectBooleanMember(String, Consumer) but the member is optional.
          +
          +
          Parameters:
          +
          key - Key to retrieve.
          +
          consumer - Consumer that accepts the boolean value.
          +
          Returns:
          +
          Returns the node.
          +
          +
          • +
        + + + +
          +
        • +

          expectNumberMember

          +
          public ObjectNode expectNumberMember​(java.lang.String key,
+                                     java.util.function.Consumer<java.lang.Number> consumer)
          +
          Requires that key exists, is a number, and passes the value to consumer.
          +
          +
          Parameters:
          +
          key - Key to retrieve.
          +
          consumer - Consumer that accepts the number value.
          +
          Returns:
          +
          Returns the node.
          +
          +
          • +
        + + + +
          +
        • +

          getNumberMember

          +
          public ObjectNode getNumberMember​(java.lang.String key,
+                                  java.util.function.Consumer<java.lang.Number> consumer)
          +
          The same as expectNumberMember(String, Consumer) but the member is optional.
          +
          +
          Parameters:
          +
          key - Key to retrieve.
          +
          consumer - Consumer that accepts the number value.
          +
          Returns:
          +
          Returns the node.
          +
          +
          • +
        + + + +
          +
        • +

          getArrayMember

          +
          public ObjectNode getArrayMember​(java.lang.String key,
+                                 java.util.function.Consumer<java.util.List<Node>> consumer)
          +
          Gets the nodes of an optional member that contains an array.
          +
          +
          Parameters:
          +
          key - Key to retrieve.
          +
          consumer - Consumer that accepts the array node value.
          +
          Returns:
          +
          Returns the node.
          +
          +
          • +
        + + + +
          +
        • +

          expectArrayMember

          +
          public <N extends Node,​T> ObjectNode expectArrayMember​(java.lang.String k,
+                                                             java.util.function.Function<N,​T> map,
+                                                             java.util.function.Consumer<java.util.List<T>> consumer)
          +
          Requires that the given member exists and is an array; then creates a list of values for the array by passing + array element through the mapping function, and passes that list to the consumer.
          +
          +
          Type Parameters:
          +
          N - Type of Node to expect in each array element.
          +
          T - Type of value returned from the mapper.
          +
          Parameters:
          +
          k - Key to retrieve.
          +
          map - Mapper that takes each array node and returns a mapped value.
          +
          consumer - Consumer that accepts the collected mapped values.
          +
          Returns:
          +
          Returns the node.
          +
          +
          • +
        + + + +
          +
        • +

          getArrayMember

          +
          public <N extends Node,​T> ObjectNode getArrayMember​(java.lang.String k,
+                                                          java.util.function.Function<N,​T> map,
+                                                          java.util.function.Consumer<java.util.List<T>> consumer)
          +
          The same as expectArrayMember(String, Function, Consumer), but the member is optional.
          +
          +
          Type Parameters:
          +
          N - Type of Node to expect in each array element.
          +
          T - Type of value returned from the mapper.
          +
          Parameters:
          +
          k - Key to retrieve.
          +
          map - Mapper that takes each array node and returns a mapped value.
          +
          consumer - Consumer that accepts the collected mapped values.
          +
          Returns:
          +
          Returns the node.
          +
          +
          • +
        + + + +
          +
        • +

          isEmpty

          +
          public boolean isEmpty()
          +
          Returns true if this object has no members.
          +
          +
          Returns:
          +
          Returns if this object is empty.
          +
          +
          • +
        + + + +
          +
        • +

          size

          +
          public int size()
          +
          Returns the number of members.
          +
          +
          Returns:
          +
          Returns the number of members.
          +
          +
          • +
        + + + +
          +
        • +

          merge

          +
          public ObjectNode merge​(ObjectNode other)
          +
          Merge this object node with another, creating a new ObjectNode. + +

          Conflicting keys are overwritten by other. If the current + object has a source location, it is applied to the result. Otherwise, + the source location of other is applied to the result.

          +
          +
          Parameters:
          +
          other - Other object node to merge with.
          +
          Returns:
          +
          Returns the merged object node.
          +
          +
          • +
        + + + +
          +
        • +

          collect

          +
          public static <T> java.util.stream.Collector<T,​java.util.Map<StringNode,​Node>,​ObjectNode> collect​(java.util.function.Function<T,​StringNode> keyMapper,
+                                                                                                                    java.util.function.Function<T,​ToNode> valueMapper)
          +
          Creates a collector that creates an ObjectNode.
          +
          +
          Type Parameters:
          +
          T - Type being collected over (e.g., Map.Entry, Pair, etc.).
          +
          Parameters:
          +
          keyMapper - Key mapping function that returns a ToNode.
          +
          valueMapper - Value mapping function that returns a ToNode.
          +
          Returns:
          +
          Returns the created collector.
          +
          +
          • +
        + + + +
          +
        • +

          collectStringKeys

          +
          public static <T> java.util.stream.Collector<T,​java.util.Map<StringNode,​Node>,​ObjectNode> collectStringKeys​(java.util.function.Function<T,​java.lang.String> keyMapper,
+                                                                                                                              java.util.function.Function<T,​ToNode> valueMapper)
          +
          Creates a collector that creates an ObjectNode.
          +
          +
          Type Parameters:
          +
          T - Type being collected over (e.g., Map.Entry, Pair, etc.).
          +
          Parameters:
          +
          keyMapper - Key mapping function that returns a string.
          +
          valueMapper - Value mapping function that returns a ToNode.
          +
          Returns:
          +
          Returns the created collector.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object other)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/node/StringNode.html b/javadoc/1.47.0/software/amazon/smithy/model/node/StringNode.html new file mode 100644 index 00000000000..209008ac89e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/node/StringNode.html @@ -0,0 +1,713 @@ + + + + + +StringNode (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.node
    +

    Class StringNode

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          StringNode

          +
          public StringNode​(java.lang.String value,
+                  SourceLocation sourceLocation)
          +
          Creates a new StringNode.
          +
          +
          Parameters:
          +
          value - Immutable value to set.
          +
          sourceLocation - Source location of where the node was defined.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createLazyString

          +
          public static Pair<StringNode,​java.util.function.Consumer<java.lang.String>> createLazyString​(java.lang.String placeholder,
+                                                                                                    SourceLocation sourceLocation)
          +
          Creates a StringNode that is lazily populated with a value provided by + the given Supplier. + +

          This method is used in the SmithyModelLoader class to be + able to resolve unquoted strings to the appropriate shape ID. Because + this can only be done after an entire model is loaded, setting the + resolved value inside of a node needs to be deferred. + +

          Lazy string nodes are not thread safe and there's no validation + to ensure that the supplier is invoked only once. Their usage should + be rare and you should generally try to use an alternative approach.

          +
          +
          Parameters:
          +
          placeholder - Placeholder string to use until the supplier is called.
          +
          sourceLocation - Location of where the value was originally defined.
          +
          Returns:
          +
          Returns a pair of the string node and the supplier to invoke with the value.
          +
          +
          • +
        + + + +
          +
        • +

          getType

          +
          public NodeType getType()
          +
          Description copied from class: Node
          +
          Gets the type of the node.
          +
          +
          Specified by:
          +
          getType in class Node
          +
          Returns:
          +
          Returns the node type.
          +
          +
          • +
        + + + +
          +
        • +

          accept

          +
          public <R> R accept​(NodeVisitor<R> visitor)
          +
          Description copied from class: Node
          +
          Accepts a visitor with the node.
          +
          +
          Specified by:
          +
          accept in class Node
          +
          Type Parameters:
          +
          R - visitor return type.
          +
          Parameters:
          +
          visitor - Visitor to dispatch to.
          +
          Returns:
          +
          Returns the accepted result.
          +
          +
          • +
        + + + +
          +
        • +

          expectStringNode

          +
          public StringNode expectStringNode​(java.lang.String errorMessage)
          +
          Description copied from class: Node
          +
          Casts the current node to a StringNode, throwing + ExpectationNotMetException when the node is the wrong type.
          +
          +
          Overrides:
          +
          expectStringNode in class Node
          +
          Parameters:
          +
          errorMessage - Error message to use if the node is of the wrong type.
          +
          Returns:
          +
          Returns a string node.
          +
          +
          • +
        + + + +
          +
        • +

          expectStringNode

          +
          public StringNode expectStringNode​(java.util.function.Supplier<java.lang.String> errorMessage)
          +
          Description copied from class: Node
          +
          Casts the current node to a StringNode, throwing + ExpectationNotMetException when the node is the wrong type.
          +
          +
          Overrides:
          +
          expectStringNode in class Node
          +
          Parameters:
          +
          errorMessage - Error message supplier.
          +
          Returns:
          +
          Returns a string node.
          +
          +
          • +
        + + + +
          +
        • +

          asStringNode

          +
          public java.util.Optional<StringNode> asStringNode()
          +
          Description copied from class: Node
          +
          Gets the node as an StringNode if it is an string.
          +
          +
          Overrides:
          +
          asStringNode in class Node
          +
          Returns:
          +
          Returns the optional StringNode.
          +
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public java.lang.String getValue()
          +
          Gets the string value.
          +
          +
          Returns:
          +
          Returns the string value.
          +
          +
          • +
        + + + +
          +
        • +

          expectOneOf

          +
          public java.lang.String expectOneOf​(java.lang.String... validValues)
          +
          Gets the string if it is one of the provided valid strings.
          +
          +
          Parameters:
          +
          validValues - A list of valid string values.
          +
          Returns:
          +
          The string value.
          +
          Throws:
          +
          ExpectationNotMetException - when the value is not one of the + valid strings.
          +
          +
          • +
        + + + +
          +
        • +

          expectOneOf

          +
          public java.lang.String expectOneOf​(java.util.Collection<java.lang.String> validValues)
          +
          Gets the string if it is one of the provided valid strings.
          +
          +
          Parameters:
          +
          validValues - A list of valid string values.
          +
          Returns:
          +
          The string value.
          +
          Throws:
          +
          ExpectationNotMetException - if the value is not in the list.
          +
          +
          • +
        + + + +
          +
        • +

          expectShapeId

          +
          public ShapeId expectShapeId​(java.lang.String namespace)
          +
          Expects that the value of the string is a Shape ID.
          +
          +
          Parameters:
          +
          namespace - Namespace to use when resolving relative shape IDs.
          +
          Returns:
          +
          Returns the parsed Shape ID.
          +
          +
          • +
        + + + +
          +
        • +

          expectShapeId

          +
          public ShapeId expectShapeId()
          +
          Expects that the value of the string is a fully-qualified Shape ID.
          +
          +
          Returns:
          +
          Returns the parsed Shape ID.
          +
          +
          • +
        + + + +
          +
        • +

          asShapeId

          +
          public java.util.Optional<ShapeId> asShapeId()
          +
          Gets the value of the string as a ShapeId if it is a valid Shape ID.
          +
          +
          Returns:
          +
          Returns the optional Shape ID.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object other)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          compareTo

          +
          public int compareTo​(StringNode o)
          +
          +
          Specified by:
          +
          compareTo in interface java.lang.Comparable<StringNode>
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/node/ToNode.html b/javadoc/1.47.0/software/amazon/smithy/model/node/ToNode.html new file mode 100644 index 00000000000..4f1386e78f0 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/node/ToNode.html @@ -0,0 +1,264 @@ + + + + + +ToNode (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.node
    +

    Interface ToNode

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          toNode

          +
          Node toNode()
          +
          Converts a value to a Node.
          +
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/node/internal/NodeHandler.html b/javadoc/1.47.0/software/amazon/smithy/model/node/internal/NodeHandler.html new file mode 100644 index 00000000000..b10a64f8172 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/node/internal/NodeHandler.html @@ -0,0 +1,338 @@ + + + + + +NodeHandler (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.node.internal
    +

    Class NodeHandler

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.node.internal.NodeHandler
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class NodeHandler
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        NodeHandler() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static Nodeparse​(java.lang.String filename, + java.lang.String content, + boolean allowComments) 
        static java.lang.StringprettyPrint​(Node node, + java.lang.String indentString) 
        static java.lang.Stringprint​(Node node) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          NodeHandler

          +
          public NodeHandler()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          parse

          +
          public static Node parse​(java.lang.String filename,
+                         java.lang.String content,
+                         boolean allowComments)
          +
          • +
        + + + +
          +
        • +

          print

          +
          public static java.lang.String print​(Node node)
          +
          • +
        + + + +
          +
        • +

          prettyPrint

          +
          public static java.lang.String prettyPrint​(Node node,
+                                           java.lang.String indentString)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/node/internal/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/model/node/internal/package-summary.html new file mode 100644 index 00000000000..7bb86fc051c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/node/internal/package-summary.html @@ -0,0 +1,215 @@ + + + + + +software.amazon.smithy.model.node.internal (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.model.node.internal

    +
    +
    +
    + + +
    This is an adaptation of minimal-json: https://github.com/ralfstx/minimal-json + +

    The classes from that project are copied into this internal package + to allow Smithy the minimal amount of JSON parsing ability it needs to + read the AST model. We copied these classes in rather than use a dependency + to keep our external dependency count to a minimum. + +

    A few modifications were made to the original code: + +

      +
    • The style of the code was changed to match the rest of the project.
      • +
    • There is configurable support for "//" line comments when parsing.
      • +
    • Classes that aren't used were removed.
      • +
    • Pretty printing was modified to use fewer classes and to accept a + String rather than char[].
      • +
    • All Location classes were converted to be + SourceLocation
      • +
    • ModelSyntaxException is now + thrown instead of ParseException.
      • +
    • Several methods were removed from JsonHandler that weren't + being used.
      • +
    • A SourceLocation is now passed in all relevant JsonHandler end* methods.
      • +
    + +

    The original copyright is as-follows: + + 

    + Copyright (c) 2013, 2014 EclipseSource
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in all
+ copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ SOFTWARE.
+
    +
    +
      +
    • + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      NodeHandler 
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/node/internal/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/model/node/internal/package-tree.html new file mode 100644 index 00000000000..843c4cd1493 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/node/internal/package-tree.html @@ -0,0 +1,161 @@ + + + + + +software.amazon.smithy.model.node.internal Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.model.node.internal

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    +
      +
    • java.lang.Object +
        +
      • software.amazon.smithy.model.node.internal.NodeHandler
        • +
      +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/node/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/model/node/package-summary.html new file mode 100644 index 00000000000..652a0f2029e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/node/package-summary.html @@ -0,0 +1,315 @@ + + + + + +software.amazon.smithy.model.node (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.model.node

    +
    +
    +
      +
    • + + + + + + + + + + + + + + + + +
      Interface Summary 
      InterfaceDescription
      NodeVisitor<R> +
      Node visitor interface.
      +
      ToNode +
      A value that can be converted to a Node.
      +
      +
      • +
    • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      ArrayNode +
      Represents an array of nodes.
      +
      ArrayNode.Builder +
      Builder used to efficiently create an ArrayNode.
      +
      BooleanNode +
      Represents a boolean node.
      +
      Node +
      Base class of for all Smithy model nodes.
      +
      NodeMapper +
      Serializes and deserializes Smithy Node values to/from objects.
      +
      NodePointer +
      JSON Pointer abstraction over Smithy Node values.
      +
      NodeVisitor.Default<R> +
      Creates NodeVisitor that return a default value when necessary + when visiting nodes.
      +
      NullNode +
      Represents a null node.
      +
      NumberNode +
      Represents a number node.
      +
      ObjectNode +
      Represents an object node.
      +
      ObjectNode.Builder +
      Builder used to efficiently create an ObjectNode.
      +
      StringNode +
      Represents a string node.
      +
      +
      • +
    • + + + + + + + + + + + + + + + + + + + + +
      Enum Summary 
      EnumDescription
      Node.NonNumericFloat +
      Non-numeric values for floats and doubles.
      +
      NodeMapper.WhenMissing +
      Specifies the behavior of the mapper when attempting to deserialize an unknown property.
      +
      NodeType +
      The set of possible node types.
      +
      +
      • +
    • + + + + + + + + + + + + + + + + + + + + +
      Exception Summary 
      ExceptionDescription
      ExpectationNotMetException +
      Thrown by Node methods that expect a node to be of a particular + type or to have a particular member.
      +
      NodeDeserializationException +
      Exception encountered during deserialization.
      +
      NodeSerializationException +
      Exception encountered during serialization.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/node/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/model/node/package-tree.html new file mode 100644 index 00000000000..61067dbeb00 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/node/package-tree.html @@ -0,0 +1,217 @@ + + + + + +software.amazon.smithy.model.node Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.model.node

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    +
      +
    • software.amazon.smithy.model.node.NodeVisitor<R>
      • +
    • software.amazon.smithy.model.node.ToNode
      • +
    +
    +
    +

    Enum Hierarchy

    +
      +
    • java.lang.Object + +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/model/package-summary.html new file mode 100644 index 00000000000..0b904b8e93b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/package-summary.html @@ -0,0 +1,213 @@ + + + + + +software.amazon.smithy.model (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.model

    +
    +
    +
      +
    • + + + + + + + + + + + + +
      Interface Summary 
      InterfaceDescription
      FromSourceLocation +
      A value that can be traced back to a SourceLocation.
      +
      +
      • +
    • + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      Model +
      A Smithy model that contains shapes, traits, metadata, and various + computed information used to interpret the model.
      +
      Model.Builder +
      Builder used to create a Model.
      +
      SourceLocation +
      Represents the source location of a model component.
      +
      +
      • +
    • + + + + + + + + + + + + +
      Exception Summary 
      ExceptionDescription
      SourceException +
      An exception that can be traced back to a SourceLocation.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/model/package-tree.html new file mode 100644 index 00000000000..089703a2631 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/package-tree.html @@ -0,0 +1,182 @@ + + + + + +software.amazon.smithy.model Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.model

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    +
      +
    • java.lang.Object +
        +
      • software.amazon.smithy.model.Model (implements software.amazon.smithy.utils.ToSmithyBuilder<T>)
        • +
      • software.amazon.smithy.model.Model.Builder (implements software.amazon.smithy.utils.SmithyBuilder<T>)
        • +
      • software.amazon.smithy.model.SourceLocation (implements java.lang.Comparable<T>, software.amazon.smithy.model.FromSourceLocation)
        • +
      • java.lang.Throwable (implements java.io.Serializable) +
          +
        • java.lang.Exception + +
          • +
        +
        • +
      +
      • +
    +
    +
    +

    Interface Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/pattern/InvalidPatternException.html b/javadoc/1.47.0/software/amazon/smithy/model/pattern/InvalidPatternException.html new file mode 100644 index 00000000000..34edc391b9e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/pattern/InvalidPatternException.html @@ -0,0 +1,306 @@ + + + + + +InvalidPatternException (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.pattern
    +

    Class InvalidPatternException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Throwable
        • +
      • +
          +
        • java.lang.Exception
          • +
        • +
            +
          • java.lang.RuntimeException
            • +
          • +
              +
            • java.lang.IllegalArgumentException
              • +
            • +
                +
              • software.amazon.smithy.model.pattern.InvalidPatternException
                • +
              +
              • +
            +
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      Direct Known Subclasses:
      +
      InvalidUriPatternException
      +
      +
      +
      public class InvalidPatternException
+extends java.lang.IllegalArgumentException
      +
      Exception thrown for invalid patterns.
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        InvalidPatternException​(java.lang.String message) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          InvalidPatternException

          +
          public InvalidPatternException​(java.lang.String message)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/pattern/InvalidUriPatternException.html b/javadoc/1.47.0/software/amazon/smithy/model/pattern/InvalidUriPatternException.html new file mode 100644 index 00000000000..29dc7fb650e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/pattern/InvalidUriPatternException.html @@ -0,0 +1,261 @@ + + + + + +InvalidUriPatternException (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.pattern
    +

    Class InvalidUriPatternException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      public final class InvalidUriPatternException
+extends InvalidPatternException
      +
      Exception thrown for invalid HTTP URI patterns.
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/pattern/SmithyPattern.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/pattern/SmithyPattern.Builder.html new file mode 100644 index 00000000000..8e37c8aab5d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/pattern/SmithyPattern.Builder.html @@ -0,0 +1,311 @@ + + + + + +SmithyPattern.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.pattern
    +

    Class SmithyPattern.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.pattern.SmithyPattern.Builder
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      SmithyPattern
      +
      +
      +
      public static final class SmithyPattern.Builder
+extends java.lang.Object
      +
      Builder used to create a SmithyPattern.
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/pattern/SmithyPattern.Segment.Type.html b/javadoc/1.47.0/software/amazon/smithy/model/pattern/SmithyPattern.Segment.Type.html new file mode 100644 index 00000000000..9ef7dd23aa0 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/pattern/SmithyPattern.Segment.Type.html @@ -0,0 +1,393 @@ + + + + + +SmithyPattern.Segment.Type (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.pattern
    +

    Enum SmithyPattern.Segment.Type

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        GREEDY_LABEL 
        LABEL 
        LITERAL 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static SmithyPattern.Segment.TypevalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static SmithyPattern.Segment.Type[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static SmithyPattern.Segment.Type[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (SmithyPattern.Segment.Type c : SmithyPattern.Segment.Type.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static SmithyPattern.Segment.Type valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/pattern/SmithyPattern.Segment.html b/javadoc/1.47.0/software/amazon/smithy/model/pattern/SmithyPattern.Segment.html new file mode 100644 index 00000000000..48d989dd348 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/pattern/SmithyPattern.Segment.html @@ -0,0 +1,490 @@ + + + + + +SmithyPattern.Segment (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.pattern
    +

    Class SmithyPattern.Segment

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.pattern.SmithyPattern.Segment
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      SmithyPattern
      +
      +
      +
      public static final class SmithyPattern.Segment
+extends java.lang.Object
      +
      Segment within a SmithyPattern.
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        booleanequals​(java.lang.Object other) 
        java.lang.StringgetContent() +
        Get the content of the segment.
        +
        inthashCode() 
        booleanisGreedyLabel() 
        booleanisLabel() 
        static SmithyPattern.Segmentparse​(java.lang.String content, + int offset) +
        Parse a segment from the given offset.
        +
        java.lang.StringtoString() +
        Get the segment as a literal value to be used in a pattern.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          parse

          +
          public static SmithyPattern.Segment parse​(java.lang.String content,
+                                          int offset)
          +
          Parse a segment from the given offset.
          +
          +
          Parameters:
          +
          content - Content of the segment.
          +
          offset - Character offset where the segment starts in the containing pattern.
          +
          Returns:
          +
          Returns the created segment.
          +
          Throws:
          +
          InvalidPatternException - if the segment is invalid.
          +
          +
          • +
        + + + +
          +
        • +

          getContent

          +
          public java.lang.String getContent()
          +
          Get the content of the segment. + +

          The return value contains the segment in its entirety for + non-labels, and the label name for both labels and greedy labels. + For example, given a segment of "{label+}", the return value of + getContent would be "label".

          +
          +
          Returns:
          +
          Content of the segment.
          +
          +
          • +
        + + + +
          +
        • +

          isLabel

          +
          public boolean isLabel()
          +
          +
          Returns:
          +
          True if the segment is a label.
          +
          +
          • +
        + + + +
          +
        • +

          isGreedyLabel

          +
          public boolean isGreedyLabel()
          +
          +
          Returns:
          +
          True if the segment is a greedy label.
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          Get the segment as a literal value to be used in a pattern. + +

          Unlike the result of getContent(), the return value + of toString includes braces for labels and "+" for + greedy labels.

          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          Returns:
          +
          The literal segment.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object other)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/pattern/SmithyPattern.html b/javadoc/1.47.0/software/amazon/smithy/model/pattern/SmithyPattern.html new file mode 100644 index 00000000000..4861dafffab --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/pattern/SmithyPattern.html @@ -0,0 +1,527 @@ + + + + + +SmithyPattern (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.pattern
    +

    Class SmithyPattern

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.pattern.SmithyPattern
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Direct Known Subclasses:
      +
      UriPattern
      +
      +
      +
      public class SmithyPattern
+extends java.lang.Object
      +
      Represents a contained pattern. + +

      A pattern is a series of segments, some of which may be labels. + +

      Labels may appear in the pattern in the form of "{label}". Labels must + not be repeated, must not contain other labels (e.g., "{fo{bar}oo}"), + and the label name must match the regex "^[a-zA-Z0-9_]+$". No labels can + appear after the query string. + +

      Greedy labels, a specialized type of label, may be specified using + "{label+}". Only a single greedy label may appear in a pattern, and it + must be the last label in a pattern. Greedy labels may be disabled for a + pattern as part of the builder construction.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getSegments

          +
          public final java.util.List<SmithyPattern.Segment> getSegments()
          +
          Gets all segments, in order.
          +
          +
          Returns:
          +
          All segments, in order, in an unmodifiable list.
          +
          +
          • +
        + + + +
          +
        • +

          getLabels

          +
          public final java.util.List<SmithyPattern.Segment> getLabels()
          +
          Get a list of all segments that are labels.
          +
          +
          Returns:
          +
          Label segments in an unmodifiable list.
          +
          +
          • +
        + + + +
          +
        • +

          getLabel

          +
          public final java.util.Optional<SmithyPattern.Segment> getLabel​(java.lang.String name)
          +
          Get a label by case-insensitive name.
          +
          +
          Parameters:
          +
          name - Name of the label to retrieve.
          +
          Returns:
          +
          An optionally found label.
          +
          +
          • +
        + + + +
          +
        • +

          getGreedyLabel

          +
          public final java.util.Optional<SmithyPattern.Segment> getGreedyLabel()
          +
          Gets the greedy label of the pattern, if present.
          +
          +
          Returns:
          +
          Returns the optionally found segment that is a greedy label.
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object other)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          getConflictingLabelSegmentsMap

          +
          public java.util.Map<SmithyPattern.Segment,​SmithyPattern.Segment> getConflictingLabelSegmentsMap​(SmithyPattern otherPattern)
          +
          Gets a map of explicitly conflicting label segments between this + pattern and another.
          +
          +
          Parameters:
          +
          otherPattern - SmithyPattern to check against.
          +
          Returns:
          +
          A map of Segments where each pair represents a conflict + and where the key is a segment from this pattern. This map is + ordered so segments that appear first in this pattern appear + first when iterating the map.
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          builder

          +
          public static SmithyPattern.Builder builder()
          +
          +
          Returns:
          +
          Returns a builder used to create a SmithyPattern.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/pattern/UriPattern.html b/javadoc/1.47.0/software/amazon/smithy/model/pattern/UriPattern.html new file mode 100644 index 00000000000..8875ab8467f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/pattern/UriPattern.html @@ -0,0 +1,445 @@ + + + + + +UriPattern (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.pattern
    +

    Class UriPattern

    +
    +
    + +
    +
      +
    • +
      +
      public final class UriPattern
+extends SmithyPattern
      +
      Represents a URI pattern. + +

      A URI pattern is an absolute path segment used to route to operations. + The pattern must start with "/", must not contain empty segments + (i.e., "//"), must not contain a fragment (i.e., "#"), and must not + end with "?". + +

      Labels may appear in the pattern in the form of "{label}". Labels must + not be repeated, must make up an entire path segment (e.g., "/{foo}/baz"), + and the label name must match the regex "^[a-zA-Z0-9_]+$". No labels can + appear after the query string. + +

      Greedy labels, a specialized type of label, may be specified using + "{label+}". Only a single greedy label may appear in a pattern, and it + must be the last label in a pattern.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          parse

          +
          public static UriPattern parse​(java.lang.String uri)
          +
          Parse a URI pattern string into a UriPattern. + +

          The provided value must match the origin-form request-target + grammar production in RFC 7230, section 5.3.1.

          +
          +
          Parameters:
          +
          uri - URI pattern to parse.
          +
          Returns:
          +
          Returns the parsed URI pattern.
          +
          Throws:
          +
          InvalidUriPatternException - for invalid URI patterns.
          +
          See Also:
          +
          RFC 7230 Section 5.3.1
          +
          +
          • +
        + + + +
          +
        • +

          getQueryLiterals

          +
          public java.util.Map<java.lang.String,​java.lang.String> getQueryLiterals()
          +
          Get an immutable map of query string literal key-value pairs.
          +
          +
          Returns:
          +
          An immutable map of parsed query string literals.
          +
          +
          • +
        + + + +
          +
        • +

          getQueryLiteralValue

          +
          public java.util.Optional<java.lang.String> getQueryLiteralValue​(java.lang.String parameter)
          +
          Gets a specific query string literal parameter value.
          +
          +
          Parameters:
          +
          parameter - Case-sensitive name of the parameter to retrieve.
          +
          Returns:
          +
          Returns the optionally found parameter value.
          +
          +
          • +
        + + + +
          +
        • +

          conflictsWith

          +
          public boolean conflictsWith​(UriPattern otherPattern)
          +
          Determines if the pattern conflicts with another pattern.
          +
          +
          Parameters:
          +
          otherPattern - SmithyPattern to check against.
          +
          Returns:
          +
          Returns true if there is a conflict.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object other)
          +
          +
          Overrides:
          +
          equals in class SmithyPattern
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/pattern/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/model/pattern/package-summary.html new file mode 100644 index 00000000000..1a4c5c1ff3b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/pattern/package-summary.html @@ -0,0 +1,222 @@ + + + + + +software.amazon.smithy.model.pattern (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.model.pattern

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/pattern/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/model/pattern/package-tree.html new file mode 100644 index 00000000000..338e2e63a50 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/pattern/package-tree.html @@ -0,0 +1,202 @@ + + + + + +software.amazon.smithy.model.pattern Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.model.pattern

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Enum Hierarchy

    +
      +
    • java.lang.Object +
        +
      • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
        • +
      +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/selector/AttributeValue.html b/javadoc/1.47.0/software/amazon/smithy/model/selector/AttributeValue.html new file mode 100644 index 00000000000..4ee841a250b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/selector/AttributeValue.html @@ -0,0 +1,571 @@ + + + + + +AttributeValue (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.selector
    +

    Interface AttributeValue

    +
    +
    +
    +
      +
    • +
      +
      public interface AttributeValue
      +
      Selector attribute values are the data model of selectors.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          toString

          +
          java.lang.String toString()
          +
          Returns the string version of an attribute value.
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          Returns:
          +
          Returns the string representation or an empty string.
          +
          +
          • +
        + + + +
          +
        • +

          toMessageString

          +
          default java.lang.String toMessageString()
          +
          Returns a string representation of the value that can be used + for creating formatted messages. + +

          This implementation gets the value of toString() + by default.

          +
          +
          Returns:
          +
          Returns the message string.
          +
          +
          • +
        + + + +
          +
        • +

          getProperty

          +
          AttributeValue getProperty​(java.lang.String key)
          +
          Gets a property from the attribute value. + +

          This method never returns null. It should instead return + a null value object when the property does not exist.

          +
          +
          Parameters:
          +
          key - Property to get.
          +
          Returns:
          +
          Returns the nested property.
          +
          +
          • +
        + + + +
          +
        • +

          getPath

          +
          default AttributeValue getPath​(java.util.List<java.lang.String> path)
          +
          Gets a property using a path to the property.
          +
          +
          Parameters:
          +
          path - The path to select from the value.
          +
          Returns:
          +
          Returns the created attribute value.
          +
          +
          • +
        + + + +
          +
        • +

          isPresent

          +
          default boolean isPresent()
          +
          Checks if the attribute value is considered present. + +

          Attribute value are considered present if they are not null. If the + attribute value is a projection, then it is considered present if it is + not empty.

          +
          +
          Returns:
          +
          Returns true if present.
          +
          +
          • +
        + + + +
          +
        • +

          getFlattenedValues

          +
          default java.util.Collection<? extends AttributeValue> getFlattenedValues()
          +
          Gets all of the attribute values contained in the attribute value. + +

          This will yield a single result for normal attributes, or a list + of multiple values for projections.

          +
          +
          Returns:
          +
          Returns the flattened attribute values contained in the attribute value.
          +
          +
          • +
        + + + +
          +
        • +

          shape

          +
          static AttributeValue shape​(Shape shape,
+                            java.util.Map<java.lang.String,​java.util.Set<Shape>> vars)
          +
          Creates a 'shape' AttributeValue for the given shape.
          +
          +
          Parameters:
          +
          shape - Shape to path into.
          +
          vars - Variables accessible to the shape.
          +
          Returns:
          +
          Returns the created selector value.
          +
          +
          • +
        + + + +
          +
        • +

          id

          +
          static AttributeValue id​(ShapeId id)
          +
          Creates an 'id' AttributeValue from a shape ID.
          +
          +
          Parameters:
          +
          id - Shape ID to create.
          +
          Returns:
          +
          Returns the created selector value.
          +
          +
          • +
        + + + +
          +
        • +

          service

          +
          static AttributeValue service​(ServiceShape service)
          +
          Creates a 'service' AttributeValue from a service shape.
          +
          +
          Parameters:
          +
          service - Shape to create.
          +
          Returns:
          +
          Returns the created selector value.
          +
          +
          • +
        + + + +
          +
        • +

          emptyValue

          +
          static AttributeValue emptyValue()
          +
          Creates an empty AttributeValue object.
          +
          +
          Returns:
          +
          Returns the created selector value.
          +
          +
          • +
        + + + +
          +
        • +

          literal

          +
          static AttributeValue literal​(java.lang.Object literal)
          +
          Creates an AttributeValue that contains a literal value.
          +
          +
          Parameters:
          +
          literal - Literal value to wrap.
          +
          Returns:
          +
          Returns the created selector value.
          +
          +
          • +
        + + + +
          +
        • +

          node

          +
          static AttributeValue node​(Node node)
          +
          Creates a 'node' AttributeValue for a Node.
          +
          +
          Parameters:
          +
          node - Node to create the value from.
          +
          Returns:
          +
          Returns the created attribute value.
          +
          +
          • +
        + + + +
          +
        • +

          projection

          +
          static AttributeValue projection​(java.util.Collection<AttributeValue> values)
          +
          Creates a 'projection' AttributeValue.
          +
          +
          Parameters:
          +
          values - Values stored in the projection.
          +
          Returns:
          +
          Returns the created projection.
          +
          +
          • +
        + + + +
          +
        • +

          parseScopedAttribute

          +
          static java.util.List<java.lang.String> parseScopedAttribute​(SimpleParser parser)
          +
          Uses the given parser to parse a scoped attribute production.
          +
          +
          Parameters:
          +
          parser - Parser to consume.
          +
          Returns:
          +
          Returns the list of validated scoped attribute path segments.
          +
          Throws:
          +
          java.lang.RuntimeException - if the parser does not contain a valid scoped attribute production.
          +
          See Also:
          +
          for an example of how this is used.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/selector/PathFinder.Path.html b/javadoc/1.47.0/software/amazon/smithy/model/selector/PathFinder.Path.html new file mode 100644 index 00000000000..d811baa9c70 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/selector/PathFinder.Path.html @@ -0,0 +1,524 @@ + + + + + +PathFinder.Path (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.selector
    +

    Class PathFinder.Path

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.util.AbstractCollection<E>
        • +
      • +
          +
        • java.util.AbstractList<Relationship>
          • +
        • +
            +
          • software.amazon.smithy.model.selector.PathFinder.Path
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.lang.Iterable<Relationship>, java.util.Collection<Relationship>, java.util.List<Relationship>
      +
      +
      +
      Enclosing class:
      +
      PathFinder
      +
      +
      +
      public static final class PathFinder.Path
+extends java.util.AbstractList<Relationship>
      +
      An immutable Relationship path from a starting shape to an end shape.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Summary

        +
          +
        • + + +

          Fields inherited from class java.util.AbstractList

          +modCount
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Path​(java.util.List<Relationship> relationships) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        Relationshipget​(int index) 
        ShapegetEndShape() +
        Gets the ending shape of the Path that + matched the selector and is connected to the + starting shape.
        +
        java.util.List<Shape>getShapes() +
        Gets a list of all shapes in the path including the starting + shape all the way to the last shape.
        +
        ShapegetStartShape() +
        Gets the starting shape of the Path.
        +
        java.util.Iterator<Relationship>iterator() 
        intsize() 
        java.lang.StringtoString() +
        Converts the path to valid Selector syntax.
        +
        +
          +
        • + + +

          Methods inherited from class java.util.AbstractList

          +add, add, addAll, clear, equals, hashCode, indexOf, lastIndexOf, listIterator, listIterator, remove, removeRange, set, subList
          • +
        +
          +
        • + + +

          Methods inherited from class java.util.AbstractCollection

          +addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
          • +
        +
          +
        • + + +

          Methods inherited from interface java.util.Collection

          +parallelStream, removeIf, stream, toArray
          • +
        +
          +
        • + + +

          Methods inherited from interface java.lang.Iterable

          +forEach
          • +
        +
          +
        • + + +

          Methods inherited from interface java.util.List

          +addAll, contains, containsAll, isEmpty, remove, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Path

          +
          public Path​(java.util.List<Relationship> relationships)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          size

          +
          public int size()
          +
          +
          Specified by:
          +
          size in interface java.util.Collection<Relationship>
          +
          Specified by:
          +
          size in interface java.util.List<Relationship>
          +
          Specified by:
          +
          size in class java.util.AbstractCollection<Relationship>
          +
          +
          • +
        + + + +
          +
        • +

          get

          +
          public Relationship get​(int index)
          +
          +
          Specified by:
          +
          get in interface java.util.List<Relationship>
          +
          Specified by:
          +
          get in class java.util.AbstractList<Relationship>
          +
          +
          • +
        + + + +
          +
        • +

          iterator

          +
          public java.util.Iterator<Relationship> iterator()
          +
          +
          Specified by:
          +
          iterator in interface java.util.Collection<Relationship>
          +
          Specified by:
          +
          iterator in interface java.lang.Iterable<Relationship>
          +
          Specified by:
          +
          iterator in interface java.util.List<Relationship>
          +
          Overrides:
          +
          iterator in class java.util.AbstractList<Relationship>
          +
          +
          • +
        + + + +
          +
        • +

          getShapes

          +
          public java.util.List<Shape> getShapes()
          +
          Gets a list of all shapes in the path including the starting + shape all the way to the last shape. + +

          The returned list does not return the last element (the + end shape targeted by the last neighbor) if it does not exist.

          +
          +
          Returns:
          +
          Returns the list of shapes.
          +
          +
          • +
        + + + +
          +
        • +

          getStartShape

          +
          public Shape getStartShape()
          +
          Gets the starting shape of the Path.
          +
          +
          Returns:
          +
          Returns the starting shape of the Path.
          +
          +
          • +
        + + + +
          +
        • +

          getEndShape

          +
          public Shape getEndShape()
          +
          Gets the ending shape of the Path that + matched the selector and is connected to the + starting shape.
          +
          +
          Returns:
          +
          Returns the ending shape of the Path.
          +
          Throws:
          +
          SourceException - if the last relationship is invalid.
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          Converts the path to valid Selector syntax.
          +
          +
          Overrides:
          +
          toString in class java.util.AbstractCollection<Relationship>
          +
          Returns:
          +
          Returns the path as a selector.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/selector/PathFinder.html b/javadoc/1.47.0/software/amazon/smithy/model/selector/PathFinder.html new file mode 100644 index 00000000000..624664af366 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/selector/PathFinder.html @@ -0,0 +1,472 @@ + + + + + +PathFinder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.selector
    +

    Class PathFinder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.selector.PathFinder
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class PathFinder
+extends java.lang.Object
      +
      Finds the possible directed relationship paths from a starting shape to + shapes connected to the starting shape that match a selector. + +

      For example, the PathFinder can answer the question of + "Where are all of the shapes in the closure of the input of an operation + marked with the sensitive trait?" + + 

      
+ PathFinder pathFinder = PathFinder.create(myModel);
+ List<PathFinder.Path> results = pathFinder.search(myOperationInput, "[trait|sensitive]");
+
      + +

      PathFinder is directed, meaning it only traverses relationships + from shapes that define a relationship to shapes that it targets. In other + words, PathFinder will not traverse relationships from a resource to + the resource's parent or from a member to the shape that contains it + because those are inverted relationships.

      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static class PathFinder.Path +
        An immutable Relationship path from a starting shape to an end shape.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static PathFindercreate​(Model model) +
        Creates a PathFinder that uses the given Model.
        +
        java.util.Optional<PathFinder.Path>createPathToInputMember​(ToShapeId operationId, + java.lang.String memberName) +
        Creates a Path to an operation input member if it exists.
        +
        java.util.Optional<PathFinder.Path>createPathToOutputMember​(ToShapeId operationId, + java.lang.String memberName) +
        Creates a Path to an operation output member if it exists.
        +
        voidrelationshipFilter​(java.util.function.Predicate<Relationship> predicate) +
        Sets a predicate function to prevents traversing specific relationships.
        +
        java.util.List<PathFinder.Path>search​(ToShapeId startingShape, + java.lang.String targetSelector) +
        Finds all of the possible paths from the starting shape to all shapes + connected to the starting shape that match the given selector.
        +
        java.util.List<PathFinder.Path>search​(ToShapeId startingShape, + java.util.Collection<Shape> targetShapes) +
        Finds all of the possible paths from the startingShape to + any of the provided shapes in targetShapes.
        +
        java.util.List<PathFinder.Path>search​(ToShapeId startingShape, + Selector targetSelector) +
        Finds all of the possible paths from the starting shape to all shapes + connected to the starting shape that match the given selector.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + +
          +
        • +

          create

          +
          public static PathFinder create​(Model model)
          +
          Creates a PathFinder that uses the given Model.
          +
          +
          Parameters:
          +
          model - Model to search using a PathFinder.
          +
          Returns:
          +
          Returns the crated PathFinder.
          +
          +
          • +
        + + + +
          +
        • +

          relationshipFilter

          +
          public void relationshipFilter​(java.util.function.Predicate<Relationship> predicate)
          +
          Sets a predicate function to prevents traversing specific relationships.
          +
          +
          Parameters:
          +
          predicate - Predicate that must return true in order to continue traversing relationships.
          +
          +
          • +
        + + + +
          +
        • +

          search

          +
          public java.util.List<PathFinder.Path> search​(ToShapeId startingShape,
+                                              java.lang.String targetSelector)
          +
          Finds all of the possible paths from the starting shape to all shapes + connected to the starting shape that match the given selector.
          +
          +
          Parameters:
          +
          startingShape - Starting shape to find the paths from.
          +
          targetSelector - Selector that matches shapes to find the path to.
          +
          Returns:
          +
          Returns the list of matching paths.
          +
          +
          • +
        + + + +
          +
        • +

          search

          +
          public java.util.List<PathFinder.Path> search​(ToShapeId startingShape,
+                                              Selector targetSelector)
          +
          Finds all of the possible paths from the starting shape to all shapes + connected to the starting shape that match the given selector.
          +
          +
          Parameters:
          +
          startingShape - Starting shape to find the paths from.
          +
          targetSelector - Selector that matches shapes to find the path to.
          +
          Returns:
          +
          Returns the list of matching paths.
          +
          +
          • +
        + + + +
          +
        • +

          search

          +
          public java.util.List<PathFinder.Path> search​(ToShapeId startingShape,
+                                              java.util.Collection<Shape> targetShapes)
          +
          Finds all of the possible paths from the startingShape to + any of the provided shapes in targetShapes.
          +
          +
          Parameters:
          +
          startingShape - Starting shape to find the paths from.
          +
          targetShapes - The shapes to try to find a path to.
          +
          Returns:
          +
          Returns the list of matching paths.
          +
          +
          • +
        + + + +
          +
        • +

          createPathToInputMember

          +
          public java.util.Optional<PathFinder.Path> createPathToInputMember​(ToShapeId operationId,
+                                                                   java.lang.String memberName)
          +
          Creates a Path to an operation input member if it exists.
          +
          +
          Parameters:
          +
          operationId - Operation to start from.
          +
          memberName - Input member name to find in the operation input.
          +
          Returns:
          +
          Returns the optionally found Path to the member.
          +
          +
          • +
        + + + +
          +
        • +

          createPathToOutputMember

          +
          public java.util.Optional<PathFinder.Path> createPathToOutputMember​(ToShapeId operationId,
+                                                                    java.lang.String memberName)
          +
          Creates a Path to an operation output member if it exists.
          +
          +
          Parameters:
          +
          operationId - Operation to start from.
          +
          memberName - Output member name to find in the operation output.
          +
          Returns:
          +
          Returns the optionally found Path to the member.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/selector/Selector.Runner.html b/javadoc/1.47.0/software/amazon/smithy/model/selector/Selector.Runner.html new file mode 100644 index 00000000000..37c78892187 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/selector/Selector.Runner.html @@ -0,0 +1,315 @@ + + + + + +Selector.Runner (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.selector
    +

    Class Selector.Runner

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.selector.Selector.Runner
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing interface:
      +
      Selector
      +
      +
      +
      @Deprecated
+public static final class Selector.Runner
+extends java.lang.Object
      +
      Deprecated. +
      This class is no longer necessary. It was originally intended + to allow more customization to how selectors are executed against a model, + but this has proven unnecessary.
      +
      +
      Builds the execution environment for a selector and executes selectors.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          selectShapes

          +
          @Deprecated
+public java.util.Set<Shape> selectShapes()
          +
          Deprecated.
          +
          • +
        + + + +
          +
        • +

          selectMatches

          +
          @Deprecated
+public void selectMatches​(java.util.function.BiConsumer<Shape,​java.util.Map<java.lang.String,​java.util.Set<Shape>>> matchConsumer)
          +
          Deprecated.
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/selector/Selector.ShapeMatch.html b/javadoc/1.47.0/software/amazon/smithy/model/selector/Selector.ShapeMatch.html new file mode 100644 index 00000000000..b8f87b29e8e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/selector/Selector.ShapeMatch.html @@ -0,0 +1,391 @@ + + + + + +Selector.ShapeMatch (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.selector
    +

    Class Selector.ShapeMatch

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.util.AbstractMap<K,​V>
        • +
      • +
          +
        • java.util.HashMap<java.lang.String,​java.util.Set<Shape>>
          • +
        • +
            +
          • software.amazon.smithy.model.selector.Selector.ShapeMatch
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,​java.util.Set<Shape>>
      +
      +
      +
      Enclosing interface:
      +
      Selector
      +
      +
      +
      public static final class Selector.ShapeMatch
+extends java.util.HashMap<java.lang.String,​java.util.Set<Shape>>
      +
      Represents a selector match found in the model. + +

      The getShape method is used to get the shape that matched, + and all of the contextual variables that were set when the match + occurred can be accessed using typical Map methods like + get, contains, etc.

      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        +
          +
        • + + +

          Nested classes/interfaces inherited from class java.util.AbstractMap

          +java.util.AbstractMap.SimpleEntry<K extends java.lang.Object,​V extends java.lang.Object>, java.util.AbstractMap.SimpleImmutableEntry<K extends java.lang.Object,​V extends java.lang.Object>
          • +
        +
          +
        • + + +

          Nested classes/interfaces inherited from interface java.util.Map

          +java.util.Map.Entry<K extends java.lang.Object,​V extends java.lang.Object>
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        ShapeMatch​(Shape shape, + java.util.Map<java.lang.String,​java.util.Set<Shape>> variables) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        ShapegetShape() +
        Gets the matching shape.
        +
        +
          +
        • + + +

          Methods inherited from class java.util.HashMap

          +clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values
          • +
        +
          +
        • + + +

          Methods inherited from class java.util.AbstractMap

          +equals, hashCode, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +finalize, getClass, notify, notifyAll, wait, wait, wait
          • +
        +
          +
        • + + +

          Methods inherited from interface java.util.Map

          +equals, hashCode
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ShapeMatch

          +
          public ShapeMatch​(Shape shape,
+                  java.util.Map<java.lang.String,​java.util.Set<Shape>> variables)
          +
          +
          Parameters:
          +
          shape - Shape that matched.
          +
          variables - Variables that matched. This map is copied into ShapeMatch.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getShape

          +
          public Shape getShape()
          +
          Gets the matching shape.
          +
          +
          Returns:
          +
          Returns the matching shape.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/selector/Selector.StartingContext.html b/javadoc/1.47.0/software/amazon/smithy/model/selector/Selector.StartingContext.html new file mode 100644 index 00000000000..034942e5445 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/selector/Selector.StartingContext.html @@ -0,0 +1,378 @@ + + + + + +Selector.StartingContext (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.selector
    +

    Class Selector.StartingContext

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.selector.Selector.StartingContext
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing interface:
      +
      Selector
      +
      +
      +
      public static final class Selector.StartingContext
+extends java.lang.Object
      +
      Starting environment context object used when evaluating a selector.
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        StartingContext() +
        Create a StartingContext that sends all shapes in a Model through the Selector.
        +
        StartingContext​(java.util.Collection<? extends Shape> startingShapes) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.util.Collection<? extends Shape>getStartingShapes() +
        Get the potentially null set of starting shapes to provide to the selector.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          StartingContext

          +
          public StartingContext()
          +
          Create a StartingContext that sends all shapes in a Model through the Selector.
          +
          • +
        + + + +
          +
        • +

          StartingContext

          +
          public StartingContext​(java.util.Collection<? extends Shape> startingShapes)
          +
          +
          Parameters:
          +
          startingShapes - A specific set of shapes to send through the Selector rather than all Model shapes.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getStartingShapes

          +
          public java.util.Collection<? extends Shape> getStartingShapes()
          +
          Get the potentially null set of starting shapes to provide to the selector.
          +
          +
          Returns:
          +
          Returns the custom set starting shapes to provide to the selector.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/selector/Selector.html b/javadoc/1.47.0/software/amazon/smithy/model/selector/Selector.html new file mode 100644 index 00000000000..3ac0d15a3de --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/selector/Selector.html @@ -0,0 +1,599 @@ + + + + + +Selector (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.selector
    +

    Interface Selector

    +
    +
    +
    +
      +
    • +
      +
      public interface Selector
      +
      Matches a set of shapes using a selector expression.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          IDENTITY

          +
          static final Selector IDENTITY
          +
          A selector that always returns all provided values.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          parse

          +
          static Selector parse​(java.lang.String expression)
          +
          Parses a selector expression.
          +
          +
          Parameters:
          +
          expression - Expression to parse.
          +
          Returns:
          +
          Returns the parsed Selector.
          +
          +
          • +
        + + + +
          +
        • +

          fromNode

          +
          static Selector fromNode​(Node node)
          +
          Creates a Selector from a Node.
          +
          +
          Parameters:
          +
          node - Node to parse.
          +
          Returns:
          +
          Returns the created selector.
          +
          Throws:
          +
          SourceException - on error.
          +
          +
          • +
        + + + +
          +
        • +

          select

          +
          default java.util.Set<Shape> select​(Model model)
          +
          Matches a selector to a model.
          +
          +
          Parameters:
          +
          model - Model used to resolve shapes with.
          +
          Returns:
          +
          Returns the matching shapes.
          +
          +
          • +
        + + + +
          +
        • +

          select

          +
          default java.util.Set<Shape> select​(Model model,
+                                    Selector.StartingContext context)
          +
          Matches a selector to a model.
          +
          +
          Parameters:
          +
          model - Model used to resolve shapes with.
          +
          context - Selector starting environment context.
          +
          Returns:
          +
          Returns the matching shapes.
          +
          +
          • +
        + + + +
          +
        • +

          consumeMatches

          +
          default void consumeMatches​(Model model,
+                            java.util.function.Consumer<Selector.ShapeMatch> shapeMatchConsumer)
          +
          Matches a selector to a set of shapes and receives each matched shape + with the variables that were set when the shape was matched.
          +
          +
          Parameters:
          +
          model - Model to select shapes from.
          +
          shapeMatchConsumer - Receives each matched shape and the vars available when the shape was matched.
          +
          +
          • +
        + + + +
          +
        • +

          consumeMatches

          +
          default void consumeMatches​(Model model,
+                            Selector.StartingContext context,
+                            java.util.function.Consumer<Selector.ShapeMatch> shapeMatchConsumer)
          +
          Matches a selector to a set of shapes and receives each matched shape + with the variables that were set when the shape was matched.
          +
          +
          Parameters:
          +
          model - Model to select shapes from.
          +
          context - Selector starting environment context.
          +
          shapeMatchConsumer - Receives each matched shape and the vars available when the shape was matched.
          +
          +
          • +
        + + + +
          +
        • +

          shapes

          +
          default java.util.stream.Stream<Shape> shapes​(Model model)
          +
          Returns a stream of shapes in a model that match the selector.
          +
          +
          Parameters:
          +
          model - Model to match the selector against.
          +
          Returns:
          +
          Returns a stream of matching shapes.
          +
          +
          • +
        + + + +
          +
        • +

          shapes

          +
          default java.util.stream.Stream<Shape> shapes​(Model model,
+                                              Selector.StartingContext context)
          +
          Returns a stream of shapes in a model that match the selector.
          +
          +
          Parameters:
          +
          model - Model to match the selector against.
          +
          context - Selector starting environment context.
          +
          Returns:
          +
          Returns a stream of matching shapes.
          +
          +
          • +
        + + + +
          +
        • +

          matches

          +
          default java.util.stream.Stream<Selector.ShapeMatch> matches​(Model model)
          +
          Returns a stream of Selector.ShapeMatch objects for each match found in + a model.
          +
          +
          Parameters:
          +
          model - Model to match the selector against.
          +
          Returns:
          +
          Returns a stream of ShapeMatch objects.
          +
          +
          • +
        + + + +
          +
        • +

          matches

          +
          default java.util.stream.Stream<Selector.ShapeMatch> matches​(Model model,
+                                                             Selector.StartingContext startingContext)
          +
          Returns a stream of Selector.ShapeMatch objects for each match found in + a model.
          +
          +
          Parameters:
          +
          model - Model to match the selector against.
          +
          startingContext - Selector starting environment context.
          +
          Returns:
          +
          Returns a stream of ShapeMatch objects.
          +
          +
          • +
        + + + +
          +
        • +

          runner

          +
          @Deprecated
+default Selector.Runner runner()
          +
          Deprecated.
          +
          Creates a Selector Runner, used to customize how a selector is + executed.
          +
          +
          Returns:
          +
          Returns the created runner.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/selector/SelectorException.html b/javadoc/1.47.0/software/amazon/smithy/model/selector/SelectorException.html new file mode 100644 index 00000000000..4ed63475dd0 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/selector/SelectorException.html @@ -0,0 +1,316 @@ + + + + + +SelectorException (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.selector
    +

    Class SelectorException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Throwable
        • +
      • +
          +
        • java.lang.Exception
          • +
        • +
            +
          • java.lang.RuntimeException
            • +
          • +
              +
            • software.amazon.smithy.model.selector.SelectorException
              • +
            +
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      Direct Known Subclasses:
      +
      SelectorSyntaxException
      +
      +
      +
      public class SelectorException
+extends java.lang.RuntimeException
      +
      Exception thrown when a selector evaluation is invalid.
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        SelectorException​(java.lang.String message) 
        SelectorException​(java.lang.String message, + java.lang.Throwable previous) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          SelectorException

          +
          public SelectorException​(java.lang.String message)
          +
          • +
        + + + +
          +
        • +

          SelectorException

          +
          public SelectorException​(java.lang.String message,
+                         java.lang.Throwable previous)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/selector/SelectorSyntaxException.html b/javadoc/1.47.0/software/amazon/smithy/model/selector/SelectorSyntaxException.html new file mode 100644 index 00000000000..a925ade4314 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/selector/SelectorSyntaxException.html @@ -0,0 +1,256 @@ + + + + + +SelectorSyntaxException (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.selector
    +

    Class SelectorSyntaxException

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      public final class SelectorSyntaxException
+extends SelectorException
      +
      Exception thrown when a selector expression is invalid.
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/selector/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/model/selector/package-summary.html new file mode 100644 index 00000000000..b941f1f7ec2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/selector/package-summary.html @@ -0,0 +1,237 @@ + + + + + +software.amazon.smithy.model.selector (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.model.selector

    +
    +
    +
      +
    • + + + + + + + + + + + + + + + + +
      Interface Summary 
      InterfaceDescription
      AttributeValue +
      Selector attribute values are the data model of selectors.
      +
      Selector +
      Matches a set of shapes using a selector expression.
      +
      +
      • +
    • + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      PathFinder +
      Finds the possible directed relationship paths from a starting shape to + shapes connected to the starting shape that match a selector.
      +
      PathFinder.Path +
      An immutable Relationship path from a starting shape to an end shape.
      +
      Selector.RunnerDeprecated. +
      This class is no longer necessary.
      +
      Selector.ShapeMatch +
      Represents a selector match found in the model.
      +
      Selector.StartingContext +
      Starting environment context object used when evaluating a selector.
      +
      +
      • +
    • + + + + + + + + + + + + + + + + +
      Exception Summary 
      ExceptionDescription
      SelectorException +
      Exception thrown when a selector evaluation is invalid.
      +
      SelectorSyntaxException +
      Exception thrown when a selector expression is invalid.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/selector/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/model/selector/package-tree.html new file mode 100644 index 00000000000..fbe003682c2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/selector/package-tree.html @@ -0,0 +1,205 @@ + + + + + +software.amazon.smithy.model.selector Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.model.selector

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    +
      +
    • java.lang.Object +
        +
      • java.util.AbstractCollection<E> (implements java.util.Collection<E>) +
          +
        • java.util.AbstractList<E> (implements java.util.List<E>) + +
          • +
        +
        • +
      • java.util.AbstractMap<K,​V> (implements java.util.Map<K,​V>) +
          +
        • java.util.HashMap<K,​V> (implements java.lang.Cloneable, java.util.Map<K,​V>, java.io.Serializable) + +
          • +
        +
        • +
      • software.amazon.smithy.model.selector.PathFinder
        • +
      • software.amazon.smithy.model.selector.Selector.Runner
        • +
      • software.amazon.smithy.model.selector.Selector.StartingContext
        • +
      • java.lang.Throwable (implements java.io.Serializable) + +
        • +
      +
      • +
    +
    +
    +

    Interface Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/AbstractShapeBuilder.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/AbstractShapeBuilder.html new file mode 100644 index 00000000000..94322d1d4f2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/AbstractShapeBuilder.html @@ -0,0 +1,782 @@ + + + + + +AbstractShapeBuilder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class AbstractShapeBuilder<B extends AbstractShapeBuilder<B,​S>,​S extends Shape>

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.shapes.AbstractShapeBuilder<B,​S>
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods Concrete Methods 
        Modifier and TypeMethodDescription
        BaddMember​(MemberShape member) +
        Adds a member to the shape IFF the shape supports members.
        +
        BaddMixin​(Shape shape) +
        Adds a mixin to the shape.
        +
        BaddTrait​(Trait trait) +
        Adds a trait to the shape builder, replacing any conflicting traits.
        +
        BaddTraits​(java.util.Collection<? extends Trait> traitsToAdd) +
        Adds traits from an iterator to the shape builder, replacing any + conflicting traits.
        +
        BclearMembers() +
        Removes all members from the builder.
        +
        BclearMixins() +
        Removes all mixins.
        +
        BclearTraits() +
        Removes all traits.
        +
        BflattenMixins() +
        Removes mixins from a shape and flattens them into the shape.
        +
        java.util.Map<ShapeId,​Trait>getAllTraits() +
        Get an immutable view of the traits applied to the builder.
        +
        ShapeIdgetId() +
        Gets the shape ID of the builder.
        +
        java.util.Optional<MemberShape>getMember​(java.lang.String memberName) +
        Gets the optional member with the given name.
        +
        abstract ShapeTypegetShapeType() +
        Gets the type of shape being built.
        +
        SourceLocationgetSourceLocation() +
        Gets the source location of a value.
        +
        Bid​(java.lang.String shapeId) +
        Sets the shape ID of the shape.
        +
        Bid​(ShapeId shapeId) +
        Sets the shape ID of the shape.
        +
        Bmixins​(java.util.Collection<? extends Shape> mixins) +
        Replaces the mixins of the shape.
        +
        BremoveMixin​(ToShapeId shape) +
        Removes a mixin from the shape by shape or ID.
        +
        BremoveTrait​(java.lang.String traitId) +
        Removes a trait from the shape builder.
        +
        BremoveTrait​(ShapeId traitId) +
        Removes a trait from the shape builder.
        +
        Bsource​(java.lang.String filename, + int line, + int column) +
        Sets the source location of the shape.
        +
        Bsource​(SourceLocation sourceLocation) +
        Sets the source location of the shape.
        +
        Btraits​(java.util.Collection<Trait> traitsToSet) +
        Replace all traits in the builder.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + + + + + +
          +
        • +

          getShapeType

          +
          public abstract ShapeType getShapeType()
          +
          Gets the type of shape being built.
          +
          +
          Returns:
          +
          Returns the shape type.
          +
          +
          • +
        + + + +
          +
        • +

          getId

          +
          public ShapeId getId()
          +
          Gets the shape ID of the builder.
          +
          +
          Returns:
          +
          Returns null if no shape ID is set.
          +
          +
          • +
        + + + +
          +
        • +

          id

          +
          public B id​(ShapeId shapeId)
          +
          Sets the shape ID of the shape.
          +
          +
          Parameters:
          +
          shapeId - Shape ID to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          id

          +
          public B id​(java.lang.String shapeId)
          +
          Sets the shape ID of the shape.
          +
          +
          Parameters:
          +
          shapeId - Absolute shape ID string to set.
          +
          Returns:
          +
          Returns the builder.
          +
          Throws:
          +
          ShapeIdSyntaxException - if the shape ID is invalid.
          +
          +
          • +
        + + + +
          +
        • +

          source

          +
          public B source​(SourceLocation sourceLocation)
          +
          Sets the source location of the shape.
          +
          +
          Parameters:
          +
          sourceLocation - Source location to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          source

          +
          public B source​(java.lang.String filename,
+                int line,
+                int column)
          +
          Sets the source location of the shape.
          +
          +
          Parameters:
          +
          filename - Name of the file in which the shape was defined.
          +
          line - Line number in the file where the shape was defined.
          +
          column - Column number of the line where the shape was defined.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          traits

          +
          public B traits​(java.util.Collection<Trait> traitsToSet)
          +
          Replace all traits in the builder.
          +
          +
          Parameters:
          +
          traitsToSet - Sequence of traits to set on the builder.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          getAllTraits

          +
          public java.util.Map<ShapeId,​Trait> getAllTraits()
          +
          Get an immutable view of the traits applied to the builder.
          +
          +
          Returns:
          +
          Returns the applied traits.
          +
          +
          • +
        + + + +
          +
        • +

          addTraits

          +
          public B addTraits​(java.util.Collection<? extends Trait> traitsToAdd)
          +
          Adds traits from an iterator to the shape builder, replacing any + conflicting traits.
          +
          +
          Parameters:
          +
          traitsToAdd - Sequence of traits to add to the builder.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          addTrait

          +
          public B addTrait​(Trait trait)
          +
          Adds a trait to the shape builder, replacing any conflicting traits.
          +
          +
          Parameters:
          +
          trait - Trait instance to add.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          removeTrait

          +
          public B removeTrait​(java.lang.String traitId)
          +
          Removes a trait from the shape builder. + +

          A relative trait name will attempt to remove a prelude trait + with the given name.

          +
          +
          Parameters:
          +
          traitId - Absolute or relative ID of the trait to remove.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          removeTrait

          +
          public B removeTrait​(ShapeId traitId)
          +
          Removes a trait from the shape builder.
          +
          +
          Parameters:
          +
          traitId - ID of the trait to remove.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          clearTraits

          +
          public B clearTraits()
          +
          Removes all traits.
          +
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          getMember

          +
          public java.util.Optional<MemberShape> getMember​(java.lang.String memberName)
          +
          Gets the optional member with the given name.
          +
          +
          Returns:
          +
          Returns the optional member with the given name.
          +
          +
          • +
        + + + +
          +
        • +

          addMember

          +
          public B addMember​(MemberShape member)
          +
          Adds a member to the shape IFF the shape supports members.
          +
          +
          Parameters:
          +
          member - Member to add to the shape.
          +
          Returns:
          +
          Returns the builder.
          +
          Throws:
          +
          java.lang.UnsupportedOperationException - if the shape does not support members.
          +
          +
          • +
        + + + +
          +
        • +

          clearMembers

          +
          public B clearMembers()
          +
          Removes all members from the builder.
          +
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          addMixin

          +
          public B addMixin​(Shape shape)
          +
          Adds a mixin to the shape.
          +
          +
          Parameters:
          +
          shape - Mixin to add.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          mixins

          +
          public B mixins​(java.util.Collection<? extends Shape> mixins)
          +
          Replaces the mixins of the shape.
          +
          +
          Parameters:
          +
          mixins - Mixins to add.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          removeMixin

          +
          public B removeMixin​(ToShapeId shape)
          +
          Removes a mixin from the shape by shape or ID.
          +
          +
          Parameters:
          +
          shape - Shape or shape ID to remove.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          clearMixins

          +
          public B clearMixins()
          +
          Removes all mixins.
          +
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          flattenMixins

          +
          public B flattenMixins()
          +
          Removes mixins from a shape and flattens them into the shape. + +

          Flattening a mixin into a shape copies the traits and members of a + mixin onto the shape, effectively resulting in the same shape but with + no trace of the mixin relationship.

          +
          +
          Returns:
          +
          Returns the updated builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/BigDecimalShape.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/BigDecimalShape.Builder.html new file mode 100644 index 00000000000..d30691055e7 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/BigDecimalShape.Builder.html @@ -0,0 +1,359 @@ + + + + + +BigDecimalShape.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class BigDecimalShape.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/BigDecimalShape.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/BigDecimalShape.html new file mode 100644 index 00000000000..71d27efe88e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/BigDecimalShape.html @@ -0,0 +1,422 @@ + + + + + +BigDecimalShape (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class BigDecimalShape

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/BigIntegerShape.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/BigIntegerShape.Builder.html new file mode 100644 index 00000000000..b78f1b8b89d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/BigIntegerShape.Builder.html @@ -0,0 +1,359 @@ + + + + + +BigIntegerShape.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class BigIntegerShape.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/BigIntegerShape.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/BigIntegerShape.html new file mode 100644 index 00000000000..fd2e5966b57 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/BigIntegerShape.html @@ -0,0 +1,422 @@ + + + + + +BigIntegerShape (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class BigIntegerShape

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/BlobShape.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/BlobShape.Builder.html new file mode 100644 index 00000000000..4f783671a56 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/BlobShape.Builder.html @@ -0,0 +1,359 @@ + + + + + +BlobShape.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class BlobShape.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/BlobShape.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/BlobShape.html new file mode 100644 index 00000000000..7c9efa98b60 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/BlobShape.html @@ -0,0 +1,417 @@ + + + + + +BlobShape (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class BlobShape

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + +
          +
        • +

          accept

          +
          public <R> R accept​(ShapeVisitor<R> visitor)
          +
          Description copied from class: Shape
          +
          Dispatches the shape to the appropriate ShapeVisitor method.
          +
          +
          Specified by:
          +
          accept in class Shape
          +
          Type Parameters:
          +
          R - Return type of the accept.
          +
          Parameters:
          +
          visitor - ShapeVisitor to use.
          +
          Returns:
          +
          Returns the result.
          +
          +
          • +
        + + + +
          +
        • +

          asBlobShape

          +
          public java.util.Optional<BlobShape> asBlobShape()
          +
          +
          Overrides:
          +
          asBlobShape in class Shape
          +
          Returns:
          +
          Optionally returns the shape as a BlobShape.
          +
          +
          • +
        + + + +
          +
        • +

          getType

          +
          public ShapeType getType()
          +
          Description copied from class: Shape
          +
          Gets the type of the shape.
          +
          +
          Specified by:
          +
          getType in class Shape
          +
          Returns:
          +
          Returns the type;
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/BooleanShape.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/BooleanShape.Builder.html new file mode 100644 index 00000000000..9de4177cbff --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/BooleanShape.Builder.html @@ -0,0 +1,359 @@ + + + + + +BooleanShape.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class BooleanShape.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/BooleanShape.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/BooleanShape.html new file mode 100644 index 00000000000..2d632de59c2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/BooleanShape.html @@ -0,0 +1,417 @@ + + + + + +BooleanShape (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class BooleanShape

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + +
          +
        • +

          accept

          +
          public <R> R accept​(ShapeVisitor<R> visitor)
          +
          Description copied from class: Shape
          +
          Dispatches the shape to the appropriate ShapeVisitor method.
          +
          +
          Specified by:
          +
          accept in class Shape
          +
          Type Parameters:
          +
          R - Return type of the accept.
          +
          Parameters:
          +
          visitor - ShapeVisitor to use.
          +
          Returns:
          +
          Returns the result.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getType

          +
          public ShapeType getType()
          +
          Description copied from class: Shape
          +
          Gets the type of the shape.
          +
          +
          Specified by:
          +
          getType in class Shape
          +
          Returns:
          +
          Returns the type;
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/ByteShape.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ByteShape.Builder.html new file mode 100644 index 00000000000..fefd7a9225e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ByteShape.Builder.html @@ -0,0 +1,359 @@ + + + + + +ByteShape.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class ByteShape.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/ByteShape.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ByteShape.html new file mode 100644 index 00000000000..af649d4771b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ByteShape.html @@ -0,0 +1,422 @@ + + + + + +ByteShape (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class ByteShape

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + +
          +
        • +

          accept

          +
          public <R> R accept​(ShapeVisitor<R> visitor)
          +
          Description copied from class: Shape
          +
          Dispatches the shape to the appropriate ShapeVisitor method.
          +
          +
          Specified by:
          +
          accept in class Shape
          +
          Type Parameters:
          +
          R - Return type of the accept.
          +
          Parameters:
          +
          visitor - ShapeVisitor to use.
          +
          Returns:
          +
          Returns the result.
          +
          +
          • +
        + + + +
          +
        • +

          asByteShape

          +
          public java.util.Optional<ByteShape> asByteShape()
          +
          +
          Overrides:
          +
          asByteShape in class Shape
          +
          Returns:
          +
          Optionally returns the shape as a ByteShape.
          +
          +
          • +
        + + + +
          +
        • +

          getType

          +
          public ShapeType getType()
          +
          Description copied from class: Shape
          +
          Gets the type of the shape.
          +
          +
          Specified by:
          +
          getType in class Shape
          +
          Returns:
          +
          Returns the type;
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/CollectionShape.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/CollectionShape.Builder.html new file mode 100644 index 00000000000..0edad79f3c0 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/CollectionShape.Builder.html @@ -0,0 +1,527 @@ + + + + + +CollectionShape.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class CollectionShape.Builder<B extends CollectionShape.Builder<B,​S>,​S extends CollectionShape>

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/CollectionShape.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/CollectionShape.html new file mode 100644 index 00000000000..2837262b1ff --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/CollectionShape.html @@ -0,0 +1,376 @@ + + + + + +CollectionShape (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class CollectionShape

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getMember

          +
          public final MemberShape getMember()
          +
          Get the member shape of the collection.
          +
          +
          Returns:
          +
          Returns the member shape.
          +
          +
          • +
        + + + +
          +
        • +

          getMember

          +
          public java.util.Optional<MemberShape> getMember​(java.lang.String memberName)
          +
          Description copied from class: Shape
          +
          Get a specific member by name. + +

          Shapes with no members return an empty Optional.

          +
          +
          Overrides:
          +
          getMember in class Shape
          +
          Parameters:
          +
          memberName - Name of the member to retrieve.
          +
          Returns:
          +
          Returns the optional member.
          +
          +
          • +
        + + + +
          +
        • +

          getAllMembers

          +
          public final java.util.Map<java.lang.String,​MemberShape> getAllMembers()
          +
          Description copied from class: Shape
          +
          Gets the members of the shape, including mixin members.
          +
          +
          Overrides:
          +
          getAllMembers in class Shape
          +
          Returns:
          +
          Returns the immutable member map.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/DocumentShape.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/DocumentShape.Builder.html new file mode 100644 index 00000000000..85579f7157e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/DocumentShape.Builder.html @@ -0,0 +1,359 @@ + + + + + +DocumentShape.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class DocumentShape.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/DocumentShape.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/DocumentShape.html new file mode 100644 index 00000000000..f2def9b4d8a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/DocumentShape.html @@ -0,0 +1,417 @@ + + + + + +DocumentShape (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class DocumentShape

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + +
          +
        • +

          accept

          +
          public <R> R accept​(ShapeVisitor<R> visitor)
          +
          Description copied from class: Shape
          +
          Dispatches the shape to the appropriate ShapeVisitor method.
          +
          +
          Specified by:
          +
          accept in class Shape
          +
          Type Parameters:
          +
          R - Return type of the accept.
          +
          Parameters:
          +
          visitor - ShapeVisitor to use.
          +
          Returns:
          +
          Returns the result.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getType

          +
          public ShapeType getType()
          +
          Description copied from class: Shape
          +
          Gets the type of the shape.
          +
          +
          Specified by:
          +
          getType in class Shape
          +
          Returns:
          +
          Returns the type;
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/DoubleShape.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/DoubleShape.Builder.html new file mode 100644 index 00000000000..8e25c894b63 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/DoubleShape.Builder.html @@ -0,0 +1,359 @@ + + + + + +DoubleShape.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class DoubleShape.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/DoubleShape.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/DoubleShape.html new file mode 100644 index 00000000000..314ee9ee4b4 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/DoubleShape.html @@ -0,0 +1,422 @@ + + + + + +DoubleShape (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class DoubleShape

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + +
          +
        • +

          accept

          +
          public <R> R accept​(ShapeVisitor<R> visitor)
          +
          Description copied from class: Shape
          +
          Dispatches the shape to the appropriate ShapeVisitor method.
          +
          +
          Specified by:
          +
          accept in class Shape
          +
          Type Parameters:
          +
          R - Return type of the accept.
          +
          Parameters:
          +
          visitor - ShapeVisitor to use.
          +
          Returns:
          +
          Returns the result.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getType

          +
          public ShapeType getType()
          +
          Description copied from class: Shape
          +
          Gets the type of the shape.
          +
          +
          Specified by:
          +
          getType in class Shape
          +
          Returns:
          +
          Returns the type;
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/EntityShape.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/EntityShape.Builder.html new file mode 100644 index 00000000000..870d187e065 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/EntityShape.Builder.html @@ -0,0 +1,495 @@ + + + + + +EntityShape.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class EntityShape.Builder<B extends EntityShape.Builder<B,​S>,​S extends EntityShape>

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          operations

          +
          public B operations​(java.util.Collection<ShapeId> ids)
          +
          • +
        + + + +
          +
        • +

          addOperation

          +
          public B addOperation​(ToShapeId id)
          +
          • +
        + + + +
          +
        • +

          addOperation

          +
          public B addOperation​(java.lang.String id)
          +
          • +
        + + + +
          +
        • +

          removeOperation

          +
          public B removeOperation​(ToShapeId id)
          +
          • +
        + + + +
          +
        • +

          clearOperations

          +
          public B clearOperations()
          +
          • +
        + + + +
          +
        • +

          resources

          +
          public B resources​(java.util.Collection<ShapeId> ids)
          +
          • +
        + + + +
          +
        • +

          addResource

          +
          public B addResource​(ToShapeId id)
          +
          • +
        + + + +
          +
        • +

          addResource

          +
          public B addResource​(java.lang.String id)
          +
          • +
        + + + +
          +
        • +

          removeResource

          +
          public B removeResource​(ToShapeId id)
          +
          • +
        + + + +
          +
        • +

          clearResources

          +
          public B clearResources()
          +
          • +
        + + + +
          +
        • +

          flattenMixins

          +
          public B flattenMixins()
          +
          Description copied from class: AbstractShapeBuilder
          +
          Removes mixins from a shape and flattens them into the shape. + +

          Flattening a mixin into a shape copies the traits and members of a + mixin onto the shape, effectively resulting in the same shape but with + no trace of the mixin relationship.

          +
          +
          Overrides:
          +
          flattenMixins in class AbstractShapeBuilder<B extends EntityShape.Builder<B,​S>,​S extends EntityShape>
          +
          Returns:
          +
          Returns the updated builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/EntityShape.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/EntityShape.html new file mode 100644 index 00000000000..95771f3469e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/EntityShape.html @@ -0,0 +1,444 @@ + + + + + +EntityShape (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class EntityShape

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getResources

          +
          public final java.util.Set<ShapeId> getResources()
          +
          +
          Returns:
          +
          Get all the resources directly bound to this shape.
          +
          +
          • +
        + + + +
          +
        • +

          getIntroducedResources

          +
          public final java.util.Set<ShapeId> getIntroducedResources()
          +
          Gets all the directly-bound resources introduced by this shape and + not inherited from mixins.
          +
          +
          Returns:
          +
          Gets the introduced resources directly-bound to the shape.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getIntroducedOperations

          +
          public final java.util.Set<ShapeId> getIntroducedOperations()
          +
          Gets operations bound through the "operations" property that + were not inherited from mixins. + +

          This will not include operations bound to resources using + a lifecycle operation binding. This will also not include + operations bound to this entity through sub-resources.

          +
          +
          Returns:
          +
          Gets the introduced operations.
          +
          +
          • +
        + + + +
          +
        • +

          getAllOperations

          +
          public java.util.Set<ShapeId> getAllOperations()
          +
          Get all operations directly bound to this shape. + +

          This will include operations bound directly to resources + using a lifecycle operation binding. This will not include + operations bound to this entity through sub-resources.

          +
          +
          Returns:
          +
          Returns all operations bound to the shape.
          +
          See Also:
          +
          TopDownIndex.getContainedOperations(software.amazon.smithy.model.shapes.ToShapeId)
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object other)
          +
          +
          Overrides:
          +
          equals in class Shape
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/EnumShape.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/EnumShape.Builder.html new file mode 100644 index 00000000000..5062ca345cb --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/EnumShape.Builder.html @@ -0,0 +1,737 @@ + + + + + +EnumShape.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class EnumShape.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/EnumShape.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/EnumShape.html new file mode 100644 index 00000000000..70bc92ee43c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/EnumShape.html @@ -0,0 +1,579 @@ + + + + + +EnumShape (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class EnumShape

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getEnumValues

          +
          public java.util.Map<java.lang.String,​java.lang.String> getEnumValues()
          +
          Gets a map of enum member names to their corresponding values.
          +
          +
          Returns:
          +
          A map of member names to enum values.
          +
          +
          • +
        + + + +
          +
        • +

          getAllMembers

          +
          public java.util.Map<java.lang.String,​MemberShape> getAllMembers()
          +
          Gets the members of the shape, including mixin members.
          +
          +
          Overrides:
          +
          getAllMembers in class Shape
          +
          Returns:
          +
          Returns the immutable member map.
          +
          +
          • +
        + + + +
          +
        • +

          findTrait

          +
          public java.util.Optional<Trait> findTrait​(ShapeId id)
          +
          Description copied from class: Shape
          +
          Attempts to find a trait applied to the shape by name.
          +
          +
          Overrides:
          +
          findTrait in class Shape
          +
          Parameters:
          +
          id - The trait shape ID.
          +
          Returns:
          +
          Returns the optionally found trait.
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          accept

          +
          public <R> R accept​(ShapeVisitor<R> cases)
          +
          Description copied from class: Shape
          +
          Dispatches the shape to the appropriate ShapeVisitor method.
          +
          +
          Overrides:
          +
          accept in class StringShape
          +
          Type Parameters:
          +
          R - Return type of the accept.
          +
          Parameters:
          +
          cases - ShapeVisitor to use.
          +
          Returns:
          +
          Returns the result.
          +
          +
          • +
        + + + +
          +
        • +

          asEnumShape

          +
          public java.util.Optional<EnumShape> asEnumShape()
          +
          +
          Overrides:
          +
          asEnumShape in class Shape
          +
          Returns:
          +
          Optionally returns the shape as a EnumShape.
          +
          +
          • +
        + + + +
          +
        • +

          fromStringShape

          +
          public static java.util.Optional<EnumShape> fromStringShape​(StringShape shape,
+                                                            boolean synthesizeNames)
          +
          Converts a base StringShape to an EnumShape if possible. + + The result will be empty if the given shape doesn't have the EnumTrait, + if the enum doesn't have names and name synthesization is disabled, or if a name + cannot be synthesized.
          +
          +
          Parameters:
          +
          shape - A base StringShape to convert.
          +
          synthesizeNames - Whether names should be synthesized if possible.
          +
          Returns:
          +
          Optionally returns an EnumShape equivalent of the given shape.
          +
          +
          • +
        + + + +
          +
        • +

          fromStringShape

          +
          public static java.util.Optional<EnumShape> fromStringShape​(StringShape shape)
          +
          Converts a base StringShape to an EnumShape if possible. + + The result will be empty if the given shape doesn't have the EnumTrait + or if the enum definitions don't have names.
          +
          +
          Parameters:
          +
          shape - A base StringShape to convert.
          +
          Returns:
          +
          Optionally returns an EnumShape equivalent of the given shape.
          +
          +
          • +
        + + + +
          +
        • +

          canConvertToEnum

          +
          public static boolean canConvertToEnum​(StringShape shape,
+                                       boolean synthesizeEnumNames)
          +
          Determines whether a given string shape can be converted to an enum shape.
          +
          +
          Parameters:
          +
          shape - The string shape to be converted.
          +
          synthesizeEnumNames - Whether synthesizing enum names should be accounted for.
          +
          Returns:
          +
          Returns true if the string shape can be converted to an enum shape.
          +
          +
          • +
        + + + +
          +
        • +

          getType

          +
          public ShapeType getType()
          +
          Description copied from class: Shape
          +
          Gets the type of the shape.
          +
          +
          Overrides:
          +
          getType in class StringShape
          +
          Returns:
          +
          Returns the type;
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/FloatShape.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/FloatShape.Builder.html new file mode 100644 index 00000000000..3fdeba0bcc1 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/FloatShape.Builder.html @@ -0,0 +1,359 @@ + + + + + +FloatShape.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class FloatShape.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/FloatShape.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/FloatShape.html new file mode 100644 index 00000000000..b949b81f81d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/FloatShape.html @@ -0,0 +1,422 @@ + + + + + +FloatShape (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class FloatShape

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + +
          +
        • +

          accept

          +
          public <R> R accept​(ShapeVisitor<R> visitor)
          +
          Description copied from class: Shape
          +
          Dispatches the shape to the appropriate ShapeVisitor method.
          +
          +
          Specified by:
          +
          accept in class Shape
          +
          Type Parameters:
          +
          R - Return type of the accept.
          +
          Parameters:
          +
          visitor - ShapeVisitor to use.
          +
          Returns:
          +
          Returns the result.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getType

          +
          public ShapeType getType()
          +
          Description copied from class: Shape
          +
          Gets the type of the shape.
          +
          +
          Specified by:
          +
          getType in class Shape
          +
          Returns:
          +
          Returns the type;
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/IntEnumShape.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/IntEnumShape.Builder.html new file mode 100644 index 00000000000..a5826122b61 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/IntEnumShape.Builder.html @@ -0,0 +1,655 @@ + + + + + +IntEnumShape.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class IntEnumShape.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/IntEnumShape.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/IntEnumShape.html new file mode 100644 index 00000000000..2f62e04003d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/IntEnumShape.html @@ -0,0 +1,478 @@ + + + + + +IntEnumShape (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class IntEnumShape

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getEnumValues

          +
          public java.util.Map<java.lang.String,​java.lang.Integer> getEnumValues()
          +
          Gets a map of enum member names to their corresponding values.
          +
          +
          Returns:
          +
          A map of member names to enum values.
          +
          +
          • +
        + + + +
          +
        • +

          getAllMembers

          +
          public java.util.Map<java.lang.String,​MemberShape> getAllMembers()
          +
          Gets the members of the shape, including mixin members.
          +
          +
          Overrides:
          +
          getAllMembers in class Shape
          +
          Returns:
          +
          Returns the immutable member map.
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          accept

          +
          public <R> R accept​(ShapeVisitor<R> cases)
          +
          Description copied from class: Shape
          +
          Dispatches the shape to the appropriate ShapeVisitor method.
          +
          +
          Overrides:
          +
          accept in class IntegerShape
          +
          Type Parameters:
          +
          R - Return type of the accept.
          +
          Parameters:
          +
          cases - ShapeVisitor to use.
          +
          Returns:
          +
          Returns the result.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getType

          +
          public ShapeType getType()
          +
          Description copied from class: Shape
          +
          Gets the type of the shape.
          +
          +
          Overrides:
          +
          getType in class IntegerShape
          +
          Returns:
          +
          Returns the type;
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/IntegerShape.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/IntegerShape.Builder.html new file mode 100644 index 00000000000..edc298d3980 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/IntegerShape.Builder.html @@ -0,0 +1,363 @@ + + + + + +IntegerShape.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class IntegerShape.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/IntegerShape.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/IntegerShape.html new file mode 100644 index 00000000000..919a6a10ac4 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/IntegerShape.html @@ -0,0 +1,426 @@ + + + + + +IntegerShape (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class IntegerShape

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + +
          +
        • +

          accept

          +
          public <R> R accept​(ShapeVisitor<R> visitor)
          +
          Description copied from class: Shape
          +
          Dispatches the shape to the appropriate ShapeVisitor method.
          +
          +
          Specified by:
          +
          accept in class Shape
          +
          Type Parameters:
          +
          R - Return type of the accept.
          +
          Parameters:
          +
          visitor - ShapeVisitor to use.
          +
          Returns:
          +
          Returns the result.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getType

          +
          public ShapeType getType()
          +
          Description copied from class: Shape
          +
          Gets the type of the shape.
          +
          +
          Specified by:
          +
          getType in class Shape
          +
          Returns:
          +
          Returns the type;
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/ListShape.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ListShape.Builder.html new file mode 100644 index 00000000000..356e208ebb8 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ListShape.Builder.html @@ -0,0 +1,375 @@ + + + + + +ListShape.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class ListShape.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/ListShape.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ListShape.html new file mode 100644 index 00000000000..339552b2c3f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ListShape.html @@ -0,0 +1,428 @@ + + + + + +ListShape (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class ListShape

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + +
          +
        • +

          accept

          +
          public <R> R accept​(ShapeVisitor<R> visitor)
          +
          Description copied from class: Shape
          +
          Dispatches the shape to the appropriate ShapeVisitor method.
          +
          +
          Specified by:
          +
          accept in class Shape
          +
          Type Parameters:
          +
          R - Return type of the accept.
          +
          Parameters:
          +
          visitor - ShapeVisitor to use.
          +
          Returns:
          +
          Returns the result.
          +
          +
          • +
        + + + +
          +
        • +

          asListShape

          +
          public java.util.Optional<ListShape> asListShape()
          +
          +
          Overrides:
          +
          asListShape in class Shape
          +
          Returns:
          +
          Optionally returns the shape as a ListShape.
          +
          +
          • +
        + + + +
          +
        • +

          getType

          +
          public ShapeType getType()
          +
          Description copied from class: Shape
          +
          Gets the type of the shape.
          +
          +
          Specified by:
          +
          getType in class Shape
          +
          Returns:
          +
          Returns the type;
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/LongShape.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/LongShape.Builder.html new file mode 100644 index 00000000000..810463f6622 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/LongShape.Builder.html @@ -0,0 +1,359 @@ + + + + + +LongShape.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class LongShape.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/LongShape.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/LongShape.html new file mode 100644 index 00000000000..462cea6c822 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/LongShape.html @@ -0,0 +1,422 @@ + + + + + +LongShape (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class LongShape

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + +
          +
        • +

          accept

          +
          public <R> R accept​(ShapeVisitor<R> visitor)
          +
          Description copied from class: Shape
          +
          Dispatches the shape to the appropriate ShapeVisitor method.
          +
          +
          Specified by:
          +
          accept in class Shape
          +
          Type Parameters:
          +
          R - Return type of the accept.
          +
          Parameters:
          +
          visitor - ShapeVisitor to use.
          +
          Returns:
          +
          Returns the result.
          +
          +
          • +
        + + + +
          +
        • +

          asLongShape

          +
          public java.util.Optional<LongShape> asLongShape()
          +
          +
          Overrides:
          +
          asLongShape in class Shape
          +
          Returns:
          +
          Optionally returns the shape as a LongShape.
          +
          +
          • +
        + + + +
          +
        • +

          getType

          +
          public ShapeType getType()
          +
          Description copied from class: Shape
          +
          Gets the type of the shape.
          +
          +
          Specified by:
          +
          getType in class Shape
          +
          Returns:
          +
          Returns the type;
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/MapShape.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/MapShape.Builder.html new file mode 100644 index 00000000000..3925098d3ad --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/MapShape.Builder.html @@ -0,0 +1,613 @@ + + + + + +MapShape.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class MapShape.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/MapShape.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/MapShape.html new file mode 100644 index 00000000000..fcc8f9d9d52 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/MapShape.html @@ -0,0 +1,506 @@ + + + + + +MapShape (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class MapShape

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          toBuilder

          +
          public MapShape.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<MapShape>
          +
          Returns:
          +
          a builder for type T
          +
          +
          • +
        + + + +
          +
        • +

          accept

          +
          public <R> R accept​(ShapeVisitor<R> visitor)
          +
          Description copied from class: Shape
          +
          Dispatches the shape to the appropriate ShapeVisitor method.
          +
          +
          Specified by:
          +
          accept in class Shape
          +
          Type Parameters:
          +
          R - Return type of the accept.
          +
          Parameters:
          +
          visitor - ShapeVisitor to use.
          +
          Returns:
          +
          Returns the result.
          +
          +
          • +
        + + + +
          +
        • +

          asMapShape

          +
          public java.util.Optional<MapShape> asMapShape()
          +
          +
          Overrides:
          +
          asMapShape in class Shape
          +
          Returns:
          +
          Optionally returns the shape as a MapShape.
          +
          +
          • +
        + + + +
          +
        • +

          getType

          +
          public ShapeType getType()
          +
          Description copied from class: Shape
          +
          Gets the type of the shape.
          +
          +
          Specified by:
          +
          getType in class Shape
          +
          Returns:
          +
          Returns the type;
          +
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public MemberShape getValue()
          +
          Get the value member shape of the map.
          +
          +
          Returns:
          +
          Returns the value member shape.
          +
          +
          • +
        + + + +
          +
        • +

          getKey

          +
          public MemberShape getKey()
          +
          Get the key member shape of the map.
          +
          +
          Returns:
          +
          Returns the key member shape.
          +
          +
          • +
        + + + +
          +
        • +

          getMember

          +
          public java.util.Optional<MemberShape> getMember​(java.lang.String memberName)
          +
          Description copied from class: Shape
          +
          Get a specific member by name. + +

          Shapes with no members return an empty Optional.

          +
          +
          Overrides:
          +
          getMember in class Shape
          +
          Parameters:
          +
          memberName - Name of the member to retrieve.
          +
          Returns:
          +
          Returns the optional member.
          +
          +
          • +
        + + + +
          +
        • +

          getAllMembers

          +
          public java.util.Map<java.lang.String,​MemberShape> getAllMembers()
          +
          Description copied from class: Shape
          +
          Gets the members of the shape, including mixin members.
          +
          +
          Overrides:
          +
          getAllMembers in class Shape
          +
          Returns:
          +
          Returns the immutable member map.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/MemberShape.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/MemberShape.Builder.html new file mode 100644 index 00000000000..60332cb1c73 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/MemberShape.Builder.html @@ -0,0 +1,425 @@ + + + + + +MemberShape.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class MemberShape.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public MemberShape build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        + + + + + + + +
          +
        • +

          target

          +
          public MemberShape.Builder target​(ToShapeId shapeId)
          +
          Sets a member shape ID on the builder.
          +
          +
          Parameters:
          +
          shapeId - MemberShape targeted shape ID.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          target

          +
          public MemberShape.Builder target​(java.lang.String shapeId)
          +
          Sets a member shape ID on the builder.
          +
          +
          Parameters:
          +
          shapeId - Targeted shape ID as an absolute member.
          +
          Returns:
          +
          Returns the builder.
          +
          Throws:
          +
          ShapeIdSyntaxException - if the shape ID is invalid.
          +
          +
          • +
        + + + +
          +
        • +

          getTarget

          +
          public ShapeId getTarget()
          +
          +
          Returns:
          +
          Returns the target currently set on the member.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/MemberShape.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/MemberShape.html new file mode 100644 index 00000000000..94aad1108b4 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/MemberShape.html @@ -0,0 +1,639 @@ + + + + + +MemberShape (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class MemberShape

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + +
          +
        • +

          getContainer

          +
          public ShapeId getContainer()
          +
          Gets the shape in which the member is contained.
          +
          +
          Returns:
          +
          Returns the containing shape id.
          +
          +
          • +
        + + + +
          +
        • +

          accept

          +
          public <R> R accept​(ShapeVisitor<R> visitor)
          +
          Description copied from class: Shape
          +
          Dispatches the shape to the appropriate ShapeVisitor method.
          +
          +
          Specified by:
          +
          accept in class Shape
          +
          Type Parameters:
          +
          R - Return type of the accept.
          +
          Parameters:
          +
          visitor - ShapeVisitor to use.
          +
          Returns:
          +
          Returns the result.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getType

          +
          public ShapeType getType()
          +
          Description copied from class: Shape
          +
          Gets the type of the shape.
          +
          +
          Specified by:
          +
          getType in class Shape
          +
          Returns:
          +
          Returns the type;
          +
          +
          • +
        + + + +
          +
        • +

          getTarget

          +
          public ShapeId getTarget()
          +
          Get the targeted member shape ID.
          +
          +
          Returns:
          +
          Returns the member shape ID.
          +
          +
          • +
        + + + +
          +
        • +

          getMemberName

          +
          public java.lang.String getMemberName()
          +
          Get the member name of the member.
          +
          +
          Returns:
          +
          Returns the member name.
          +
          +
          • +
        + + + +
          +
        • +

          isRequired

          +
          public boolean isRequired()
          +
          +
          Returns:
          +
          Returns true if the member has the required trait.
          +
          +
          • +
        + + + +
          +
        • +

          isOptional

          +
          public boolean isOptional()
          +
          +
          Returns:
          +
          Returns true if the member is not required.
          +
          +
          • +
        + + + +
          +
        • +

          hasNullDefault

          +
          public boolean hasNullDefault()
          +
          +
          Returns:
          +
          Returns true if the member has a default set explicitly to null.
          +
          +
          • +
        + + + +
          +
        • +

          hasNonNullDefault

          +
          public boolean hasNonNullDefault()
          +
          +
          Returns:
          +
          Returns true if the member has a default not set to null.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object other)
          +
          +
          Overrides:
          +
          equals in class Shape
          +
          +
          • +
        + + + +
          +
        • +

          getMemberTrait

          +
          public <T extends Trait> java.util.Optional<T> getMemberTrait​(Model model,
+                                                              java.lang.Class<T> trait)
          +
          Description copied from class: Shape
          +
          Gets a trait from the member shape or from the shape targeted by the + member. + +

          If the shape is not a member, then the method functions the same as + Shape.getTrait(Class).

          +
          +
          Overrides:
          +
          getMemberTrait in class Shape
          +
          Type Parameters:
          +
          T - Trait type to get.
          +
          Parameters:
          +
          model - Model used to find member targets.
          +
          trait - Trait type to get.
          +
          Returns:
          +
          Returns the optionally found trait on the shape or member.
          +
          See Also:
          +
          Shape.getTrait(Class)
          +
          +
          • +
        + + + +
          +
        • +

          findMemberTrait

          +
          public java.util.Optional<Trait> findMemberTrait​(Model model,
+                                                 java.lang.String traitName)
          +
          Description copied from class: Shape
          +
          Gets a trait from the member shape or from the shape targeted by the + member. + +

          If the shape is not a member, then the method functions the same as + Shape.findTrait(String).

          +
          +
          Overrides:
          +
          findMemberTrait in class Shape
          +
          Parameters:
          +
          model - Model used to find member targets.
          +
          traitName - Trait name to get.
          +
          Returns:
          +
          Returns the optionally found trait on the shape or member.
          +
          See Also:
          +
          Shape.findTrait(String)
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/ModelSerializer.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ModelSerializer.Builder.html new file mode 100644 index 00000000000..64564669f28 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ModelSerializer.Builder.html @@ -0,0 +1,417 @@ + + + + + +ModelSerializer.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class ModelSerializer.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.shapes.ModelSerializer.Builder
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          metadataFilter

          +
          public ModelSerializer.Builder metadataFilter​(java.util.function.Predicate<java.lang.String> metadataFilter)
          +
          Predicate that determines if a metadata is serialized.
          +
          +
          Parameters:
          +
          metadataFilter - Predicate that accepts a metadata key.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          shapeFilter

          +
          public ModelSerializer.Builder shapeFilter​(java.util.function.Predicate<Shape> shapeFilter)
          +
          Predicate that determines if a shape and its traits are serialized.
          +
          +
          Parameters:
          +
          shapeFilter - Predicate that accepts a shape.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          includePrelude

          +
          public ModelSerializer.Builder includePrelude​(boolean includePrelude)
          +
          Enables or disables including the prelude in the serialized model. + +

          By default, the prelude is not included. + +

          This should nearly always be left at default, as per the spec the prelude is + inherently part of every model, and so any Smithy implementation must build in + an understanding of the prelude. Disabling this filter can be useful for those + implementations to allow them to build their understanding of it from a JSON + version of the prelude.

          +
          +
          Parameters:
          +
          includePrelude - boolean indicating whether the prelude should be included or not.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          traitFilter

          +
          public ModelSerializer.Builder traitFilter​(java.util.function.Predicate<Trait> traitFilter)
          +
          Sets a predicate that can be used to filter trait values from + appearing in the serialized model. + +

          Note that this does not filter out trait definitions. It only filters + out instances of traits from being serialized on shapes.

          +
          +
          Parameters:
          +
          traitFilter - Predicate that filters out trait definitions.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          version

          +
          public ModelSerializer.Builder version​(java.lang.String version)
          +
          Sets the IDL version to serialize. Defaults to 2.0. + +

          Version "1.0" serialization cannot be used with includePrelude.

          +
          +
          Parameters:
          +
          version - IDL version to set. Can be "1", "1.0", "2", or "2.0". + "1" and "2" are normalized to "1.0" and "2.0".
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/ModelSerializer.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ModelSerializer.html new file mode 100644 index 00000000000..612bddf78a9 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ModelSerializer.html @@ -0,0 +1,315 @@ + + + + + +ModelSerializer (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class ModelSerializer

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.shapes.ModelSerializer
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class ModelSerializer
+extends java.lang.Object
      +
      Serializes a Model to an ObjectNode. + +

      The serialized value sorts all map key-value pairs so that they contain + a consistent key ordering, reducing noise in diffs based on + serialized model. + +

      After serializing to an ObjectNode, the node can then be serialized + to formats like JSON, YAML, Ion, etc.

      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/NumberShape.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/NumberShape.html new file mode 100644 index 00000000000..c7c08343165 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/NumberShape.html @@ -0,0 +1,253 @@ + + + + + +NumberShape (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class NumberShape

    +
    +
    + +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/OperationShape.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/OperationShape.Builder.html new file mode 100644 index 00000000000..58de17c8894 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/OperationShape.Builder.html @@ -0,0 +1,571 @@ + + + + + +OperationShape.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class OperationShape.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          input

          +
          public OperationShape.Builder input​(ToShapeId inputShape)
          +
          Sets the input shape ID of the operation.
          +
          +
          Parameters:
          +
          inputShape - Shape ID that MUST reference a structure.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          output

          +
          public OperationShape.Builder output​(ToShapeId outputShape)
          +
          Sets the output shape ID of the operation.
          +
          +
          Parameters:
          +
          outputShape - Shape ID that MUST reference a structure.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          errors

          +
          public OperationShape.Builder errors​(java.util.Collection<ShapeId> errorShapeIds)
          +
          Sets and replaces the errors of the operation.
          +
          +
          Parameters:
          +
          errorShapeIds - Error shape IDs to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          addError

          +
          public OperationShape.Builder addError​(ToShapeId errorShapeId)
          +
          Adds an error to the operation.
          +
          +
          Parameters:
          +
          errorShapeId - Error shape ID to add.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          addError

          +
          public OperationShape.Builder addError​(java.lang.String errorShapeId)
          +
          Adds an error to the operation.
          +
          +
          Parameters:
          +
          errorShapeId - Error shape ID to add.
          +
          Returns:
          +
          Returns the builder.
          +
          Throws:
          +
          ShapeIdSyntaxException - if the shape ID is invalid.
          +
          +
          • +
        + + + +
          +
        • +

          addErrors

          +
          public OperationShape.Builder addErrors​(java.util.Collection<ShapeId> errorShapeIds)
          +
          Adds an each of the errors to the operation.
          +
          +
          Parameters:
          +
          errorShapeIds - Error shape IDs to add.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          removeError

          +
          public OperationShape.Builder removeError​(ToShapeId errorShapeId)
          +
          Removes an error by Shape ID.
          +
          +
          Parameters:
          +
          errorShapeId - Error shape ID to remove.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          clearErrors

          +
          public OperationShape.Builder clearErrors()
          +
          Removes all errors.
          +
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          build

          +
          public OperationShape build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/OperationShape.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/OperationShape.html new file mode 100644 index 00000000000..2a82c7040e2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/OperationShape.html @@ -0,0 +1,613 @@ + + + + + +OperationShape (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class OperationShape

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + +
          +
        • +

          accept

          +
          public <R> R accept​(ShapeVisitor<R> visitor)
          +
          Description copied from class: Shape
          +
          Dispatches the shape to the appropriate ShapeVisitor method.
          +
          +
          Specified by:
          +
          accept in class Shape
          +
          Type Parameters:
          +
          R - Return type of the accept.
          +
          Parameters:
          +
          visitor - ShapeVisitor to use.
          +
          Returns:
          +
          Returns the result.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getType

          +
          public ShapeType getType()
          +
          Description copied from class: Shape
          +
          Gets the type of the shape.
          +
          +
          Specified by:
          +
          getType in class Shape
          +
          Returns:
          +
          Returns the type;
          +
          +
          • +
        + + + +
          +
        • +

          getInput

          +
          public java.util.Optional<ShapeId> getInput()
          +

          Gets the optional shape ID of the input of the operation.

          + +

          For backward compatibility, if the input targets smithy.api#Unit, + then an empty optional is returned.

          +
          +
          Returns:
          +
          Returns the optional shape ID.
          +
          +
          • +
        + + + +
          +
        • +

          getOutput

          +
          public java.util.Optional<ShapeId> getOutput()
          +

          Gets the optional shape ID of the output of the operation.

          + +

          For backward compatibility, if the output targets smithy.api#Unit, + then an empty optional is returned.

          +
          +
          Returns:
          +
          Returns the optional shape ID.
          +
          +
          • +
        + + + +
          +
        • +

          getInputShape

          +
          public ShapeId getInputShape()
          +
          Gets the input of the operation. + +

          All operations have input, and they default to target + smithy.api#Unit.

          +
          +
          Returns:
          +
          Returns the non-nullable input.
          +
          +
          • +
        + + + +
          +
        • +

          getOutputShape

          +
          public ShapeId getOutputShape()
          +
          Gets the output of the operation. + +

          All operations have output, and they default to target + smithy.api#Unit.

          +
          +
          Returns:
          +
          Returns the non-nullable output.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getIntroducedErrors

          +
          public java.util.List<ShapeId> getIntroducedErrors()
          +
          Gets the errors introduced by the shape and not inherited + from mixins.
          +
          +
          Returns:
          +
          Returns the introduced errors.
          +
          +
          • +
        + + + +
          +
        • +

          getErrors

          +
          public java.util.List<ShapeId> getErrors​(ServiceShape service)
          +

          Gets a list of the error shape IDs the operation can encounter, + including any common errors of a service. + +

          No validation is performed here to ensure that the operation is + actually bound to the given service shape.

          +
          +
          Returns:
          +
          Returns the errors.
          +
          See Also:
          +
          OperationIndex.getErrors(ToShapeId, ToShapeId)
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object other)
          +
          +
          Overrides:
          +
          equals in class Shape
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/ResourceShape.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ResourceShape.Builder.html new file mode 100644 index 00000000000..4fc29747f1a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ResourceShape.Builder.html @@ -0,0 +1,659 @@ + + + + + +ResourceShape.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class ResourceShape.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/ResourceShape.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ResourceShape.html new file mode 100644 index 00000000000..6262aba7483 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ResourceShape.html @@ -0,0 +1,691 @@ + + + + + +ResourceShape (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class ResourceShape

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + +
          +
        • +

          accept

          +
          public <R> R accept​(ShapeVisitor<R> visitor)
          +
          Description copied from class: Shape
          +
          Dispatches the shape to the appropriate ShapeVisitor method.
          +
          +
          Specified by:
          +
          accept in class Shape
          +
          Type Parameters:
          +
          R - Return type of the accept.
          +
          Parameters:
          +
          visitor - ShapeVisitor to use.
          +
          Returns:
          +
          Returns the result.
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          getType

          +
          public ShapeType getType()
          +
          Description copied from class: Shape
          +
          Gets the type of the shape.
          +
          +
          Specified by:
          +
          getType in class Shape
          +
          Returns:
          +
          Returns the type;
          +
          +
          • +
        + + + +
          +
        • +

          getCollectionOperations

          +
          public java.util.Set<ShapeId> getCollectionOperations()
          +
          Gets the operations bound through the "collectionOperations" property. + + This will not include operations bound to resources using a lifecycle + operation binding.
          +
          +
          Returns:
          +
          Get the "collectionOperations" directly bound to this shape.
          +
          See Also:
          +
          getAllOperations()
          +
          +
          • +
        + + + +
          +
        • +

          getIdentifiers

          +
          public java.util.Map<java.lang.String,​ShapeId> getIdentifiers()
          +
          Gets the identifiers of the resource.
          +
          +
          Returns:
          +
          Returns the identifiers map of name to shape ID.
          +
          +
          • +
        + + + +
          +
        • +

          hasIdentifiers

          +
          public boolean hasIdentifiers()
          +
          +
          Returns:
          +
          Returns true if this resource defines any identifiers.
          +
          +
          • +
        + + + +
          +
        • +

          getProperties

          +
          public java.util.Map<java.lang.String,​ShapeId> getProperties()
          +
          • +
        + + + +
          +
        • +

          hasProperties

          +
          public boolean hasProperties()
          +
          • +
        + + + +
          +
        • +

          getPut

          +
          public java.util.Optional<ShapeId> getPut()
          +
          Gets the put lifecycle operation of the resource.
          +
          +
          Returns:
          +
          Returns the optionally found lifecycle.
          +
          +
          • +
        + + + +
          +
        • +

          getCreate

          +
          public java.util.Optional<ShapeId> getCreate()
          +
          Gets the create lifecycle operation of the resource.
          +
          +
          Returns:
          +
          Returns the optionally found lifecycle.
          +
          +
          • +
        + + + +
          +
        • +

          getRead

          +
          public java.util.Optional<ShapeId> getRead()
          +
          Gets the read lifecycle operation of the resource.
          +
          +
          Returns:
          +
          Returns the optionally found lifecycle.
          +
          +
          • +
        + + + +
          +
        • +

          getUpdate

          +
          public java.util.Optional<ShapeId> getUpdate()
          +
          Gets the update lifecycle operation of the resource.
          +
          +
          Returns:
          +
          Returns the optionally found lifecycle.
          +
          +
          • +
        + + + +
          +
        • +

          getDelete

          +
          public java.util.Optional<ShapeId> getDelete()
          +
          Gets the delete lifecycle operation of the resource.
          +
          +
          Returns:
          +
          Returns the optionally found lifecycle.
          +
          +
          • +
        + + + +
          +
        • +

          getList

          +
          public java.util.Optional<ShapeId> getList()
          +
          Gets the list lifecycle operation of the resource.
          +
          +
          Returns:
          +
          Returns the optionally found lifecycle.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object other)
          +
          +
          Overrides:
          +
          equals in class EntityShape
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/ServiceShape.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ServiceShape.Builder.html new file mode 100644 index 00000000000..06214bd7541 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ServiceShape.Builder.html @@ -0,0 +1,616 @@ + + + + + +ServiceShape.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class ServiceShape.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public ServiceShape build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +
        • +

          errors

          +
          public ServiceShape.Builder errors​(java.util.Collection<ShapeId> errorShapeIds)
          +
          Sets and replaces the errors of the service. Each error is implicitly + bound to every operation within the closure of the service.
          +
          +
          Parameters:
          +
          errorShapeIds - Error shape IDs to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          addError

          +
          public ServiceShape.Builder addError​(ToShapeId errorShapeId)
          +
          Adds an error to the service that is implicitly bound to every operation + within the closure of the service.
          +
          +
          Parameters:
          +
          errorShapeId - Error shape ID to add.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          addError

          +
          public ServiceShape.Builder addError​(java.lang.String errorShapeId)
          +
          Adds an error to the service that is implicitly bound to every + operation within the closure of the service.
          +
          +
          Parameters:
          +
          errorShapeId - Error shape ID to add.
          +
          Returns:
          +
          Returns the builder.
          +
          Throws:
          +
          ShapeIdSyntaxException - if the shape ID is invalid.
          +
          +
          • +
        + + + +
          +
        • +

          addErrors

          +
          public ServiceShape.Builder addErrors​(java.util.List<ShapeId> errorShapeIds)
          +
          Adds errors to the service that are implicitly bound to every operation + within the closure of the service.
          +
          +
          Parameters:
          +
          errorShapeIds - Error shape IDs to add.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          removeError

          +
          public ServiceShape.Builder removeError​(ToShapeId errorShapeId)
          +
          Removes an error by Shape ID.
          +
          +
          Parameters:
          +
          errorShapeId - Error shape ID to remove.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          clearErrors

          +
          public ServiceShape.Builder clearErrors()
          +
          Removes all errors.
          +
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/ServiceShape.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ServiceShape.html new file mode 100644 index 00000000000..242a33c673e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ServiceShape.html @@ -0,0 +1,615 @@ + + + + + +ServiceShape (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class ServiceShape

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + +
          +
        • +

          accept

          +
          public <R> R accept​(ShapeVisitor<R> visitor)
          +
          Description copied from class: Shape
          +
          Dispatches the shape to the appropriate ShapeVisitor method.
          +
          +
          Specified by:
          +
          accept in class Shape
          +
          Type Parameters:
          +
          R - Return type of the accept.
          +
          Parameters:
          +
          visitor - ShapeVisitor to use.
          +
          Returns:
          +
          Returns the result.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object other)
          +
          +
          Overrides:
          +
          equals in class EntityShape
          +
          +
          • +
        + + + +
          +
        • +

          getType

          +
          public ShapeType getType()
          +
          Description copied from class: Shape
          +
          Gets the type of the shape.
          +
          +
          Specified by:
          +
          getType in class Shape
          +
          Returns:
          +
          Returns the type;
          +
          +
          • +
        + + + +
          +
        • +

          getVersion

          +
          public java.lang.String getVersion()
          +
          Get the version of the service. An empty string is returned + if the version is undefined.
          +
          +
          Returns:
          +
          The version of the service.
          +
          +
          • +
        + + + +
          +
        • +

          getIntroducedVersion

          +
          public java.lang.String getIntroducedVersion()
          +
          Gets the version of the service introduced by the shape and not + inherited from mixins. An empty string is returned if the version + is undefined.
          +
          +
          Returns:
          +
          The introduced version of the service.
          +
          +
          • +
        + + + +
          +
        • +

          getRename

          +
          public java.util.Map<ShapeId,​java.lang.String> getRename()
          +
          +
          Returns:
          +
          The rename map of the service.
          +
          +
          • +
        + + + +
          +
        • +

          getIntroducedRename

          +
          public java.util.Map<ShapeId,​java.lang.String> getIntroducedRename()
          +
          Gets the rename map introduced by the shape and not inherited + from mixins.
          +
          +
          Returns:
          +
          The introduced rename map of the service.
          +
          +
          • +
        + + + +
          +
        • +

          getErrors

          +
          public java.util.List<ShapeId> getErrors()
          +

          Gets a list of the common errors that can be encountered by + every operation in the service.

          + +

          Each returned ShapeId must resolve to a + StructureShape that is targeted by an error trait; however, + this is only guaranteed after a model is validated.

          +
          +
          Returns:
          +
          Returns the errors.
          +
          +
          • +
        + + + +
          +
        • +

          getIntroducedErrors

          +
          public java.util.List<ShapeId> getIntroducedErrors()
          +
          Gets the list of common errors introduced by the shape and not + inherited from mixins. These errors can be encountered by every + operation in the service. + + Each returned ShapeId must resolve to a + StructureShape that is targeted by an error trait; however, + this is only guaranteed after a model is validated.
          +
          +
          Returns:
          +
          Returns the introduced service errors.
          +
          +
          • +
        + + + +
          +
        • +

          getContextualName

          +
          public java.lang.String getContextualName​(ToShapeId shape)
          +
          Gets the contextual name of a shape within the closure. + +

          If there is a rename property entry for the given shape ID, then + the renamed shape name is returned. Otherwise, the name part of the + given shape ID is returned, regardless of if the shape exists in the + closure of the service. + +

          This is a mirror of ShapeId.getName(ServiceShape) + that serves to make this functionality more discoverable.

          +
          +
          Parameters:
          +
          shape - Shape to get the contextual name of.
          +
          Returns:
          +
          Returns the contextual name of the shape within the service.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/SetShape.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/SetShape.Builder.html new file mode 100644 index 00000000000..c6d4cf1c8b4 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/SetShape.Builder.html @@ -0,0 +1,780 @@ + + + + + +SetShape.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class SetShape.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/SetShape.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/SetShape.html new file mode 100644 index 00000000000..705381075ee --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/SetShape.html @@ -0,0 +1,456 @@ + + + + + +SetShape (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class SetShape

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.lang.Comparable<Shape>, FromSourceLocation, ToShapeId, Tagged, ToSmithyBuilder<ListShape>
      +
      +
      +
      @Deprecated
+public final class SetShape
+extends ListShape
      +
      Deprecated.
      +
      Represents a set shape. + +

      Sets are deprecated. Use list shapes with the uniqueItems trait instead. + When serialized using IDL v2, sets are converted to lists with the + uniqueItems trait.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + +
          +
        • +

          accept

          +
          public <R> R accept​(ShapeVisitor<R> visitor)
          +
          Deprecated.
          +
          Description copied from class: Shape
          +
          Dispatches the shape to the appropriate ShapeVisitor method.
          +
          +
          Overrides:
          +
          accept in class ListShape
          +
          Type Parameters:
          +
          R - Return type of the accept.
          +
          Parameters:
          +
          visitor - ShapeVisitor to use.
          +
          Returns:
          +
          Returns the result.
          +
          +
          • +
        + + + +
          +
        • +

          asSetShape

          +
          public java.util.Optional<SetShape> asSetShape()
          +
          Deprecated.
          +
          +
          Overrides:
          +
          asSetShape in class Shape
          +
          Returns:
          +
          Optionally returns the shape as a SetShape.
          +
          +
          • +
        + + + +
          +
        • +

          getType

          +
          public ShapeType getType()
          +
          Deprecated.
          +
          Description copied from class: Shape
          +
          Gets the type of the shape.
          +
          +
          Overrides:
          +
          getType in class ListShape
          +
          Returns:
          +
          Returns the type;
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/Shape.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/Shape.html new file mode 100644 index 00000000000..8907e321282 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/Shape.html @@ -0,0 +1,1832 @@ + + + + + +Shape (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class Shape

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.shapes.Shape
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validateMixins

          +
          protected void validateMixins​(java.util.Map<ShapeId,​Shape> mixins,
+                              java.util.Map<ShapeId,​Trait> introducedTraits)
          +
          • +
        + + + +
          +
        • +

          getRequiredMembers

          +
          protected MemberShape[] getRequiredMembers​(AbstractShapeBuilder<?,​?> builder,
+                                           java.lang.String... requiredMembersNames)
          +
          • +
        + + + +
          +
        • +

          validateMemberShapeIds

          +
          protected final void validateMemberShapeIds()
          +
          • +
        + + + + + +
          +
        • +

          shapeToBuilder

          +
          public static <B extends AbstractShapeBuilder<B,​S>,​S extends Shape> B shapeToBuilder​(S shape)
          +
          Converts a shape, potentially of an unknown concrete type, into a + Shape builder.
          +
          +
          Type Parameters:
          +
          B - Shape builder to create.
          +
          S - Shape that is being converted to a builder.
          +
          Parameters:
          +
          shape - Shape to create a builder from.
          +
          Returns:
          +
          Returns a shape fro the given shape.
          +
          +
          • +
        + + + +
          +
        • +

          getType

          +
          public abstract ShapeType getType()
          +
          Gets the type of the shape.
          +
          +
          Returns:
          +
          Returns the type;
          +
          +
          • +
        + + + +
          +
        • +

          accept

          +
          public abstract <R> R accept​(ShapeVisitor<R> visitor)
          +
          Dispatches the shape to the appropriate ShapeVisitor method.
          +
          +
          Type Parameters:
          +
          R - Return type of the accept.
          +
          Parameters:
          +
          visitor - ShapeVisitor to use.
          +
          Returns:
          +
          Returns the result.
          +
          +
          • +
        + + + +
          +
        • +

          getId

          +
          public final ShapeId getId()
          +
          Get the ShapeId of the shape.
          +
          +
          Returns:
          +
          Returns the shape ID.
          +
          +
          • +
        + + + +
          +
        • +

          hasTrait

          +
          public boolean hasTrait​(java.lang.String id)
          +
          Checks if the shape has a specific trait by name. + +

          Relative shape IDs are assumed to refer to the "smithy.api" + namespace.

          +
          +
          Parameters:
          +
          id - The possibly relative trait ID.
          +
          Returns:
          +
          Returns true if the shape has the given trait.
          +
          +
          • +
        + + + +
          +
        • +

          hasTrait

          +
          public boolean hasTrait​(ShapeId id)
          +
          Checks if the shape has a specific trait by name.
          +
          +
          Parameters:
          +
          id - The fully-qualified trait ID.
          +
          Returns:
          +
          Returns true if the shape has the given trait.
          +
          +
          • +
        + + + +
          +
        • +

          hasTrait

          +
          public boolean hasTrait​(java.lang.Class<? extends Trait> traitClass)
          +
          Checks if the shape has a specific trait by class.
          +
          +
          Parameters:
          +
          traitClass - Trait class to check.
          +
          Returns:
          +
          Returns true if the shape has the given trait.
          +
          +
          • +
        + + + +
          +
        • +

          findTrait

          +
          public java.util.Optional<Trait> findTrait​(ShapeId id)
          +
          Attempts to find a trait applied to the shape by name.
          +
          +
          Parameters:
          +
          id - The trait shape ID.
          +
          Returns:
          +
          Returns the optionally found trait.
          +
          +
          • +
        + + + +
          +
        • +

          findTrait

          +
          public java.util.Optional<Trait> findTrait​(java.lang.String id)
          +
          Attempts to find a trait applied to the shape by ID. + +

          Relative shape IDs are assumed to refer to the "smithy.api" + namespace.

          +
          +
          Parameters:
          +
          id - The trait ID.
          +
          Returns:
          +
          Returns the optionally found trait.
          +
          +
          • +
        + + + +
          +
        • +

          getTrait

          +
          public final <T extends Trait> java.util.Optional<T> getTrait​(java.lang.Class<T> traitClass)
          +
          Attempt to retrieve a specific Trait by class from the shape. + +

          The first trait instance found matching the given type is returned.

          +
          +
          Type Parameters:
          +
          T - The instance of the trait to retrieve.
          +
          Parameters:
          +
          traitClass - Trait class to retrieve.
          +
          Returns:
          +
          Returns the matching trait.
          +
          +
          • +
        + + + +
          +
        • +

          expectTrait

          +
          public final <T extends Trait> T expectTrait​(java.lang.Class<T> traitClass)
          +
          Gets specific Trait by class from the shape or throws if not found.
          +
          +
          Type Parameters:
          +
          T - The instance of the trait to retrieve.
          +
          Parameters:
          +
          traitClass - Trait class to retrieve.
          +
          Returns:
          +
          Returns the matching trait.
          +
          Throws:
          +
          ExpectationNotMetException - if the trait cannot be found.
          +
          +
          • +
        + + + +
          +
        • +

          getAllTraits

          +
          public final java.util.Map<ShapeId,​Trait> getAllTraits()
          +
          Gets all of the traits attached to the shape.
          +
          +
          Returns:
          +
          Returns the attached traits.
          +
          +
          • +
        + + + +
          +
        • +

          getMemberTrait

          +
          public <T extends Trait> java.util.Optional<T> getMemberTrait​(Model model,
+                                                              java.lang.Class<T> trait)
          +
          Gets a trait from the member shape or from the shape targeted by the + member. + +

          If the shape is not a member, then the method functions the same as + getTrait(Class).

          +
          +
          Type Parameters:
          +
          T - Trait type to get.
          +
          Parameters:
          +
          model - Model used to find member targets.
          +
          trait - Trait type to get.
          +
          Returns:
          +
          Returns the optionally found trait on the shape or member.
          +
          See Also:
          +
          getTrait(Class)
          +
          +
          • +
        + + + +
          +
        • +

          findMemberTrait

          +
          public java.util.Optional<Trait> findMemberTrait​(Model model,
+                                                 java.lang.String traitName)
          +
          Gets a trait from the member shape or from the shape targeted by the + member. + +

          If the shape is not a member, then the method functions the same as + findTrait(String).

          +
          +
          Parameters:
          +
          model - Model used to find member targets.
          +
          traitName - Trait name to get.
          +
          Returns:
          +
          Returns the optionally found trait on the shape or member.
          +
          See Also:
          +
          findTrait(String)
          +
          +
          • +
        + + + +
          +
        • +

          asBigDecimalShape

          +
          public java.util.Optional<BigDecimalShape> asBigDecimalShape()
          +
          +
          Returns:
          +
          Optionally returns the shape as a BigDecimalShape.
          +
          +
          • +
        + + + +
          +
        • +

          asBigIntegerShape

          +
          public java.util.Optional<BigIntegerShape> asBigIntegerShape()
          +
          +
          Returns:
          +
          Optionally returns the shape as a BigIntegerShape.
          +
          +
          • +
        + + + +
          +
        • +

          asBlobShape

          +
          public java.util.Optional<BlobShape> asBlobShape()
          +
          +
          Returns:
          +
          Optionally returns the shape as a BlobShape.
          +
          +
          • +
        + + + +
          +
        • +

          asBooleanShape

          +
          public java.util.Optional<BooleanShape> asBooleanShape()
          +
          +
          Returns:
          +
          Optionally returns the shape as a BooleanShape.
          +
          +
          • +
        + + + +
          +
        • +

          asByteShape

          +
          public java.util.Optional<ByteShape> asByteShape()
          +
          +
          Returns:
          +
          Optionally returns the shape as a ByteShape.
          +
          +
          • +
        + + + +
          +
        • +

          asShortShape

          +
          public java.util.Optional<ShortShape> asShortShape()
          +
          +
          Returns:
          +
          Optionally returns the shape as a ShortShape.
          +
          +
          • +
        + + + +
          +
        • +

          asFloatShape

          +
          public java.util.Optional<FloatShape> asFloatShape()
          +
          +
          Returns:
          +
          Optionally returns the shape as a FloatShape.
          +
          +
          • +
        + + + +
          +
        • +

          asDocumentShape

          +
          public java.util.Optional<DocumentShape> asDocumentShape()
          +
          +
          Returns:
          +
          Optionally returns the shape as a DocumentShape.
          +
          +
          • +
        + + + +
          +
        • +

          asDoubleShape

          +
          public java.util.Optional<DoubleShape> asDoubleShape()
          +
          +
          Returns:
          +
          Optionally returns the shape as a DoubleShape.
          +
          +
          • +
        + + + +
          +
        • +

          asIntegerShape

          +
          public java.util.Optional<IntegerShape> asIntegerShape()
          +
          +
          Returns:
          +
          Optionally returns the shape as a IntegerShape.
          +
          +
          • +
        + + + +
          +
        • +

          asIntEnumShape

          +
          public java.util.Optional<IntEnumShape> asIntEnumShape()
          +
          +
          Returns:
          +
          Optionally returns the shape as a IntEnumShape.
          +
          +
          • +
        + + + +
          +
        • +

          asListShape

          +
          public java.util.Optional<ListShape> asListShape()
          +
          +
          Returns:
          +
          Optionally returns the shape as a ListShape.
          +
          +
          • +
        + + + +
          +
        • +

          asSetShape

          +
          @Deprecated
+public java.util.Optional<SetShape> asSetShape()
          +
          Deprecated.
          +
          +
          Returns:
          +
          Optionally returns the shape as a SetShape.
          +
          +
          • +
        + + + +
          +
        • +

          asLongShape

          +
          public java.util.Optional<LongShape> asLongShape()
          +
          +
          Returns:
          +
          Optionally returns the shape as a LongShape.
          +
          +
          • +
        + + + +
          +
        • +

          asMapShape

          +
          public java.util.Optional<MapShape> asMapShape()
          +
          +
          Returns:
          +
          Optionally returns the shape as a MapShape.
          +
          +
          • +
        + + + +
          +
        • +

          asMemberShape

          +
          public java.util.Optional<MemberShape> asMemberShape()
          +
          +
          Returns:
          +
          Optionally returns the shape as a MemberShape.
          +
          +
          • +
        + + + +
          +
        • +

          asOperationShape

          +
          public java.util.Optional<OperationShape> asOperationShape()
          +
          +
          Returns:
          +
          Optionally returns the shape as an OperationShape.
          +
          +
          • +
        + + + +
          +
        • +

          asResourceShape

          +
          public java.util.Optional<ResourceShape> asResourceShape()
          +
          +
          Returns:
          +
          Optionally returns the shape as a ResourceShape.
          +
          +
          • +
        + + + +
          +
        • +

          asServiceShape

          +
          public java.util.Optional<ServiceShape> asServiceShape()
          +
          +
          Returns:
          +
          Optionally returns the shape as a ServiceShape.
          +
          +
          • +
        + + + +
          +
        • +

          asStringShape

          +
          public java.util.Optional<StringShape> asStringShape()
          +
          +
          Returns:
          +
          Optionally returns the shape as a StringShape.
          +
          +
          • +
        + + + +
          +
        • +

          asEnumShape

          +
          public java.util.Optional<EnumShape> asEnumShape()
          +
          +
          Returns:
          +
          Optionally returns the shape as a EnumShape.
          +
          +
          • +
        + + + +
          +
        • +

          asStructureShape

          +
          public java.util.Optional<StructureShape> asStructureShape()
          +
          +
          Returns:
          +
          Optionally returns the shape as a StructureShape.
          +
          +
          • +
        + + + +
          +
        • +

          asUnionShape

          +
          public java.util.Optional<UnionShape> asUnionShape()
          +
          +
          Returns:
          +
          Optionally returns the shape as a UnionShape.
          +
          +
          • +
        + + + +
          +
        • +

          asTimestampShape

          +
          public java.util.Optional<TimestampShape> asTimestampShape()
          +
          +
          Returns:
          +
          Optionally returns the shape as a TimestampShape.
          +
          +
          • +
        + + + +
          +
        • +

          isBigDecimalShape

          +
          public final boolean isBigDecimalShape()
          +
          +
          Returns:
          +
          Returns true if the shape is a BigDecimalShape shape.
          +
          +
          • +
        + + + +
          +
        • +

          isBigIntegerShape

          +
          public final boolean isBigIntegerShape()
          +
          +
          Returns:
          +
          Returns true if the shape is a BigIntegerShape shape.
          +
          +
          • +
        + + + +
          +
        • +

          isBlobShape

          +
          public final boolean isBlobShape()
          +
          +
          Returns:
          +
          Returns true if the shape is a BlobShape shape.
          +
          +
          • +
        + + + +
          +
        • +

          isBooleanShape

          +
          public final boolean isBooleanShape()
          +
          +
          Returns:
          +
          Returns true if the shape is a BooleanShape shape.
          +
          +
          • +
        + + + +
          +
        • +

          isByteShape

          +
          public final boolean isByteShape()
          +
          +
          Returns:
          +
          Returns true if the shape is a ByteShape shape.
          +
          +
          • +
        + + + +
          +
        • +

          isShortShape

          +
          public final boolean isShortShape()
          +
          +
          Returns:
          +
          Returns true if the shape is a ShortShape shape.
          +
          +
          • +
        + + + +
          +
        • +

          isFloatShape

          +
          public final boolean isFloatShape()
          +
          +
          Returns:
          +
          Returns true if the shape is a FloatShape shape.
          +
          +
          • +
        + + + +
          +
        • +

          isDocumentShape

          +
          public final boolean isDocumentShape()
          +
          +
          Returns:
          +
          Returns true if the shape is an DocumentShape shape.
          +
          +
          • +
        + + + +
          +
        • +

          isDoubleShape

          +
          public final boolean isDoubleShape()
          +
          +
          Returns:
          +
          Returns true if the shape is an DoubleShape shape.
          +
          +
          • +
        + + + +
          +
        • +

          isListShape

          +
          public final boolean isListShape()
          +
          +
          Returns:
          +
          Returns true if the shape is a ListShape shape.
          +
          +
          • +
        + + + +
          +
        • +

          isSetShape

          +
          @Deprecated
+public final boolean isSetShape()
          +
          Deprecated.
          +
          +
          Returns:
          +
          Returns true if the shape is a SetShape shape.
          +
          +
          • +
        + + + +
          +
        • +

          isIntegerShape

          +
          public final boolean isIntegerShape()
          +
          +
          Returns:
          +
          Returns true if the shape is a IntegerShape shape.
          +
          +
          • +
        + + + +
          +
        • +

          isIntEnumShape

          +
          public final boolean isIntEnumShape()
          +
          +
          Returns:
          +
          Returns true if the shape is a IntEnumShape shape.
          +
          +
          • +
        + + + +
          +
        • +

          isLongShape

          +
          public final boolean isLongShape()
          +
          +
          Returns:
          +
          Returns true if the shape is a LongShape shape.
          +
          +
          • +
        + + + +
          +
        • +

          isMapShape

          +
          public final boolean isMapShape()
          +
          +
          Returns:
          +
          Returns true if the shape is a MapShape shape.
          +
          +
          • +
        + + + +
          +
        • +

          isMemberShape

          +
          public final boolean isMemberShape()
          +
          +
          Returns:
          +
          Returns true if the shape is a MemberShape shape.
          +
          +
          • +
        + + + +
          +
        • +

          isOperationShape

          +
          public final boolean isOperationShape()
          +
          +
          Returns:
          +
          Returns true if the shape is an OperationShape shape.
          +
          +
          • +
        + + + +
          +
        • +

          isResourceShape

          +
          public final boolean isResourceShape()
          +
          +
          Returns:
          +
          Returns true if the shape is a ResourceShape shape.
          +
          +
          • +
        + + + +
          +
        • +

          isServiceShape

          +
          public final boolean isServiceShape()
          +
          +
          Returns:
          +
          Returns true if the shape is a ServiceShape shape.
          +
          +
          • +
        + + + +
          +
        • +

          isStringShape

          +
          public final boolean isStringShape()
          +
          +
          Returns:
          +
          Returns true if the shape is a StringShape shape.
          +
          +
          • +
        + + + +
          +
        • +

          isEnumShape

          +
          public final boolean isEnumShape()
          +
          +
          Returns:
          +
          Returns true if the shape is an EnumShape shape.
          +
          +
          • +
        + + + +
          +
        • +

          isStructureShape

          +
          public final boolean isStructureShape()
          +
          +
          Returns:
          +
          Returns true if the shape is a StructureShape shape.
          +
          +
          • +
        + + + +
          +
        • +

          isUnionShape

          +
          public final boolean isUnionShape()
          +
          +
          Returns:
          +
          Returns true if the shape is a UnionShape shape.
          +
          +
          • +
        + + + +
          +
        • +

          isTimestampShape

          +
          public final boolean isTimestampShape()
          +
          +
          Returns:
          +
          Returns true if the shape is a TimestampShape shape.
          +
          +
          • +
        + + + +
          +
        • +

          members

          +
          public java.util.Collection<MemberShape> members()
          +
          Gets all the members contained in the shape.
          +
          +
          Returns:
          +
          Returns the members contained in the shape (if any).
          +
          +
          • +
        + + + +
          +
        • +

          getMember

          +
          public java.util.Optional<MemberShape> getMember​(java.lang.String name)
          +
          Get a specific member by name. + +

          Shapes with no members return an empty Optional.

          +
          +
          Parameters:
          +
          name - Name of the member to retrieve.
          +
          Returns:
          +
          Returns the optional member.
          +
          +
          • +
        + + + +
          +
        • +

          getAllMembers

          +
          public java.util.Map<java.lang.String,​MemberShape> getAllMembers()
          +
          Gets the members of the shape, including mixin members.
          +
          +
          Returns:
          +
          Returns the immutable member map.
          +
          +
          • +
        + + + +
          +
        • +

          getMemberNames

          +
          public java.util.List<java.lang.String> getMemberNames()
          +
          Returns an ordered list of member names based on the order they are + defined in the model, including mixin members. + +

          The order in which map key and value members are returned might + not match the order in which they were defined in the model because + their ordering is insignificant.

          +
          +
          Returns:
          +
          Returns an immutable list of member names.
          +
          +
          • +
        + + + +
          +
        • +

          getMixins

          +
          public java.util.Set<ShapeId> getMixins()
          +
          Get an ordered set of mixins attached to the shape.
          +
          +
          Returns:
          +
          Returns the ordered mixin shape IDs.
          +
          +
          • +
        + + + +
          +
        • +

          getIntroducedTraits

          +
          public java.util.Map<ShapeId,​Trait> getIntroducedTraits()
          +
          Gets the traits introduced by the shape and not inherited + from mixins.
          +
          +
          Returns:
          +
          Returns the introduced traits.
          +
          +
          • +
        + + + +
          +
        • +

          toShapeId

          +
          public ShapeId toShapeId()
          +
          +
          Specified by:
          +
          toShapeId in interface ToShapeId
          +
          Returns:
          +
          Returns the shape ID of an object.
          +
          +
          • +
        + + + +
          +
        • +

          getTags

          +
          public final java.util.List<java.lang.String> getTags()
          +
          Description copied from interface: Tagged
          +
          Gets the tags applied to an object.
          +
          +
          Specified by:
          +
          getTags in interface Tagged
          +
          Returns:
          +
          Returns the tag values.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          compareTo

          +
          public int compareTo​(Shape other)
          +
          +
          Specified by:
          +
          compareTo in interface java.lang.Comparable<Shape>
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public final java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/ShapeId.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ShapeId.html new file mode 100644 index 00000000000..3eba6f8c1cd --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ShapeId.html @@ -0,0 +1,794 @@ + + + + + +ShapeId (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class ShapeId

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.shapes.ShapeId
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.lang.Comparable<ShapeId>, ToShapeId
      +
      +
      +
      public final class ShapeId
+extends java.lang.Object
+implements ToShapeId, java.lang.Comparable<ShapeId>
      +
      Immutable identifier for each shape in a model. + +

      A shape ID is constructed from an absolute or relative shape + reference. A shape reference has the following structure: + + NAMESPACE#NAME$MEMBER + +

      An absolute reference contains a namespace and a pound sign. + A relative reference omits the namespace and pound sign prefix. In + both absolute and relative shape references, the member is optional. + +

        +
      • Relative path : ShapeName
        • +
      • Relative path with a member : ShapeName$memberName
        • +
      • Absolute path : name.space#ShapeName
        • +
      • Absolute path with a member : name.space#ShapeName$memberName
        • +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.lang.StringasRelativeReference() +
        Creates a string that contains a relative reference to the ID.
        +
        intcompareTo​(ShapeId other) 
        booleanequals​(java.lang.Object other) 
        static ShapeIdfrom​(java.lang.String id) +
        Creates an absolute shape ID from the given string.
        +
        static ShapeIdfromNode​(Node node) 
        static ShapeIdfromOptionalNamespace​(java.lang.String defaultNamespace, + java.lang.String shapeName) +
        Builds a Id from the given reference.
        +
        static ShapeIdfromParts​(java.lang.String namespace, + java.lang.String name) +
        Creates an absolute shape ID from parts of a shape ID.
        +
        static ShapeIdfromParts​(java.lang.String namespace, + java.lang.String name, + java.lang.String member) +
        Creates an absolute shape ID from parts of a shape ID.
        +
        static ShapeIdfromRelative​(java.lang.String namespace, + java.lang.String relativeName) +
        Builds a Id from a relative shape reference.
        +
        java.util.Optional<java.lang.String>getMember() +
        Gets the optional member of the shape.
        +
        java.lang.StringgetName() +
        Get the name of the shape.
        +
        java.lang.StringgetName​(ServiceShape service) +
        Get the name of the shape when it is used within the contextual + closure of a service.
        +
        java.lang.StringgetNamespace() +
        Get the namespace of the shape.
        +
        inthashCode() 
        booleanhasMember() +
        Checks if the ID has a member set.
        +
        static booleanisValidIdentifier​(java.lang.CharSequence identifier) +
        Checks if the given string is a valid identifier.
        +
        static booleanisValidNamespace​(java.lang.CharSequence namespace) +
        Checks if the given string is a valid namespace.
        +
        ShapeIdtoShapeId() 
        java.lang.StringtoString() +
        Converts the Id into a shape ID string.
        +
        ShapeIdwithMember​(java.lang.String member) +
        Creates a new Shape.Id with a member add to it.
        +
        ShapeIdwithNamespace​(java.lang.String namespace) +
        Creates a shape ID that uses a different namespace than the current ID.
        +
        ShapeIdwithoutMember() +
        Creates a new Shape.Id with no member.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          from

          +
          public static ShapeId from​(java.lang.String id)
          +
          Creates an absolute shape ID from the given string.
          +
          +
          Parameters:
          +
          id - Shape ID to parse.
          +
          Returns:
          +
          The parsed ID.
          +
          Throws:
          +
          ShapeIdSyntaxException - when the ID is malformed.
          +
          +
          • +
        + + + +
          +
        • +

          fromNode

          +
          public static ShapeId fromNode​(Node node)
          +
          • +
        + + + +
          +
        • +

          isValidNamespace

          +
          public static boolean isValidNamespace​(java.lang.CharSequence namespace)
          +
          Checks if the given string is a valid namespace.
          +
          +
          Parameters:
          +
          namespace - Namespace value to check.
          +
          Returns:
          +
          Returns true if this is a valid namespace.
          +
          +
          • +
        + + + +
          +
        • +

          isValidIdentifier

          +
          public static boolean isValidIdentifier​(java.lang.CharSequence identifier)
          +
          Checks if the given string is a valid identifier.
          +
          +
          Parameters:
          +
          identifier - Identifier value to check.
          +
          Returns:
          +
          Returns true if this is a valid identifier.
          +
          +
          • +
        + + + +
          +
        • +

          fromParts

          +
          public static ShapeId fromParts​(java.lang.String namespace,
+                                java.lang.String name,
+                                java.lang.String member)
          +
          Creates an absolute shape ID from parts of a shape ID.
          +
          +
          Parameters:
          +
          namespace - Namespace of the shape.
          +
          name - Name of the shape.
          +
          member - Optional/nullable member name.
          +
          Returns:
          +
          The parsed ID.
          +
          Throws:
          +
          ShapeIdSyntaxException - when the ID is malformed.
          +
          +
          • +
        + + + +
          +
        • +

          fromParts

          +
          public static ShapeId fromParts​(java.lang.String namespace,
+                                java.lang.String name)
          +
          Creates an absolute shape ID from parts of a shape ID.
          +
          +
          Parameters:
          +
          namespace - Namespace of the shape.
          +
          name - Name of the shape.
          +
          Returns:
          +
          The parsed ID.
          +
          Throws:
          +
          ShapeIdSyntaxException - when the ID is malformed.
          +
          +
          • +
        + + + +
          +
        • +

          fromRelative

          +
          public static ShapeId fromRelative​(java.lang.String namespace,
+                                   java.lang.String relativeName)
          +
          Builds a Id from a relative shape reference. + +

          The given shape reference must not contain a namespace prefix. + It may contain a member.

          +
          +
          Parameters:
          +
          namespace - The namespace.
          +
          relativeName - A relative shape reference.
          +
          Returns:
          +
          Returns a Id extracted from relativeName.
          +
          Throws:
          +
          ShapeIdSyntaxException - when the namespace or shape reference + is malformed.
          +
          +
          • +
        + + + +
          +
        • +

          fromOptionalNamespace

          +
          public static ShapeId fromOptionalNamespace​(java.lang.String defaultNamespace,
+                                            java.lang.String shapeName)
          +
          Builds a Id from the given reference. + +

          If the shape reference contains a namespace, it is treated as an + absolute reference. If it does not contain a namespace prefix, it is + treated as a relative shape reference and the given default namespace + is used.

          +
          +
          Parameters:
          +
          defaultNamespace - The namespace to use when the shape reference + does not contain a namespace.
          +
          shapeName - A relative or absolute shape reference.
          +
          Returns:
          +
          Returns a Id extracted from shape reference.
          +
          Throws:
          +
          ShapeIdSyntaxException - when the namespace or shape reference + is malformed.
          +
          +
          • +
        + + + +
          +
        • +

          withMember

          +
          public ShapeId withMember​(java.lang.String member)
          +
          Creates a new Shape.Id with a member add to it.
          +
          +
          Parameters:
          +
          member - Member to set.
          +
          Returns:
          +
          returns a new Shape.Id
          +
          Throws:
          +
          ShapeIdSyntaxException - if the member name syntax is invalid.
          +
          +
          • +
        + + + +
          +
        • +

          toShapeId

          +
          public ShapeId toShapeId()
          +
          +
          Specified by:
          +
          toShapeId in interface ToShapeId
          +
          Returns:
          +
          Returns the shape ID of an object.
          +
          +
          • +
        + + + +
          +
        • +

          compareTo

          +
          public int compareTo​(ShapeId other)
          +
          +
          Specified by:
          +
          compareTo in interface java.lang.Comparable<ShapeId>
          +
          +
          • +
        + + + +
          +
        • +

          withoutMember

          +
          public ShapeId withoutMember()
          +
          Creates a new Shape.Id with no member.
          +
          +
          Returns:
          +
          returns a new Shape.Id, or the existing shape if it has no member.
          +
          +
          • +
        + + + +
          +
        • +

          getNamespace

          +
          public java.lang.String getNamespace()
          +
          Get the namespace of the shape.
          +
          +
          Returns:
          +
          Returns the namespace.
          +
          +
          • +
        + + + +
          +
        • +

          getName

          +
          public java.lang.String getName()
          +
          Get the name of the shape. + +

          Use getName(ServiceShape) when performing transformations + like code generation of the shapes used in services or clients.

          +
          +
          Returns:
          +
          Returns the name.
          +
          +
          • +
        + + + +
          +
        • +

          getName

          +
          public java.lang.String getName​(ServiceShape service)
          +
          Get the name of the shape when it is used within the contextual + closure of a service. + +

          This method should be used when performing transformations like + code generation of a Smithy model. Service shapes can rename shapes + used within the closure of a service to give shapes unambiguous names + independent of a namespace. + +

          This is a mirror of ServiceShape.getContextualName(ToShapeId) + that serves to make this functionality more discoverable.

          +
          +
          Parameters:
          +
          service - Service shape used to contextualize the name.
          +
          Returns:
          +
          Returns the contextualized shape name when used in a service.
          +
          +
          • +
        + + + +
          +
        • +

          getMember

          +
          public java.util.Optional<java.lang.String> getMember()
          +
          Gets the optional member of the shape.
          +
          +
          Returns:
          +
          Returns the optional member.
          +
          +
          • +
        + + + +
          +
        • +

          hasMember

          +
          public boolean hasMember()
          +
          Checks if the ID has a member set.
          +
          +
          Returns:
          +
          Returns true if the ID has a member.
          +
          +
          • +
        + + + +
          +
        • +

          asRelativeReference

          +
          public java.lang.String asRelativeReference()
          +
          Creates a string that contains a relative reference to the ID.
          +
          +
          Returns:
          +
          Returns a relative shape ID string with no namespace.
          +
          +
          • +
        + + + +
          +
        • +

          withNamespace

          +
          public ShapeId withNamespace​(java.lang.String namespace)
          +
          Creates a shape ID that uses a different namespace than the current ID.
          +
          +
          Parameters:
          +
          namespace - Namespace to use.
          +
          Returns:
          +
          Returns the shape ID with the changed namespace.
          +
          Throws:
          +
          ShapeIdSyntaxException - if the namespace is invalid.
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          Converts the Id into a shape ID string. + + For example: "com.foo.bar#Baz$member".
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          Returns:
          +
          Returns a shape ID as a string.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object other)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/ShapeIdSyntaxException.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ShapeIdSyntaxException.html new file mode 100644 index 00000000000..a25b28617b1 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ShapeIdSyntaxException.html @@ -0,0 +1,302 @@ + + + + + +ShapeIdSyntaxException (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class ShapeIdSyntaxException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Throwable
        • +
      • +
          +
        • java.lang.Exception
          • +
        • +
            +
          • java.lang.RuntimeException
            • +
          • +
              +
            • java.lang.IllegalArgumentException
              • +
            • +
                +
              • software.amazon.smithy.model.shapes.ShapeIdSyntaxException
                • +
              +
              • +
            +
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      public class ShapeIdSyntaxException
+extends java.lang.IllegalArgumentException
      +
      Represents a shape ID syntax error.
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        ShapeIdSyntaxException​(java.lang.String message) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ShapeIdSyntaxException

          +
          public ShapeIdSyntaxException​(java.lang.String message)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/ShapeType.Category.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ShapeType.Category.html new file mode 100644 index 00000000000..04dbc511f66 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ShapeType.Category.html @@ -0,0 +1,406 @@ + + + + + +ShapeType.Category (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Enum ShapeType.Category

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Enum<ShapeType.Category>
        • +
      • +
          +
        • software.amazon.smithy.model.shapes.ShapeType.Category
          • +
        +
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static ShapeType.CategoryvalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static ShapeType.Category[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static ShapeType.Category[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (ShapeType.Category c : ShapeType.Category.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static ShapeType.Category valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/ShapeType.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ShapeType.html new file mode 100644 index 00000000000..27cdffe1579 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ShapeType.html @@ -0,0 +1,817 @@ + + + + + +ShapeType (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Enum ShapeType

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Enum<ShapeType>
        • +
      • +
          +
        • software.amazon.smithy.model.shapes.ShapeType
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable, java.lang.Comparable<ShapeType>
      +
      +
      +
      public enum ShapeType
+extends java.lang.Enum<ShapeType>
      +
      An enumeration of the different types in a model.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static class ShapeType.Category 
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        AbstractShapeBuilder<?,​?>createBuilderForType() +
        Creates a shape builder that corresponds to the shape type.
        +
        static java.util.Optional<ShapeType>fromString​(java.lang.String text) +
        Create a new Shape.Type from a string.
        +
        ShapeType.CategorygetCategory() +
        Returns the category of the shape type, as defined in the Smithy + specification (one of SIMPLE, AGGREGATE, or SERVICE).
        +
        java.lang.Class<? extends Shape>getShapeClass() +
        Gets the class that implements this shape type.
        +
        booleanisShapeType​(ShapeType other) +
        Returns whether this shape type is equivalent to the given shape type, + accounting for things like enums being considered specializations of strings.
        +
        java.lang.StringtoString() 
        static ShapeTypevalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static ShapeType[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static ShapeType[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (ShapeType c : ShapeType.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static ShapeType valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Enum<ShapeType>
          +
          +
          • +
        + + + +
          +
        • +

          getShapeClass

          +
          public java.lang.Class<? extends Shape> getShapeClass()
          +
          Gets the class that implements this shape type.
          +
          +
          Returns:
          +
          Returns the shape class.
          +
          +
          • +
        + + + +
          +
        • +

          getCategory

          +
          public ShapeType.Category getCategory()
          +
          Returns the category of the shape type, as defined in the Smithy + specification (one of SIMPLE, AGGREGATE, or SERVICE).
          +
          +
          Returns:
          +
          Returns the category of the type.
          +
          +
          • +
        + + + +
          +
        • +

          isShapeType

          +
          public boolean isShapeType​(ShapeType other)
          +
          Returns whether this shape type is equivalent to the given shape type, + accounting for things like enums being considered specializations of strings.
          +
          +
          Parameters:
          +
          other - The other shape type to compare against.
          +
          Returns:
          +
          Returns true if the shape types are equivalent.
          +
          +
          • +
        + + + +
          +
        • +

          fromString

          +
          public static java.util.Optional<ShapeType> fromString​(java.lang.String text)
          +
          Create a new Shape.Type from a string.
          +
          +
          Parameters:
          +
          text - Text to convert into a Shape.Type
          +
          Returns:
          +
          Returns the Type in an Optional.
          +
          +
          • +
        + + + +
          +
        • +

          createBuilderForType

          +
          public AbstractShapeBuilder<?,​?> createBuilderForType()
          +
          Creates a shape builder that corresponds to the shape type.
          +
          +
          Returns:
          +
          Returns a shape builder corresponding to the type.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/ShapeVisitor.DataShapeVisitor.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ShapeVisitor.DataShapeVisitor.html new file mode 100644 index 00000000000..ab7565a5411 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ShapeVisitor.DataShapeVisitor.html @@ -0,0 +1,383 @@ + + + + + +ShapeVisitor.DataShapeVisitor (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class ShapeVisitor.DataShapeVisitor<R>

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.shapes.ShapeVisitor.DataShapeVisitor<R>
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Type Parameters:
      +
      R - Return type.
      +
      +
      +
      All Implemented Interfaces:
      +
      ShapeVisitor<R>
      +
      +
      +
      Enclosing interface:
      +
      ShapeVisitor<R>
      +
      +
      +
      public abstract static class ShapeVisitor.DataShapeVisitor<R>
+extends java.lang.Object
+implements ShapeVisitor<R>
      +
      Creates ShapeVisitor that only requires implementation of + all data shape branches, but does not support service shapes.
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/ShapeVisitor.Default.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ShapeVisitor.Default.html new file mode 100644 index 00000000000..422053b408e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ShapeVisitor.Default.html @@ -0,0 +1,730 @@ + + + + + +ShapeVisitor.Default (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class ShapeVisitor.Default<R>

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.shapes.ShapeVisitor.Default<R>
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Type Parameters:
      +
      R - Return type.
      +
      +
      +
      All Implemented Interfaces:
      +
      ShapeVisitor<R>
      +
      +
      +
      Enclosing interface:
      +
      ShapeVisitor<R>
      +
      +
      +
      public abstract static class ShapeVisitor.Default<R>
+extends java.lang.Object
+implements ShapeVisitor<R>
      +
      Creates ShapeVisitor that return a value when necessary + when visiting shapes.
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/ShapeVisitor.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ShapeVisitor.html new file mode 100644 index 00000000000..7d7d568b465 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ShapeVisitor.html @@ -0,0 +1,621 @@ + + + + + +ShapeVisitor (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Interface ShapeVisitor<R>

    +
    +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/ShortShape.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ShortShape.Builder.html new file mode 100644 index 00000000000..e3d207f1bc5 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ShortShape.Builder.html @@ -0,0 +1,359 @@ + + + + + +ShortShape.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class ShortShape.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/ShortShape.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ShortShape.html new file mode 100644 index 00000000000..b3ad53bb363 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ShortShape.html @@ -0,0 +1,422 @@ + + + + + +ShortShape (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class ShortShape

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + +
          +
        • +

          accept

          +
          public <R> R accept​(ShapeVisitor<R> visitor)
          +
          Description copied from class: Shape
          +
          Dispatches the shape to the appropriate ShapeVisitor method.
          +
          +
          Specified by:
          +
          accept in class Shape
          +
          Type Parameters:
          +
          R - Return type of the accept.
          +
          Parameters:
          +
          visitor - ShapeVisitor to use.
          +
          Returns:
          +
          Returns the result.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getType

          +
          public ShapeType getType()
          +
          Description copied from class: Shape
          +
          Gets the type of the shape.
          +
          +
          Specified by:
          +
          getType in class Shape
          +
          Returns:
          +
          Returns the type;
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/SimpleShape.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/SimpleShape.html new file mode 100644 index 00000000000..e842c17db9b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/SimpleShape.html @@ -0,0 +1,248 @@ + + + + + +SimpleShape (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class SimpleShape

    +
    +
    + +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/SmithyIdlComponentOrder.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/SmithyIdlComponentOrder.html new file mode 100644 index 00000000000..d6820d65022 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/SmithyIdlComponentOrder.html @@ -0,0 +1,413 @@ + + + + + +SmithyIdlComponentOrder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Enum SmithyIdlComponentOrder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        ALPHA_NUMERIC +
        Sort shapes, traits, and metadata alphabetically.
        +
        PREFERRED +
        Reorganizes shapes based on a preferred ordering of shapes, and alphanumeric traits and metadata.
        +
        SOURCE_LOCATION +
        Sort shapes, traits, and metadata by source location, persisting their original placement when parsed.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static SmithyIdlComponentOrdervalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static SmithyIdlComponentOrder[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + +
          +
        • +

          ALPHA_NUMERIC

          +
          public static final SmithyIdlComponentOrder ALPHA_NUMERIC
          +
          Sort shapes, traits, and metadata alphabetically. Member order, however, is not sorted.
          +
          • +
        + + + +
          +
        • +

          SOURCE_LOCATION

          +
          public static final SmithyIdlComponentOrder SOURCE_LOCATION
          +
          Sort shapes, traits, and metadata by source location, persisting their original placement when parsed.
          +
          • +
        + + + +
          +
        • +

          PREFERRED

          +
          public static final SmithyIdlComponentOrder PREFERRED
          +
          Reorganizes shapes based on a preferred ordering of shapes, and alphanumeric traits and metadata. + +

          Shapes are ordered as follows: + +

            +
          • Trait definitions
            • +
          • Services
            • +
          • Resources
            • +
          • Operations
            • +
          • Structures
            • +
          • Unions
            • +
          • Lists
            • +
          • Maps
            • +
          • Finally, alphabetically by shape type.
            • +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static SmithyIdlComponentOrder[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (SmithyIdlComponentOrder c : SmithyIdlComponentOrder.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static SmithyIdlComponentOrder valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/SmithyIdlModelSerializer.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/SmithyIdlModelSerializer.Builder.html new file mode 100644 index 00000000000..bc525daf51b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/SmithyIdlModelSerializer.Builder.html @@ -0,0 +1,581 @@ + + + + + +SmithyIdlModelSerializer.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class SmithyIdlModelSerializer.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.shapes.SmithyIdlModelSerializer.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          metadataFilter

          +
          public SmithyIdlModelSerializer.Builder metadataFilter​(java.util.function.Predicate<java.lang.String> metadataFilter)
          +
          Predicate that determines if a metadata is serialized.
          +
          +
          Parameters:
          +
          metadataFilter - Predicate that accepts a metadata key.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          shapeFilter

          +
          public SmithyIdlModelSerializer.Builder shapeFilter​(java.util.function.Predicate<Shape> shapeFilter)
          +
          Predicate that determines if a shape and its traits are serialized.
          +
          +
          Parameters:
          +
          shapeFilter - Predicate that accepts a shape.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          traitFilter

          +
          public SmithyIdlModelSerializer.Builder traitFilter​(java.util.function.Predicate<Trait> traitFilter)
          +
          Sets a predicate that can be used to filter trait values from + appearing in the serialized model. + +

          Note that this does not filter out trait definitions. It only filters + out instances of traits from being serialized on shapes.

          +
          +
          Parameters:
          +
          traitFilter - Predicate that filters out trait definitions.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          shapePlacer

          +
          public SmithyIdlModelSerializer.Builder shapePlacer​(java.util.function.Function<Shape,​java.nio.file.Path> shapePlacer)
          +
          Function that determines what output file a shape should go in. + +

          The returned paths may be absolute or relative. + +

          NOTE: the Smithy IDL only supports one namespace per file.

          +
          +
          Parameters:
          +
          shapePlacer - Function that accepts a shape and returns file path.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          basePath

          +
          public SmithyIdlModelSerializer.Builder basePath​(java.nio.file.Path basePath)
          +
          A base path to use for any created models.
          +
          +
          Parameters:
          +
          basePath - The base directory to assign models to.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          serializePrelude

          +
          public SmithyIdlModelSerializer.Builder serializePrelude()
          +
          Enables serializing shapes in the Smithy prelude. + Defaults to false.
          +
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          componentOrder

          +
          public SmithyIdlModelSerializer.Builder componentOrder​(SmithyIdlComponentOrder componentOrder)
          +
          Defines how components are sorted in the model, changing the default behavior of sorting alphabetically. + +

          You can serialize metadata, shapes, and traits in the original order they were defined by setting + this to SmithyIdlComponentOrder.SOURCE_LOCATION.

          +
          +
          Parameters:
          +
          componentOrder - Change how components are sorted.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          inlineInputSuffix

          +
          public SmithyIdlModelSerializer.Builder inlineInputSuffix​(java.lang.String inlineInputSuffix)
          +
          Defines what suffixes are checked on operation input shapes to determine whether + inline syntax should be used. + +

          This will also set the "operationInputSuffix" control statement.

          +
          +
          Parameters:
          +
          inlineInputSuffix - The suffix to use for inline operation input.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          inlineOutputSuffix

          +
          public SmithyIdlModelSerializer.Builder inlineOutputSuffix​(java.lang.String inlineOutputSuffix)
          +
          Defines what suffixes are checked on operation output shapes to determine whether + inline syntax should be used. + +

          This will also set the "operationOutputSuffix" control statement.

          +
          +
          Parameters:
          +
          inlineOutputSuffix - The suffix to use for inline operation output.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          inferInlineIoSuffixes

          +
          public SmithyIdlModelSerializer.Builder inferInlineIoSuffixes​(boolean shouldinferInlineIoSuffixes)
          +
          Determines whether the inline IO suffixes should be automatically determined. + +

          If true, this will determine any shared IO suffixes for each file. Only the + shapes present within each file will impact what that file's suffixes will be. + +

          The suffixes set by inlineInputSuffix(String) and inlineOutputSuffix(String) + will be the default values.

          +
          +
          Parameters:
          +
          shouldinferInlineIoSuffixes - Whether inline IO suffixes should be inferred for each file.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/SmithyIdlModelSerializer.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/SmithyIdlModelSerializer.html new file mode 100644 index 00000000000..690083990d1 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/SmithyIdlModelSerializer.html @@ -0,0 +1,349 @@ + + + + + +SmithyIdlModelSerializer (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class SmithyIdlModelSerializer

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.shapes.SmithyIdlModelSerializer
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class SmithyIdlModelSerializer
+extends java.lang.Object
      +
      Serializes a Model into a set of Smithy IDL files.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          serialize

          +
          public java.util.Map<java.nio.file.Path,​java.lang.String> serialize​(Model model)
          +
          Serializes a Model into a set of Smithy IDL files. + +

          The output is a mapping + +

          By default the paths are relative paths where each namespace is given its own file in the form + "namespace.smithy". This is configurable via the shape placer, which can place shapes into absolute + paths. + +

          If the model contains no shapes, or all shapes are filtered out, then a single path "metadata.smithy" + will be present. This will contain only any defined metadata.

          +
          +
          Parameters:
          +
          model - The model to serialize.
          +
          Returns:
          +
          A map of (possibly relative) file paths to Smithy IDL strings.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          placeShapesByNamespace

          +
          public static java.nio.file.Path placeShapesByNamespace​(Shape shape)
          +
          Sorts shapes into files based on their namespace, where each file is named {namespace}.smithy.
          +
          +
          Parameters:
          +
          shape - The shape to assign a file to.
          +
          Returns:
          +
          Returns the file the given shape should be placed in.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/StringShape.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/StringShape.Builder.html new file mode 100644 index 00000000000..a737e0fcb65 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/StringShape.Builder.html @@ -0,0 +1,363 @@ + + + + + +StringShape.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class StringShape.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/StringShape.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/StringShape.html new file mode 100644 index 00000000000..6f972a41240 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/StringShape.html @@ -0,0 +1,421 @@ + + + + + +StringShape (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class StringShape

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + +
          +
        • +

          accept

          +
          public <R> R accept​(ShapeVisitor<R> visitor)
          +
          Description copied from class: Shape
          +
          Dispatches the shape to the appropriate ShapeVisitor method.
          +
          +
          Specified by:
          +
          accept in class Shape
          +
          Type Parameters:
          +
          R - Return type of the accept.
          +
          Parameters:
          +
          visitor - ShapeVisitor to use.
          +
          Returns:
          +
          Returns the result.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getType

          +
          public ShapeType getType()
          +
          Description copied from class: Shape
          +
          Gets the type of the shape.
          +
          +
          Specified by:
          +
          getType in class Shape
          +
          Returns:
          +
          Returns the type;
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/StructureShape.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/StructureShape.Builder.html new file mode 100644 index 00000000000..1a4ea1bcac2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/StructureShape.Builder.html @@ -0,0 +1,686 @@ + + + + + +StructureShape.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class StructureShape.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public StructureShape build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getMember

          +
          public java.util.Optional<MemberShape> getMember​(java.lang.String memberName)
          +
          Description copied from class: AbstractShapeBuilder
          +
          Gets the optional member with the given name.
          +
          +
          Overrides:
          +
          getMember in class AbstractShapeBuilder<B extends software.amazon.smithy.model.shapes.NamedMembersShapeBuilder<B,​S>,​S extends Shape>
          +
          Returns:
          +
          Returns the optional member with the given name.
          +
          +
          • +
        + + + +
          +
        • +

          id

          +
          public final B id​(ShapeId shapeId)
          +
          Description copied from class: AbstractShapeBuilder
          +
          Sets the shape ID of the shape.
          +
          +
          Overrides:
          +
          id in class AbstractShapeBuilder<B extends software.amazon.smithy.model.shapes.NamedMembersShapeBuilder<B,​S>,​S extends Shape>
          +
          Parameters:
          +
          shapeId - Shape ID to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          members

          +
          public B members​(java.util.Collection<MemberShape> members)
          +
          Replaces the members of the builder.
          +
          +
          Parameters:
          +
          members - Members to add to the builder.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          clearMembers

          +
          public B clearMembers()
          +
          Description copied from class: AbstractShapeBuilder
          +
          Removes all members from the builder.
          +
          +
          Overrides:
          +
          clearMembers in class AbstractShapeBuilder<B extends software.amazon.smithy.model.shapes.NamedMembersShapeBuilder<B,​S>,​S extends Shape>
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          addMember

          +
          public B addMember​(MemberShape member)
          +
          Description copied from class: AbstractShapeBuilder
          +
          Adds a member to the shape IFF the shape supports members.
          +
          +
          Overrides:
          +
          addMember in class AbstractShapeBuilder<B extends software.amazon.smithy.model.shapes.NamedMembersShapeBuilder<B,​S>,​S extends Shape>
          +
          Parameters:
          +
          member - Member to add to the shape.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          addMember

          +
          public B addMember​(java.lang.String memberName,
+                   ShapeId target)
          +
          Adds a member to the builder.
          +
          +
          Parameters:
          +
          memberName - Member name to add.
          +
          target - Target of the member.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          addMember

          +
          public B addMember​(java.lang.String memberName,
+                   ShapeId target,
+                   java.util.function.Consumer<MemberShape.Builder> memberUpdater)
          +
          Adds a member to the builder.
          +
          +
          Parameters:
          +
          memberName - Member name to add.
          +
          target - Target of the member.
          +
          memberUpdater - Consumer that can update the created member shape.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          removeMember

          +
          public B removeMember​(java.lang.String member)
          +
          Removes a member by name. + +

          Note that removing a member that was added by a mixin results in + an inconsistent model. It's best to use ModelTransform to ensure + that the model remains consistent when removing members.

          +
          +
          Parameters:
          +
          member - Member name to remove.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          addMixin

          +
          public B addMixin​(Shape shape)
          +
          Description copied from class: AbstractShapeBuilder
          +
          Adds a mixin to the shape.
          +
          +
          Overrides:
          +
          addMixin in class AbstractShapeBuilder<B extends software.amazon.smithy.model.shapes.NamedMembersShapeBuilder<B,​S>,​S extends Shape>
          +
          Parameters:
          +
          shape - Mixin to add.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          removeMixin

          +
          public B removeMixin​(ToShapeId shape)
          +
          Description copied from class: AbstractShapeBuilder
          +
          Removes a mixin from the shape by shape or ID.
          +
          +
          Overrides:
          +
          removeMixin in class AbstractShapeBuilder<B extends software.amazon.smithy.model.shapes.NamedMembersShapeBuilder<B,​S>,​S extends Shape>
          +
          Parameters:
          +
          shape - Shape or shape ID to remove.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          flattenMixins

          +
          public B flattenMixins()
          +
          Description copied from class: AbstractShapeBuilder
          +
          Removes mixins from a shape and flattens them into the shape. + +

          Flattening a mixin into a shape copies the traits and members of a + mixin onto the shape, effectively resulting in the same shape but with + no trace of the mixin relationship.

          +
          +
          Overrides:
          +
          flattenMixins in class AbstractShapeBuilder<B extends software.amazon.smithy.model.shapes.NamedMembersShapeBuilder<B,​S>,​S extends Shape>
          +
          Returns:
          +
          Returns the updated builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/StructureShape.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/StructureShape.html new file mode 100644 index 00000000000..74941d9fda9 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/StructureShape.html @@ -0,0 +1,440 @@ + + + + + +StructureShape (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class StructureShape

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          builder

          +
          public static StructureShape.Builder builder()
          +
          +
          Returns:
          +
          Creates a new StructureShape builder.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          accept

          +
          public <R> R accept​(ShapeVisitor<R> visitor)
          +
          Description copied from class: Shape
          +
          Dispatches the shape to the appropriate ShapeVisitor method.
          +
          +
          Specified by:
          +
          accept in class Shape
          +
          Type Parameters:
          +
          R - Return type of the accept.
          +
          Parameters:
          +
          visitor - ShapeVisitor to use.
          +
          Returns:
          +
          Returns the result.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getType

          +
          public ShapeType getType()
          +
          Description copied from class: Shape
          +
          Gets the type of the shape.
          +
          +
          Specified by:
          +
          getType in class Shape
          +
          Returns:
          +
          Returns the type;
          +
          +
          • +
        + + + +
          +
        • +

          getAllMembers

          +
          public java.util.Map<java.lang.String,​MemberShape> getAllMembers()
          +
          Description copied from class: Shape
          +
          Gets the members of the shape, including mixin members.
          +
          +
          Overrides:
          +
          getAllMembers in class Shape
          +
          Returns:
          +
          Returns the immutable member map.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/TimestampShape.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/TimestampShape.Builder.html new file mode 100644 index 00000000000..a7b61a804b8 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/TimestampShape.Builder.html @@ -0,0 +1,359 @@ + + + + + +TimestampShape.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class TimestampShape.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/TimestampShape.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/TimestampShape.html new file mode 100644 index 00000000000..5bc59ce843b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/TimestampShape.html @@ -0,0 +1,417 @@ + + + + + +TimestampShape (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class TimestampShape

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + +
          +
        • +

          accept

          +
          public <R> R accept​(ShapeVisitor<R> visitor)
          +
          Description copied from class: Shape
          +
          Dispatches the shape to the appropriate ShapeVisitor method.
          +
          +
          Specified by:
          +
          accept in class Shape
          +
          Type Parameters:
          +
          R - Return type of the accept.
          +
          Parameters:
          +
          visitor - ShapeVisitor to use.
          +
          Returns:
          +
          Returns the result.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getType

          +
          public ShapeType getType()
          +
          Description copied from class: Shape
          +
          Gets the type of the shape.
          +
          +
          Specified by:
          +
          getType in class Shape
          +
          Returns:
          +
          Returns the type;
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/ToShapeId.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ToShapeId.html new file mode 100644 index 00000000000..5f1a13d2683 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/ToShapeId.html @@ -0,0 +1,261 @@ + + + + + +ToShapeId (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Interface ToShapeId

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          toShapeId

          +
          ShapeId toShapeId()
          +
          +
          Returns:
          +
          Returns the shape ID of an object.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/UnionShape.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/UnionShape.Builder.html new file mode 100644 index 00000000000..1e495414a0b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/UnionShape.Builder.html @@ -0,0 +1,686 @@ + + + + + +UnionShape.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class UnionShape.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public UnionShape build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getMember

          +
          public java.util.Optional<MemberShape> getMember​(java.lang.String memberName)
          +
          Description copied from class: AbstractShapeBuilder
          +
          Gets the optional member with the given name.
          +
          +
          Overrides:
          +
          getMember in class AbstractShapeBuilder<B extends software.amazon.smithy.model.shapes.NamedMembersShapeBuilder<B,​S>,​S extends Shape>
          +
          Returns:
          +
          Returns the optional member with the given name.
          +
          +
          • +
        + + + +
          +
        • +

          id

          +
          public final B id​(ShapeId shapeId)
          +
          Description copied from class: AbstractShapeBuilder
          +
          Sets the shape ID of the shape.
          +
          +
          Overrides:
          +
          id in class AbstractShapeBuilder<B extends software.amazon.smithy.model.shapes.NamedMembersShapeBuilder<B,​S>,​S extends Shape>
          +
          Parameters:
          +
          shapeId - Shape ID to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          members

          +
          public B members​(java.util.Collection<MemberShape> members)
          +
          Replaces the members of the builder.
          +
          +
          Parameters:
          +
          members - Members to add to the builder.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          clearMembers

          +
          public B clearMembers()
          +
          Description copied from class: AbstractShapeBuilder
          +
          Removes all members from the builder.
          +
          +
          Overrides:
          +
          clearMembers in class AbstractShapeBuilder<B extends software.amazon.smithy.model.shapes.NamedMembersShapeBuilder<B,​S>,​S extends Shape>
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          addMember

          +
          public B addMember​(MemberShape member)
          +
          Description copied from class: AbstractShapeBuilder
          +
          Adds a member to the shape IFF the shape supports members.
          +
          +
          Overrides:
          +
          addMember in class AbstractShapeBuilder<B extends software.amazon.smithy.model.shapes.NamedMembersShapeBuilder<B,​S>,​S extends Shape>
          +
          Parameters:
          +
          member - Member to add to the shape.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          addMember

          +
          public B addMember​(java.lang.String memberName,
+                   ShapeId target)
          +
          Adds a member to the builder.
          +
          +
          Parameters:
          +
          memberName - Member name to add.
          +
          target - Target of the member.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          addMember

          +
          public B addMember​(java.lang.String memberName,
+                   ShapeId target,
+                   java.util.function.Consumer<MemberShape.Builder> memberUpdater)
          +
          Adds a member to the builder.
          +
          +
          Parameters:
          +
          memberName - Member name to add.
          +
          target - Target of the member.
          +
          memberUpdater - Consumer that can update the created member shape.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          removeMember

          +
          public B removeMember​(java.lang.String member)
          +
          Removes a member by name. + +

          Note that removing a member that was added by a mixin results in + an inconsistent model. It's best to use ModelTransform to ensure + that the model remains consistent when removing members.

          +
          +
          Parameters:
          +
          member - Member name to remove.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          addMixin

          +
          public B addMixin​(Shape shape)
          +
          Description copied from class: AbstractShapeBuilder
          +
          Adds a mixin to the shape.
          +
          +
          Overrides:
          +
          addMixin in class AbstractShapeBuilder<B extends software.amazon.smithy.model.shapes.NamedMembersShapeBuilder<B,​S>,​S extends Shape>
          +
          Parameters:
          +
          shape - Mixin to add.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          removeMixin

          +
          public B removeMixin​(ToShapeId shape)
          +
          Description copied from class: AbstractShapeBuilder
          +
          Removes a mixin from the shape by shape or ID.
          +
          +
          Overrides:
          +
          removeMixin in class AbstractShapeBuilder<B extends software.amazon.smithy.model.shapes.NamedMembersShapeBuilder<B,​S>,​S extends Shape>
          +
          Parameters:
          +
          shape - Shape or shape ID to remove.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          flattenMixins

          +
          public B flattenMixins()
          +
          Description copied from class: AbstractShapeBuilder
          +
          Removes mixins from a shape and flattens them into the shape. + +

          Flattening a mixin into a shape copies the traits and members of a + mixin onto the shape, effectively resulting in the same shape but with + no trace of the mixin relationship.

          +
          +
          Overrides:
          +
          flattenMixins in class AbstractShapeBuilder<B extends software.amazon.smithy.model.shapes.NamedMembersShapeBuilder<B,​S>,​S extends Shape>
          +
          Returns:
          +
          Returns the updated builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/UnionShape.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/UnionShape.html new file mode 100644 index 00000000000..18a9dcb3d48 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/UnionShape.html @@ -0,0 +1,436 @@ + + + + + +UnionShape (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.shapes
    +

    Class UnionShape

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + +
          +
        • +

          accept

          +
          public <R> R accept​(ShapeVisitor<R> visitor)
          +
          Description copied from class: Shape
          +
          Dispatches the shape to the appropriate ShapeVisitor method.
          +
          +
          Specified by:
          +
          accept in class Shape
          +
          Type Parameters:
          +
          R - Return type of the accept.
          +
          Parameters:
          +
          visitor - ShapeVisitor to use.
          +
          Returns:
          +
          Returns the result.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getType

          +
          public ShapeType getType()
          +
          Description copied from class: Shape
          +
          Gets the type of the shape.
          +
          +
          Specified by:
          +
          getType in class Shape
          +
          Returns:
          +
          Returns the type;
          +
          +
          • +
        + + + +
          +
        • +

          getAllMembers

          +
          public java.util.Map<java.lang.String,​MemberShape> getAllMembers()
          +
          Description copied from class: Shape
          +
          Gets the members of the shape, including mixin members.
          +
          +
          Overrides:
          +
          getAllMembers in class Shape
          +
          Returns:
          +
          Returns the immutable member map.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/package-summary.html new file mode 100644 index 00000000000..bf2f3db7e5b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/package-summary.html @@ -0,0 +1,599 @@ + + + + + +software.amazon.smithy.model.shapes (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.model.shapes

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/shapes/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/model/shapes/package-tree.html new file mode 100644 index 00000000000..ca6a6f48b99 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/shapes/package-tree.html @@ -0,0 +1,305 @@ + + + + + +software.amazon.smithy.model.shapes Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.model.shapes

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +

    Enum Hierarchy

    +
      +
    • java.lang.Object +
        +
      • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
        • +
      +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/AbstractTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/AbstractTrait.Provider.html new file mode 100644 index 00000000000..fffbe5048b8 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/AbstractTrait.Provider.html @@ -0,0 +1,336 @@ + + + + + +AbstractTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class AbstractTrait.Provider

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.traits.AbstractTrait.Provider
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider​(ShapeId id) 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider​(ShapeId id)
          +
          +
          Parameters:
          +
          id - ID of the trait that the provider creates.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getShapeId

          +
          public ShapeId getShapeId()
          +
          +
          Specified by:
          +
          getShapeId in interface TraitService
          +
          Returns:
          +
          Gets the shape ID of the trait that this provider created.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/AbstractTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/AbstractTrait.html new file mode 100644 index 00000000000..5ee969611ff --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/AbstractTrait.html @@ -0,0 +1,555 @@ + + + + + +AbstractTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class AbstractTrait

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.traits.AbstractTrait
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          AbstractTrait

          +
          public AbstractTrait​(ShapeId id,
+                     FromSourceLocation sourceLocation)
          +
          +
          Parameters:
          +
          id - ID of the trait.
          +
          sourceLocation - Where the trait was defined.
          +
          +
          • +
        + + + +
          +
        • +

          AbstractTrait

          +
          public AbstractTrait​(ShapeId id,
+                     Node nodeValue)
          +
          +
          Parameters:
          +
          id - ID of the trait.
          +
          nodeValue - The node representation of the shape, if known and trusted.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          toShapeId

          +
          public final ShapeId toShapeId()
          +
          Description copied from interface: Trait
          +
          Gets the shape ID of the trait.
          +
          +
          Specified by:
          +
          toShapeId in interface ToShapeId
          +
          Specified by:
          +
          toShapeId in interface Trait
          +
          Returns:
          +
          Returns the fully-qualified shape ID of the trait.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object other)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public final Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          createNode

          +
          protected abstract Node createNode()
          +
          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.
          +
          +
          Returns:
          +
          Returns the trait as a node.
          +
          +
          • +
        + + + +
          +
        • +

          setNodeCache

          +
          protected final void setNodeCache​(Node value)
          +
          Sets the node cache of the trait up front, if known. + +

          This is useful for maintaining a trait value exactly as provided in + a model file, allowing for validation to detect extraneous properties, + and removing the need to create the node again when calling createNode.

          +
          +
          Parameters:
          +
          value - Value to set.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/AbstractTraitBuilder.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/AbstractTraitBuilder.html new file mode 100644 index 00000000000..042925f0fff --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/AbstractTraitBuilder.html @@ -0,0 +1,356 @@ + + + + + +AbstractTraitBuilder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class AbstractTraitBuilder<T extends Trait,​B extends AbstractTraitBuilder>

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.traits.AbstractTraitBuilder<T,​B>
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          AbstractTraitBuilder

          +
          public AbstractTraitBuilder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          sourceLocation

          +
          public B sourceLocation​(FromSourceLocation sourceLocation)
          +
          Sets the source location of where the trait was defined.
          +
          +
          Parameters:
          +
          sourceLocation - Location of the trait.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          getSourceLocation

          +
          public SourceLocation getSourceLocation()
          +
          Gets the source location configured for the builder.
          +
          +
          Returns:
          +
          Returns the source location or null if not set.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/AddedDefaultTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/AddedDefaultTrait.Provider.html new file mode 100644 index 00000000000..f0afe4d143c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/AddedDefaultTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +AddedDefaultTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class AddedDefaultTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/AddedDefaultTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/AddedDefaultTrait.html new file mode 100644 index 00000000000..d258a854721 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/AddedDefaultTrait.html @@ -0,0 +1,367 @@ + + + + + +AddedDefaultTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class AddedDefaultTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          AddedDefaultTrait

          +
          public AddedDefaultTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          AddedDefaultTrait

          +
          public AddedDefaultTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/AnnotationTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/AnnotationTrait.Provider.html new file mode 100644 index 00000000000..3f09dca3f79 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/AnnotationTrait.Provider.html @@ -0,0 +1,349 @@ + + + + + +AnnotationTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class AnnotationTrait.Provider<T extends AnnotationTrait>

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider​(ShapeId id, + java.util.function.Function<ObjectNode,​T> traitFactory) 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider​(ShapeId id,
+                java.util.function.Function<ObjectNode,​T> traitFactory)
          +
          +
          Parameters:
          +
          id - ID of the trait being created.
          +
          traitFactory - Factory function used to create the trait.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public T createTrait​(ShapeId id,
+                     Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          id - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/AnnotationTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/AnnotationTrait.html new file mode 100644 index 00000000000..cf3fcbca3ed --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/AnnotationTrait.html @@ -0,0 +1,444 @@ + + + + + +AnnotationTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class AnnotationTrait

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.traits.AnnotationTrait
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          toShapeId

          +
          public final ShapeId toShapeId()
          +
          Description copied from interface: Trait
          +
          Gets the shape ID of the trait.
          +
          +
          Specified by:
          +
          toShapeId in interface ToShapeId
          +
          Specified by:
          +
          toShapeId in interface Trait
          +
          Returns:
          +
          Returns the fully-qualified shape ID of the trait.
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public final Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object other)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/AuthDefinitionTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/AuthDefinitionTrait.Builder.html new file mode 100644 index 00000000000..40757f9b1b4 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/AuthDefinitionTrait.Builder.html @@ -0,0 +1,362 @@ + + + + + +AuthDefinitionTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class AuthDefinitionTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/AuthDefinitionTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/AuthDefinitionTrait.Provider.html new file mode 100644 index 00000000000..ddb621d80be --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/AuthDefinitionTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +AuthDefinitionTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class AuthDefinitionTrait.Provider

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public AuthDefinitionTrait createTrait​(ShapeId target,
+                                       Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/AuthDefinitionTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/AuthDefinitionTrait.html new file mode 100644 index 00000000000..557f9e144b9 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/AuthDefinitionTrait.html @@ -0,0 +1,474 @@ + + + + + +AuthDefinitionTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class AuthDefinitionTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getTraits

          +
          public java.util.List<ShapeId> getTraits()
          +
          Gets the list of shape IDs that auth implementations must know about + in order to successfully utilize the auth scheme.
          +
          +
          Returns:
          +
          Returns the auth traits.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          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.
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/AuthTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/AuthTrait.Provider.html new file mode 100644 index 00000000000..e689f20e5c5 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/AuthTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +AuthTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class AuthTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/AuthTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/AuthTrait.html new file mode 100644 index 00000000000..7f4a7644d3a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/AuthTrait.html @@ -0,0 +1,496 @@ + + + + + +AuthTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class AuthTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          AuthTrait

          +
          @Deprecated
+public AuthTrait​(java.util.List<ShapeId> values,
+                 FromSourceLocation sourceLocation)
          +
          Deprecated.
          +
          • +
        + + + +
          +
        • +

          AuthTrait

          +
          @Deprecated
+public AuthTrait​(java.util.List<ShapeId> values)
          +
          Deprecated.
          +
          • +
        + + + + + + + +
          +
        • +

          AuthTrait

          +
          public AuthTrait​(java.util.Set<ShapeId> values)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getValueSet

          +
          public java.util.Set<ShapeId> getValueSet()
          +
          Gets the auth scheme trait values.
          +
          +
          Returns:
          +
          Returns the supported auth schemes.
          +
          +
          • +
        + + + +
          +
        • +

          getValues

          +
          @Deprecated
+public java.util.List<ShapeId> getValues()
          +
          Deprecated.
          +
          • +
        + + + +
          +
        • +

          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.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/BoxTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/BoxTrait.Provider.html new file mode 100644 index 00000000000..54ce6df1ead --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/BoxTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +BoxTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class BoxTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/BoxTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/BoxTrait.html new file mode 100644 index 00000000000..d024ea08dd2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/BoxTrait.html @@ -0,0 +1,435 @@ + + + + + +BoxTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class BoxTrait

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      FromSourceLocation, ToNode, ToShapeId, Trait
      +
      +
      +
      @Deprecated
+public final class BoxTrait
+extends AnnotationTrait
      +
      Deprecated. +
      Use NullableIndex instead.
      +
      +
      Indicates that a shape is boxed, meaning a value may or may not be present. + +

      This trait is only used in Smithy IDL 1.0 models and is not allowed in + 2.0 models.

      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static class BoxTrait.Provider +
        Deprecated.
        + 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        static ShapeIdID +
        Deprecated.
        + 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        BoxTrait() +
        Deprecated.
        + 
        BoxTrait​(ObjectNode node) +
        Deprecated.
        + 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          Deprecated.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          BoxTrait

          +
          public BoxTrait​(ObjectNode node)
          +
          Deprecated.
          +
          • +
        + + + +
          +
        • +

          BoxTrait

          +
          public BoxTrait()
          +
          Deprecated.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          isSynthetic

          +
          public boolean isSynthetic()
          +
          Deprecated.
          +
          Description copied from interface: Trait
          +
          Checks if this trait is persisted with the shape, or if it is a + synthetic, or transient trait, only meant to temporarily aid in + some kind of in-memory model transformation. + +

          Because synthetic traits are not persisted with shapes, they also + do not need to be defined in Smithy's semantic model before they can + be used in the model.

          +
          +
          Returns:
          +
          Returns true if the trait is not persisted on the shape.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/ClientOptionalTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/ClientOptionalTrait.Provider.html new file mode 100644 index 00000000000..c3ac9c3e39b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/ClientOptionalTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +ClientOptionalTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class ClientOptionalTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/ClientOptionalTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/ClientOptionalTrait.html new file mode 100644 index 00000000000..2fbe4d1226d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/ClientOptionalTrait.html @@ -0,0 +1,386 @@ + + + + + +ClientOptionalTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class ClientOptionalTrait

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      FromSourceLocation, ToNode, ToShapeId, Trait
      +
      +
      +
      public final class ClientOptionalTrait
+extends AnnotationTrait
      +
      Indicates that non-authoritative code generators should treat a member + as optional even if it's required or default. + +

      Because this trait is added by default to the members of a structure + marked with the input trait, this trait can be defined as either + synthetic or non-synthetic.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ClientOptionalTrait

          +
          public ClientOptionalTrait()
          +
          • +
        + + + +
          +
        • +

          ClientOptionalTrait

          +
          public ClientOptionalTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          ClientOptionalTrait

          +
          public ClientOptionalTrait​(SourceLocation location)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/CorsTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/CorsTrait.Builder.html new file mode 100644 index 00000000000..4c4a39dc334 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/CorsTrait.Builder.html @@ -0,0 +1,350 @@ + + + + + +CorsTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class CorsTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + +
          +
        • +

          additionalAllowedHeaders

          +
          public CorsTrait.Builder additionalAllowedHeaders​(java.util.Set<java.lang.String> additionalAllowedHeaders)
          +
          • +
        + + + +
          +
        • +

          additionalExposedHeaders

          +
          public CorsTrait.Builder additionalExposedHeaders​(java.util.Set<java.lang.String> additionalExposedHeaders)
          +
          • +
        + + + +
          +
        • +

          build

          +
          public CorsTrait build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/CorsTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/CorsTrait.Provider.html new file mode 100644 index 00000000000..b70033c4f45 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/CorsTrait.Provider.html @@ -0,0 +1,348 @@ + + + + + +CorsTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class CorsTrait.Provider

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.traits.CorsTrait.Provider
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      TraitService
      +
      +
      +
      Enclosing class:
      +
      CorsTrait
      +
      +
      +
      public static final class CorsTrait.Provider
+extends java.lang.Object
+implements TraitService
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getShapeId

          +
          public ShapeId getShapeId()
          +
          +
          Specified by:
          +
          getShapeId in interface TraitService
          +
          Returns:
          +
          Gets the shape ID of the trait that this provider created.
          +
          +
          • +
        + + + +
          +
        • +

          createTrait

          +
          public CorsTrait createTrait​(ShapeId target,
+                             Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Specified by:
          +
          createTrait in interface TraitService
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/CorsTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/CorsTrait.html new file mode 100644 index 00000000000..f3938df6cbe --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/CorsTrait.html @@ -0,0 +1,502 @@ + + + + + +CorsTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class CorsTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getOrigin

          +
          public java.lang.String getOrigin()
          +
          • +
        + + + +
          +
        • +

          getMaxAge

          +
          public int getMaxAge()
          +
          • +
        + + + +
          +
        • +

          getAdditionalAllowedHeaders

          +
          public java.util.Set<java.lang.String> getAdditionalAllowedHeaders()
          +
          • +
        + + + +
          +
        • +

          getAdditionalExposedHeaders

          +
          public java.util.Set<java.lang.String> getAdditionalExposedHeaders()
          +
          • +
        + + + + + + + +
          +
        • +

          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.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object other)
          +
          +
          Overrides:
          +
          equals in class AbstractTrait
          +
          +
          • +
        + + + + + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/DefaultTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/DefaultTrait.Provider.html new file mode 100644 index 00000000000..89c4fa0a1ee --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/DefaultTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +DefaultTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class DefaultTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/DefaultTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/DefaultTrait.html new file mode 100644 index 00000000000..bbfc63395b2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/DefaultTrait.html @@ -0,0 +1,405 @@ + + + + + +DefaultTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class DefaultTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          DefaultTrait

          +
          public DefaultTrait​(Node value)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          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.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/DeprecatedTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/DeprecatedTrait.Builder.html new file mode 100644 index 00000000000..97c164b9420 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/DeprecatedTrait.Builder.html @@ -0,0 +1,323 @@ + + + + + +DeprecatedTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class DeprecatedTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/DeprecatedTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/DeprecatedTrait.Provider.html new file mode 100644 index 00000000000..1991caf22d8 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/DeprecatedTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +DeprecatedTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class DeprecatedTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/DeprecatedTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/DeprecatedTrait.html new file mode 100644 index 00000000000..c7647aa56e4 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/DeprecatedTrait.html @@ -0,0 +1,459 @@ + + + + + +DeprecatedTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class DeprecatedTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getSince

          +
          public java.util.Optional<java.lang.String> getSince()
          +
          Gets the deprecated since value.
          +
          +
          Returns:
          +
          returns the optional deprecated since value.
          +
          +
          • +
        + + + +
          +
        • +

          getMessage

          +
          public java.util.Optional<java.lang.String> getMessage()
          +
          Gets the deprecation message value.
          +
          +
          Returns:
          +
          returns the optional deprecation message value.
          +
          +
          • +
        + + + +
          +
        • +

          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.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          builder

          +
          public static DeprecatedTrait.Builder builder()
          +
          +
          Returns:
          +
          Returns a builder used to create a deprecated trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/DocumentationTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/DocumentationTrait.Provider.html new file mode 100644 index 00000000000..aacb7e4a757 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/DocumentationTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +DocumentationTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class DocumentationTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/DocumentationTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/DocumentationTrait.html new file mode 100644 index 00000000000..6da4f9e4437 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/DocumentationTrait.html @@ -0,0 +1,382 @@ + + + + + +DocumentationTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class DocumentationTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          DocumentationTrait

          +
          public DocumentationTrait​(java.lang.String value,
+                          SourceLocation sourceLocation)
          +
          • +
        + + + +
          +
        • +

          DocumentationTrait

          +
          public DocumentationTrait​(java.lang.String value)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/DynamicTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/DynamicTrait.html new file mode 100644 index 00000000000..3b4d89a2318 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/DynamicTrait.html @@ -0,0 +1,360 @@ + + + + + +DynamicTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class DynamicTrait

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      FromSourceLocation, ToNode, ToShapeId, Trait
      +
      +
      +
      public final class DynamicTrait
+extends AbstractTrait
      +
      A general-purpose trait used to represent traits that are defined in the + model and have no concrete implementation.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          DynamicTrait

          +
          public DynamicTrait​(ShapeId id,
+                    Node value)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          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.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/EffectiveTraitQuery.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/EffectiveTraitQuery.Builder.html new file mode 100644 index 00000000000..63a31c63327 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/EffectiveTraitQuery.Builder.html @@ -0,0 +1,399 @@ + + + + + +EffectiveTraitQuery.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class EffectiveTraitQuery.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.traits.EffectiveTraitQuery.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          model

          +
          public EffectiveTraitQuery.Builder model​(Model model)
          +
          Sets the required model to query.
          +
          +
          Parameters:
          +
          model - Model to query.
          +
          Returns:
          +
          Returns the query object builder.
          +
          +
          • +
        + + + +
          +
        • +

          traitClass

          +
          public EffectiveTraitQuery.Builder traitClass​(java.lang.Class<? extends Trait> traitClass)
          +
          Sets the required trait being queried.
          +
          +
          Parameters:
          +
          traitClass - Trait to detect on shapes.
          +
          Returns:
          +
          Returns the query object builder.
          +
          +
          • +
        + + + +
          +
        • +

          inheritFromContainer

          +
          public EffectiveTraitQuery.Builder inheritFromContainer​(boolean inheritFromContainer)
          +
          When testing member shapes, also checks the container of the member for + the presence of a trait. + +

          By default, traits are not inherited from a member's parent container.

          +
          +
          Parameters:
          +
          inheritFromContainer - Set to true to inherit traits from member containers.
          +
          Returns:
          +
          Returns the query object builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/EffectiveTraitQuery.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/EffectiveTraitQuery.html new file mode 100644 index 00000000000..b19a398c89d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/EffectiveTraitQuery.html @@ -0,0 +1,351 @@ + + + + + +EffectiveTraitQuery (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class EffectiveTraitQuery

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.traits.EffectiveTraitQuery
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          isTraitApplied

          +
          public boolean isTraitApplied​(ToShapeId shapeId)
          +
          Checks if the trait is effectively applied to a shape.
          +
          +
          Parameters:
          +
          shapeId - Shape to test.
          +
          Returns:
          +
          Returns true if the trait is effectively applied to the shape.
          +
          +
          • +
        + + + +
          +
        • +

          builder

          +
          public static EffectiveTraitQuery.Builder builder()
          +
          Creates a new query builder.
          +
          +
          Returns:
          +
          Returns the created builder.
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/EndpointTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/EndpointTrait.Builder.html new file mode 100644 index 00000000000..6f4f01420c1 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/EndpointTrait.Builder.html @@ -0,0 +1,308 @@ + + + + + +EndpointTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class EndpointTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          build

          +
          public EndpointTrait build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/EndpointTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/EndpointTrait.Provider.html new file mode 100644 index 00000000000..d17cae4e435 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/EndpointTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +EndpointTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class EndpointTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/EndpointTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/EndpointTrait.html new file mode 100644 index 00000000000..1513c225ab0 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/EndpointTrait.html @@ -0,0 +1,429 @@ + + + + + +EndpointTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class EndpointTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          builder

          +
          public static EndpointTrait.Builder builder()
          +
          +
          Returns:
          +
          Returns a builder used to create an Endpoint trait.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          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.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/EnumDefinition.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/EnumDefinition.Builder.html new file mode 100644 index 00000000000..5bcbb9ffde6 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/EnumDefinition.Builder.html @@ -0,0 +1,424 @@ + + + + + +EnumDefinition.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class EnumDefinition.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.traits.EnumDefinition.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/EnumDefinition.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/EnumDefinition.html new file mode 100644 index 00000000000..e560cc8cbcd --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/EnumDefinition.html @@ -0,0 +1,482 @@ + + + + + +EnumDefinition (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class EnumDefinition

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.traits.EnumDefinition
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getValue

          +
          public java.lang.String getValue()
          +
          • +
        + + + +
          +
        • +

          getName

          +
          public java.util.Optional<java.lang.String> getName()
          +
          • +
        + + + +
          +
        • +

          getDocumentation

          +
          public java.util.Optional<java.lang.String> getDocumentation()
          +
          • +
        + + + +
          +
        • +

          isDeprecated

          +
          public boolean isDeprecated()
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getTags

          +
          public java.util.List<java.lang.String> getTags()
          +
          Description copied from interface: Tagged
          +
          Gets the tags applied to an object.
          +
          +
          Specified by:
          +
          getTags in interface Tagged
          +
          Returns:
          +
          Returns the tag values.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object other)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/EnumTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/EnumTrait.Builder.html new file mode 100644 index 00000000000..4e8c9292766 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/EnumTrait.Builder.html @@ -0,0 +1,395 @@ + + + + + +EnumTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class EnumTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/EnumTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/EnumTrait.Provider.html new file mode 100644 index 00000000000..2973e245cd1 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/EnumTrait.Provider.html @@ -0,0 +1,348 @@ + + + + + +EnumTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class EnumTrait.Provider

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.traits.EnumTrait.Provider
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      TraitService
      +
      +
      +
      Enclosing class:
      +
      EnumTrait
      +
      +
      +
      public static final class EnumTrait.Provider
+extends java.lang.Object
+implements TraitService
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getShapeId

          +
          public ShapeId getShapeId()
          +
          +
          Specified by:
          +
          getShapeId in interface TraitService
          +
          Returns:
          +
          Gets the shape ID of the trait that this provider created.
          +
          +
          • +
        + + + +
          +
        • +

          createTrait

          +
          public EnumTrait createTrait​(ShapeId target,
+                             Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Specified by:
          +
          createTrait in interface TraitService
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/EnumTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/EnumTrait.html new file mode 100644 index 00000000000..8cb1c8aa2cd --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/EnumTrait.html @@ -0,0 +1,561 @@ + + + + + +EnumTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class EnumTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          Deprecated.
          +
          • +
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getValues

          +
          public java.util.List<EnumDefinition> getValues()
          +
          Deprecated.
          +
          Gets the enum value to body.
          +
          +
          Returns:
          +
          returns the enum constant definitions.
          +
          +
          • +
        + + + +
          +
        • +

          getEnumDefinitionValues

          +
          public java.util.List<java.lang.String> getEnumDefinitionValues()
          +
          Deprecated.
          +
          Gets the acceptable enum literal values.
          +
          +
          Returns:
          +
          returns the enum constant definitions.
          +
          +
          • +
        + + + +
          +
        • +

          hasNames

          +
          public boolean hasNames()
          +
          Deprecated.
          +
          Checks if all of the constants of an enum define a name. + +

          Note that either all constants must have a name or no constants can + have a name.

          +
          +
          Returns:
          +
          Returns true if all constants define a name.
          +
          +
          • +
        + + + +
          +
        • +

          createNode

          +
          protected Node createNode()
          +
          Deprecated.
          +
          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 EnumTrait.Builder toBuilder()
          +
          Deprecated.
          +
          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<EnumTrait>
          +
          Returns:
          +
          a builder for type T
          +
          +
          • +
        + + + +
          +
        • +

          builder

          +
          public static EnumTrait.Builder builder()
          +
          Deprecated.
          +
          +
          Returns:
          +
          Returns an enum trait builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/EnumValueTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/EnumValueTrait.Builder.html new file mode 100644 index 00000000000..86c6126c850 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/EnumValueTrait.Builder.html @@ -0,0 +1,362 @@ + + + + + +EnumValueTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class EnumValueTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public EnumValueTrait build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        + + + + + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/EnumValueTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/EnumValueTrait.Provider.html new file mode 100644 index 00000000000..8cefc78b708 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/EnumValueTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +EnumValueTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class EnumValueTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/EnumValueTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/EnumValueTrait.html new file mode 100644 index 00000000000..0f9348f9104 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/EnumValueTrait.html @@ -0,0 +1,499 @@ + + + + + +EnumValueTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class EnumValueTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getStringValue

          +
          public java.util.Optional<java.lang.String> getStringValue()
          +
          Gets the string value if a string value was set.
          +
          +
          Returns:
          +
          Optionally returns the string value.
          +
          +
          • +
        + + + +
          +
        • +

          expectStringValue

          +
          public java.lang.String expectStringValue()
          +
          Gets the string value.
          +
          +
          Returns:
          +
          Returns the string value.
          +
          Throws:
          +
          ExpectationNotMetException - if the string value was not set.
          +
          +
          • +
        + + + +
          +
        • +

          getIntValue

          +
          public java.util.Optional<java.lang.Integer> getIntValue()
          +
          Gets the int value if an int value was set.
          +
          +
          Returns:
          +
          Returns the set int value.
          +
          +
          • +
        + + + +
          +
        • +

          expectIntValue

          +
          public int expectIntValue()
          +
          Gets the int value.
          +
          +
          Returns:
          +
          Returns the int value.
          +
          Throws:
          +
          ExpectationNotMetException - if the int value was not set.
          +
          +
          • +
        + + + +
          +
        • +

          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.
          +
          +
          • +
        + + + + + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/ErrorTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/ErrorTrait.Provider.html new file mode 100644 index 00000000000..e3ddd5bd875 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/ErrorTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +ErrorTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class ErrorTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/ErrorTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/ErrorTrait.html new file mode 100644 index 00000000000..aea52dca197 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/ErrorTrait.html @@ -0,0 +1,463 @@ + + + + + +ErrorTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class ErrorTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ErrorTrait

          +
          public ErrorTrait​(java.lang.String value,
+                  SourceLocation sourceLocation)
          +
          • +
        + + + +
          +
        • +

          ErrorTrait

          +
          public ErrorTrait​(java.lang.String value)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getDefaultHttpStatusCode

          +
          public int getDefaultHttpStatusCode()
          +
          Returns the recommended default HTTP status code of the error.
          +
          +
          Returns:
          +
          Returns the default HTTP status code.
          +
          +
          • +
        + + + +
          +
        • +

          isClientError

          +
          public boolean isClientError()
          +
          +
          Returns:
          +
          Returns true if is a client error.
          +
          +
          • +
        + + + +
          +
        • +

          isServerError

          +
          public boolean isServerError()
          +
          +
          Returns:
          +
          Returns true if it is a server error.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/EventHeaderTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/EventHeaderTrait.Provider.html new file mode 100644 index 00000000000..23409ce4746 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/EventHeaderTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +EventHeaderTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class EventHeaderTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/EventHeaderTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/EventHeaderTrait.html new file mode 100644 index 00000000000..34fda674a4c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/EventHeaderTrait.html @@ -0,0 +1,371 @@ + + + + + +EventHeaderTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class EventHeaderTrait

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      FromSourceLocation, ToNode, ToShapeId, Trait
      +
      +
      +
      public final class EventHeaderTrait
+extends AnnotationTrait
      +
      Marks a structure member of an event as an event header. + +

      This trait can targets members of a structure marked with the event + trait that targets blob, boolean, integer, long, string, or timestamp.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          EventHeaderTrait

          +
          public EventHeaderTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          EventHeaderTrait

          +
          public EventHeaderTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/EventPayloadTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/EventPayloadTrait.Provider.html new file mode 100644 index 00000000000..749b2ac5f21 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/EventPayloadTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +EventPayloadTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class EventPayloadTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/EventPayloadTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/EventPayloadTrait.html new file mode 100644 index 00000000000..fd253f69df2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/EventPayloadTrait.html @@ -0,0 +1,371 @@ + + + + + +EventPayloadTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class EventPayloadTrait

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      FromSourceLocation, ToNode, ToShapeId, Trait
      +
      +
      +
      public final class EventPayloadTrait
+extends AnnotationTrait
      +
      Marks a structure member of an event as the event payload. + + This trait can targets members of a structure marked with the event trait + that targets a blob or structure.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          EventPayloadTrait

          +
          public EventPayloadTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          EventPayloadTrait

          +
          public EventPayloadTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/ExamplesTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/ExamplesTrait.Builder.html new file mode 100644 index 00000000000..7f0eca73774 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/ExamplesTrait.Builder.html @@ -0,0 +1,363 @@ + + + + + +ExamplesTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class ExamplesTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/ExamplesTrait.ErrorExample.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/ExamplesTrait.ErrorExample.Builder.html new file mode 100644 index 00000000000..b9d54f2cffe --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/ExamplesTrait.ErrorExample.Builder.html @@ -0,0 +1,353 @@ + + + + + +ExamplesTrait.ErrorExample.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class ExamplesTrait.ErrorExample.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.traits.ExamplesTrait.ErrorExample.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/ExamplesTrait.ErrorExample.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/ExamplesTrait.ErrorExample.html new file mode 100644 index 00000000000..bda61769697 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/ExamplesTrait.ErrorExample.html @@ -0,0 +1,472 @@ + + + + + +ExamplesTrait.ErrorExample (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class ExamplesTrait.ErrorExample

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.traits.ExamplesTrait.ErrorExample
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/ExamplesTrait.Example.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/ExamplesTrait.Example.Builder.html new file mode 100644 index 00000000000..1386a9726f0 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/ExamplesTrait.Example.Builder.html @@ -0,0 +1,410 @@ + + + + + +ExamplesTrait.Example.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class ExamplesTrait.Example.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.traits.ExamplesTrait.Example.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/ExamplesTrait.Example.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/ExamplesTrait.Example.html new file mode 100644 index 00000000000..76ebc992dca --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/ExamplesTrait.Example.html @@ -0,0 +1,493 @@ + + + + + +ExamplesTrait.Example (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class ExamplesTrait.Example

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.traits.ExamplesTrait.Example
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getTitle

          +
          public java.lang.String getTitle()
          +
          +
          Returns:
          +
          Returns the title.
          +
          +
          • +
        + + + +
          +
        • +

          getDocumentation

          +
          public java.util.Optional<java.lang.String> getDocumentation()
          +
          +
          Returns:
          +
          Gets the optional documentation.
          +
          +
          • +
        + + + +
          +
        • +

          getInput

          +
          public ObjectNode getInput()
          +
          +
          Returns:
          +
          Gets the input object.
          +
          +
          • +
        + + + +
          +
        • +

          getOutput

          +
          public java.util.Optional<ObjectNode> getOutput()
          +
          +
          Returns:
          +
          Gets the output object.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getAllowConstraintErrors

          +
          public boolean getAllowConstraintErrors()
          +
          +
          Returns:
          +
          Returns true if input constraints errors are allowed.
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + + + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/ExamplesTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/ExamplesTrait.Provider.html new file mode 100644 index 00000000000..c4a251ed8d3 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/ExamplesTrait.Provider.html @@ -0,0 +1,348 @@ + + + + + +ExamplesTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class ExamplesTrait.Provider

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.traits.ExamplesTrait.Provider
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      TraitService
      +
      +
      +
      Enclosing class:
      +
      ExamplesTrait
      +
      +
      +
      public static final class ExamplesTrait.Provider
+extends java.lang.Object
+implements TraitService
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getShapeId

          +
          public ShapeId getShapeId()
          +
          +
          Specified by:
          +
          getShapeId in interface TraitService
          +
          Returns:
          +
          Gets the shape ID of the trait that this provider created.
          +
          +
          • +
        + + + +
          +
        • +

          createTrait

          +
          public ExamplesTrait createTrait​(ShapeId target,
+                                 Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Specified by:
          +
          createTrait in interface TraitService
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/ExamplesTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/ExamplesTrait.html new file mode 100644 index 00000000000..fcea4de59b3 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/ExamplesTrait.html @@ -0,0 +1,487 @@ + + + + + +ExamplesTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class ExamplesTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getExamples

          +
          public java.util.List<ExamplesTrait.Example> getExamples()
          +
          +
          Returns:
          +
          Each example.
          +
          +
          • +
        + + + +
          +
        • +

          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.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object other)
          +
          +
          Overrides:
          +
          equals in class AbstractTrait
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          builder

          +
          public static ExamplesTrait.Builder builder()
          +
          +
          Returns:
          +
          Returns a builder used to create an examples trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/ExternalDocumentationTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/ExternalDocumentationTrait.Builder.html new file mode 100644 index 00000000000..4e8569b25e4 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/ExternalDocumentationTrait.Builder.html @@ -0,0 +1,379 @@ + + + + + +ExternalDocumentationTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class ExternalDocumentationTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/ExternalDocumentationTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/ExternalDocumentationTrait.Provider.html new file mode 100644 index 00000000000..32cf001b8ae --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/ExternalDocumentationTrait.Provider.html @@ -0,0 +1,348 @@ + + + + + +ExternalDocumentationTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class ExternalDocumentationTrait.Provider

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.traits.ExternalDocumentationTrait.Provider
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getShapeId

          +
          public ShapeId getShapeId()
          +
          +
          Specified by:
          +
          getShapeId in interface TraitService
          +
          Returns:
          +
          Gets the shape ID of the trait that this provider created.
          +
          +
          • +
        + + + +
          +
        • +

          createTrait

          +
          public ExternalDocumentationTrait createTrait​(ShapeId target,
+                                              Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Specified by:
          +
          createTrait in interface TraitService
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/ExternalDocumentationTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/ExternalDocumentationTrait.html new file mode 100644 index 00000000000..066eb8c807c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/ExternalDocumentationTrait.html @@ -0,0 +1,478 @@ + + + + + +ExternalDocumentationTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class ExternalDocumentationTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        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.
          +
          +
          • +
        + + + + + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/HostLabelTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/HostLabelTrait.Provider.html new file mode 100644 index 00000000000..679f91422d6 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/HostLabelTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +HostLabelTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class HostLabelTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/HostLabelTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/HostLabelTrait.html new file mode 100644 index 00000000000..cf1422fde2a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/HostLabelTrait.html @@ -0,0 +1,369 @@ + + + + + +HostLabelTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class HostLabelTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HostLabelTrait

          +
          public HostLabelTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          HostLabelTrait

          +
          public HostLabelTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpApiKeyAuthTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpApiKeyAuthTrait.Builder.html new file mode 100644 index 00000000000..70fba3c5c90 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpApiKeyAuthTrait.Builder.html @@ -0,0 +1,336 @@ + + + + + +HttpApiKeyAuthTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class HttpApiKeyAuthTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpApiKeyAuthTrait.Location.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpApiKeyAuthTrait.Location.html new file mode 100644 index 00000000000..dd994c6d766 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpApiKeyAuthTrait.Location.html @@ -0,0 +1,398 @@ + + + + + +HttpApiKeyAuthTrait.Location (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Enum HttpApiKeyAuthTrait.Location

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        HEADER 
        QUERY 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.lang.StringtoString() 
        static HttpApiKeyAuthTrait.LocationvalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static HttpApiKeyAuthTrait.Location[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static HttpApiKeyAuthTrait.Location[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (HttpApiKeyAuthTrait.Location c : HttpApiKeyAuthTrait.Location.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static HttpApiKeyAuthTrait.Location valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpApiKeyAuthTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpApiKeyAuthTrait.Provider.html new file mode 100644 index 00000000000..81f27fa9522 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpApiKeyAuthTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +HttpApiKeyAuthTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class HttpApiKeyAuthTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpApiKeyAuthTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpApiKeyAuthTrait.html new file mode 100644 index 00000000000..4dc1e945e48 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpApiKeyAuthTrait.html @@ -0,0 +1,459 @@ + + + + + +HttpApiKeyAuthTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class HttpApiKeyAuthTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getScheme

          +
          public java.util.Optional<java.lang.String> getScheme()
          +
          • +
        + + + +
          +
        • +

          getName

          +
          public java.lang.String getName()
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          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.
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpBasicAuthTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpBasicAuthTrait.Provider.html new file mode 100644 index 00000000000..b1d232f427c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpBasicAuthTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +HttpBasicAuthTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class HttpBasicAuthTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpBasicAuthTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpBasicAuthTrait.html new file mode 100644 index 00000000000..adeedde7f17 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpBasicAuthTrait.html @@ -0,0 +1,368 @@ + + + + + +HttpBasicAuthTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class HttpBasicAuthTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpBasicAuthTrait

          +
          public HttpBasicAuthTrait()
          +
          • +
        + + + +
          +
        • +

          HttpBasicAuthTrait

          +
          public HttpBasicAuthTrait​(ObjectNode node)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpBearerAuthTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpBearerAuthTrait.Provider.html new file mode 100644 index 00000000000..afd638320cb --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpBearerAuthTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +HttpBearerAuthTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class HttpBearerAuthTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpBearerAuthTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpBearerAuthTrait.html new file mode 100644 index 00000000000..3bef9a0b600 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpBearerAuthTrait.html @@ -0,0 +1,368 @@ + + + + + +HttpBearerAuthTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class HttpBearerAuthTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpBearerAuthTrait

          +
          public HttpBearerAuthTrait()
          +
          • +
        + + + +
          +
        • +

          HttpBearerAuthTrait

          +
          public HttpBearerAuthTrait​(ObjectNode node)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpChecksumRequiredTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpChecksumRequiredTrait.Provider.html new file mode 100644 index 00000000000..5903c610029 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpChecksumRequiredTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +HttpChecksumRequiredTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class HttpChecksumRequiredTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpChecksumRequiredTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpChecksumRequiredTrait.html new file mode 100644 index 00000000000..9ead158d512 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpChecksumRequiredTrait.html @@ -0,0 +1,370 @@ + + + + + +HttpChecksumRequiredTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class HttpChecksumRequiredTrait

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      FromSourceLocation, ToNode, ToShapeId, Trait
      +
      +
      +
      public final class HttpChecksumRequiredTrait
+extends AnnotationTrait
      +
      Indicates that an operation requires a checksum in its HTTP request. + By default, the checksum used for a service is a MD5 checksum passed + in the Content-MD5 header.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpChecksumRequiredTrait

          +
          public HttpChecksumRequiredTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          HttpChecksumRequiredTrait

          +
          public HttpChecksumRequiredTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpDigestAuthTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpDigestAuthTrait.Provider.html new file mode 100644 index 00000000000..ed6fd5dcfe2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpDigestAuthTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +HttpDigestAuthTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class HttpDigestAuthTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpDigestAuthTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpDigestAuthTrait.html new file mode 100644 index 00000000000..7393af565ad --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpDigestAuthTrait.html @@ -0,0 +1,368 @@ + + + + + +HttpDigestAuthTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class HttpDigestAuthTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpDigestAuthTrait

          +
          public HttpDigestAuthTrait()
          +
          • +
        + + + +
          +
        • +

          HttpDigestAuthTrait

          +
          public HttpDigestAuthTrait​(ObjectNode node)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpErrorTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpErrorTrait.Provider.html new file mode 100644 index 00000000000..414edb58f03 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpErrorTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +HttpErrorTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class HttpErrorTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpErrorTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpErrorTrait.html new file mode 100644 index 00000000000..1205b8bf53b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpErrorTrait.html @@ -0,0 +1,434 @@ + + + + + +HttpErrorTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class HttpErrorTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpErrorTrait

          +
          public HttpErrorTrait​(int code,
+                      FromSourceLocation sourceLocation)
          +
          • +
        + + + +
          +
        • +

          HttpErrorTrait

          +
          public HttpErrorTrait​(int code)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getCode

          +
          public int getCode()
          +
          • +
        + + + +
          +
        • +

          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.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpHeaderTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpHeaderTrait.Provider.html new file mode 100644 index 00000000000..17dcded4c6b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpHeaderTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +HttpHeaderTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class HttpHeaderTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpHeaderTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpHeaderTrait.html new file mode 100644 index 00000000000..567f90e400c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpHeaderTrait.html @@ -0,0 +1,382 @@ + + + + + +HttpHeaderTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class HttpHeaderTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpHeaderTrait

          +
          public HttpHeaderTrait​(java.lang.String value,
+                       SourceLocation sourceLocation)
          +
          • +
        + + + +
          +
        • +

          HttpHeaderTrait

          +
          public HttpHeaderTrait​(java.lang.String value)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpLabelTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpLabelTrait.Provider.html new file mode 100644 index 00000000000..3f7d2dba089 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpLabelTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +HttpLabelTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class HttpLabelTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpLabelTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpLabelTrait.html new file mode 100644 index 00000000000..8714d599b57 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpLabelTrait.html @@ -0,0 +1,369 @@ + + + + + +HttpLabelTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class HttpLabelTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpLabelTrait

          +
          public HttpLabelTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          HttpLabelTrait

          +
          public HttpLabelTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpPayloadTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpPayloadTrait.Provider.html new file mode 100644 index 00000000000..4fa6b6d964c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpPayloadTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +HttpPayloadTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class HttpPayloadTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpPayloadTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpPayloadTrait.html new file mode 100644 index 00000000000..7f6a8eec8be --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpPayloadTrait.html @@ -0,0 +1,368 @@ + + + + + +HttpPayloadTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class HttpPayloadTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpPayloadTrait

          +
          public HttpPayloadTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          HttpPayloadTrait

          +
          public HttpPayloadTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpPrefixHeadersTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpPrefixHeadersTrait.Provider.html new file mode 100644 index 00000000000..acaad0e7af6 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpPrefixHeadersTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +HttpPrefixHeadersTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class HttpPrefixHeadersTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpPrefixHeadersTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpPrefixHeadersTrait.html new file mode 100644 index 00000000000..e69cf735189 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpPrefixHeadersTrait.html @@ -0,0 +1,382 @@ + + + + + +HttpPrefixHeadersTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class HttpPrefixHeadersTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpPrefixHeadersTrait

          +
          public HttpPrefixHeadersTrait​(java.lang.String value,
+                              SourceLocation sourceLocation)
          +
          • +
        + + + +
          +
        • +

          HttpPrefixHeadersTrait

          +
          public HttpPrefixHeadersTrait​(java.lang.String value)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpQueryParamsTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpQueryParamsTrait.Provider.html new file mode 100644 index 00000000000..bf7d63c168a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpQueryParamsTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +HttpQueryParamsTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class HttpQueryParamsTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpQueryParamsTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpQueryParamsTrait.html new file mode 100644 index 00000000000..f9aeafd151c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpQueryParamsTrait.html @@ -0,0 +1,368 @@ + + + + + +HttpQueryParamsTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class HttpQueryParamsTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpQueryParamsTrait

          +
          public HttpQueryParamsTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          HttpQueryParamsTrait

          +
          public HttpQueryParamsTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpQueryTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpQueryTrait.Provider.html new file mode 100644 index 00000000000..66886da90ed --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpQueryTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +HttpQueryTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class HttpQueryTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpQueryTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpQueryTrait.html new file mode 100644 index 00000000000..45a38b29e9a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpQueryTrait.html @@ -0,0 +1,382 @@ + + + + + +HttpQueryTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class HttpQueryTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpQueryTrait

          +
          public HttpQueryTrait​(java.lang.String value,
+                      SourceLocation sourceLocation)
          +
          • +
        + + + +
          +
        • +

          HttpQueryTrait

          +
          public HttpQueryTrait​(java.lang.String value)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpResponseCodeTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpResponseCodeTrait.Provider.html new file mode 100644 index 00000000000..db7f5faf5ec --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpResponseCodeTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +HttpResponseCodeTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class HttpResponseCodeTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpResponseCodeTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpResponseCodeTrait.html new file mode 100644 index 00000000000..d56ef46d542 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpResponseCodeTrait.html @@ -0,0 +1,370 @@ + + + + + +HttpResponseCodeTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class HttpResponseCodeTrait

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      FromSourceLocation, ToNode, ToShapeId, Trait
      +
      +
      +
      public final class HttpResponseCodeTrait
+extends AnnotationTrait
      +
      Indicates that the structure member represents the HTTP response + status code. This MAY differ from the HTTP status code provided + in the response.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpResponseCodeTrait

          +
          public HttpResponseCodeTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          HttpResponseCodeTrait

          +
          public HttpResponseCodeTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpTrait.Builder.html new file mode 100644 index 00000000000..14900e73e44 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpTrait.Builder.html @@ -0,0 +1,377 @@ + + + + + +HttpTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class HttpTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpTrait.Provider.html new file mode 100644 index 00000000000..cb94f453a44 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +HttpTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class HttpTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpTrait.html new file mode 100644 index 00000000000..b324bf3c126 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/HttpTrait.html @@ -0,0 +1,495 @@ + + + + + +HttpTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class HttpTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getMethod

          +
          public java.lang.String getMethod()
          +
          • +
        + + + +
          +
        • +

          getCode

          +
          public int getCode()
          +
          • +
        + + + +
          +
        • +

          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.
          +
          +
          • +
        + + + +
          +
        • +

          builder

          +
          public static HttpTrait.Builder builder()
          +
          +
          Returns:
          +
          Returns a builder used to create an Http trait.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object other)
          +
          +
          Overrides:
          +
          equals in class AbstractTrait
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/IdRefTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/IdRefTrait.Builder.html new file mode 100644 index 00000000000..bbfa2701050 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/IdRefTrait.Builder.html @@ -0,0 +1,336 @@ + + + + + +IdRefTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class IdRefTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          failWhenMissing

          +
          public IdRefTrait.Builder failWhenMissing​(boolean failWhenMissing)
          +
          • +
        + + + + + + + +
          +
        • +

          errorMessage

          +
          public IdRefTrait.Builder errorMessage​(java.lang.String errorMessage)
          +
          • +
        + + + +
          +
        • +

          build

          +
          public IdRefTrait build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/IdRefTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/IdRefTrait.Provider.html new file mode 100644 index 00000000000..b1d58615e71 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/IdRefTrait.Provider.html @@ -0,0 +1,348 @@ + + + + + +IdRefTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class IdRefTrait.Provider

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.traits.IdRefTrait.Provider
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      TraitService
      +
      +
      +
      Enclosing class:
      +
      IdRefTrait
      +
      +
      +
      public static final class IdRefTrait.Provider
+extends java.lang.Object
+implements TraitService
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getShapeId

          +
          public ShapeId getShapeId()
          +
          +
          Specified by:
          +
          getShapeId in interface TraitService
          +
          Returns:
          +
          Gets the shape ID of the trait that this provider created.
          +
          +
          • +
        + + + +
          +
        • +

          createTrait

          +
          public IdRefTrait createTrait​(ShapeId target,
+                              Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Specified by:
          +
          createTrait in interface TraitService
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/IdRefTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/IdRefTrait.html new file mode 100644 index 00000000000..ef168a608cc --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/IdRefTrait.html @@ -0,0 +1,464 @@ + + + + + +IdRefTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class IdRefTrait

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      FromSourceLocation, ToNode, ToShapeId, Trait, ToSmithyBuilder<IdRefTrait>
      +
      +
      +
      public final class IdRefTrait
+extends AbstractTrait
+implements ToSmithyBuilder<IdRefTrait>
      +
      Indicates that a string value must contain a valid shape ID. + +

      failWhenMissing can be set to true to fail when the + shape ID contained in a string shape cannot be found in the result + set of the selector property. failWhenMissing defaults to + false when not set. + +

      The selector property is used to query the model for all shapes + that match a shape selector. The value contained within the string shape + targeted by this trait MUST match one of the shapes returns by the shape + selector if failWhenMissing is set to true. selector + defaults to "*" when not set.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getSelector

          +
          public Selector getSelector()
          +
          • +
        + + + +
          +
        • +

          failWhenMissing

          +
          public boolean failWhenMissing()
          +
          • +
        + + + +
          +
        • +

          getErrorMessage

          +
          public java.util.Optional<java.lang.String> getErrorMessage()
          +
          • +
        + + + + + + + +
          +
        • +

          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.
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/IdempotencyTokenTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/IdempotencyTokenTrait.Provider.html new file mode 100644 index 00000000000..616dc7a221f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/IdempotencyTokenTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +IdempotencyTokenTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class IdempotencyTokenTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/IdempotencyTokenTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/IdempotencyTokenTrait.html new file mode 100644 index 00000000000..9acce6087b8 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/IdempotencyTokenTrait.html @@ -0,0 +1,369 @@ + + + + + +IdempotencyTokenTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class IdempotencyTokenTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          IdempotencyTokenTrait

          +
          public IdempotencyTokenTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          IdempotencyTokenTrait

          +
          public IdempotencyTokenTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/IdempotentTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/IdempotentTrait.Provider.html new file mode 100644 index 00000000000..dc9b5b3653e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/IdempotentTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +IdempotentTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class IdempotentTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/IdempotentTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/IdempotentTrait.html new file mode 100644 index 00000000000..f406a79054e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/IdempotentTrait.html @@ -0,0 +1,368 @@ + + + + + +IdempotentTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class IdempotentTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          IdempotentTrait

          +
          public IdempotentTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          IdempotentTrait

          +
          public IdempotentTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/InputTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/InputTrait.Provider.html new file mode 100644 index 00000000000..85d4c280472 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/InputTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +InputTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class InputTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/InputTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/InputTrait.html new file mode 100644 index 00000000000..1cd74da6bd5 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/InputTrait.html @@ -0,0 +1,381 @@ + + + + + +InputTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class InputTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          InputTrait

          +
          public InputTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          InputTrait

          +
          public InputTrait()
          +
          • +
        + + + +
          +
        • +

          InputTrait

          +
          public InputTrait​(SourceLocation sourceLocation)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/InternalTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/InternalTrait.Provider.html new file mode 100644 index 00000000000..890f173f20b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/InternalTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +InternalTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class InternalTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/InternalTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/InternalTrait.html new file mode 100644 index 00000000000..956f8f2030a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/InternalTrait.html @@ -0,0 +1,369 @@ + + + + + +InternalTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class InternalTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          InternalTrait

          +
          public InternalTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          InternalTrait

          +
          public InternalTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/JsonNameTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/JsonNameTrait.Provider.html new file mode 100644 index 00000000000..8cacd15ee63 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/JsonNameTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +JsonNameTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class JsonNameTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/JsonNameTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/JsonNameTrait.html new file mode 100644 index 00000000000..cdec793e65a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/JsonNameTrait.html @@ -0,0 +1,383 @@ + + + + + +JsonNameTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class JsonNameTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          JsonNameTrait

          +
          public JsonNameTrait​(java.lang.String value,
+                     SourceLocation sourceLocation)
          +
          • +
        + + + +
          +
        • +

          JsonNameTrait

          +
          public JsonNameTrait​(java.lang.String value)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/LengthTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/LengthTrait.Builder.html new file mode 100644 index 00000000000..74f5256b2f8 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/LengthTrait.Builder.html @@ -0,0 +1,363 @@ + + + + + +LengthTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class LengthTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + +
          +
        • +

          build

          +
          public LengthTrait build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/LengthTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/LengthTrait.Provider.html new file mode 100644 index 00000000000..2a8704c4988 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/LengthTrait.Provider.html @@ -0,0 +1,348 @@ + + + + + +LengthTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class LengthTrait.Provider

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.traits.LengthTrait.Provider
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      TraitService
      +
      +
      +
      Enclosing class:
      +
      LengthTrait
      +
      +
      +
      public static final class LengthTrait.Provider
+extends java.lang.Object
+implements TraitService
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getShapeId

          +
          public ShapeId getShapeId()
          +
          +
          Specified by:
          +
          getShapeId in interface TraitService
          +
          Returns:
          +
          Gets the shape ID of the trait that this provider created.
          +
          +
          • +
        + + + +
          +
        • +

          createTrait

          +
          public LengthTrait createTrait​(ShapeId target,
+                               Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Specified by:
          +
          createTrait in interface TraitService
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/LengthTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/LengthTrait.html new file mode 100644 index 00000000000..cb0a9537c40 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/LengthTrait.html @@ -0,0 +1,459 @@ + + + + + +LengthTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class LengthTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getMin

          +
          public java.util.Optional<java.lang.Long> getMin()
          +
          Gets the min value.
          +
          +
          Returns:
          +
          returns the optional min value.
          +
          +
          • +
        + + + +
          +
        • +

          getMax

          +
          public java.util.Optional<java.lang.Long> getMax()
          +
          Gets the max value.
          +
          +
          Returns:
          +
          returns the optional max value.
          +
          +
          • +
        + + + +
          +
        • +

          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.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          builder

          +
          public static LengthTrait.Builder builder()
          +
          +
          Returns:
          +
          Returns a builder used to create a length trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/MediaTypeTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/MediaTypeTrait.Provider.html new file mode 100644 index 00000000000..0ca22ce1e27 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/MediaTypeTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +MediaTypeTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class MediaTypeTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/MediaTypeTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/MediaTypeTrait.html new file mode 100644 index 00000000000..a9d8cde7304 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/MediaTypeTrait.html @@ -0,0 +1,382 @@ + + + + + +MediaTypeTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class MediaTypeTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          MediaTypeTrait

          +
          public MediaTypeTrait​(java.lang.String value,
+                      SourceLocation sourceLocation)
          +
          • +
        + + + +
          +
        • +

          MediaTypeTrait

          +
          public MediaTypeTrait​(java.lang.String value)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/MixinTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/MixinTrait.Builder.html new file mode 100644 index 00000000000..7c2c91c290b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/MixinTrait.Builder.html @@ -0,0 +1,363 @@ + + + + + +MixinTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class MixinTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public MixinTrait build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        + + + + + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/MixinTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/MixinTrait.Provider.html new file mode 100644 index 00000000000..2a555dd4935 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/MixinTrait.Provider.html @@ -0,0 +1,348 @@ + + + + + +MixinTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class MixinTrait.Provider

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.traits.MixinTrait.Provider
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      TraitService
      +
      +
      +
      Enclosing class:
      +
      MixinTrait
      +
      +
      +
      public static final class MixinTrait.Provider
+extends java.lang.Object
+implements TraitService
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getShapeId

          +
          public ShapeId getShapeId()
          +
          +
          Specified by:
          +
          getShapeId in interface TraitService
          +
          Returns:
          +
          Gets the shape ID of the trait that this provider created.
          +
          +
          • +
        + + + +
          +
        • +

          createTrait

          +
          public MixinTrait createTrait​(ShapeId target,
+                              Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Specified by:
          +
          createTrait in interface TraitService
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/MixinTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/MixinTrait.html new file mode 100644 index 00000000000..1e9f4c196a0 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/MixinTrait.html @@ -0,0 +1,465 @@ + + + + + +MixinTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class MixinTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getLocalTraits

          +
          public java.util.Set<ShapeId> getLocalTraits()
          +
          Gets the mixin local traits.
          +
          +
          Returns:
          +
          returns the mixin local traits.
          +
          +
          • +
        + + + +
          +
        • +

          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.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getNonLocalTraitsFromMap

          +
          public static java.util.Map<ShapeId,​Trait> getNonLocalTraitsFromMap​(java.util.Map<ShapeId,​Trait> traits)
          +
          Helper method used to filter out non-local traits from a map of traits. + +

          If the map is empty or does not contain a mixin trait, then it is + returned as-is. If the map does contain the mixin trait, then a new map + is created that does not contain any of the localTraits specified on + the trait.

          +
          +
          Parameters:
          +
          traits - Traits to filter based on the localTraits property of the mixin.
          +
          Returns:
          +
          Returns the filtered traits.
          +
          +
          • +
        + + + +
          +
        • +

          builder

          +
          public static MixinTrait.Builder builder()
          +
          +
          Returns:
          +
          Returns a new MixinTrait builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/NestedPropertiesTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/NestedPropertiesTrait.Provider.html new file mode 100644 index 00000000000..ef35b5fd0f6 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/NestedPropertiesTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +NestedPropertiesTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class NestedPropertiesTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/NestedPropertiesTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/NestedPropertiesTrait.html new file mode 100644 index 00000000000..e25f4bb0c0f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/NestedPropertiesTrait.html @@ -0,0 +1,356 @@ + + + + + +NestedPropertiesTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class NestedPropertiesTrait

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      FromSourceLocation, ToNode, ToShapeId, Trait
      +
      +
      +
      public final class NestedPropertiesTrait
+extends AnnotationTrait
      +
      Indicates that the contents of a structure member contain the top-level + properties of the associated resource.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          NestedPropertiesTrait

          +
          public NestedPropertiesTrait​(ObjectNode node)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/NoReplaceTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/NoReplaceTrait.Provider.html new file mode 100644 index 00000000000..97beb0d3d77 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/NoReplaceTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +NoReplaceTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class NoReplaceTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/NoReplaceTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/NoReplaceTrait.html new file mode 100644 index 00000000000..7f0ace3349f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/NoReplaceTrait.html @@ -0,0 +1,370 @@ + + + + + +NoReplaceTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class NoReplaceTrait

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      FromSourceLocation, ToNode, ToShapeId, Trait
      +
      +
      +
      public final class NoReplaceTrait
+extends AnnotationTrait
      +
      Indicates that the put lifecycle operation of a resource + can only be used to create a resource and cannot replace + an existing resource.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          NoReplaceTrait

          +
          public NoReplaceTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          NoReplaceTrait

          +
          public NoReplaceTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/NotPropertyTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/NotPropertyTrait.Provider.html new file mode 100644 index 00000000000..120ff21a954 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/NotPropertyTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +NotPropertyTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class NotPropertyTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/NotPropertyTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/NotPropertyTrait.html new file mode 100644 index 00000000000..aa08cdf812f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/NotPropertyTrait.html @@ -0,0 +1,369 @@ + + + + + +NotPropertyTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class NotPropertyTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          NotPropertyTrait

          +
          public NotPropertyTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          NotPropertyTrait

          +
          public NotPropertyTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/OptionalAuthTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/OptionalAuthTrait.Provider.html new file mode 100644 index 00000000000..a4871952378 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/OptionalAuthTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +OptionalAuthTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class OptionalAuthTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/OptionalAuthTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/OptionalAuthTrait.html new file mode 100644 index 00000000000..9bc01d9bd36 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/OptionalAuthTrait.html @@ -0,0 +1,368 @@ + + + + + +OptionalAuthTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class OptionalAuthTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          OptionalAuthTrait

          +
          public OptionalAuthTrait()
          +
          • +
        + + + +
          +
        • +

          OptionalAuthTrait

          +
          public OptionalAuthTrait​(ObjectNode node)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/OutputTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/OutputTrait.Provider.html new file mode 100644 index 00000000000..072b541125d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/OutputTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +OutputTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class OutputTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/OutputTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/OutputTrait.html new file mode 100644 index 00000000000..157ca38ed41 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/OutputTrait.html @@ -0,0 +1,381 @@ + + + + + +OutputTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class OutputTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          OutputTrait

          +
          public OutputTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          OutputTrait

          +
          public OutputTrait()
          +
          • +
        + + + +
          +
        • +

          OutputTrait

          +
          public OutputTrait​(SourceLocation sourceLocation)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/PaginatedTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/PaginatedTrait.Builder.html new file mode 100644 index 00000000000..b606d240328 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/PaginatedTrait.Builder.html @@ -0,0 +1,391 @@ + + + + + +PaginatedTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class PaginatedTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/PaginatedTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/PaginatedTrait.Provider.html new file mode 100644 index 00000000000..08169b1257d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/PaginatedTrait.Provider.html @@ -0,0 +1,348 @@ + + + + + +PaginatedTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class PaginatedTrait.Provider

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.traits.PaginatedTrait.Provider
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      TraitService
      +
      +
      +
      Enclosing class:
      +
      PaginatedTrait
      +
      +
      +
      public static final class PaginatedTrait.Provider
+extends java.lang.Object
+implements TraitService
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getShapeId

          +
          public ShapeId getShapeId()
          +
          +
          Specified by:
          +
          getShapeId in interface TraitService
          +
          Returns:
          +
          Gets the shape ID of the trait that this provider created.
          +
          +
          • +
        + + + +
          +
        • +

          createTrait

          +
          public PaginatedTrait createTrait​(ShapeId target,
+                                  Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Specified by:
          +
          createTrait in interface TraitService
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/PaginatedTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/PaginatedTrait.html new file mode 100644 index 00000000000..6118c2e6ecb --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/PaginatedTrait.html @@ -0,0 +1,596 @@ + + + + + +PaginatedTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class PaginatedTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getItems

          +
          public java.util.Optional<java.lang.String> getItems()
          +
          +
          Returns:
          +
          The `items` property of the trait.
          +
          +
          • +
        + + + +
          +
        • +

          getInputToken

          +
          public java.util.Optional<java.lang.String> getInputToken()
          +
          +
          Returns:
          +
          The `inputToken` property of the trait.
          +
          +
          • +
        + + + +
          +
        • +

          getOutputToken

          +
          public java.util.Optional<java.lang.String> getOutputToken()
          +
          +
          Returns:
          +
          The `outputToken` property of the trait.
          +
          +
          • +
        + + + +
          +
        • +

          getPageSize

          +
          public java.util.Optional<java.lang.String> getPageSize()
          +
          +
          Returns:
          +
          The optional `pageSize` property.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          resolveFullPath

          +
          public static java.util.List<MemberShape> resolveFullPath​(java.lang.String path,
+                                                          Model model,
+                                                          StructureShape shape)
          +
          Resolves an output path to a list of MemberShape. + +

          A path is a series of identifiers separated by dots (`.`) where each identifier + represents a member name in a structure.

          +
          +
          Parameters:
          +
          path - The path to resolve.
          +
          model - The model to be searched when resolving the path.
          +
          shape - The shape where path resolution should start, e.g. the output shape + of an operation.
          +
          Returns:
          +
          The list of member shapes corresponding to each path identifier. An unresolvable path will be returned + as an empty list.
          +
          +
          • +
        + + + +
          +
        • +

          merge

          +
          public PaginatedTrait merge​(PaginatedTrait other)
          +
          Merges this paginated trait with another trait. + +

          Values set on this trait take precedence over values of the + other trait. This operation is typically performed to merge the + paginated trait of an operation with the paginated trait of a service. + +

          If other is null, the current trait is returned as-is.

          +
          +
          Parameters:
          +
          other - Other trait to merge with.
          +
          Returns:
          +
          Returns a newly created trait that maintains the same source location.
          +
          +
          • +
        + + + +
          +
        • +

          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.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          builder

          +
          public static PaginatedTrait.Builder builder()
          +
          +
          Returns:
          +
          Returns a paginated trait builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/PatternTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/PatternTrait.Provider.html new file mode 100644 index 00000000000..806109fd4ec --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/PatternTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +PatternTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class PatternTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/PatternTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/PatternTrait.html new file mode 100644 index 00000000000..c7d95c7e522 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/PatternTrait.html @@ -0,0 +1,427 @@ + + + + + +PatternTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class PatternTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          PatternTrait

          +
          public PatternTrait​(java.lang.String value,
+                    SourceLocation sourceLocation)
          +
          • +
        + + + +
          +
        • +

          PatternTrait

          +
          public PatternTrait​(java.lang.String value)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getPattern

          +
          public java.util.regex.Pattern getPattern()
          +
          Gets the regex pattern.
          +
          +
          Returns:
          +
          returns compiled regular expression.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/PrivateTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/PrivateTrait.Provider.html new file mode 100644 index 00000000000..d595e454471 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/PrivateTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +PrivateTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class PrivateTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/PrivateTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/PrivateTrait.html new file mode 100644 index 00000000000..1ff9b42e371 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/PrivateTrait.html @@ -0,0 +1,369 @@ + + + + + +PrivateTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class PrivateTrait

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static class PrivateTrait.Provider 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        static ShapeIdID 
        +
        • +
      +
      + +
      + +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          PrivateTrait

          +
          public PrivateTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          PrivateTrait

          +
          public PrivateTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/PropertyTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/PropertyTrait.Builder.html new file mode 100644 index 00000000000..1d1f8005d15 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/PropertyTrait.Builder.html @@ -0,0 +1,348 @@ + + + + + +PropertyTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class PropertyTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          build

          +
          public PropertyTrait build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/PropertyTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/PropertyTrait.Provider.html new file mode 100644 index 00000000000..7ad5607784b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/PropertyTrait.Provider.html @@ -0,0 +1,348 @@ + + + + + +PropertyTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class PropertyTrait.Provider

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.traits.PropertyTrait.Provider
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      TraitService
      +
      +
      +
      Enclosing class:
      +
      PropertyTrait
      +
      +
      +
      public static final class PropertyTrait.Provider
+extends java.lang.Object
+implements TraitService
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getShapeId

          +
          public ShapeId getShapeId()
          +
          +
          Specified by:
          +
          getShapeId in interface TraitService
          +
          Returns:
          +
          Gets the shape ID of the trait that this provider created.
          +
          +
          • +
        + + + +
          +
        • +

          createTrait

          +
          public PropertyTrait createTrait​(ShapeId target,
+                                 Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Specified by:
          +
          createTrait in interface TraitService
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/PropertyTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/PropertyTrait.html new file mode 100644 index 00000000000..5f2f6c0b6d8 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/PropertyTrait.html @@ -0,0 +1,425 @@ + + + + + +PropertyTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class PropertyTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getName

          +
          public java.util.Optional<java.lang.String> getName()
          +
          • +
        + + + +
          +
        • +

          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.
          +
          +
          • +
        + + + + + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/ProtocolDefinitionTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/ProtocolDefinitionTrait.Builder.html new file mode 100644 index 00000000000..7b02afe747e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/ProtocolDefinitionTrait.Builder.html @@ -0,0 +1,376 @@ + + + + + +ProtocolDefinitionTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class ProtocolDefinitionTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/ProtocolDefinitionTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/ProtocolDefinitionTrait.Provider.html new file mode 100644 index 00000000000..72a32f404aa --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/ProtocolDefinitionTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +ProtocolDefinitionTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class ProtocolDefinitionTrait.Provider

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public ProtocolDefinitionTrait createTrait​(ShapeId target,
+                                           Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/ProtocolDefinitionTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/ProtocolDefinitionTrait.html new file mode 100644 index 00000000000..797ac7a6c99 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/ProtocolDefinitionTrait.html @@ -0,0 +1,495 @@ + + + + + +ProtocolDefinitionTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class ProtocolDefinitionTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getTraits

          +
          public java.util.List<ShapeId> getTraits()
          +
          Gets the list of shape IDs that protocol implementations must know about + in order to successfully utilize the protocol.
          +
          +
          Returns:
          +
          Returns the protocol traits.
          +
          +
          • +
        + + + +
          +
        • +

          getNoInlineDocumentSupport

          +
          public boolean getNoInlineDocumentSupport()
          +
          Checks if this protocol does not support inline documents.
          +
          +
          Returns:
          +
          Returns true if inline documents are not supported.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          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.
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/RangeTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/RangeTrait.Builder.html new file mode 100644 index 00000000000..e6f94802515 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/RangeTrait.Builder.html @@ -0,0 +1,363 @@ + + + + + +RangeTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class RangeTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + +
          +
        • +

          build

          +
          public RangeTrait build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/RangeTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/RangeTrait.Provider.html new file mode 100644 index 00000000000..1bf050c78c9 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/RangeTrait.Provider.html @@ -0,0 +1,348 @@ + + + + + +RangeTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class RangeTrait.Provider

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.traits.RangeTrait.Provider
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      TraitService
      +
      +
      +
      Enclosing class:
      +
      RangeTrait
      +
      +
      +
      public static final class RangeTrait.Provider
+extends java.lang.Object
+implements TraitService
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getShapeId

          +
          public ShapeId getShapeId()
          +
          +
          Specified by:
          +
          getShapeId in interface TraitService
          +
          Returns:
          +
          Gets the shape ID of the trait that this provider created.
          +
          +
          • +
        + + + +
          +
        • +

          createTrait

          +
          public RangeTrait createTrait​(ShapeId target,
+                              Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Specified by:
          +
          createTrait in interface TraitService
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/RangeTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/RangeTrait.html new file mode 100644 index 00000000000..a402eeee57c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/RangeTrait.html @@ -0,0 +1,459 @@ + + + + + +RangeTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class RangeTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getMin

          +
          public java.util.Optional<java.math.BigDecimal> getMin()
          +
          Gets the min value.
          +
          +
          Returns:
          +
          returns the optional min value.
          +
          +
          • +
        + + + +
          +
        • +

          getMax

          +
          public java.util.Optional<java.math.BigDecimal> getMax()
          +
          Gets the max value.
          +
          +
          Returns:
          +
          returns the optional max value.
          +
          +
          • +
        + + + +
          +
        • +

          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.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          builder

          +
          public static RangeTrait.Builder builder()
          +
          +
          Returns:
          +
          Returns a new RangeTrait builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/ReadonlyTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/ReadonlyTrait.Provider.html new file mode 100644 index 00000000000..edfea6094b9 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/ReadonlyTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +ReadonlyTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class ReadonlyTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/ReadonlyTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/ReadonlyTrait.html new file mode 100644 index 00000000000..8c7b2ad1724 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/ReadonlyTrait.html @@ -0,0 +1,368 @@ + + + + + +ReadonlyTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class ReadonlyTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ReadonlyTrait

          +
          public ReadonlyTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          ReadonlyTrait

          +
          public ReadonlyTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/RecommendedTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/RecommendedTrait.Builder.html new file mode 100644 index 00000000000..54593de99cf --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/RecommendedTrait.Builder.html @@ -0,0 +1,349 @@ + + + + + +RecommendedTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class RecommendedTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          build

          +
          public RecommendedTrait build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/RecommendedTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/RecommendedTrait.Provider.html new file mode 100644 index 00000000000..e63272542e8 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/RecommendedTrait.Provider.html @@ -0,0 +1,348 @@ + + + + + +RecommendedTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class RecommendedTrait.Provider

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.traits.RecommendedTrait.Provider
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getShapeId

          +
          public ShapeId getShapeId()
          +
          +
          Specified by:
          +
          getShapeId in interface TraitService
          +
          Returns:
          +
          Gets the shape ID of the trait that this provider created.
          +
          +
          • +
        + + + +
          +
        • +

          createTrait

          +
          public RecommendedTrait createTrait​(ShapeId target,
+                                    Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Specified by:
          +
          createTrait in interface TraitService
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/RecommendedTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/RecommendedTrait.html new file mode 100644 index 00000000000..9dc58b85393 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/RecommendedTrait.html @@ -0,0 +1,437 @@ + + + + + +RecommendedTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class RecommendedTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getReason

          +
          public java.util.Optional<java.lang.String> getReason()
          +
          Gets the reason it is recommended to set this member.
          +
          +
          Returns:
          +
          returns the optional reason.
          +
          +
          • +
        + + + +
          +
        • +

          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.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          builder

          +
          public static RecommendedTrait.Builder builder()
          +
          +
          Returns:
          +
          Returns a new RecommendedTrait builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/ReferencesTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/ReferencesTrait.Builder.html new file mode 100644 index 00000000000..2ca37631c70 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/ReferencesTrait.Builder.html @@ -0,0 +1,377 @@ + + + + + +ReferencesTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class ReferencesTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/ReferencesTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/ReferencesTrait.Provider.html new file mode 100644 index 00000000000..9ccceebca76 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/ReferencesTrait.Provider.html @@ -0,0 +1,348 @@ + + + + + +ReferencesTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class ReferencesTrait.Provider

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.traits.ReferencesTrait.Provider
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      TraitService
      +
      +
      +
      Enclosing class:
      +
      ReferencesTrait
      +
      +
      +
      public static final class ReferencesTrait.Provider
+extends java.lang.Object
+implements TraitService
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getShapeId

          +
          public ShapeId getShapeId()
          +
          +
          Specified by:
          +
          getShapeId in interface TraitService
          +
          Returns:
          +
          Gets the shape ID of the trait that this provider created.
          +
          +
          • +
        + + + +
          +
        • +

          createTrait

          +
          public ReferencesTrait createTrait​(ShapeId target,
+                                   Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Specified by:
          +
          createTrait in interface TraitService
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/ReferencesTrait.Reference.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/ReferencesTrait.Reference.Builder.html new file mode 100644 index 00000000000..558649f91ab --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/ReferencesTrait.Reference.Builder.html @@ -0,0 +1,342 @@ + + + + + +ReferencesTrait.Reference.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class ReferencesTrait.Reference.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.traits.ReferencesTrait.Reference.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/ReferencesTrait.Reference.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/ReferencesTrait.Reference.html new file mode 100644 index 00000000000..a21cb141e68 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/ReferencesTrait.Reference.html @@ -0,0 +1,481 @@ + + + + + +ReferencesTrait.Reference (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class ReferencesTrait.Reference

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.traits.ReferencesTrait.Reference
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + +
          +
        • +

          getResource

          +
          public ShapeId getResource()
          +
          Get the referenced shape.
          +
          +
          Returns:
          +
          Returns the referenced shape.
          +
          +
          • +
        + + + +
          +
        • +

          getService

          +
          public java.util.Optional<ShapeId> getService()
          +
          Get the service binding.
          +
          +
          Returns:
          +
          Returns the optionally referenced service.
          +
          +
          • +
        + + + +
          +
        • +

          getIds

          +
          public java.util.Map<java.lang.String,​java.lang.String> getIds()
          +
          +
          Returns:
          +
          Returns the immutable mapping of member names to resource identifier name.
          +
          +
          • +
        + + + +
          +
        • +

          getRel

          +
          public java.util.Optional<java.lang.String> getRel()
          +
          +
          Returns:
          +
          Gets the optional rel property.
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/ReferencesTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/ReferencesTrait.html new file mode 100644 index 00000000000..a5f039bbe74 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/ReferencesTrait.html @@ -0,0 +1,508 @@ + + + + + +ReferencesTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class ReferencesTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        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.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object other)
          +
          +
          Overrides:
          +
          equals in class AbstractTrait
          +
          +
          • +
        + + + + + + + +
          +
        • +

          builder

          +
          public static ReferencesTrait.Builder builder()
          +
          +
          Returns:
          +
          Returns a builder used to create a references trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/RequestCompressionTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/RequestCompressionTrait.Builder.html new file mode 100644 index 00000000000..63071361573 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/RequestCompressionTrait.Builder.html @@ -0,0 +1,336 @@ + + + + + +RequestCompressionTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class RequestCompressionTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/RequestCompressionTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/RequestCompressionTrait.Provider.html new file mode 100644 index 00000000000..bd07bcff793 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/RequestCompressionTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +RequestCompressionTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class RequestCompressionTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/RequestCompressionTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/RequestCompressionTrait.html new file mode 100644 index 00000000000..3b13a9a8425 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/RequestCompressionTrait.html @@ -0,0 +1,460 @@ + + + + + +RequestCompressionTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class RequestCompressionTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        + + + +
          +
        • +

          SUPPORTED_COMPRESSION_ALGORITHMS

          +
          public static final java.util.Set<java.lang.String> SUPPORTED_COMPRESSION_ALGORITHMS
          +
          Set of supported compression algorithm encoding values.
          +
          • +
        + + + + +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/RequiredTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/RequiredTrait.Provider.html new file mode 100644 index 00000000000..239e309ee2a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/RequiredTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +RequiredTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class RequiredTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/RequiredTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/RequiredTrait.html new file mode 100644 index 00000000000..79ccdd96382 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/RequiredTrait.html @@ -0,0 +1,368 @@ + + + + + +RequiredTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class RequiredTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          RequiredTrait

          +
          public RequiredTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          RequiredTrait

          +
          public RequiredTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/RequiresLengthTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/RequiresLengthTrait.Provider.html new file mode 100644 index 00000000000..6e0d058c464 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/RequiresLengthTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +RequiresLengthTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class RequiresLengthTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/RequiresLengthTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/RequiresLengthTrait.html new file mode 100644 index 00000000000..593a4fb7c38 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/RequiresLengthTrait.html @@ -0,0 +1,368 @@ + + + + + +RequiresLengthTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class RequiresLengthTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          RequiresLengthTrait

          +
          public RequiresLengthTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          RequiresLengthTrait

          +
          public RequiresLengthTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/ResourceIdentifierTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/ResourceIdentifierTrait.Provider.html new file mode 100644 index 00000000000..175c59def19 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/ResourceIdentifierTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +ResourceIdentifierTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class ResourceIdentifierTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/ResourceIdentifierTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/ResourceIdentifierTrait.html new file mode 100644 index 00000000000..aff0c672a2d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/ResourceIdentifierTrait.html @@ -0,0 +1,383 @@ + + + + + +ResourceIdentifierTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class ResourceIdentifierTrait

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      FromSourceLocation, ToNode, ToShapeId, Trait
      +
      +
      +
      public final class ResourceIdentifierTrait
+extends StringTrait
      +
      Binds an operation input member to a named identifier of the resource to + which the operation is bound.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ResourceIdentifierTrait

          +
          public ResourceIdentifierTrait​(java.lang.String value,
+                               SourceLocation sourceLocation)
          +
          • +
        + + + +
          +
        • +

          ResourceIdentifierTrait

          +
          public ResourceIdentifierTrait​(java.lang.String value)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/RetryableTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/RetryableTrait.Builder.html new file mode 100644 index 00000000000..edf216f58d2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/RetryableTrait.Builder.html @@ -0,0 +1,318 @@ + + + + + +RetryableTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class RetryableTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public RetryableTrait build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        + + + +
          +
        • +

          throttling

          +
          public RetryableTrait.Builder throttling​(boolean throttling)
          +
          Indicates if the retry is considered a throttle.
          +
          +
          Parameters:
          +
          throttling - Set to true if the retry is a throttle.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/RetryableTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/RetryableTrait.Provider.html new file mode 100644 index 00000000000..1e7c47b5ece --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/RetryableTrait.Provider.html @@ -0,0 +1,348 @@ + + + + + +RetryableTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class RetryableTrait.Provider

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.traits.RetryableTrait.Provider
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      TraitService
      +
      +
      +
      Enclosing class:
      +
      RetryableTrait
      +
      +
      +
      public static final class RetryableTrait.Provider
+extends java.lang.Object
+implements TraitService
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getShapeId

          +
          public ShapeId getShapeId()
          +
          +
          Specified by:
          +
          getShapeId in interface TraitService
          +
          Returns:
          +
          Gets the shape ID of the trait that this provider created.
          +
          +
          • +
        + + + +
          +
        • +

          createTrait

          +
          public RetryableTrait createTrait​(ShapeId target,
+                                  Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Specified by:
          +
          createTrait in interface TraitService
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/RetryableTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/RetryableTrait.html new file mode 100644 index 00000000000..ee65b6895df --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/RetryableTrait.html @@ -0,0 +1,474 @@ + + + + + +RetryableTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class RetryableTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          builder

          +
          public static RetryableTrait.Builder builder()
          +
          Creates a builder for a retryable trait.
          +
          +
          Returns:
          +
          Returns the created builder.
          +
          +
          • +
        + + + +
          +
        • +

          getThrottling

          +
          public boolean getThrottling()
          +
          +
          Returns:
          +
          Returns true if the retry is a throttle.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          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.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object other)
          +
          +
          Overrides:
          +
          equals in class AbstractTrait
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/SensitiveTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/SensitiveTrait.Provider.html new file mode 100644 index 00000000000..5a4cf82b67b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/SensitiveTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +SensitiveTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class SensitiveTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/SensitiveTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/SensitiveTrait.html new file mode 100644 index 00000000000..9de9961775d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/SensitiveTrait.html @@ -0,0 +1,369 @@ + + + + + +SensitiveTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class SensitiveTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          SensitiveTrait

          +
          public SensitiveTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          SensitiveTrait

          +
          public SensitiveTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/SinceTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/SinceTrait.Provider.html new file mode 100644 index 00000000000..e02ce6ef246 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/SinceTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +SinceTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class SinceTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/SinceTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/SinceTrait.html new file mode 100644 index 00000000000..422183f5d2d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/SinceTrait.html @@ -0,0 +1,382 @@ + + + + + +SinceTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class SinceTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          SinceTrait

          +
          public SinceTrait​(java.lang.String value,
+                  SourceLocation sourceLocation)
          +
          • +
        + + + +
          +
        • +

          SinceTrait

          +
          public SinceTrait​(java.lang.String value)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/SparseTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/SparseTrait.Provider.html new file mode 100644 index 00000000000..a036a32089d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/SparseTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +SparseTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class SparseTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/SparseTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/SparseTrait.html new file mode 100644 index 00000000000..89f6ec031c0 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/SparseTrait.html @@ -0,0 +1,368 @@ + + + + + +SparseTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class SparseTrait

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static class SparseTrait.Provider 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        static ShapeIdID 
        +
        • +
      +
      + +
      + +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          SparseTrait

          +
          public SparseTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          SparseTrait

          +
          public SparseTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/StreamingTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/StreamingTrait.Provider.html new file mode 100644 index 00000000000..c05ada5973b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/StreamingTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +StreamingTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class StreamingTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/StreamingTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/StreamingTrait.html new file mode 100644 index 00000000000..ea5458468cc --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/StreamingTrait.html @@ -0,0 +1,443 @@ + + + + + +StreamingTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class StreamingTrait

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      FromSourceLocation, ToNode, ToShapeId, Trait
      +
      +
      +
      public final class StreamingTrait
+extends AnnotationTrait
      +
      Indicates that the data stored in the shape is very large and should + not be stored in memory, or that the size of the data stored in the + shape is unknown at the start of a request.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          StreamingTrait

          +
          public StreamingTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          StreamingTrait

          +
          public StreamingTrait()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          isEventStream

          +
          public static boolean isEventStream​(Shape shape)
          +
          Determines whether a given shape is an event stream.
          +
          +
          Parameters:
          +
          shape - The shape to check.
          +
          Returns:
          +
          True if the shape is a union and has the streaming trait.
          +
          +
          • +
        + + + +
          +
        • +

          isEventStream

          +
          public static boolean isEventStream​(Model model,
+                                    MemberShape member)
          +
          Determines whether a given member targets an event stream.
          +
          +
          Parameters:
          +
          model - The model containing the member and its target.
          +
          member - The member whose target should be checked.
          +
          Returns:
          +
          True if the member targets a union with the streaming trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/StringListTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/StringListTrait.Builder.html new file mode 100644 index 00000000000..bd46d117371 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/StringListTrait.Builder.html @@ -0,0 +1,433 @@ + + + + + +StringListTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class StringListTrait.Builder<TRAIT extends StringListTrait,​BUILDER extends StringListTrait.Builder>

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Builder() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        BUILDERaddValue​(java.lang.String value) +
        Adds a value to the builder.
        +
        BUILDERclearValues() +
        Clears all values out of the builder.
        +
        java.util.List<java.lang.String>getValues() +
        Gets the values set in the builder.
        +
        BUILDERremoveValue​(java.lang.String value) +
        Removes a value from the builder.
        +
        BUILDERvalues​(java.util.Collection<java.lang.String> values) +
        Replaces all of the values in the builder with the given values.
        +
        + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getValues

          +
          public java.util.List<java.lang.String> getValues()
          +
          Gets the values set in the builder.
          +
          +
          Returns:
          +
          Returns the set values.
          +
          +
          • +
        + + + +
          +
        • +

          addValue

          +
          public BUILDER addValue​(java.lang.String value)
          +
          Adds a value to the builder.
          +
          +
          Parameters:
          +
          value - Value to add.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          values

          +
          public BUILDER values​(java.util.Collection<java.lang.String> values)
          +
          Replaces all of the values in the builder with the given values.
          +
          +
          Parameters:
          +
          values - Value to replace into the builder.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          removeValue

          +
          public BUILDER removeValue​(java.lang.String value)
          +
          Removes a value from the builder.
          +
          +
          Parameters:
          +
          value - Value to remove.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          clearValues

          +
          public BUILDER clearValues()
          +
          Clears all values out of the builder.
          +
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/StringListTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/StringListTrait.Provider.html new file mode 100644 index 00000000000..93dbfe43f24 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/StringListTrait.Provider.html @@ -0,0 +1,349 @@ + + + + + +StringListTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class StringListTrait.Provider<T extends StringListTrait>

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider​(ShapeId id, + java.util.function.BiFunction<java.util.List<java.lang.String>,​SourceLocation,​T> traitFactory) 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider​(ShapeId id,
+                java.util.function.BiFunction<java.util.List<java.lang.String>,​SourceLocation,​T> traitFactory)
          +
          +
          Parameters:
          +
          id - The ID of the trait being created.
          +
          traitFactory - The factory used to create the trait.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public T createTrait​(ShapeId id,
+                     Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          id - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/StringListTrait.StringListTraitConstructor.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/StringListTrait.StringListTraitConstructor.html new file mode 100644 index 00000000000..4a06ac50ace --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/StringListTrait.StringListTraitConstructor.html @@ -0,0 +1,274 @@ + + + + + +StringListTrait.StringListTraitConstructor (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Interface StringListTrait.StringListTraitConstructor<T extends StringListTrait>

    +
    +
    +
    +
      +
    • +
      +
      Type Parameters:
      +
      T - Type of StringList trait to create.
      +
      +
      +
      Enclosing class:
      +
      StringListTrait
      +
      +
      +
      Functional Interface:
      +
      This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
      +
      +
      +
      @FunctionalInterface
+public static interface StringListTrait.StringListTraitConstructor<T extends StringListTrait>
      +
      Factory method to create a StringList provider.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          create

          +
          T create​(java.util.List<java.lang.String> values,
+         FromSourceLocation sourceLocation)
          +
          Wraps the constructor of a StringList trait.
          +
          +
          Parameters:
          +
          values - Values to pass to the trait.
          +
          sourceLocation - The location in which the trait was defined.
          +
          Returns:
          +
          Returns the created StringList trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/StringListTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/StringListTrait.html new file mode 100644 index 00000000000..b33bafb3d16 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/StringListTrait.html @@ -0,0 +1,412 @@ + + + + + +StringListTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class StringListTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          StringListTrait

          +
          public StringListTrait​(ShapeId id,
+                       java.util.List<java.lang.String> values,
+                       FromSourceLocation sourceLocation)
          +
          +
          Parameters:
          +
          id - The id of the trait being created.
          +
          values - The string values of the trait.
          +
          sourceLocation - Where the trait was defined.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createNode

          +
          protected final 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.
          +
          +
          • +
        + + + +
          +
        • +

          getValues

          +
          public final java.util.List<java.lang.String> getValues()
          +
          +
          Returns:
          +
          Gets the trait values.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/StringTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/StringTrait.Provider.html new file mode 100644 index 00000000000..98a68ce82c1 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/StringTrait.Provider.html @@ -0,0 +1,349 @@ + + + + + +StringTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class StringTrait.Provider<T extends StringTrait>

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider​(ShapeId id, + java.util.function.BiFunction<java.lang.String,​SourceLocation,​T> traitFactory) 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider​(ShapeId id,
+                java.util.function.BiFunction<java.lang.String,​SourceLocation,​T> traitFactory)
          +
          +
          Parameters:
          +
          id - The name of the trait being created.
          +
          traitFactory - The factory used to create the trait.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public T createTrait​(ShapeId id,
+                     Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          id - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/StringTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/StringTrait.html new file mode 100644 index 00000000000..fc40b334701 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/StringTrait.html @@ -0,0 +1,397 @@ + + + + + +StringTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class StringTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          StringTrait

          +
          public StringTrait​(ShapeId id,
+                   java.lang.String value,
+                   FromSourceLocation sourceLocation)
          +
          +
          Parameters:
          +
          id - The ID of the trait being created.
          +
          value - The string value of the trait.
          +
          sourceLocation - Where the trait was defined.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getValue

          +
          public java.lang.String getValue()
          +
          +
          Returns:
          +
          Get the trait value.
          +
          +
          • +
        + + + +
          +
        • +

          createNode

          +
          protected final 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.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/SuppressTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/SuppressTrait.Builder.html new file mode 100644 index 00000000000..f04f09f8b9c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/SuppressTrait.Builder.html @@ -0,0 +1,306 @@ + + + + + +SuppressTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class SuppressTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public SuppressTrait build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/SuppressTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/SuppressTrait.Provider.html new file mode 100644 index 00000000000..c22f6a5d893 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/SuppressTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +SuppressTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class SuppressTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/SuppressTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/SuppressTrait.html new file mode 100644 index 00000000000..d1b85ba22e6 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/SuppressTrait.html @@ -0,0 +1,403 @@ + + + + + +SuppressTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class SuppressTrait

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/TagsTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/TagsTrait.Builder.html new file mode 100644 index 00000000000..9aad5bec9c9 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/TagsTrait.Builder.html @@ -0,0 +1,306 @@ + + + + + +TagsTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class TagsTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public TagsTrait build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/TagsTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/TagsTrait.Provider.html new file mode 100644 index 00000000000..02cbe13f0fd --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/TagsTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +TagsTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class TagsTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/TagsTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/TagsTrait.html new file mode 100644 index 00000000000..34e743b173f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/TagsTrait.html @@ -0,0 +1,435 @@ + + + + + +TagsTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class TagsTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getTags

          +
          public java.util.List<java.lang.String> getTags()
          +
          Description copied from interface: Tagged
          +
          Gets the tags applied to an object.
          +
          +
          Specified by:
          +
          getTags in interface Tagged
          +
          Returns:
          +
          Returns the tag values.
          +
          +
          • +
        + + + + + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/TimestampFormatTrait.Format.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/TimestampFormatTrait.Format.html new file mode 100644 index 00000000000..e099a55bf3c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/TimestampFormatTrait.Format.html @@ -0,0 +1,450 @@ + + + + + +TimestampFormatTrait.Format (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Enum TimestampFormatTrait.Format

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static TimestampFormatTrait.Format[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (TimestampFormatTrait.Format c : TimestampFormatTrait.Format.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static TimestampFormatTrait.Format valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          fromString

          +
          public static TimestampFormatTrait.Format fromString​(java.lang.String value)
          +
          Create a Format from a string that would appear in a model. + +

          Any unknown value is returned as Unknown.

          +
          +
          Parameters:
          +
          value - Value from a trait or model.
          +
          Returns:
          +
          Returns the Format enum value.
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Enum<TimestampFormatTrait.Format>
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/TimestampFormatTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/TimestampFormatTrait.Provider.html new file mode 100644 index 00000000000..86bc0b74e2b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/TimestampFormatTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +TimestampFormatTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class TimestampFormatTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/TimestampFormatTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/TimestampFormatTrait.html new file mode 100644 index 00000000000..224257f9d74 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/TimestampFormatTrait.html @@ -0,0 +1,488 @@ + + + + + +TimestampFormatTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class TimestampFormatTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          TimestampFormatTrait

          +
          public TimestampFormatTrait​(java.lang.String value,
+                            SourceLocation sourceLocation)
          +
          • +
        + + + +
          +
        • +

          TimestampFormatTrait

          +
          public TimestampFormatTrait​(java.lang.String value)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getFormat

          +
          public TimestampFormatTrait.Format getFormat()
          +
          Gets the timestampFormat value as a Format enum.
          +
          +
          Returns:
          +
          Returns the Format enum.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/TitleTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/TitleTrait.Provider.html new file mode 100644 index 00000000000..193f3a430a2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/TitleTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +TitleTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class TitleTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/TitleTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/TitleTrait.html new file mode 100644 index 00000000000..0c603358fbc --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/TitleTrait.html @@ -0,0 +1,382 @@ + + + + + +TitleTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class TitleTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          TitleTrait

          +
          public TitleTrait​(java.lang.String value,
+                  SourceLocation sourceLocation)
          +
          • +
        + + + +
          +
        • +

          TitleTrait

          +
          public TitleTrait​(java.lang.String value)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/Trait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/Trait.html new file mode 100644 index 00000000000..c6056084470 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/Trait.html @@ -0,0 +1,474 @@ + + + + + +Trait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Interface Trait

    +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods 
        Modifier and TypeMethodDescription
        static <S extends Shape,​T extends Trait>
        java.util.stream.Stream<Pair<S,​T>>        		flatMapStream​(S shape, + java.lang.Class<T> traitClass) +
        Deprecated.
        +
        static java.lang.StringgetIdiomaticTraitName​(java.lang.String traitName) +
        Gets the idiomatic name of a prelude trait by stripping off the + smithy.api# prefix.
        +
        static java.lang.StringgetIdiomaticTraitName​(ToShapeId id) +
        Gets the idiomatic name of a prelude trait by stripping off the + smithy.api# prefix.
        +
        default booleanisSynthetic() +
        Checks if this trait is persisted with the shape, or if it is a + synthetic, or transient trait, only meant to temporarily aid in + some kind of in-memory model transformation.
        +
        static java.lang.StringmakeAbsoluteName​(java.lang.String traitName) +
        Makes the given trait name absolute if it is relative.
        +
        static java.lang.StringmakeAbsoluteName​(java.lang.String traitName, + java.lang.String defaultNamespace) +
        Makes the given trait name absolute if it is relative.
        +
        ShapeIdtoShapeId() +
        Gets the shape ID of the trait.
        +
        + +
          +
        • + + +

          Methods inherited from interface software.amazon.smithy.model.node.ToNode

          +toNode
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          toShapeId

          +
          ShapeId toShapeId()
          +
          Gets the shape ID of the trait.
          +
          +
          Specified by:
          +
          toShapeId in interface ToShapeId
          +
          Returns:
          +
          Returns the fully-qualified shape ID of the trait.
          +
          +
          • +
        + + + +
          +
        • +

          isSynthetic

          +
          default boolean isSynthetic()
          +
          Checks if this trait is persisted with the shape, or if it is a + synthetic, or transient trait, only meant to temporarily aid in + some kind of in-memory model transformation. + +

          Because synthetic traits are not persisted with shapes, they also + do not need to be defined in Smithy's semantic model before they can + be used in the model.

          +
          +
          Returns:
          +
          Returns true if the trait is not persisted on the shape.
          +
          +
          • +
        + + + + + +
          +
        • +

          flatMapStream

          +
          @Deprecated
+static <S extends Shape,​T extends Trait> java.util.stream.Stream<Pair<S,​T>> flatMapStream​(S shape,
+                                                                                                      java.lang.Class<T> traitClass)
          +
          Deprecated.
          +
          Used in a stream flatMapStream to return a Stream with a + Pair of Shape and Trait if the trait is present on the + given shape. + +

          This method is deprecated because it generally results in harder + to read code using unnamed tuples. Use Shape.hasTrait(Class) + and Shape.expectTrait(Class) instead.

          +
          +
          Type Parameters:
          +
          S - Shape
          +
          T - Trait
          +
          Parameters:
          +
          shape - Shape to query for the trait.
          +
          traitClass - Trait to retrieve.
          +
          Returns:
          +
          Returns the Stream of the found trait or an empty stream.
          +
          +
          • +
        + + + +
          +
        • +

          getIdiomaticTraitName

          +
          static java.lang.String getIdiomaticTraitName​(java.lang.String traitName)
          +
          Gets the idiomatic name of a prelude trait by stripping off the + smithy.api# prefix. This is used in various error messages.
          +
          +
          Parameters:
          +
          traitName - Trait name to make idiomatic.
          +
          Returns:
          +
          Returns the idiomatic trait name.
          +
          +
          • +
        + + + +
          +
        • +

          getIdiomaticTraitName

          +
          static java.lang.String getIdiomaticTraitName​(ToShapeId id)
          +
          Gets the idiomatic name of a prelude trait by stripping off the + smithy.api# prefix. This is used in various error messages.
          +
          +
          Parameters:
          +
          id - Trait name to make idiomatic.
          +
          Returns:
          +
          Returns the idiomatic trait name.
          +
          +
          • +
        + + + +
          +
        • +

          makeAbsoluteName

          +
          static java.lang.String makeAbsoluteName​(java.lang.String traitName)
          +
          Makes the given trait name absolute if it is relative. + +

          The namespace used to resolve with the trait name is the + prelude namespace, smithy.api.

          +
          +
          Parameters:
          +
          traitName - Trait name to make absolute.
          +
          Returns:
          +
          Returns the absolute trait name.
          +
          +
          • +
        + + + +
          +
        • +

          makeAbsoluteName

          +
          static java.lang.String makeAbsoluteName​(java.lang.String traitName,
+                                         java.lang.String defaultNamespace)
          +
          Makes the given trait name absolute if it is relative.
          +
          +
          Parameters:
          +
          traitName - Trait name to make absolute.
          +
          defaultNamespace - Namespace to use if the name is relative.
          +
          Returns:
          +
          Returns the absolute trait name.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/TraitDefinition.BreakingChangeRule.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/TraitDefinition.BreakingChangeRule.html new file mode 100644 index 00000000000..21d15e36dd7 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/TraitDefinition.BreakingChangeRule.html @@ -0,0 +1,493 @@ + + + + + +TraitDefinition.BreakingChangeRule (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class TraitDefinition.BreakingChangeRule

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.traits.TraitDefinition.BreakingChangeRule
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ToNode
      +
      +
      +
      Enclosing class:
      +
      TraitDefinition
      +
      +
      +
      public static final class TraitDefinition.BreakingChangeRule
+extends java.lang.Object
+implements ToNode
      +
      Represents an individual trait diff rule to define backward compatibility rules.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getPath

          +
          public java.util.Optional<NodePointer> getPath()
          +
          • +
        + + + +
          +
        • +

          getDefaultedPath

          +
          public NodePointer getDefaultedPath()
          +
          • +
        + + + +
          +
        • +

          getSeverity

          +
          public java.util.Optional<Severity> getSeverity()
          +
          • +
        + + + +
          +
        • +

          getDefaultedSeverity

          +
          public Severity getDefaultedSeverity()
          +
          • +
        + + + + + + + +
          +
        • +

          getMessage

          +
          public java.util.Optional<java.lang.String> getMessage()
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object obj)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/TraitDefinition.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/TraitDefinition.Builder.html new file mode 100644 index 00000000000..f01ed89be87 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/TraitDefinition.Builder.html @@ -0,0 +1,407 @@ + + + + + +TraitDefinition.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class TraitDefinition.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/TraitDefinition.ChangeType.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/TraitDefinition.ChangeType.html new file mode 100644 index 00000000000..6a62d7bdb21 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/TraitDefinition.ChangeType.html @@ -0,0 +1,502 @@ + + + + + +TraitDefinition.ChangeType (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Enum TraitDefinition.ChangeType

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        ADD +
        Emit when a trait or value is added that previously did not exist.
        +
        ANY +
        Emit when any change occurs.
        +
        PRESENCE +
        Emit when a trait is added or removed.
        +
        REMOVE +
        Emit when a trait or value is removed.
        +
        UPDATE +
        Emit when a trait already existed, continues to exist, but it is modified.
        +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static TraitDefinition.ChangeType[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (TraitDefinition.ChangeType c : TraitDefinition.ChangeType.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static TraitDefinition.ChangeType valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        + + + + + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Enum<TraitDefinition.ChangeType>
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/TraitDefinition.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/TraitDefinition.Provider.html new file mode 100644 index 00000000000..2cfd2ff347b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/TraitDefinition.Provider.html @@ -0,0 +1,348 @@ + + + + + +TraitDefinition.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class TraitDefinition.Provider

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.traits.TraitDefinition.Provider
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      TraitService
      +
      +
      +
      Enclosing class:
      +
      TraitDefinition
      +
      +
      +
      public static final class TraitDefinition.Provider
+extends java.lang.Object
+implements TraitService
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getShapeId

          +
          public ShapeId getShapeId()
          +
          +
          Specified by:
          +
          getShapeId in interface TraitService
          +
          Returns:
          +
          Gets the shape ID of the trait that this provider created.
          +
          +
          • +
        + + + +
          +
        • +

          createTrait

          +
          public TraitDefinition createTrait​(ShapeId target,
+                                   Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Specified by:
          +
          createTrait in interface TraitService
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/TraitDefinition.StructurallyExclusive.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/TraitDefinition.StructurallyExclusive.html new file mode 100644 index 00000000000..941fcf77f0e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/TraitDefinition.StructurallyExclusive.html @@ -0,0 +1,444 @@ + + + + + +TraitDefinition.StructurallyExclusive (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Enum TraitDefinition.StructurallyExclusive

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static TraitDefinition.StructurallyExclusive[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (TraitDefinition.StructurallyExclusive c : TraitDefinition.StructurallyExclusive.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static TraitDefinition.StructurallyExclusive valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        + + + + + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/TraitDefinition.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/TraitDefinition.html new file mode 100644 index 00000000000..1baa00b694d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/TraitDefinition.html @@ -0,0 +1,625 @@ + + + + + +TraitDefinition (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class TraitDefinition

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + +
          +
        • +

          getSelector

          +
          public Selector getSelector()
          +
          Gets the valid places in a model that this trait can be applied.
          +
          +
          Returns:
          +
          Returns the trait selector.
          +
          +
          • +
        + + + +
          +
        • +

          getConflicts

          +
          public java.util.List<ShapeId> getConflicts()
          +
          Gets the trait names that conflict with this trait.
          +
          +
          Returns:
          +
          Returns the conflicting trait names.
          +
          +
          • +
        + + + +
          +
        • +

          getStructurallyExclusive

          +
          public java.util.Optional<TraitDefinition.StructurallyExclusive> getStructurallyExclusive()
          +
          Gets the structurallyExclusive property of the trait.
          +
          +
          Returns:
          +
          Returns the structurallyExclusive property of the trait.
          +
          +
          • +
        + + + +
          +
        • +

          isStructurallyExclusiveByMember

          +
          public boolean isStructurallyExclusiveByMember()
          +
          +
          Returns:
          +
          Returns true if the trait is structurallyExclusive by member.
          +
          +
          • +
        + + + +
          +
        • +

          isStructurallyExclusiveByTarget

          +
          public boolean isStructurallyExclusiveByTarget()
          +
          +
          Returns:
          +
          Returns true if the trait is structurallyExclusive by target.
          +
          +
          • +
        + + + +
          +
        • +

          getBreakingChanges

          +
          public java.util.List<TraitDefinition.BreakingChangeRule> getBreakingChanges()
          +
          +
          Returns:
          +
          Returns the breaking change rules of the trait.
          +
          +
          • +
        + + + +
          +
        • +

          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.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object other)
          +
          +
          Overrides:
          +
          equals in class AbstractTrait
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/TraitFactory.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/TraitFactory.html new file mode 100644 index 00000000000..de819ab6850 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/TraitFactory.html @@ -0,0 +1,343 @@ + + + + + +TraitFactory (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Interface TraitFactory

    +
    +
    +
    +
      +
    • +
      +
      Functional Interface:
      +
      This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
      +
      +
      +
      @FunctionalInterface
+public interface TraitFactory
      +
      Creates traits using trait data from a model.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          java.util.Optional<Trait> createTrait​(ShapeId id,
+                                      ShapeId target,
+                                      Node value)
          +
          Creates and configures a trait using model trait data.
          +
          +
          Parameters:
          +
          id - Shape ID of the trait.
          +
          target - Shape that the trait is applied on.
          +
          value - The Node value of the trait.
          +
          Returns:
          +
          Returns the created trait wrapped in an Optional.
          +
          Throws:
          +
          SourceException - on configuration error.
          +
          java.lang.RuntimeException - if an error occurs while creating the trait.
          +
          +
          • +
        + + + +
          +
        • +

          createServiceFactory

          +
          static TraitFactory createServiceFactory​(java.lang.Iterable<TraitService> services)
          +
          Creates a TraitFactory that uses a List of TraitService provider instances.
          +
          +
          Parameters:
          +
          services - List of TraitService provider instances.
          +
          Returns:
          +
          Returns the created TraitFactory.
          +
          +
          • +
        + + + +
          +
        • +

          createServiceFactory

          +
          static TraitFactory createServiceFactory()
          +
          Creates a TraitFactory that discovers TraitService providers using + the Thread context class loader.
          +
          +
          Returns:
          +
          Returns the created TraitFactory.
          +
          +
          • +
        + + + +
          +
        • +

          createServiceFactory

          +
          static TraitFactory createServiceFactory​(java.lang.ClassLoader classLoader)
          +
          Creates a TraitFactory that discovers TraitService providers using + the given ClassLoader.
          +
          +
          Parameters:
          +
          classLoader - Class loader used to find TraitService providers.
          +
          Returns:
          +
          Returns the created TraitFactory.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/TraitService.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/TraitService.html new file mode 100644 index 00000000000..39b4298a75e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/TraitService.html @@ -0,0 +1,288 @@ + + + + + +TraitService (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Interface TraitService

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getShapeId

          +
          ShapeId getShapeId()
          +
          +
          Returns:
          +
          Gets the shape ID of the trait that this provider created.
          +
          +
          • +
        + + + +
          +
        • +

          createTrait

          +
          Trait createTrait​(ShapeId target,
+                  Node value)
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/TraitValidatorsTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/TraitValidatorsTrait.Builder.html new file mode 100644 index 00000000000..586483a8c05 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/TraitValidatorsTrait.Builder.html @@ -0,0 +1,324 @@ + + + + + +TraitValidatorsTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class TraitValidatorsTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/TraitValidatorsTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/TraitValidatorsTrait.Provider.html new file mode 100644 index 00000000000..4893e5efe9d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/TraitValidatorsTrait.Provider.html @@ -0,0 +1,348 @@ + + + + + +TraitValidatorsTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class TraitValidatorsTrait.Provider

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.traits.TraitValidatorsTrait.Provider
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getShapeId

          +
          public ShapeId getShapeId()
          +
          +
          Specified by:
          +
          getShapeId in interface TraitService
          +
          Returns:
          +
          Gets the shape ID of the trait that this provider created.
          +
          +
          • +
        + + + +
          +
        • +

          createTrait

          +
          public TraitValidatorsTrait createTrait​(ShapeId target,
+                                        Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Specified by:
          +
          createTrait in interface TraitService
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/TraitValidatorsTrait.Validator.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/TraitValidatorsTrait.Validator.html new file mode 100644 index 00000000000..504ad8ea07e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/TraitValidatorsTrait.Validator.html @@ -0,0 +1,434 @@ + + + + + +TraitValidatorsTrait.Validator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class TraitValidatorsTrait.Validator

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.traits.TraitValidatorsTrait.Validator
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ToNode
      +
      +
      +
      Enclosing class:
      +
      TraitValidatorsTrait
      +
      +
      +
      public static final class TraitValidatorsTrait.Validator
+extends java.lang.Object
+implements ToNode
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Validator

          +
          public Validator​(Selector selector,
+                 java.lang.String message)
          +
          • +
        + + + +
          +
        • +

          Validator

          +
          public Validator​(Selector selector,
+                 java.lang.String message,
+                 Severity severity)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          getSelector

          +
          public Selector getSelector()
          +
          • +
        + + + +
          +
        • +

          getMessage

          +
          public java.util.Optional<java.lang.String> getMessage()
          +
          • +
        + + + +
          +
        • +

          getSeverity

          +
          public Severity getSeverity()
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/TraitValidatorsTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/TraitValidatorsTrait.html new file mode 100644 index 00000000000..bf8ae756d20 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/TraitValidatorsTrait.html @@ -0,0 +1,437 @@ + + + + + +TraitValidatorsTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class TraitValidatorsTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          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.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getValidators

          +
          public java.util.Map<java.lang.String,​TraitValidatorsTrait.Validator> getValidators()
          +
          Get a map of ID suffixes to validators.
          +
          +
          Returns:
          +
          Returns an unmodifiable map.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/UniqueItemsTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/UniqueItemsTrait.Provider.html new file mode 100644 index 00000000000..9db5a77388e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/UniqueItemsTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +UniqueItemsTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class UniqueItemsTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/UniqueItemsTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/UniqueItemsTrait.html new file mode 100644 index 00000000000..729fc110969 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/UniqueItemsTrait.html @@ -0,0 +1,368 @@ + + + + + +UniqueItemsTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class UniqueItemsTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          UniqueItemsTrait

          +
          public UniqueItemsTrait()
          +
          • +
        + + + +
          +
        • +

          UniqueItemsTrait

          +
          public UniqueItemsTrait​(SourceLocation sourceLocation)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/UnitTypeTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/UnitTypeTrait.Provider.html new file mode 100644 index 00000000000..2bfcb9e2a81 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/UnitTypeTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +UnitTypeTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class UnitTypeTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/UnitTypeTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/UnitTypeTrait.html new file mode 100644 index 00000000000..cf8aa94423c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/UnitTypeTrait.html @@ -0,0 +1,387 @@ + + + + + +UnitTypeTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class UnitTypeTrait

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static class UnitTypeTrait.Provider 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        static ShapeIdID +
        The unitType shape ID.
        +
        static ShapeIdUNIT +
        The shape ID of the built-in Unit type that uses this trait.
        +
        +
        • +
      +
      + +
      + +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          The unitType shape ID.
          +
          • +
        + + + +
          +
        • +

          UNIT

          +
          public static final ShapeId UNIT
          +
          The shape ID of the built-in Unit type that uses this trait.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          UnitTypeTrait

          +
          public UnitTypeTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          UnitTypeTrait

          +
          public UnitTypeTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/UnstableTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/UnstableTrait.Provider.html new file mode 100644 index 00000000000..c227967cc47 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/UnstableTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +UnstableTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class UnstableTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/UnstableTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/UnstableTrait.html new file mode 100644 index 00000000000..d4153a66397 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/UnstableTrait.html @@ -0,0 +1,368 @@ + + + + + +UnstableTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class UnstableTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          UnstableTrait

          +
          public UnstableTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          UnstableTrait

          +
          public UnstableTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/XmlAttributeTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/XmlAttributeTrait.Provider.html new file mode 100644 index 00000000000..8736d8c3a6c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/XmlAttributeTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +XmlAttributeTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class XmlAttributeTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/XmlAttributeTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/XmlAttributeTrait.html new file mode 100644 index 00000000000..61751a5c187 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/XmlAttributeTrait.html @@ -0,0 +1,368 @@ + + + + + +XmlAttributeTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class XmlAttributeTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          XmlAttributeTrait

          +
          public XmlAttributeTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          XmlAttributeTrait

          +
          public XmlAttributeTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/XmlFlattenedTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/XmlFlattenedTrait.Provider.html new file mode 100644 index 00000000000..f11fd354ad5 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/XmlFlattenedTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +XmlFlattenedTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class XmlFlattenedTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/XmlFlattenedTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/XmlFlattenedTrait.html new file mode 100644 index 00000000000..a5625d13efd --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/XmlFlattenedTrait.html @@ -0,0 +1,367 @@ + + + + + +XmlFlattenedTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class XmlFlattenedTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          XmlFlattenedTrait

          +
          public XmlFlattenedTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          XmlFlattenedTrait

          +
          public XmlFlattenedTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/XmlNameTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/XmlNameTrait.Provider.html new file mode 100644 index 00000000000..a538b976795 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/XmlNameTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +XmlNameTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class XmlNameTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/XmlNameTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/XmlNameTrait.html new file mode 100644 index 00000000000..fa715b05ffb --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/XmlNameTrait.html @@ -0,0 +1,383 @@ + + + + + +XmlNameTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class XmlNameTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          XmlNameTrait

          +
          public XmlNameTrait​(java.lang.String value,
+                    SourceLocation sourceLocation)
          +
          • +
        + + + +
          +
        • +

          XmlNameTrait

          +
          public XmlNameTrait​(java.lang.String value)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/XmlNamespaceTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/XmlNamespaceTrait.Builder.html new file mode 100644 index 00000000000..d5c6a3e72f6 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/XmlNamespaceTrait.Builder.html @@ -0,0 +1,323 @@ + + + + + +XmlNamespaceTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class XmlNamespaceTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/XmlNamespaceTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/XmlNamespaceTrait.Provider.html new file mode 100644 index 00000000000..a197ed0fedd --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/XmlNamespaceTrait.Provider.html @@ -0,0 +1,348 @@ + + + + + +XmlNamespaceTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class XmlNamespaceTrait.Provider

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.traits.XmlNamespaceTrait.Provider
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getShapeId

          +
          public ShapeId getShapeId()
          +
          +
          Specified by:
          +
          getShapeId in interface TraitService
          +
          Returns:
          +
          Gets the shape ID of the trait that this provider created.
          +
          +
          • +
        + + + +
          +
        • +

          createTrait

          +
          public XmlNamespaceTrait createTrait​(ShapeId target,
+                                     Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Specified by:
          +
          createTrait in interface TraitService
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/XmlNamespaceTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/XmlNamespaceTrait.html new file mode 100644 index 00000000000..56207565b11 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/XmlNamespaceTrait.html @@ -0,0 +1,445 @@ + + + + + +XmlNamespaceTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits
    +

    Class XmlNamespaceTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getUri

          +
          public java.lang.String getUri()
          +
          • +
        + + + +
          +
        • +

          getPrefix

          +
          public java.util.Optional<java.lang.String> getPrefix()
          +
          • +
        + + + +
          +
        • +

          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.
          +
          +
          • +
        + + + +
          +
        • +

          builder

          +
          public static XmlNamespaceTrait.Builder builder()
          +
          +
          Returns:
          +
          Returns a builder used to create an XmlNamespace trait.
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/package-summary.html new file mode 100644 index 00000000000..9d1c8b44f0a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/package-summary.html @@ -0,0 +1,1266 @@ + + + + + +software.amazon.smithy.model.traits (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.model.traits

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/package-tree.html new file mode 100644 index 00000000000..31a91354bed --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/package-tree.html @@ -0,0 +1,433 @@ + + + + + +software.amazon.smithy.model.traits Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.model.traits

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +

    Enum Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/synthetic/NoAuthTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/synthetic/NoAuthTrait.html new file mode 100644 index 00000000000..b029fee9e44 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/synthetic/NoAuthTrait.html @@ -0,0 +1,398 @@ + + + + + +NoAuthTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits.synthetic
    +

    Class NoAuthTrait

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        static ShapeIdID 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        NoAuthTrait() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        booleanisSynthetic() +
        Checks if this trait is persisted with the shape, or if it is a + synthetic, or transient trait, only meant to temporarily aid in + some kind of in-memory model transformation.
        +
        + +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          NoAuthTrait

          +
          public NoAuthTrait()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          isSynthetic

          +
          public boolean isSynthetic()
          +
          Description copied from interface: Trait
          +
          Checks if this trait is persisted with the shape, or if it is a + synthetic, or transient trait, only meant to temporarily aid in + some kind of in-memory model transformation. + +

          Because synthetic traits are not persisted with shapes, they also + do not need to be defined in Smithy's semantic model before they can + be used in the model.

          +
          +
          Returns:
          +
          Returns true if the trait is not persisted on the shape.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/synthetic/OriginalShapeIdTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/synthetic/OriginalShapeIdTrait.html new file mode 100644 index 00000000000..dc60538f1ee --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/synthetic/OriginalShapeIdTrait.html @@ -0,0 +1,447 @@ + + + + + +OriginalShapeIdTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits.synthetic
    +

    Class OriginalShapeIdTrait

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      FromSourceLocation, ToNode, ToShapeId, Trait
      +
      +
      +
      public final class OriginalShapeIdTrait
+extends AbstractTrait
      +
      Used to provide the original shape ID of a shape that is renamed + in the semantic model. + +

      This is a synthetic trait that is not defined in the semantic model, + nor is it persisted when the model is serialized.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          OriginalShapeIdTrait

          +
          public OriginalShapeIdTrait​(ShapeId original)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getOriginalId

          +
          public ShapeId getOriginalId()
          +
          Gets the original shape ID of the shape before it was renamed.
          +
          +
          Returns:
          +
          Returns the shape original shape ID.
          +
          +
          • +
        + + + +
          +
        • +

          isSynthetic

          +
          public boolean isSynthetic()
          +
          Description copied from interface: Trait
          +
          Checks if this trait is persisted with the shape, or if it is a + synthetic, or transient trait, only meant to temporarily aid in + some kind of in-memory model transformation. + +

          Because synthetic traits are not persisted with shapes, they also + do not need to be defined in Smithy's semantic model before they can + be used in the model.

          +
          +
          Returns:
          +
          Returns true if the trait is not persisted on the shape.
          +
          +
          • +
        + + + +
          +
        • +

          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.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/synthetic/SyntheticEnumTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/synthetic/SyntheticEnumTrait.Builder.html new file mode 100644 index 00000000000..40a539673e7 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/synthetic/SyntheticEnumTrait.Builder.html @@ -0,0 +1,350 @@ + + + + + +SyntheticEnumTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits.synthetic
    +

    Class SyntheticEnumTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/synthetic/SyntheticEnumTrait.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/synthetic/SyntheticEnumTrait.html new file mode 100644 index 00000000000..11c5b0390e8 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/synthetic/SyntheticEnumTrait.html @@ -0,0 +1,434 @@ + + + + + +SyntheticEnumTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.traits.synthetic
    +

    Class SyntheticEnumTrait

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      FromSourceLocation, ToNode, ToShapeId, Trait, ToSmithyBuilder<EnumTrait>
      +
      +
      +
      public final class SyntheticEnumTrait
+extends EnumTrait
      +
      A synthetic copy of the EnumTrait for use in the EnumShape. + + This exists only to bridge compatibility between IDL 1.0 and 2.0. This + synthetic trait will be applied to enum shapes so that code generators + can treat enum shapes as string shapes with the enum trait. We set synthetic + to true so that it won't get serialized. We change the shape id so that + it doesn't trip up selector validation for the enum trait, which does + not allow targeting enum shapes.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          isSynthetic

          +
          public boolean isSynthetic()
          +
          Description copied from interface: Trait
          +
          Checks if this trait is persisted with the shape, or if it is a + synthetic, or transient trait, only meant to temporarily aid in + some kind of in-memory model transformation. + +

          Because synthetic traits are not persisted with shapes, they also + do not need to be defined in Smithy's semantic model before they can + be used in the model.

          +
          +
          Returns:
          +
          Returns true if the trait is not persisted on the shape.
          +
          +
          • +
        + + + + + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/synthetic/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/synthetic/package-summary.html new file mode 100644 index 00000000000..9d97b1995a8 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/synthetic/package-summary.html @@ -0,0 +1,183 @@ + + + + + +software.amazon.smithy.model.traits.synthetic (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.model.traits.synthetic

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/traits/synthetic/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/model/traits/synthetic/package-tree.html new file mode 100644 index 00000000000..a08328fb1b5 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/traits/synthetic/package-tree.html @@ -0,0 +1,184 @@ + + + + + +software.amazon.smithy.model.traits.synthetic Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.model.traits.synthetic

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/transform/ChangeShapeTypeOption.html b/javadoc/1.47.0/software/amazon/smithy/model/transform/ChangeShapeTypeOption.html new file mode 100644 index 00000000000..f4c8ebae6cd --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/transform/ChangeShapeTypeOption.html @@ -0,0 +1,369 @@ + + + + + +ChangeShapeTypeOption (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.transform
    +

    Enum ChangeShapeTypeOption

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Enum<ChangeShapeTypeOption>
        • +
      • +
          +
        • software.amazon.smithy.model.transform.ChangeShapeTypeOption
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable, java.lang.Comparable<ChangeShapeTypeOption>
      +
      +
      +
      public enum ChangeShapeTypeOption
+extends java.lang.Enum<ChangeShapeTypeOption>
      +
      Options that can be enabled when changing shape types.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        SYNTHESIZE_ENUM_NAMES +
        Enables synthesizing enum names when changing a string shape to an enum shape and the + string shape's EnumTrait doesn't have names.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static ChangeShapeTypeOptionvalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static ChangeShapeTypeOption[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + +
          +
        • +

          SYNTHESIZE_ENUM_NAMES

          +
          public static final ChangeShapeTypeOption SYNTHESIZE_ENUM_NAMES
          +
          Enables synthesizing enum names when changing a string shape to an enum shape and the + string shape's EnumTrait doesn't have names.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static ChangeShapeTypeOption[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (ChangeShapeTypeOption c : ChangeShapeTypeOption.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static ChangeShapeTypeOption valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/transform/ModelTransformException.html b/javadoc/1.47.0/software/amazon/smithy/model/transform/ModelTransformException.html new file mode 100644 index 00000000000..8bd068fec97 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/transform/ModelTransformException.html @@ -0,0 +1,312 @@ + + + + + +ModelTransformException (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.transform
    +

    Class ModelTransformException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Throwable
        • +
      • +
          +
        • java.lang.Exception
          • +
        • +
            +
          • java.lang.RuntimeException
            • +
          • +
              +
            • software.amazon.smithy.model.transform.ModelTransformException
              • +
            +
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      public final class ModelTransformException
+extends java.lang.RuntimeException
      +
      Exception thrown when a model transformation error occurs.
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ModelTransformException

          +
          public ModelTransformException​(java.lang.String message)
          +
          • +
        + + + +
          +
        • +

          ModelTransformException

          +
          public ModelTransformException​(java.lang.String message,
+                               java.lang.Throwable previous)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/transform/ModelTransformer.html b/javadoc/1.47.0/software/amazon/smithy/model/transform/ModelTransformer.html new file mode 100644 index 00000000000..e0bafb31c7f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/transform/ModelTransformer.html @@ -0,0 +1,1399 @@ + + + + + +ModelTransformer (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.transform
    +

    Class ModelTransformer

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.transform.ModelTransformer
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class ModelTransformer
+extends java.lang.Object
      +
      Class used to transform Models.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        ModeladdClientOptional​(Model model, + boolean applyWhenNoDefaultValue) +
        Add the clientOptional trait to members that are effectively nullable because + they are part of a structure marked with the input trait or they aren't required + and don't have a default trait.
        +
        ModelchangeShapeType​(Model model, + java.util.Map<ShapeId,​ShapeType> shapeToType) +
        Changes the type of each given shape.
        +
        ModelchangeShapeType​(Model model, + java.util.Map<ShapeId,​ShapeType> shapeToType, + ChangeShapeTypeOption... changeShapeTypeOptions) +
        Changes the type of each given shape.
        +
        ModelchangeStringEnumsToEnumShapes​(Model model) +
        Changes each compatible string shape with the enum trait to an enum shape.
        +
        ModelchangeStringEnumsToEnumShapes​(Model model, + boolean synthesizeEnumNames) +
        Changes each compatible string shape with the enum trait to an enum shape.
        +
        ModelcopyServiceErrorsToOperations​(Model model, + ServiceShape forService) +
        Copies the errors defined on the given service onto each operation bound to the + service, effectively flattening service error inheritance.
        +
        static ModelTransformercreate() +
        Creates a ModelTransformer using ModelTransformerPlugin instances + discovered using the com.software.smithy.transform class + loader and any modules found in the module path.
        +
        ModelcreateDedicatedInputAndOutput​(Model model, + java.lang.String inputSuffix, + java.lang.String outputSuffix) +
        Updates the model so that every operation has a dedicated input shape marked + with the input trait and output shape marked with the output + trait, and the targeted shapes all have a consistent shape name of + OperationName + inputSuffix / outputSuffix depending on the + context.
        +
        static ModelTransformercreateWithPlugins​(java.util.List<ModelTransformerPlugin> plugins) +
        Creates a ModelTransformer using a list of ModelTransformer plugins.
        +
        static ModelTransformercreateWithServiceProviders​(java.lang.ClassLoader classLoader) +
        Creates a ModelTransformer that finds ModelTransformerPlugin + service providers using the given ClassLoader.
        +
        ModeldeconflictErrorsWithSharedStatusCode​(Model model, + ServiceShape forService) +
        Deconflicts errors that share a status code.
        +
        ModeldowngradeEnums​(Model model) +
        Changes each enum shape to a string shape and each intEnum to an integer.
        +
        ModeldowngradeToV1​(Model model) +
        Removes Smithy IDL 2.0 features from a model that are not strictly necessary to keep for consistency with the + rest of Smithy.
        +
        ModelfilterMetadata​(Model model, + java.util.function.BiPredicate<java.lang.String,​Node> predicate) +
        Filters out metadata key-value pairs from a model that do not match + a predicate.
        +
        ModelfilterShapes​(Model model, + java.util.function.Predicate<Shape> predicate) +
        Filters shapes out of the model that do not match the given predicate.
        +
        ModelfilterTraits​(Model model, + java.util.function.BiPredicate<Shape,​Trait> predicate) +
        Filters traits out of the model that do not match the given predicate.
        +
        ModelflattenAndRemoveMixins​(Model model) +
        Flattens mixins out of the model and removes them from the model.
        +
        ModelgetModelWithoutTraitShapes​(Model model) +
        Gets all shapes from a model where shapes that define traits or shapes + that are only used as part of a trait definition have been removed.
        +
        ModelgetModelWithoutTraitShapes​(Model model, + java.util.function.Predicate<Shape> keepFilter) +
        Gets all shapes from a model where shapes that define traits or shapes + that are only used as part of a trait definition have been removed.
        +
        ModelmapShapes​(Model model, + java.util.function.Function<Shape,​Shape> mapper) +
        Maps over all shapes in the model using a mapping function, allowing + shapes to be replaced with completely different shapes or slightly + modified shapes.
        +
        ModelmapShapes​(Model model, + java.util.List<java.util.function.Function<Shape,​Shape>> mappers) +
        Maps over all shapes in the model using multiple mapping functions.
        +
        ModelmapTraits​(Model model, + java.util.function.BiFunction<Shape,​Trait,​Trait> mapper) +
        Maps over all traits in the model using a mapping function that accepts + the shape the trait is applied to, a trait, and returns a trait, + possibly even a different kind of trait.
        +
        ModelmapTraits​(Model model, + java.util.List<java.util.function.BiFunction<Shape,​Trait,​Trait>> mappers) +
        Maps over all traits in the model using multiple mapping functions.
        +
        ModelremoveInvalidDefaults​(Model model) +
        Remove default traits if the default conflicts with the range trait of the shape.
        +
        ModelremoveShapes​(Model model, + java.util.Collection<? extends Shape> shapes) +
        Removes shapes from the model while ensuring that the model is in a + consistent state.
        +
        ModelremoveShapesIf​(Model model, + java.util.function.Predicate<Shape> predicate) +
        Removes shapes from the model that match the given predicate.
        +
        ModelremoveTraitsIf​(Model model, + java.util.function.BiPredicate<Shape,​Trait> predicate) +
        Filters traits out of the model that match a predicate function.
        +
        ModelremoveUnreferencedShapes​(Model model) +
        Removes shapes (excluding service shapes) that are not referenced by + any other shapes.
        +
        ModelremoveUnreferencedShapes​(Model model, + java.util.function.Predicate<Shape> keepFilter) +
        Removes shapes (excluding service shapes) that are not referenced by + any other shapes.
        +
        ModelremoveUnreferencedTraitDefinitions​(Model model) +
        Removes definitions for traits that are not used by any shape in the + model.base.
        +
        ModelremoveUnreferencedTraitDefinitions​(Model model, + java.util.function.Predicate<Shape> keepFilter) +
        Removes trait definitions for traits that are not used by any shape + in the model.
        +
        ModelrenameShapes​(Model model, + java.util.Map<ShapeId,​ShapeId> renamed) +
        Renames shapes using ShapeId pairs while ensuring that the + transformed model is in a consistent state.
        +
        ModelrenameShapes​(Model model, + java.util.Map<ShapeId,​ShapeId> renamed, + java.util.function.Supplier<ModelAssembler> modelAssemblerSupplier) +
        Renames shapes using ShapeId pairs while ensuring that the + transformed model is in a consistent state.
        +
        ModelreplaceShapes​(Model model, + java.util.Collection<? extends Shape> shapes) +
        Adds or replaces shapes into the model while ensuring that the model + is in a consistent state.
        +
        ModelscrubTraitDefinitions​(Model model) +
        Removes all trait definitions from a model and all shapes that are + only connected to the graph either directly or transitively by a + trait definition shape.
        +
        ModelscrubTraitDefinitions​(Model model, + java.util.function.Predicate<Shape> keepFilter) +
        Removes trait definitions from a model and all shapes that are + only connected to the graph either directly or transitively by a + trait definition shape.
        +
        ModelsortMembers​(Model model, + java.util.Comparator<MemberShape> comparator) +
        Reorders the members of structure and union shapes using the given + Comparator.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + +
          +
        • +

          create

          +
          public static ModelTransformer create()
          +
          Creates a ModelTransformer using ModelTransformerPlugin instances + discovered using the com.software.smithy.transform class + loader and any modules found in the module path.
          +
          +
          Returns:
          +
          Returns the created ModelTransformer.
          +
          +
          • +
        + + + +
          +
        • +

          createWithPlugins

          +
          public static ModelTransformer createWithPlugins​(java.util.List<ModelTransformerPlugin> plugins)
          +
          Creates a ModelTransformer using a list of ModelTransformer plugins.
          +
          +
          Parameters:
          +
          plugins - Plugins to use with the transformer.
          +
          Returns:
          +
          Returns the created ModelTransformer.
          +
          +
          • +
        + + + +
          +
        • +

          createWithServiceProviders

          +
          public static ModelTransformer createWithServiceProviders​(java.lang.ClassLoader classLoader)
          +
          Creates a ModelTransformer that finds ModelTransformerPlugin + service providers using the given ClassLoader.
          +
          +
          Parameters:
          +
          classLoader - ClassLoader used to find ModelTransformerPlugin instances.
          +
          Returns:
          +
          Returns the created ModelTransformer.
          +
          +
          • +
        + + + +
          +
        • +

          replaceShapes

          +
          public Model replaceShapes​(Model model,
+                           java.util.Collection<? extends Shape> shapes)
          +
          Adds or replaces shapes into the model while ensuring that the model + is in a consistent state.
          +
          +
          Parameters:
          +
          model - Model to transform.
          +
          shapes - Shapes to add or replace in the model.base.
          +
          Returns:
          +
          Returns the transformed model.base.
          +
          +
          • +
        + + + +
          +
        • +

          removeShapes

          +
          public Model removeShapes​(Model model,
+                          java.util.Collection<? extends Shape> shapes)
          +
          Removes shapes from the model while ensuring that the model is in a + consistent state.
          +
          +
          Parameters:
          +
          model - Model to transform.
          +
          shapes - Shapes to add or replace in the model.base.
          +
          Returns:
          +
          Returns the transformed model.base.
          +
          +
          • +
        + + + +
          +
        • +

          removeShapesIf

          +
          public Model removeShapesIf​(Model model,
+                            java.util.function.Predicate<Shape> predicate)
          +
          Removes shapes from the model that match the given predicate.
          +
          +
          Parameters:
          +
          model - Model to transform.
          +
          predicate - Predicate that accepts a shape and returns true to + remove it.
          +
          Returns:
          +
          Returns the transformed model.base.
          +
          +
          • +
        + + + +
          +
        • +

          renameShapes

          +
          public Model renameShapes​(Model model,
+                          java.util.Map<ShapeId,​ShapeId> renamed)
          +
          Renames shapes using ShapeId pairs while ensuring that the + transformed model is in a consistent state. + +

          This transformer ensures that when an aggregate shape is renamed, all + members are updated in the model.

          +
          +
          Parameters:
          +
          model - Model to transform.
          +
          renamed - Map of shapeIds
          +
          Returns:
          +
          Returns the transformed model.base.
          +
          +
          • +
        + + + +
          +
        • +

          renameShapes

          +
          public Model renameShapes​(Model model,
+                          java.util.Map<ShapeId,​ShapeId> renamed,
+                          java.util.function.Supplier<ModelAssembler> modelAssemblerSupplier)
          +
          Renames shapes using ShapeId pairs while ensuring that the + transformed model is in a consistent state. + +

          This transformer ensures that when an aggregate shape is renamed, all + members are updated in the model.

          +
          +
          Parameters:
          +
          model - Model to transform.
          +
          renamed - Map of shapeIds
          +
          modelAssemblerSupplier - Supplier used to create ModelAssemblers in each transform.
          +
          Returns:
          +
          Returns the transformed model.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          filterTraits

          +
          public Model filterTraits​(Model model,
+                          java.util.function.BiPredicate<Shape,​Trait> predicate)
          +
          Filters traits out of the model that do not match the given predicate. + +

          The predicate function accepts the shape that a trait is attached to + and the trait. If the predicate returns false, then the trait is + removed from the shape.

          +
          +
          Parameters:
          +
          model - Model to transform.
          +
          predicate - Predicate that accepts a (Shape, Trait) and returns + false if the trait should be removed.
          +
          Returns:
          +
          Returns the transformed model.base.
          +
          +
          • +
        + + + +
          +
        • +

          removeTraitsIf

          +
          public Model removeTraitsIf​(Model model,
+                            java.util.function.BiPredicate<Shape,​Trait> predicate)
          +
          Filters traits out of the model that match a predicate function. + +

          The predicate function accepts the shape that a trait is attached to + and the trait. If the predicate returns true, then the trait is removed + from the shape.

          +
          +
          Parameters:
          +
          model - Model to transform.
          +
          predicate - Predicate that accepts a (Shape, Trait) and returns + true if the trait should be removed.
          +
          Returns:
          +
          Returns the transformed model.base.
          +
          +
          • +
        + + + +
          +
        • +

          filterMetadata

          +
          public Model filterMetadata​(Model model,
+                            java.util.function.BiPredicate<java.lang.String,​Node> predicate)
          +
          Filters out metadata key-value pairs from a model that do not match + a predicate.
          +
          +
          Parameters:
          +
          model - Model to transform.
          +
          predicate - A predicate that accepts a metadata key-value pair. + If the predicate returns true, then the metadata key-value pair is + kept. Otherwise, it is removed.
          +
          Returns:
          +
          Returns the transformed model.base.
          +
          +
          • +
        + + + +
          +
        • +

          mapTraits

          +
          public Model mapTraits​(Model model,
+                       java.util.function.BiFunction<Shape,​Trait,​Trait> mapper)
          +
          Maps over all traits in the model using a mapping function that accepts + the shape the trait is applied to, a trait, and returns a trait, + possibly even a different kind of trait. + +

          An exception is thrown if a trait is returned that targets a + different shape than the Shape passed into the mapper function.

          +
          +
          Parameters:
          +
          model - Model to transform.
          +
          mapper - Mapping function that accepts a (Shape, Trait) and returns + the mapped Trait.
          +
          Returns:
          +
          Returns the transformed model.base.
          +
          +
          • +
        + + + +
          +
        • +

          mapTraits

          +
          public Model mapTraits​(Model model,
+                       java.util.List<java.util.function.BiFunction<Shape,​Trait,​Trait>> mappers)
          +
          Maps over all traits in the model using multiple mapping functions. + +

          Note: passing in a list of mappers is much more efficient than + invoking mapTraits multiple times because it reduces the number + of intermediate models that are needed to perform the transformation.

          +
          +
          Parameters:
          +
          model - Model to transform.
          +
          mappers - Mapping functions that accepts a (Shape, Trait) and + returns the mapped Trait.
          +
          Returns:
          +
          Returns the transformed model.base.
          +
          See Also:
          +
          for more information.
          +
          +
          • +
        + + + +
          +
        • +

          mapShapes

          +
          public Model mapShapes​(Model model,
+                       java.util.function.Function<Shape,​Shape> mapper)
          +
          Maps over all shapes in the model using a mapping function, allowing + shapes to be replaced with completely different shapes or slightly + modified shapes. + +

          An exception is thrown if a mapper returns a shape with a different + shape ID or a different type.

          +
          +
          Parameters:
          +
          model - Model to transform.
          +
          mapper - Mapping function that accepts a shape and returns a shape + with the same ID.
          +
          Returns:
          +
          Returns the transformed model.base.
          +
          +
          • +
        + + + +
          +
        • +

          mapShapes

          +
          public Model mapShapes​(Model model,
+                       java.util.List<java.util.function.Function<Shape,​Shape>> mappers)
          +
          Maps over all shapes in the model using multiple mapping functions. + +

          Note: passing in a list of mappers is much more efficient than + invoking mapShapes multiple times because it reduces the + number of intermediate models that are needed to perform the + transformation.

          +
          +
          Parameters:
          +
          model - Model to transform.
          +
          mappers - Mapping functions that accepts a shape and returns a + shape with the same ID.
          +
          Returns:
          +
          Returns the transformed model.base.
          +
          See Also:
          +
          for more information.
          +
          +
          • +
        + + + +
          +
        • +

          removeUnreferencedShapes

          +
          public Model removeUnreferencedShapes​(Model model)
          +
          Removes shapes (excluding service shapes) that are not referenced by + any other shapes.
          +
          +
          Parameters:
          +
          model - Model to transform.
          +
          Returns:
          +
          Returns the transformed model.base.
          +
          +
          • +
        + + + +
          +
        • +

          removeUnreferencedShapes

          +
          public Model removeUnreferencedShapes​(Model model,
+                                      java.util.function.Predicate<Shape> keepFilter)
          +
          Removes shapes (excluding service shapes) that are not referenced by + any other shapes. + + Shapes that are part of the prelude or that act as the shape of any + trait, regardless of if the trait is in use in the model, are never + considered unreferenced.
          +
          +
          Parameters:
          +
          model - Model to transform.
          +
          keepFilter - Predicate function that accepts an unreferenced + shape and returns true to remove the shape or false to keep the shape + in the model.base.
          +
          Returns:
          +
          Returns the transformed model.base.
          +
          +
          • +
        + + + +
          +
        • +

          removeUnreferencedTraitDefinitions

          +
          public Model removeUnreferencedTraitDefinitions​(Model model)
          +
          Removes definitions for traits that are not used by any shape in the + model.base. + + Trait definitions that are part of the prelude will not be removed.
          +
          +
          Parameters:
          +
          model - Model to transform
          +
          Returns:
          +
          Returns the transformed model.base.
          +
          +
          • +
        + + + +
          +
        • +

          removeUnreferencedTraitDefinitions

          +
          public Model removeUnreferencedTraitDefinitions​(Model model,
+                                                java.util.function.Predicate<Shape> keepFilter)
          +
          Removes trait definitions for traits that are not used by any shape + in the model. + +

          Trait definitions that are part of the prelude will not be removed.

          +
          +
          Parameters:
          +
          model - Model to transform
          +
          keepFilter - Predicate function that accepts an unreferenced trait + shape (that has the TraitDefinition trait) and returns true to + remove the definition or false to keep the definition in the model.base.
          +
          Returns:
          +
          Returns the transformed model.base.
          +
          +
          • +
        + + + +
          +
        • +

          scrubTraitDefinitions

          +
          public Model scrubTraitDefinitions​(Model model)
          +
          Removes all trait definitions from a model and all shapes that are + only connected to the graph either directly or transitively by a + trait definition shape. + +

          This can be useful when serializing a Smithy model to a format that + does not include trait definitions and the shapes used by trait definitions + would have no meaning (e.g., OpenAPI).

          +
          +
          Parameters:
          +
          model - Model to transform.
          +
          Returns:
          +
          Returns the transformed model.base.
          +
          +
          • +
        + + + +
          +
        • +

          scrubTraitDefinitions

          +
          public Model scrubTraitDefinitions​(Model model,
+                                   java.util.function.Predicate<Shape> keepFilter)
          +
          Removes trait definitions from a model and all shapes that are + only connected to the graph either directly or transitively by a + trait definition shape. + +

          This can be useful when serializing a Smithy model to a format that + does not include trait definitions and the shapes used by trait definitions + would have no meaning (e.g., OpenAPI).

          +
          +
          Parameters:
          +
          model - Model to transform.
          +
          keepFilter - Predicate function that accepts an trait shape (that + has the TraitDefinition trait) and returns true to remove the + definition or false to keep the definition in the model.
          +
          Returns:
          +
          Returns the transformed model.
          +
          +
          • +
        + + + +
          +
        • +

          getModelWithoutTraitShapes

          +
          public Model getModelWithoutTraitShapes​(Model model)
          +
          Gets all shapes from a model where shapes that define traits or shapes + that are only used as part of a trait definition have been removed.
          +
          +
          Parameters:
          +
          model - Model that contains shapes.
          +
          Returns:
          +
          Returns a model that contains matching shapes.
          +
          +
          • +
        + + + +
          +
        • +

          getModelWithoutTraitShapes

          +
          public Model getModelWithoutTraitShapes​(Model model,
+                                        java.util.function.Predicate<Shape> keepFilter)
          +
          Gets all shapes from a model where shapes that define traits or shapes + that are only used as part of a trait definition have been removed.
          +
          +
          Parameters:
          +
          model - Model that contains shapes.
          +
          keepFilter - Predicate function that accepts a trait shape (that + has the TraitDefinition trait) and returns true to remove the + definition or false to keep the definition in the model.
          +
          Returns:
          +
          Returns a model that contains matching shapes.
          +
          +
          • +
        + + + +
          +
        • +

          sortMembers

          +
          public Model sortMembers​(Model model,
+                         java.util.Comparator<MemberShape> comparator)
          +
          Reorders the members of structure and union shapes using the given + Comparator. + +

          Note that by default, Smithy models retain the order in which + members are defined in the model. However, in programming languages + where this isn't important, it may be desirable to order members + alphabetically or using some other kind of order.

          +
          +
          Parameters:
          +
          model - Model that contains shapes.
          +
          comparator - Comparator used to order members of unions and structures.
          +
          Returns:
          +
          Returns a model that contains matching shapes.
          +
          +
          • +
        + + + +
          +
        • +

          changeShapeType

          +
          public Model changeShapeType​(Model model,
+                             java.util.Map<ShapeId,​ShapeType> shapeToType)
          +
          Changes the type of each given shape. + +

          The following transformations are permitted: + +

            +
          • Any simple type to any simple type
            • +
          • List to set
            • +
          • Set to list
            • +
          • Structure to union
            • +
          • Union to structure
            • +
          +
          +
          Parameters:
          +
          model - Model to transform.
          +
          shapeToType - Map of shape IDs to the new type to use for the shape.
          +
          Returns:
          +
          Returns the transformed model.
          +
          Throws:
          +
          ModelTransformException - if an incompatible type transform is attempted.
          +
          +
          • +
        + + + +
          +
        • +

          changeShapeType

          +
          public Model changeShapeType​(Model model,
+                             java.util.Map<ShapeId,​ShapeType> shapeToType,
+                             ChangeShapeTypeOption... changeShapeTypeOptions)
          +
          Changes the type of each given shape. + +

          The following transformations are permitted: + +

            +
          • Any simple type to any simple type
            • +
          • List to set
            • +
          • Set to list
            • +
          • Structure to union
            • +
          • Union to structure
            • +
          +
          +
          Parameters:
          +
          model - Model to transform.
          +
          shapeToType - Map of shape IDs to the new type to use for the shape.
          +
          changeShapeTypeOptions - An array of options to enable when changing types.
          +
          Returns:
          +
          Returns the transformed model.
          +
          Throws:
          +
          ModelTransformException - if an incompatible type transform is attempted.
          +
          +
          • +
        + + + +
          +
        • +

          changeStringEnumsToEnumShapes

          +
          public Model changeStringEnumsToEnumShapes​(Model model,
+                                           boolean synthesizeEnumNames)
          +
          Changes each compatible string shape with the enum trait to an enum shape. + +

          A member will be created on the shape for each entry in the EnumTrait. + +

          When the enum definition from the enum trait has been marked as deprecated, or + tagged as "internal", the corresponding enum shape member will be marked with the + DeprecatedTrait or InternalTrait accordingly.

          +
          +
          Parameters:
          +
          model - Model to transform.
          +
          synthesizeEnumNames - Whether enums without names should have names synthesized if possible.
          +
          Returns:
          +
          Returns the transformed model.
          +
          +
          • +
        + + + +
          +
        • +

          changeStringEnumsToEnumShapes

          +
          public Model changeStringEnumsToEnumShapes​(Model model)
          +
          Changes each compatible string shape with the enum trait to an enum shape. + +

          A member will be created on the shape for each entry in the EnumTrait. + +

          Strings with enum traits that don't define names are not converted.

          +
          +
          Parameters:
          +
          model - Model to transform.
          +
          Returns:
          +
          Returns the transformed model.
          +
          +
          • +
        + + + +
          +
        • +

          downgradeEnums

          +
          public Model downgradeEnums​(Model model)
          +
          Changes each enum shape to a string shape and each intEnum to an integer.
          +
          +
          Parameters:
          +
          model - Model to transform.
          +
          Returns:
          +
          Returns the transformed model.
          +
          +
          • +
        + + + +
          +
        • +

          copyServiceErrorsToOperations

          +
          public Model copyServiceErrorsToOperations​(Model model,
+                                           ServiceShape forService)
          +
          Copies the errors defined on the given service onto each operation bound to the + service, effectively flattening service error inheritance.
          +
          +
          Parameters:
          +
          model - Model to modify.
          +
          forService - Service shape to use as the basis for copying errors to operations.
          +
          Returns:
          +
          Returns the transformed model.
          +
          +
          • +
        + + + +
          +
        • +

          createDedicatedInputAndOutput

          +
          public Model createDedicatedInputAndOutput​(Model model,
+                                           java.lang.String inputSuffix,
+                                           java.lang.String outputSuffix)
          +
          Updates the model so that every operation has a dedicated input shape marked + with the input trait and output shape marked with the output + trait, and the targeted shapes all have a consistent shape name of + OperationName + inputSuffix / outputSuffix depending on the + context. + +

          If an operation's input already targets a shape marked with the input + trait, then the existing input shape is used as input, though the shape will + be renamed if it does not use the given inputSuffix. If an operation's + output already targets a shape marked with the output trait, then the + existing output shape is used as output, though the shape will be renamed if it + does not use the given outputSuffix. + +

          If the operation's input shape starts with the name of the operation and is + only used throughout the model as the input of the operation, then it is updated + to have the input trait, and the name remains unaltered. + +

          If the operation's output shape starts with the name of the operation and is + only used throughout the model as the output of the operation, then it is updated + to have the output trait, and the name remains unaltered. + +

          If the operation's input shape does not start with the operation's name or + is used in other places throughout the model, a copy of the targeted input + structure is created, the name of the shape becomes OperationName + inputSuffix, + and the input trait is added to the shape. The operation is then updated + to target the created shape, and the original shape is left as-is in the model. + +

          If the operation's output shape does not start with the operation's name or + is used in other places throughout the model, a copy of the targeted output + structure is created, the name of the shape becomes OperationName + outputSuffix, + and the output trait is added to the shape. The operation is then updated + to target the created shape, and the original shape is left as-is in the model. + +

          If a naming conflict occurs while attempting to create a new shape, then + the default naming conflict resolver will attempt to name the shape + OperationName + "Operation" + inputSuffix / outputSuffix + depending on the context. If the name is still in conflict with other + shapes in the model, then a ModelTransformException is thrown. + +

          Any time a shape is renamed, the original shape ID of the shape is captured + on the shape using the synthetic OriginalShapeIdTrait. This might be + useful for protocols that need to serialize input and output shape names.

          +
          +
          Parameters:
          +
          model - Model to update.
          +
          inputSuffix - Suffix to append to dedicated input shapes (e.g., "Input").
          +
          outputSuffix - Suffix to append to dedicated input shapes (e.g., "Output").
          +
          Returns:
          +
          Returns the updated model.
          +
          Throws:
          +
          ModelTransformException - if an input or output shape name conflict occurs.
          +
          +
          • +
        + + + +
          +
        • +

          flattenAndRemoveMixins

          +
          public Model flattenAndRemoveMixins​(Model model)
          +
          Flattens mixins out of the model and removes them from the model.
          +
          +
          Parameters:
          +
          model - Model to flatten.
          +
          Returns:
          +
          Returns the flattened model.
          +
          +
          • +
        + + + +
          +
        • +

          addClientOptional

          +
          public Model addClientOptional​(Model model,
+                               boolean applyWhenNoDefaultValue)
          +
          Add the clientOptional trait to members that are effectively nullable because + they are part of a structure marked with the input trait or they aren't required + and don't have a default trait.
          +
          +
          Parameters:
          +
          model - Model to transform.
          +
          applyWhenNoDefaultValue - Set to true to add clientOptional to members that target + shapes with no zero value (e.g., structure and union).
          +
          Returns:
          +
          Returns the transformed model.
          +
          +
          • +
        + + + +
          +
        • +

          downgradeToV1

          +
          public Model downgradeToV1​(Model model)
          +
          Removes Smithy IDL 2.0 features from a model that are not strictly necessary to keep for consistency with the + rest of Smithy. + +

          This transformer is lossy, and converts enum shapes to string shapes with the enum trait, intEnum shapes to + integer shapes, flattens and removes mixins, removes properties from resources, and removes default traits that + have no impact on IDL 1.0 semantics (i.e., default traits on structure members set to something other than null, + or default traits on any other shape that are not the zero value of the shape of a 1.0 model).

          +
          +
          Parameters:
          +
          model - Model to downgrade.
          +
          Returns:
          +
          Returns the downgraded model.
          +
          +
          • +
        + + + +
          +
        • +

          removeInvalidDefaults

          +
          public Model removeInvalidDefaults​(Model model)
          +
          Remove default traits if the default conflicts with the range trait of the shape.
          +
          +
          Parameters:
          +
          model - Model to transform.
          +
          Returns:
          +
          Returns the transformed model.
          +
          +
          • +
        + + + +
          +
        • +

          deconflictErrorsWithSharedStatusCode

          +
          public Model deconflictErrorsWithSharedStatusCode​(Model model,
+                                                  ServiceShape forService)
          +
          Deconflicts errors that share a status code.
          +
          +
          Parameters:
          +
          model - Model to transform.
          +
          Returns:
          +
          Returns the transformed model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/transform/ModelTransformerPlugin.html b/javadoc/1.47.0/software/amazon/smithy/model/transform/ModelTransformerPlugin.html new file mode 100644 index 00000000000..a205fae3823 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/transform/ModelTransformerPlugin.html @@ -0,0 +1,272 @@ + + + + + +ModelTransformerPlugin (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.transform
    +

    Interface ModelTransformerPlugin

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          onRemove

          +
          default Model onRemove​(ModelTransformer transformer,
+                       java.util.Collection<Shape> removed,
+                       Model model)
          +
          The method that is invoked each time shapes are removed from a model.
          +
          +
          Parameters:
          +
          transformer - Transformer used to replace/remove shapes from the model.
          +
          removed - The of shapes that were removed from the model.
          +
          model - Model that has been altered to remove removed.
          +
          Returns:
          +
          Returns a transformed version of the passed in model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/transform/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/model/transform/package-summary.html new file mode 100644 index 00000000000..1d4d1572420 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/transform/package-summary.html @@ -0,0 +1,217 @@ + + + + + +software.amazon.smithy.model.transform (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.model.transform

    +
    +
    +
      +
    • + + + + + + + + + + + + +
      Interface Summary 
      InterfaceDescription
      ModelTransformerPlugin +
      Plugin service used with ModelTransformer.
      +
      +
      • +
    • + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      ModelTransformer +
      Class used to transform Models.
      +
      +
      • +
    • + + + + + + + + + + + + +
      Enum Summary 
      EnumDescription
      ChangeShapeTypeOption +
      Options that can be enabled when changing shape types.
      +
      +
      • +
    • + + + + + + + + + + + + +
      Exception Summary 
      ExceptionDescription
      ModelTransformException +
      Exception thrown when a model transformation error occurs.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/transform/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/model/transform/package-tree.html new file mode 100644 index 00000000000..7d1c90efbb7 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/transform/package-tree.html @@ -0,0 +1,194 @@ + + + + + +software.amazon.smithy.model.transform Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.model.transform

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    +
      +
    • java.lang.Object +
        +
      • software.amazon.smithy.model.transform.ModelTransformer
        • +
      • java.lang.Throwable (implements java.io.Serializable) +
          +
        • java.lang.Exception + +
          • +
        +
        • +
      +
      • +
    +
    +
    +

    Interface Hierarchy

    + +
    +
    +

    Enum Hierarchy

    +
      +
    • java.lang.Object +
        +
      • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
        • +
      +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/CleanBindings.html b/javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/CleanBindings.html new file mode 100644 index 00000000000..3a3e46444fe --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/CleanBindings.html @@ -0,0 +1,330 @@ + + + + + +CleanBindings (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.transform.plugins
    +

    Class CleanBindings

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.transform.plugins.CleanBindings
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ModelTransformerPlugin
      +
      +
      +
      public final class CleanBindings
+extends java.lang.Object
+implements ModelTransformerPlugin
      +
      Removes operation bindings from resources and services when operations + are removed, and removes resource bindings from services and resources when + resources are removed.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        CleanBindings() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        ModelonRemove​(ModelTransformer transformer, + java.util.Collection<Shape> shapes, + Model model) +
        The method that is invoked each time shapes are removed from a model.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          CleanBindings

          +
          public CleanBindings()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          onRemove

          +
          public Model onRemove​(ModelTransformer transformer,
+                      java.util.Collection<Shape> shapes,
+                      Model model)
          +
          Description copied from interface: ModelTransformerPlugin
          +
          The method that is invoked each time shapes are removed from a model.
          +
          +
          Specified by:
          +
          onRemove in interface ModelTransformerPlugin
          +
          Parameters:
          +
          transformer - Transformer used to replace/remove shapes from the model.
          +
          shapes - The of shapes that were removed from the model.
          +
          model - Model that has been altered to remove removed.
          +
          Returns:
          +
          Returns a transformed version of the passed in model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/CleanOperationStructures.html b/javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/CleanOperationStructures.html new file mode 100644 index 00000000000..558c36ba2a1 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/CleanOperationStructures.html @@ -0,0 +1,329 @@ + + + + + +CleanOperationStructures (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.transform.plugins
    +

    Class CleanOperationStructures

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.transform.plugins.CleanOperationStructures
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ModelTransformerPlugin
      +
      +
      +
      public final class CleanOperationStructures
+extends java.lang.Object
+implements ModelTransformerPlugin
      +
      Removes references to removed structures from operation + input, output, and errors.
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        ModelonRemove​(ModelTransformer transformer, + java.util.Collection<Shape> removed, + Model model) +
        The method that is invoked each time shapes are removed from a model.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          CleanOperationStructures

          +
          public CleanOperationStructures()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          onRemove

          +
          public Model onRemove​(ModelTransformer transformer,
+                      java.util.Collection<Shape> removed,
+                      Model model)
          +
          Description copied from interface: ModelTransformerPlugin
          +
          The method that is invoked each time shapes are removed from a model.
          +
          +
          Specified by:
          +
          onRemove in interface ModelTransformerPlugin
          +
          Parameters:
          +
          transformer - Transformer used to replace/remove shapes from the model.
          +
          removed - The of shapes that were removed from the model.
          +
          model - Model that has been altered to remove removed.
          +
          Returns:
          +
          Returns a transformed version of the passed in model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/CleanResourceReferences.html b/javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/CleanResourceReferences.html new file mode 100644 index 00000000000..fc20ea45885 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/CleanResourceReferences.html @@ -0,0 +1,329 @@ + + + + + +CleanResourceReferences (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.transform.plugins
    +

    Class CleanResourceReferences

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.transform.plugins.CleanResourceReferences
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        ModelonRemove​(ModelTransformer transformer, + java.util.Collection<Shape> shapes, + Model model) +
        The method that is invoked each time shapes are removed from a model.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          CleanResourceReferences

          +
          public CleanResourceReferences()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          onRemove

          +
          public Model onRemove​(ModelTransformer transformer,
+                      java.util.Collection<Shape> shapes,
+                      Model model)
          +
          Description copied from interface: ModelTransformerPlugin
          +
          The method that is invoked each time shapes are removed from a model.
          +
          +
          Specified by:
          +
          onRemove in interface ModelTransformerPlugin
          +
          Parameters:
          +
          transformer - Transformer used to replace/remove shapes from the model.
          +
          shapes - The of shapes that were removed from the model.
          +
          model - Model that has been altered to remove removed.
          +
          Returns:
          +
          Returns a transformed version of the passed in model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/CleanServiceRenames.html b/javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/CleanServiceRenames.html new file mode 100644 index 00000000000..56172522a3f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/CleanServiceRenames.html @@ -0,0 +1,328 @@ + + + + + +CleanServiceRenames (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.transform.plugins
    +

    Class CleanServiceRenames

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.transform.plugins.CleanServiceRenames
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ModelTransformerPlugin
      +
      +
      +
      public final class CleanServiceRenames
+extends java.lang.Object
+implements ModelTransformerPlugin
      +
      Removes "rename" entries from service shapes when a shape is removed.
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        ModelonRemove​(ModelTransformer transformer, + java.util.Collection<Shape> shapes, + Model model) +
        The method that is invoked each time shapes are removed from a model.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          CleanServiceRenames

          +
          public CleanServiceRenames()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          onRemove

          +
          public Model onRemove​(ModelTransformer transformer,
+                      java.util.Collection<Shape> shapes,
+                      Model model)
          +
          Description copied from interface: ModelTransformerPlugin
          +
          The method that is invoked each time shapes are removed from a model.
          +
          +
          Specified by:
          +
          onRemove in interface ModelTransformerPlugin
          +
          Parameters:
          +
          transformer - Transformer used to replace/remove shapes from the model.
          +
          shapes - The of shapes that were removed from the model.
          +
          model - Model that has been altered to remove removed.
          +
          Returns:
          +
          Returns a transformed version of the passed in model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/CleanStructureAndUnionMembers.html b/javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/CleanStructureAndUnionMembers.html new file mode 100644 index 00000000000..bfcc86afdd3 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/CleanStructureAndUnionMembers.html @@ -0,0 +1,335 @@ + + + + + +CleanStructureAndUnionMembers (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.transform.plugins
    +

    Class CleanStructureAndUnionMembers

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.transform.plugins.CleanStructureAndUnionMembers
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ModelTransformerPlugin
      +
      +
      +
      public final class CleanStructureAndUnionMembers
+extends java.lang.Object
+implements ModelTransformerPlugin
      +
      Cleans up structure, union, enum, and intEnum shapes after shapes are removed. + +
        +
      • Ensures that structure and union shapes are updated to no + longer reference any removed members.
        • +
      • Ensures that structure/union members that reference shapes + that have been removed are also removed.
        • +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        ModelonRemove​(ModelTransformer transformer, + java.util.Collection<Shape> removed, + Model model) +
        The method that is invoked each time shapes are removed from a model.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          CleanStructureAndUnionMembers

          +
          public CleanStructureAndUnionMembers()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          onRemove

          +
          public Model onRemove​(ModelTransformer transformer,
+                      java.util.Collection<Shape> removed,
+                      Model model)
          +
          Description copied from interface: ModelTransformerPlugin
          +
          The method that is invoked each time shapes are removed from a model.
          +
          +
          Specified by:
          +
          onRemove in interface ModelTransformerPlugin
          +
          Parameters:
          +
          transformer - Transformer used to replace/remove shapes from the model.
          +
          removed - The of shapes that were removed from the model.
          +
          model - Model that has been altered to remove removed.
          +
          Returns:
          +
          Returns a transformed version of the passed in model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/CleanTraitDefinitions.html b/javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/CleanTraitDefinitions.html new file mode 100644 index 00000000000..9047731765b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/CleanTraitDefinitions.html @@ -0,0 +1,329 @@ + + + + + +CleanTraitDefinitions (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.transform.plugins
    +

    Class CleanTraitDefinitions

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.transform.plugins.CleanTraitDefinitions
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        ModelonRemove​(ModelTransformer transformer, + java.util.Collection<Shape> removed, + Model model) +
        The method that is invoked each time shapes are removed from a model.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          CleanTraitDefinitions

          +
          public CleanTraitDefinitions()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          onRemove

          +
          public Model onRemove​(ModelTransformer transformer,
+                      java.util.Collection<Shape> removed,
+                      Model model)
          +
          Description copied from interface: ModelTransformerPlugin
          +
          The method that is invoked each time shapes are removed from a model.
          +
          +
          Specified by:
          +
          onRemove in interface ModelTransformerPlugin
          +
          Parameters:
          +
          transformer - Transformer used to replace/remove shapes from the model.
          +
          removed - The of shapes that were removed from the model.
          +
          model - Model that has been altered to remove removed.
          +
          Returns:
          +
          Returns a transformed version of the passed in model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/RemoveMixins.html b/javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/RemoveMixins.html new file mode 100644 index 00000000000..f5e82adff70 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/RemoveMixins.html @@ -0,0 +1,328 @@ + + + + + +RemoveMixins (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.transform.plugins
    +

    Class RemoveMixins

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.transform.plugins.RemoveMixins
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ModelTransformerPlugin
      +
      +
      +
      public final class RemoveMixins
+extends java.lang.Object
+implements ModelTransformerPlugin
      +
      Removes mixins from shapes when a mixin is removed from the model.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        RemoveMixins() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        ModelonRemove​(ModelTransformer transformer, + java.util.Collection<Shape> shapes, + Model model) +
        The method that is invoked each time shapes are removed from a model.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          RemoveMixins

          +
          public RemoveMixins()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          onRemove

          +
          public Model onRemove​(ModelTransformer transformer,
+                      java.util.Collection<Shape> shapes,
+                      Model model)
          +
          Description copied from interface: ModelTransformerPlugin
          +
          The method that is invoked each time shapes are removed from a model.
          +
          +
          Specified by:
          +
          onRemove in interface ModelTransformerPlugin
          +
          Parameters:
          +
          transformer - Transformer used to replace/remove shapes from the model.
          +
          shapes - The of shapes that were removed from the model.
          +
          model - Model that has been altered to remove removed.
          +
          Returns:
          +
          Returns a transformed version of the passed in model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/RemoveTraits.html b/javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/RemoveTraits.html new file mode 100644 index 00000000000..bf4c5b489a6 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/RemoveTraits.html @@ -0,0 +1,328 @@ + + + + + +RemoveTraits (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.transform.plugins
    +

    Class RemoveTraits

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.transform.plugins.RemoveTraits
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ModelTransformerPlugin
      +
      +
      +
      public final class RemoveTraits
+extends java.lang.Object
+implements ModelTransformerPlugin
      +
      Removes traits from shapes when trait definitions are removed.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        RemoveTraits() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        ModelonRemove​(ModelTransformer transformer, + java.util.Collection<Shape> shapes, + Model model) +
        The method that is invoked each time shapes are removed from a model.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          RemoveTraits

          +
          public RemoveTraits()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          onRemove

          +
          public Model onRemove​(ModelTransformer transformer,
+                      java.util.Collection<Shape> shapes,
+                      Model model)
          +
          Description copied from interface: ModelTransformerPlugin
          +
          The method that is invoked each time shapes are removed from a model.
          +
          +
          Specified by:
          +
          onRemove in interface ModelTransformerPlugin
          +
          Parameters:
          +
          transformer - Transformer used to replace/remove shapes from the model.
          +
          shapes - The of shapes that were removed from the model.
          +
          model - Model that has been altered to remove removed.
          +
          Returns:
          +
          Returns a transformed version of the passed in model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/package-summary.html new file mode 100644 index 00000000000..0a5b126ca48 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/package-summary.html @@ -0,0 +1,213 @@ + + + + + +software.amazon.smithy.model.transform.plugins (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.model.transform.plugins

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/package-tree.html new file mode 100644 index 00000000000..d4a8d6a911b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/transform/plugins/package-tree.html @@ -0,0 +1,168 @@ + + + + + +software.amazon.smithy.model.transform.plugins Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.model.transform.plugins

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/AbstractValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/AbstractValidator.html new file mode 100644 index 00000000000..3a1f6d79335 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/AbstractValidator.html @@ -0,0 +1,1070 @@ + + + + + +AbstractValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation
    +

    Class AbstractValidator

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.validation.AbstractValidator
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          AbstractValidator

          +
          public AbstractValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getName

          +
          public java.lang.String getName()
          +
          • +
        + + + +
          +
        • +

          error

          +
          protected final ValidationEvent error​(Shape shape,
+                                      java.lang.String message)
          +
          • +
        + + + +
          +
        • +

          error

          +
          protected final ValidationEvent error​(Shape shape,
+                                      java.lang.String message,
+                                      java.lang.String eventIdSubpart1)
          +
          • +
        + + + +
          +
        • +

          error

          +
          protected final ValidationEvent error​(Shape shape,
+                                      java.lang.String message,
+                                      java.lang.String eventIdSubpart1,
+                                      java.lang.String eventIdSubpart2)
          +
          • +
        + + + +
          +
        • +

          error

          +
          protected final ValidationEvent error​(Shape shape,
+                                      java.lang.String message,
+                                      java.lang.String eventIdSubpart1,
+                                      java.lang.String eventIdSubpart2,
+                                      java.lang.String eventIdSubpart3)
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          error

          +
          protected final ValidationEvent error​(Shape shape,
+                                      FromSourceLocation location,
+                                      java.lang.String message,
+                                      java.lang.String eventIdSubpart1,
+                                      java.lang.String eventIdSubpart2)
          +
          • +
        + + + +
          +
        • +

          error

          +
          protected final ValidationEvent error​(Shape shape,
+                                      FromSourceLocation location,
+                                      java.lang.String message,
+                                      java.lang.String eventIdSubpart1,
+                                      java.lang.String eventIdSubpart2,
+                                      java.lang.String eventIdSubpart3)
          +
          • +
        + + + +
          +
        • +

          danger

          +
          protected final ValidationEvent danger​(Shape shape,
+                                       java.lang.String message)
          +
          • +
        + + + +
          +
        • +

          danger

          +
          protected final ValidationEvent danger​(Shape shape,
+                                       java.lang.String message,
+                                       java.lang.String eventIdSubpart1)
          +
          • +
        + + + +
          +
        • +

          danger

          +
          protected final ValidationEvent danger​(Shape shape,
+                                       java.lang.String message,
+                                       java.lang.String eventIdSubpart1,
+                                       java.lang.String eventIdSubpart2)
          +
          • +
        + + + +
          +
        • +

          danger

          +
          protected final ValidationEvent danger​(Shape shape,
+                                       java.lang.String message,
+                                       java.lang.String eventIdSubpart1,
+                                       java.lang.String eventIdSubpart2,
+                                       java.lang.String eventIdSubpart3)
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          danger

          +
          protected final ValidationEvent danger​(Shape shape,
+                                       FromSourceLocation location,
+                                       java.lang.String message,
+                                       java.lang.String eventIdSubpart1,
+                                       java.lang.String eventIdSubpart2)
          +
          • +
        + + + +
          +
        • +

          danger

          +
          protected final ValidationEvent danger​(Shape shape,
+                                       FromSourceLocation location,
+                                       java.lang.String message,
+                                       java.lang.String eventIdSubpart1,
+                                       java.lang.String eventIdSubpart2,
+                                       java.lang.String eventIdSubpart3)
          +
          • +
        + + + +
          +
        • +

          warning

          +
          protected final ValidationEvent warning​(Shape shape,
+                                        java.lang.String message)
          +
          • +
        + + + +
          +
        • +

          warning

          +
          protected final ValidationEvent warning​(Shape shape,
+                                        java.lang.String message,
+                                        java.lang.String eventIdSubpart1)
          +
          • +
        + + + +
          +
        • +

          warning

          +
          protected final ValidationEvent warning​(Shape shape,
+                                        java.lang.String message,
+                                        java.lang.String eventIdSubpart1,
+                                        java.lang.String eventIdSubpart2)
          +
          • +
        + + + +
          +
        • +

          warning

          +
          protected final ValidationEvent warning​(Shape shape,
+                                        java.lang.String message,
+                                        java.lang.String eventIdSubpart1,
+                                        java.lang.String eventIdSubpart2,
+                                        java.lang.String eventIdSubpart3)
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          warning

          +
          protected final ValidationEvent warning​(Shape shape,
+                                        FromSourceLocation location,
+                                        java.lang.String message,
+                                        java.lang.String eventIdSubpart1,
+                                        java.lang.String eventIdSubpart2)
          +
          • +
        + + + +
          +
        • +

          warning

          +
          protected final ValidationEvent warning​(Shape shape,
+                                        FromSourceLocation location,
+                                        java.lang.String message,
+                                        java.lang.String eventIdSubpart1,
+                                        java.lang.String eventIdSubpart2,
+                                        java.lang.String eventIdSubpart3)
          +
          • +
        + + + + + + + +
          +
        • +

          note

          +
          protected final ValidationEvent note​(Shape shape,
+                                     java.lang.String message,
+                                     java.lang.String eventIdSubpart1)
          +
          • +
        + + + +
          +
        • +

          note

          +
          protected final ValidationEvent note​(Shape shape,
+                                     java.lang.String message,
+                                     java.lang.String eventIdSubpart1,
+                                     java.lang.String eventIdSubpart2)
          +
          • +
        + + + +
          +
        • +

          note

          +
          protected final ValidationEvent note​(Shape shape,
+                                     java.lang.String message,
+                                     java.lang.String eventIdSubpart1,
+                                     java.lang.String eventIdSubpart2,
+                                     java.lang.String eventIdSubpart3)
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          note

          +
          protected final ValidationEvent note​(Shape shape,
+                                     FromSourceLocation location,
+                                     java.lang.String message,
+                                     java.lang.String eventIdSubpart1,
+                                     java.lang.String eventIdSubpart2)
          +
          • +
        + + + +
          +
        • +

          note

          +
          protected final ValidationEvent note​(Shape shape,
+                                     FromSourceLocation location,
+                                     java.lang.String message,
+                                     java.lang.String eventIdSubpart1,
+                                     java.lang.String eventIdSubpart2,
+                                     java.lang.String eventIdSubpart3)
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          createEvent

          +
          protected final ValidationEvent createEvent​(Severity severity,
+                                            Shape shape,
+                                            FromSourceLocation loc,
+                                            java.lang.String message,
+                                            java.lang.String eventIdSubpart1,
+                                            java.lang.String eventIdSubpart2)
          +
          • +
        + + + +
          +
        • +

          createEvent

          +
          protected final ValidationEvent createEvent​(Severity severity,
+                                            Shape shape,
+                                            FromSourceLocation loc,
+                                            java.lang.String message,
+                                            java.lang.String eventIdSubpart1,
+                                            java.lang.String eventIdSubpart2,
+                                            java.lang.String eventIdSubpart3)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/ContextualValidationEventFormatter.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/ContextualValidationEventFormatter.html new file mode 100644 index 00000000000..c8ba8b1a4e0 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/ContextualValidationEventFormatter.html @@ -0,0 +1,331 @@ + + + + + +ContextualValidationEventFormatter (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation
    +

    Class ContextualValidationEventFormatter

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.validation.ContextualValidationEventFormatter
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ValidationEventFormatter
      +
      +
      +
      public final class ContextualValidationEventFormatter
+extends java.lang.Object
+implements ValidationEventFormatter
      +
      This validation event formatter outputs a validation event that points + to the source code line that triggered the event. + +

      If the event does not have a source location, then this formatter + will not attempt to load the contents of the model. + +

      This formatter outputs messages similar to the following text:

      + + 
      {@code
+ ERROR: aws.protocols.tests.ec2#IgnoresWrappingXmlName (Model)
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.lang.Stringformat​(ValidationEvent event) +
        Converts the event to a string.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          ContextualValidationEventFormatter

          +
          public ContextualValidationEventFormatter()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/LineValidationEventFormatter.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/LineValidationEventFormatter.html new file mode 100644 index 00000000000..babe5c372e5 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/LineValidationEventFormatter.html @@ -0,0 +1,322 @@ + + + + + +LineValidationEventFormatter (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation
    +

    Class LineValidationEventFormatter

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.validation.LineValidationEventFormatter
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.lang.Stringformat​(ValidationEvent event) +
        Converts the event to a string.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          LineValidationEventFormatter

          +
          public LineValidationEventFormatter()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/NodeValidationVisitor.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/NodeValidationVisitor.Builder.html new file mode 100644 index 00000000000..edf45cfb082 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/NodeValidationVisitor.Builder.html @@ -0,0 +1,492 @@ + + + + + +NodeValidationVisitor.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation
    +

    Class NodeValidationVisitor.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.validation.NodeValidationVisitor.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          model

          +
          public NodeValidationVisitor.Builder model​(Model model)
          +
          Sets the required model to use when traversing + walking shapes during validation.
          +
          +
          Parameters:
          +
          model - Model that contains shapes to validate.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          value

          +
          public NodeValidationVisitor.Builder value​(Node value)
          +
          Sets the required node value to validate.
          +
          +
          Parameters:
          +
          value - Value to validate.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          eventId

          +
          public NodeValidationVisitor.Builder eventId​(java.lang.String id)
          +
          Sets an optional custom event ID to use for created validation events.
          +
          +
          Parameters:
          +
          id - Custom event ID.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          startingContext

          +
          public NodeValidationVisitor.Builder startingContext​(java.lang.String contextText)
          +
          Sets an optional starting context of the validator that is prepended + to each emitted validation event message.
          +
          +
          Parameters:
          +
          contextText - Starting event message content.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          eventShapeId

          +
          public NodeValidationVisitor.Builder eventShapeId​(ShapeId eventShapeId)
          +
          Sets an optional shape ID that is used as the shape ID in each + validation event emitted by the validator.
          +
          +
          Parameters:
          +
          eventShapeId - Shape ID to set on every validation event.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + + + + + + + + + + + + + + + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/NodeValidationVisitor.Feature.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/NodeValidationVisitor.Feature.html new file mode 100644 index 00000000000..e43d6474978 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/NodeValidationVisitor.Feature.html @@ -0,0 +1,437 @@ + + + + + +NodeValidationVisitor.Feature (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation
    +

    Enum NodeValidationVisitor.Feature

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + +
          +
        • +

          RANGE_TRAIT_ZERO_VALUE_WARNING

          +
          public static final NodeValidationVisitor.Feature RANGE_TRAIT_ZERO_VALUE_WARNING
          +
          Emit a warning when a range trait is incompatible with a default value of 0. + +

          This was a common pattern in Smithy 1.0 and earlier. It implies that the value is effectively + required. However, changing the type of the value by un-boxing it or adjusting the range trait would + be a lossy transformation when migrating a model from 1.0 to 2.0.

          +
          • +
        + + + +
          +
        • +

          ALLOW_CONSTRAINT_ERRORS

          +
          public static final NodeValidationVisitor.Feature ALLOW_CONSTRAINT_ERRORS
          +
          Lowers severity of constraint trait validations to WARNING.
          +
          • +
        + + + +
          +
        • +

          ALLOW_OPTIONAL_NULLS

          +
          public static final NodeValidationVisitor.Feature ALLOW_OPTIONAL_NULLS
          +
          Allows null values to be provided for an optional structure member. + +

          By default, null values are not allowed for optional types.

          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static NodeValidationVisitor.Feature[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (NodeValidationVisitor.Feature c : NodeValidationVisitor.Feature.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static NodeValidationVisitor.Feature valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        + + + + + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/NodeValidationVisitor.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/NodeValidationVisitor.html new file mode 100644 index 00000000000..b16dc299cce --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/NodeValidationVisitor.html @@ -0,0 +1,785 @@ + + + + + +NodeValidationVisitor (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation
    +

    Class NodeValidationVisitor

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.validation.NodeValidationVisitor
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ShapeVisitor<java.util.List<ValidationEvent>>
      +
      +
      +
      public final class NodeValidationVisitor
+extends java.lang.Object
+implements ShapeVisitor<java.util.List<ValidationEvent>>
      +
      Validates Node values provided for Shape definitions. + +

      This visitor validator is used to ensure that values provided for custom + traits and examples are correct for their schema definitions. A map of + shape types to a list of additional validators can be provided to perform + additional, non-standard, validation of these values. For example, this can + be used to provide additional validation needed for custom traits that are + applied to the shape of the data.

      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/Severity.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/Severity.html new file mode 100644 index 00000000000..1f2d4b98094 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/Severity.html @@ -0,0 +1,511 @@ + + + + + +Severity (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation
    +

    Enum Severity

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Enum<Severity>
        • +
      • +
          +
        • software.amazon.smithy.model.validation.Severity
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable, java.lang.Comparable<Severity>, ToNode
      +
      +
      +
      public enum Severity
+extends java.lang.Enum<Severity>
+implements ToNode
      +
      Severity level of a validation exception.
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        booleancanSuppress() +
        Check if the severity level of the error can be suppressed.
        +
        static SeverityfromNode​(Node node) +
        Creates a severity value from a node.
        +
        static java.util.Optional<Severity>fromString​(java.lang.String text) +
        Create a new Severity from a string.
        +
        NodetoNode() +
        Converts a value to a Node.
        +
        static SeverityvalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static Severity[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + +
          +
        • +

          SUPPRESSED

          +
          public static final Severity SUPPRESSED
          +
          • +
        + + + +
          +
        • +

          NOTE

          +
          public static final Severity NOTE
          +
          • +
        + + + +
          +
        • +

          WARNING

          +
          public static final Severity WARNING
          +
          • +
        + + + +
          +
        • +

          DANGER

          +
          public static final Severity DANGER
          +
          • +
        + + + +
          +
        • +

          ERROR

          +
          public static final Severity ERROR
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static Severity[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (Severity c : Severity.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static Severity valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          canSuppress

          +
          public boolean canSuppress()
          +
          Check if the severity level of the error can be suppressed.
          +
          +
          Returns:
          +
          Returns true if a suppression can silence errors at this + severity level.
          +
          +
          • +
        + + + +
          +
        • +

          fromString

          +
          public static java.util.Optional<Severity> fromString​(java.lang.String text)
          +
          Create a new Severity from a string.
          +
          +
          Parameters:
          +
          text - Text to convert into a severity level.
          +
          Returns:
          +
          Returns the format in an Optional.
          +
          +
          • +
        + + + +
          +
        • +

          fromNode

          +
          public static Severity fromNode​(Node node)
          +
          Creates a severity value from a node.
          +
          +
          Parameters:
          +
          node - Node to parse.
          +
          Returns:
          +
          Returns the parsed Severity.
          +
          Throws:
          +
          ExpectationNotMetException - if the node is invalid.
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/ValidatedResult.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/ValidatedResult.html new file mode 100644 index 00000000000..395e02c6ab9 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/ValidatedResult.html @@ -0,0 +1,561 @@ + + + + + +ValidatedResult (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation
    +

    Class ValidatedResult<T>

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.validation.ValidatedResult<T>
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Type Parameters:
      +
      T - The type being created.
      +
      +
      +
      public final class ValidatedResult<T>
+extends java.lang.Object
      +
      Represents the result of an operation and the ValidationEvents + that occurred.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + + + +
          +
        • +

          ValidatedResult

          +
          public ValidatedResult​(T result,
+                       java.util.List<ValidationEvent> events)
          +
          Creates a result with a value and events.
          +
          +
          Parameters:
          +
          result - Value to set.
          +
          events - Events to set.
          +
          +
          • +
        + + + + + +
          +
        • +

          ValidatedResult

          +
          @Deprecated
+public ValidatedResult​(T result,
+                       java.util.Collection<ValidationEvent> events)
          +
          Deprecated.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          fromErrors

          +
          public static <T> ValidatedResult<T> fromErrors​(java.util.List<ValidationEvent> events)
          +
          Creates a new ValidatedResult with no values and a list of + ValidationEvents.
          +
          +
          Type Parameters:
          +
          T - The type of value in the result.
          +
          Parameters:
          +
          events - Validation events on the result.
          +
          Returns:
          +
          Returns the created ValidatedResult.
          +
          +
          • +
        + + + + + + + + + +
          +
        • +

          fromValue

          +
          public static <T> ValidatedResult<T> fromValue​(T value)
          +
          Creates a new ValidatedResult with a value and no + ValidationEvents.
          +
          +
          Type Parameters:
          +
          T - The type of value in the result.
          +
          Parameters:
          +
          value - Result value,
          +
          Returns:
          +
          Returns the created ValidatedResult.
          +
          +
          • +
        + + + +
          +
        • +

          empty

          +
          public static <T> ValidatedResult<T> empty()
          +
          Creates an empty ValidatedResult with no value and no events.
          +
          +
          Type Parameters:
          +
          T - The type of value in the result.
          +
          Returns:
          +
          Returns the created ValidatedResult.
          +
          +
          • +
        + + + +
          +
        • +

          getValidationEvents

          +
          public java.util.List<ValidationEvent> getValidationEvents()
          +
          Get the list of ValidationEvents associated with the result.
          +
          +
          Returns:
          +
          Returns the validation events.
          +
          +
          • +
        + + + +
          +
        • +

          getValidationEvents

          +
          public java.util.List<ValidationEvent> getValidationEvents​(Severity severity)
          +
          Get validation events of a particular severity.
          +
          +
          Parameters:
          +
          severity - Severity to get.
          +
          Returns:
          +
          Returns a list of events with the given severity.
          +
          +
          • +
        + + + +
          +
        • +

          getResult

          +
          public java.util.Optional<T> getResult()
          +
          Get the optional result.
          +
          +
          Returns:
          +
          Returns the optional result.
          +
          +
          • +
        + + + +
          +
        • +

          unwrap

          +
          public T unwrap()
          +
          Get the result, but throw if there are any ERROR or DANGER events or if the + result is empty.
          +
          +
          Returns:
          +
          Returns the result.
          +
          Throws:
          +
          ValidatedResultException - if there are any ERROR or DANGER events.
          +
          java.lang.IllegalStateException - if there is no result.
          +
          +
          • +
        + + + +
          +
        • +

          validate

          +
          public java.util.Optional<T> validate()
          +
          Get the optional result, and throw if there are any ERROR events.
          +
          +
          Returns:
          +
          Returns the optional result.
          +
          Throws:
          +
          ValidatedResultException - if there are any ERROR events.
          +
          +
          • +
        + + + +
          +
        • +

          isBroken

          +
          public boolean isBroken()
          +
          Checks if the result has any error or danger events..
          +
          +
          Returns:
          +
          Returns true if there are errors or unsuppressed dangers.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/ValidatedResultException.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/ValidatedResultException.html new file mode 100644 index 00000000000..86618c56919 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/ValidatedResultException.html @@ -0,0 +1,336 @@ + + + + + +ValidatedResultException (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation
    +

    Class ValidatedResultException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Throwable
        • +
      • +
          +
        • java.lang.Exception
          • +
        • +
            +
          • java.lang.RuntimeException
            • +
          • +
              +
            • software.amazon.smithy.model.validation.ValidatedResultException
              • +
            +
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      public class ValidatedResultException
+extends java.lang.RuntimeException
      +
      Thrown when ValidatedResult.validate() is called and the result contains + ERROR events.
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.util.List<ValidationEvent>getValidationEvents() 
        +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ValidatedResultException

          +
          public ValidatedResultException​(java.util.List<ValidationEvent> events)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getValidationEvents

          +
          public java.util.List<ValidationEvent> getValidationEvents()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/ValidationEvent.Builder.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/ValidationEvent.Builder.html new file mode 100644 index 00000000000..08b53f9296b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/ValidationEvent.Builder.html @@ -0,0 +1,520 @@ + + + + + +ValidationEvent.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation
    +

    Class ValidationEvent.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.validation.ValidationEvent.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          message

          +
          public ValidationEvent.Builder message​(java.lang.String eventMessage)
          +
          Sets the required message of the event.
          +
          +
          Parameters:
          +
          eventMessage - Message to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          message

          +
          public ValidationEvent.Builder message​(java.lang.String eventMessage,
+                                       java.lang.Object... placeholders)
          +
          • +
        + + + +
          +
        • +

          severity

          +
          public ValidationEvent.Builder severity​(Severity severity)
          +
          Sets the required severity of the event.
          +
          +
          Parameters:
          +
          severity - Event severity.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          eventId

          +
          public ValidationEvent.Builder eventId​(java.lang.String eventId)
          +
          Deprecated. +
          Use the id(String eventId) setter to match the node format.
          +
          +
          Sets the required event ID of the event.
          +
          +
          Parameters:
          +
          eventId - Event ID.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          id

          +
          public ValidationEvent.Builder id​(java.lang.String eventId)
          +
          Sets the required event ID of the event.
          +
          +
          Parameters:
          +
          eventId - Event ID.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          sourceLocation

          +
          public ValidationEvent.Builder sourceLocation​(FromSourceLocation sourceLocation)
          +
          Sets the source location of where the event occurred.
          +
          +
          Parameters:
          +
          sourceLocation - Event source location.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + + + +
          +
        • +

          shapeId

          +
          public <T extends ToShapeId> ValidationEvent.Builder shapeId​(T toShapeId)
          +
          Sets the shape ID related to the event.
          +
          +
          Type Parameters:
          +
          T - Value to convert to a shape ID.
          +
          Parameters:
          +
          toShapeId - Shape ID.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          shape

          +
          public ValidationEvent.Builder shape​(Shape encounteredShape)
          +
          Sets the shape ID and source location based on a shape.
          +
          +
          Parameters:
          +
          encounteredShape - Shape.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          suppressionReason

          +
          public ValidationEvent.Builder suppressionReason​(java.lang.String eventSuppressionReason)
          +
          Sets a reason for suppressing the event. + +

          This is only relevant if the severity is SUPPRESSED.

          +
          +
          Parameters:
          +
          eventSuppressionReason - Event suppression reason.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          hint

          +
          public ValidationEvent.Builder hint​(java.lang.String hint)
          +
          Sets an optional hint adding more detail about how to fix a specific issue.
          +
          +
          Parameters:
          +
          hint - Hint to set
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/ValidationEvent.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/ValidationEvent.html new file mode 100644 index 00000000000..7d347d359b9 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/ValidationEvent.html @@ -0,0 +1,714 @@ + + + + + +ValidationEvent (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation
    +

    Class ValidationEvent

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.validation.ValidationEvent
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          fromSourceException

          +
          public static ValidationEvent fromSourceException​(SourceException exception)
          +
          Creates a new ValidationEvent from a SourceException.
          +
          +
          Parameters:
          +
          exception - Exception to use to create the event.
          +
          Returns:
          +
          Returns a created validation event with an ID of Model.
          +
          +
          • +
        + + + +
          +
        • +

          fromSourceException

          +
          public static ValidationEvent fromSourceException​(SourceException exception,
+                                                  java.lang.String prefix)
          +
          Creates a new ValidationEvent from a SourceException.
          +
          +
          Parameters:
          +
          exception - Exception to use to create the event.
          +
          prefix - Prefix string to add to the message.
          +
          Returns:
          +
          Returns a created validation event with an ID of Model.
          +
          +
          • +
        + + + +
          +
        • +

          fromSourceException

          +
          public static ValidationEvent fromSourceException​(SourceException exception,
+                                                  java.lang.String prefix,
+                                                  ShapeId shapeId)
          +
          Creates a new ValidationEvent from a SourceException.
          +
          +
          Parameters:
          +
          exception - Exception to use to create the event.
          +
          prefix - Prefix string to add to the message.
          +
          shapeId - ShapeId to associate with the event.
          +
          Returns:
          +
          Returns a created validation event with an ID of Model.
          +
          +
          • +
        + + + +
          +
        • +

          compareTo

          +
          public int compareTo​(ValidationEvent other)
          +
          +
          Specified by:
          +
          compareTo in interface java.lang.Comparable<ValidationEvent>
          +
          +
          • +
        + + + + + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          getMessage

          +
          public java.lang.String getMessage()
          +
          +
          Returns:
          +
          The human-readable event message.
          +
          +
          • +
        + + + +
          +
        • +

          getSeverity

          +
          public Severity getSeverity()
          +
          +
          Returns:
          +
          The severity level of the event.
          +
          +
          • +
        + + + +
          +
        • +

          getEventId

          +
          public java.lang.String getEventId()
          +
          Deprecated. +
          Use the getId() method to match the node format.
          +
          +
          Returns the identifier of the validation event. + +

          The validation event identifier can be used to suppress events.

          +
          +
          Returns:
          +
          Returns the event ID.
          +
          +
          • +
        + + + +
          +
        • +

          containsId

          +
          public boolean containsId​(java.lang.String id)
          +
          Tests if the event ID hierarchically contains the given ID. + +

          Event IDs that contain dots (.) are hierarchical. An event ID of + "Foo.Bar" contains the ID "Foo" and "Foo.Bar". + However, an event ID of "Foo" does not contain the ID + "Foo.Bar" as "Foo.Bar" is more specific than "Foo". + If an event ID exactly matches the given id, then it also contains + the ID (for example, "Foo.Bar." contains "Foo.Bar.".

          +
          +
          Parameters:
          +
          id - ID to test.
          +
          Returns:
          +
          Returns true if the event's event ID contains the given id.
          +
          +
          • +
        + + + +
          +
        • +

          getId

          +
          public java.lang.String getId()
          +
          Returns the identifier of the validation event. + +

          The validation event identifier can be used to suppress events.

          +
          +
          Returns:
          +
          Returns the event ID.
          +
          +
          • +
        + + + +
          +
        • +

          getShapeId

          +
          public java.util.Optional<ShapeId> getShapeId()
          +
          +
          Returns:
          +
          The shape ID that is associated with the event.
          +
          +
          • +
        + + + +
          +
        • +

          getSuppressionReason

          +
          public java.util.Optional<java.lang.String> getSuppressionReason()
          +
          Get the reason that the event was suppressed.
          +
          +
          Returns:
          +
          Returns the suppression reason if available.
          +
          +
          • +
        + + + +
          +
        • +

          getHint

          +
          public java.util.Optional<java.lang.String> getHint()
          +
          Get an optional hint that adds more detail about how to fix a specific issue.
          +
          +
          Returns:
          +
          Returns the hint if available.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/ValidationEventDecorator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/ValidationEventDecorator.html new file mode 100644 index 00000000000..8098761fb4e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/ValidationEventDecorator.html @@ -0,0 +1,351 @@ + + + + + +ValidationEventDecorator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation
    +

    Interface ValidationEventDecorator

    +
    +
    +
    +
      +
    • +
      +
      public interface ValidationEventDecorator
      +
      Validation event decorators take validation events and transform them by adding more contextual information, + usually adding a hint to let the user know what can it be done to solve the issue. This might add context specific + information that is not relevant for all cases such as links to internal knowledge sites or explicit instructions + relevant only to the context where Smithy is being used.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          canDecorate

          +
          boolean canDecorate​(ValidationEvent ev)
          +
          Returns true if this decorator knows how to decorate this event, usually by looking at the event id.
          +
          +
          Parameters:
          +
          ev - The event to test against
          +
          Returns:
          +
          true if this decorator knows how to decorate this event
          +
          +
          • +
        + + + +
          +
        • +

          decorate

          +
          ValidationEvent decorate​(ValidationEvent ev)
          +
          Takes an event and potentially updates it to decorate it. Returns the same event if this decorators does not know + how to handle the event.
          +
          +
          Returns:
          +
          The decorated event or the original one if no decoration took place.
          +
          +
          • +
        + + + +
          +
        • +

          compose

          +
          static ValidationEventDecorator compose​(java.util.List<ValidationEventDecorator> decorators)
          +
          Creates a decorator composed of one or more decorators.
          +
          +
          Parameters:
          +
          decorators - Decorators to compose.
          +
          Returns:
          +
          Returns the composed decorator.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/ValidationEventFormatter.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/ValidationEventFormatter.html new file mode 100644 index 00000000000..03caa4421b4 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/ValidationEventFormatter.html @@ -0,0 +1,262 @@ + + + + + +ValidationEventFormatter (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation
    +

    Interface ValidationEventFormatter

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          format

          +
          java.lang.String format​(ValidationEvent event)
          +
          Converts the event to a string.
          +
          +
          Parameters:
          +
          event - Event to write as a string.
          +
          Returns:
          +
          Returns the event as a formatted string.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/ValidationUtils.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/ValidationUtils.html new file mode 100644 index 00000000000..d5d50c59161 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/ValidationUtils.html @@ -0,0 +1,427 @@ + + + + + +ValidationUtils (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation
    +

    Class ValidationUtils

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.validation.ValidationUtils
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class ValidationUtils
+extends java.lang.Object
      +
      Utility methods used when validating.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods Deprecated Methods 
        Modifier and TypeMethodDescription
        static <T extends ToShapeId>
        java.util.Map<java.lang.String,​java.util.List<ShapeId>>        		findDuplicateShapeNames​(java.util.Collection<T> shapes) +
        Deprecated.
        +
        static booleanisCriticalEvent​(java.lang.String eventId) +
        Checks if the given validation event was emitted by a critical validator.
        +
        static booleanisCriticalValidator​(java.lang.Class<? extends Validator> validator) +
        Checks if the given validator class is a critical validator that should be applied before other downstream + validators are applied.
        +
        static java.lang.StringorderedTickedList​(java.util.Collection<?> values) +
        Creates a comma separated string made up of the given collection.
        +
        static java.util.List<java.lang.String>splitCamelCaseWord​(java.lang.String word) +
        Splits a camelCase word into a list of words.
        +
        static java.lang.StringtickedList​(java.util.Collection<?> values) +
        Creates a comma separated string made up of the given collection.
        +
        static java.lang.StringtickedList​(java.util.stream.Stream<?> values) 
        static java.lang.StringtickedPrettyPrintedNode​(Node node) +
        Writes the contents of a Node to a pretty-printed JSON string surrounded in backticks.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + +
          +
        • +

          isCriticalValidator

          +
          public static boolean isCriticalValidator​(java.lang.Class<? extends Validator> validator)
          +
          Checks if the given validator class is a critical validator that should be applied before other downstream + validators are applied.
          +
          +
          Parameters:
          +
          validator - Validator class to check.
          +
          Returns:
          +
          Returns true if the given validator is considered a critical validator.
          +
          +
          • +
        + + + +
          +
        • +

          isCriticalEvent

          +
          public static boolean isCriticalEvent​(java.lang.String eventId)
          +
          Checks if the given validation event was emitted by a critical validator.
          +
          +
          Parameters:
          +
          eventId - Event ID to check if it's a critical validation event.
          +
          Returns:
          +
          Returns true if the given event was emitted from a critical validator.
          +
          +
          • +
        + + + +
          +
        • +

          splitCamelCaseWord

          +
          public static java.util.List<java.lang.String> splitCamelCaseWord​(java.lang.String word)
          +
          Splits a camelCase word into a list of words.
          +
          +
          Parameters:
          +
          word - Word to split.
          +
          Returns:
          +
          Returns the split words.
          +
          +
          • +
        + + + +
          +
        • +

          orderedTickedList

          +
          public static java.lang.String orderedTickedList​(java.util.Collection<?> values)
          +
          Creates a comma separated string made up of the given collection. + Each value is surrounded by "`", and the values are sorted to make it + easier to write tests against the messages.
          +
          +
          Parameters:
          +
          values - Values to turn into a comma separated list.
          +
          Returns:
          +
          Returns the string.
          +
          +
          • +
        + + + +
          +
        • +

          tickedList

          +
          public static java.lang.String tickedList​(java.util.Collection<?> values)
          +
          Creates a comma separated string made up of the given collection. + Each value is surrounded by "`", and the values are sorted to make it + easier to write tests against the messages.
          +
          +
          Parameters:
          +
          values - Values to turn into a comma separated list.
          +
          Returns:
          +
          Returns the string.
          +
          +
          • +
        + + + +
          +
        • +

          tickedList

          +
          public static java.lang.String tickedList​(java.util.stream.Stream<?> values)
          +
          • +
        + + + +
          +
        • +

          tickedPrettyPrintedNode

          +
          public static java.lang.String tickedPrettyPrintedNode​(Node node)
          +
          Writes the contents of a Node to a pretty-printed JSON string surrounded in backticks.
          +
          +
          Parameters:
          +
          node - Node to write.
          +
          Returns:
          +
          Returns a string suitable for Markdown rendering.
          +
          +
          • +
        + + + +
          +
        • +

          findDuplicateShapeNames

          +
          @Deprecated
+public static <T extends ToShapeId> java.util.Map<java.lang.String,​java.util.List<ShapeId>> findDuplicateShapeNames​(java.util.Collection<T> shapes)
          +
          Deprecated.
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/Validator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/Validator.html new file mode 100644 index 00000000000..82fc13fb0d6 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/Validator.html @@ -0,0 +1,352 @@ + + + + + +Validator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation
    +

    Interface Validator

    +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        static java.lang.StringMODEL_DEPRECATION +
        Event ID used when something in the model is deprecated.
        +
        static java.lang.StringMODEL_ERROR +
        Event ID used for structural errors encountered when loading a model.
        +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          MODEL_ERROR

          +
          static final java.lang.String MODEL_ERROR
          +
          Event ID used for structural errors encountered when loading a model.
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        + + + +
          +
        • +

          MODEL_DEPRECATION

          +
          static final java.lang.String MODEL_DEPRECATION
          +
          Event ID used when something in the model is deprecated.
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          java.util.List<ValidationEvent> validate​(Model model)
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/ValidatorFactory.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/ValidatorFactory.html new file mode 100644 index 00000000000..7ada3193c16 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/ValidatorFactory.html @@ -0,0 +1,407 @@ + + + + + +ValidatorFactory (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation
    +

    Interface ValidatorFactory

    +
    +
    +
    +
      +
    • +
      +
      public interface ValidatorFactory
      +
      Creates built-in Validator instances and Validator + instances loaded by name.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          loadBuiltinValidators

          +
          java.util.List<Validator> loadBuiltinValidators()
          +
          Returns a list of built-in validators that are always applied to a + Model regardless of if they are explicitly configured in the metadata + of a model. This is in contrast to validators returns from calling + createValidator(java.lang.String, software.amazon.smithy.model.node.ObjectNode), which are only applied to a model if they + are declared in the metadata section of a model.
          +
          +
          Returns:
          +
          Returns the loaded validators.
          +
          +
          • +
        + + + +
          +
        • +

          loadDecorators

          +
          default java.util.List<ValidationEventDecorator> loadDecorators()
          +
          Returns a list of decorators.
          +
          +
          Returns:
          +
          Returns the loaded decorators.
          +
          +
          • +
        + + + +
          +
        • +

          createValidator

          +
          java.util.Optional<Validator> createValidator​(java.lang.String name,
+                                              ObjectNode configuration)
          +
          Creates and configures a Validator by name.
          +
          +
          Parameters:
          +
          name - Name of the validator to create.
          +
          configuration - Configuration data used to create the validator.
          +
          Returns:
          +
          Returns the created validator wrapped in an Optional.
          +
          Throws:
          +
          SourceException - on configuration error.
          +
          java.lang.RuntimeException - if an error occurs while creating.
          +
          +
          • +
        + + + +
          +
        • +

          createServiceFactory

          +
          static ValidatorFactory createServiceFactory​(java.lang.Iterable<Validator> validators,
+                                             java.lang.Iterable<ValidatorService> services)
          +
          Creates a ValidatorFactory that uses a collection of built-in validators + and a collection of ValidatorService instances for configurable validators. + +

          The validators and services passed to this method are copied into a + List before creating the actual factory to avoid holding on to + ServiceLoader VM-wide instances that potentially utilize a + Thread's context ClassLoader.

          +
          +
          Parameters:
          +
          validators - Built-in validators to provide from the factory.
          +
          services - ValidatorService instances to use to create validators.
          +
          Returns:
          +
          Returns the created ValidatorFactory.
          +
          +
          • +
        + + + +
          +
        • +

          createServiceFactory

          +
          static ValidatorFactory createServiceFactory​(java.lang.Iterable<Validator> validators,
+                                             java.lang.Iterable<ValidatorService> services,
+                                             java.lang.Iterable<ValidationEventDecorator> decorators)
          +
          Creates a ValidatorFactory that uses a collection of built-in validators + and a collection of ValidatorService instances for configurable validators. + +

          The validators and services passed to this method are copied into a + List before creating the actual factory to avoid holding on to + ServiceLoader VM-wide instances that potentially utilize a + Thread's context ClassLoader.

          +
          +
          Parameters:
          +
          validators - Built-in validators to provide from the factory.
          +
          services - ValidatorService instances to use to create validators.
          +
          decorators - ValidationEventDecorator instances to use to create decorators.
          +
          Returns:
          +
          Returns the created ValidatorFactory.
          +
          +
          • +
        + + + +
          +
        • +

          createServiceFactory

          +
          static ValidatorFactory createServiceFactory​(java.lang.ClassLoader classLoader)
          +
          Creates a ValidatorFactory that discovers service providers using + the given ClassLoader.
          +
          +
          Parameters:
          +
          classLoader - Class loader used to find ValidatorProviders.
          +
          Returns:
          +
          Returns the created factory.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/ValidatorService.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/ValidatorService.Provider.html new file mode 100644 index 00000000000..4c888180979 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/ValidatorService.Provider.html @@ -0,0 +1,406 @@ + + + + + +ValidatorService.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation
    +

    Class ValidatorService.Provider

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.validation.ValidatorService.Provider
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider​(java.lang.Class<T> klass, + java.util.function.Function<ObjectNode,​T> provider) 
        Provider​(java.lang.Class<T> klass, + java.util.function.Supplier<T> supplier) 
        Provider​(java.lang.String name, + java.util.function.Function<ObjectNode,​? extends Validator> provider) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        ValidatorcreateValidator​(ObjectNode configuration) +
        Creates a validator using configuration.
        +
        java.lang.StringgetName() +
        Gets the name of the validator.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider​(java.lang.String name,
+                java.util.function.Function<ObjectNode,​? extends Validator> provider)
          +
          • +
        + + + +
          +
        • +

          Provider

          +
          public Provider​(java.lang.Class<T> klass,
+                java.util.function.Function<ObjectNode,​T> provider)
          +
          • +
        + + + +
          +
        • +

          Provider

          +
          public Provider​(java.lang.Class<T> klass,
+                java.util.function.Supplier<T> supplier)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getName

          +
          public final java.lang.String getName()
          +
          Description copied from interface: ValidatorService
          +
          Gets the name of the validator. + +

          This name is used to find a matching validator configured in the + Smithy model and match it to an implementation.

          +
          +
          Specified by:
          +
          getName in interface ValidatorService
          +
          Returns:
          +
          Returns the name of the validator it creates.
          +
          +
          • +
        + + + +
          +
        • +

          createValidator

          +
          public final Validator createValidator​(ObjectNode configuration)
          +
          Description copied from interface: ValidatorService
          +
          Creates a validator using configuration.
          +
          +
          Specified by:
          +
          createValidator in interface ValidatorService
          +
          Parameters:
          +
          configuration - Validator configuration.
          +
          Returns:
          +
          Returns the created validator.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/ValidatorService.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/ValidatorService.html new file mode 100644 index 00000000000..d5cbc02cce8 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/ValidatorService.html @@ -0,0 +1,338 @@ + + + + + +ValidatorService (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation
    +

    Interface ValidatorService

    +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeInterfaceDescription
        static class ValidatorService.Provider +
        Provides a simple abstraction for creating validator service subclasses.
        +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getName

          +
          java.lang.String getName()
          +
          Gets the name of the validator. + +

          This name is used to find a matching validator configured in the + Smithy model and match it to an implementation.

          +
          +
          Returns:
          +
          Returns the name of the validator it creates.
          +
          +
          • +
        + + + +
          +
        • +

          createValidator

          +
          Validator createValidator​(ObjectNode configuration)
          +
          Creates a validator using configuration.
          +
          +
          Parameters:
          +
          configuration - Validator configuration.
          +
          Returns:
          +
          Returns the created validator.
          +
          +
          • +
        + + + +
          +
        • +

          determineValidatorName

          +
          static java.lang.String determineValidatorName​(java.lang.Class<?> clazz)
          +
          Determines the name of a validator based on a class name. + +

          This method returns the simple name of a class and strips off + "Validator" from the end of the name if present.

          +
          +
          Parameters:
          +
          clazz - Class to determine the validator name of.
          +
          Returns:
          +
          Returns the validator name based on heuristics.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/linters/EmitEachSelectorValidator.Config.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/linters/EmitEachSelectorValidator.Config.html new file mode 100644 index 00000000000..723e5831ddf --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/linters/EmitEachSelectorValidator.Config.html @@ -0,0 +1,414 @@ + + + + + +EmitEachSelectorValidator.Config (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.linters
    +

    Class EmitEachSelectorValidator.Config

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.validation.linters.EmitEachSelectorValidator.Config
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      EmitEachSelectorValidator
      +
      +
      +
      public static final class EmitEachSelectorValidator.Config
+extends java.lang.Object
      +
      EmitEachSelector configuration settings.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Config() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        ShapeIdgetBindToTrait() +
        Gets the optional trait that each emitted event is bound to.
        +
        java.lang.StringgetMessageTemplate() +
        Gets the optional message template that can reference selector variables.
        +
        SelectorgetSelector() +
        Gets the required selector that matches shapes.
        +
        voidsetBindToTrait​(ShapeId bindToTrait) 
        voidsetMessageTemplate​(java.lang.String messageTemplate) +
        Sets the optional message template for each emitted event.
        +
        voidsetSelector​(Selector selector) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Config

          +
          public Config()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getSelector

          +
          public Selector getSelector()
          +
          Gets the required selector that matches shapes. + +

          Each shape that matches the given selector will emit a + validation event.

          +
          +
          Returns:
          +
          Selector to match on.
          +
          +
          • +
        + + + +
          +
        • +

          setSelector

          +
          public void setSelector​(Selector selector)
          +
          • +
        + + + +
          +
        • +

          getBindToTrait

          +
          public ShapeId getBindToTrait()
          +
          Gets the optional trait that each emitted event is bound to. + +

          An event is only emitted for shapes that have this trait.

          +
          +
          Returns:
          +
          Returns the trait to bind each event to.
          +
          +
          • +
        + + + +
          +
        • +

          setBindToTrait

          +
          public void setBindToTrait​(ShapeId bindToTrait)
          +
          • +
        + + + +
          +
        • +

          getMessageTemplate

          +
          public java.lang.String getMessageTemplate()
          +
          Gets the optional message template that can reference selector variables.
          +
          +
          Returns:
          +
          Returns the message template.
          +
          +
          • +
        + + + +
          +
        • +

          setMessageTemplate

          +
          public void setMessageTemplate​(java.lang.String messageTemplate)
          +
          Sets the optional message template for each emitted event.
          +
          +
          Parameters:
          +
          messageTemplate - Message template to set.
          +
          Throws:
          +
          ModelSyntaxException - if the message template is invalid.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/linters/EmitEachSelectorValidator.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/linters/EmitEachSelectorValidator.Provider.html new file mode 100644 index 00000000000..e7aa40fdfa6 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/linters/EmitEachSelectorValidator.Provider.html @@ -0,0 +1,303 @@ + + + + + +EmitEachSelectorValidator.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.linters
    +

    Class EmitEachSelectorValidator.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/linters/EmitEachSelectorValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/linters/EmitEachSelectorValidator.html new file mode 100644 index 00000000000..b2551987a6f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/linters/EmitEachSelectorValidator.html @@ -0,0 +1,382 @@ + + + + + +EmitEachSelectorValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.linters
    +

    Class EmitEachSelectorValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class EmitEachSelectorValidator
+extends AbstractValidator
      +
      Emits a validation event for each shape that matches a selector.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          EmitEachSelectorValidator

          +
          public EmitEachSelectorValidator​(EmitEachSelectorValidator.Config config)
          +
          +
          Parameters:
          +
          config - Validator configuration.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/linters/EmitNoneSelectorValidator.Config.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/linters/EmitNoneSelectorValidator.Config.html new file mode 100644 index 00000000000..e2b7017f13c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/linters/EmitNoneSelectorValidator.Config.html @@ -0,0 +1,332 @@ + + + + + +EmitNoneSelectorValidator.Config (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.linters
    +

    Class EmitNoneSelectorValidator.Config

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.validation.linters.EmitNoneSelectorValidator.Config
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      EmitNoneSelectorValidator
      +
      +
      +
      public static final class EmitNoneSelectorValidator.Config
+extends java.lang.Object
      +
      EmitNoneSelector configuration settings.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Config() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        SelectorgetSelector() +
        Gets the selector that if no shapes match, a validation event + is emitted.
        +
        voidsetSelector​(Selector selector) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Config

          +
          public Config()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getSelector

          +
          public Selector getSelector()
          +
          Gets the selector that if no shapes match, a validation event + is emitted.
          +
          +
          Returns:
          +
          Returns the selector.
          +
          +
          • +
        + + + +
          +
        • +

          setSelector

          +
          public void setSelector​(Selector selector)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/linters/EmitNoneSelectorValidator.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/linters/EmitNoneSelectorValidator.Provider.html new file mode 100644 index 00000000000..2f02b9e3a45 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/linters/EmitNoneSelectorValidator.Provider.html @@ -0,0 +1,303 @@ + + + + + +EmitNoneSelectorValidator.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.linters
    +

    Class EmitNoneSelectorValidator.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/linters/EmitNoneSelectorValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/linters/EmitNoneSelectorValidator.html new file mode 100644 index 00000000000..c08ceb13358 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/linters/EmitNoneSelectorValidator.html @@ -0,0 +1,338 @@ + + + + + +EmitNoneSelectorValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.linters
    +

    Class EmitNoneSelectorValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class EmitNoneSelectorValidator
+extends AbstractValidator
      +
      Emits a validation event if no shapes match the given selector.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/linters/UnreferencedShapeValidator.Config.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/linters/UnreferencedShapeValidator.Config.html new file mode 100644 index 00000000000..0eb1eed1437 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/linters/UnreferencedShapeValidator.Config.html @@ -0,0 +1,333 @@ + + + + + +UnreferencedShapeValidator.Config (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.linters
    +

    Class UnreferencedShapeValidator.Config

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.validation.linters.UnreferencedShapeValidator.Config
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      UnreferencedShapeValidator
      +
      +
      +
      public static final class UnreferencedShapeValidator.Config
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Config() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        SelectorgetRootShapeSelector() +
        The Selector used to find root shapes, and any shape that is not connected to any of the returned root + shapes is considered unreferenced.
        +
        voidsetRootShapeSelector​(Selector rootShapeSelector) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Config

          +
          public Config()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getRootShapeSelector

          +
          public Selector getRootShapeSelector()
          +
          The Selector used to find root shapes, and any shape that is not connected to any of the returned root + shapes is considered unreferenced. + +

          Defaults to "service" if not set.

          +
          +
          Returns:
          +
          Returns the root selector;
          +
          +
          • +
        + + + +
          +
        • +

          setRootShapeSelector

          +
          public void setRootShapeSelector​(Selector rootShapeSelector)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/linters/UnreferencedShapeValidator.Provider.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/linters/UnreferencedShapeValidator.Provider.html new file mode 100644 index 00000000000..690af85962a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/linters/UnreferencedShapeValidator.Provider.html @@ -0,0 +1,303 @@ + + + + + +UnreferencedShapeValidator.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.linters
    +

    Class UnreferencedShapeValidator.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/linters/UnreferencedShapeValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/linters/UnreferencedShapeValidator.html new file mode 100644 index 00000000000..91b76b6ce9e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/linters/UnreferencedShapeValidator.html @@ -0,0 +1,340 @@ + + + + + +UnreferencedShapeValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.linters
    +

    Class UnreferencedShapeValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class UnreferencedShapeValidator
+extends AbstractValidator
      +
      Finds shapes that aren't connected to any shapes considered "roots" (defaults to service shapes). + +

      This linter is in smithy-model rather than smithy-linters so that it's easier for developers relying on the + deprecated UnreferencedShape validator that was always on to migrate to this one instead without needing another + dependency.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/linters/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/linters/package-summary.html new file mode 100644 index 00000000000..f1f4b566f01 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/linters/package-summary.html @@ -0,0 +1,206 @@ + + + + + +software.amazon.smithy.model.validation.linters (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.model.validation.linters

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/linters/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/linters/package-tree.html new file mode 100644 index 00000000000..75b49de1580 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/linters/package-tree.html @@ -0,0 +1,177 @@ + + + + + +software.amazon.smithy.model.validation.linters Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.model.validation.linters

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/node/NodeValidatorPlugin.Context.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/node/NodeValidatorPlugin.Context.html new file mode 100644 index 00000000000..30d79634da6 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/node/NodeValidatorPlugin.Context.html @@ -0,0 +1,404 @@ + + + + + +NodeValidatorPlugin.Context (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.node
    +

    Class NodeValidatorPlugin.Context

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.validation.node.NodeValidatorPlugin.Context
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing interface:
      +
      NodeValidatorPlugin
      +
      +
      +
      public static final class NodeValidatorPlugin.Context
+extends java.lang.Object
      +
      Validation context to pass to each NodeValidatorPlugin.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          model

          +
          public Model model()
          +
          Get the model being evaluated.
          +
          +
          Returns:
          +
          Returns the model.
          +
          +
          • +
        + + + +
          +
        • +

          select

          +
          public java.util.Set<Shape> select​(Selector selector)
          +
          Select and memoize shapes from the model using a Selector. + +

          The cache used by this method is not thread-safe, though that's + fine because NodeValidatorPlugins using the same Context all run + within the same thread.

          +
          +
          Parameters:
          +
          selector - Selector to evaluate.
          +
          Returns:
          +
          Returns the matching shapes.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          setReferringMember

          +
          public void setReferringMember​(MemberShape referringMember)
          +
          • +
        + + + +
          +
        • +

          getReferringMember

          +
          public java.util.Optional<MemberShape> getReferringMember()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/node/NodeValidatorPlugin.Emitter.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/node/NodeValidatorPlugin.Emitter.html new file mode 100644 index 00000000000..c6c92732a58 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/node/NodeValidatorPlugin.Emitter.html @@ -0,0 +1,297 @@ + + + + + +NodeValidatorPlugin.Emitter (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.node
    +

    Interface NodeValidatorPlugin.Emitter

    +
    +
    +
    +
      +
    • +
      +
      Enclosing interface:
      +
      NodeValidatorPlugin
      +
      +
      +
      Functional Interface:
      +
      This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
      +
      +
      +
      @FunctionalInterface
+public static interface NodeValidatorPlugin.Emitter
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          accept

          +
          void accept​(FromSourceLocation sourceLocation,
+            Severity severity,
+            java.lang.String message,
+            java.lang.String... additionalEventIdParts)
          +
          • +
        + + + +
          +
        • +

          accept

          +
          default void accept​(FromSourceLocation sourceLocation,
+                    java.lang.String message)
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/node/NodeValidatorPlugin.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/node/NodeValidatorPlugin.html new file mode 100644 index 00000000000..ee4e6555843 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/node/NodeValidatorPlugin.html @@ -0,0 +1,361 @@ + + + + + +NodeValidatorPlugin (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.node
    +

    Interface NodeValidatorPlugin

    +
    +
    +
    +
      +
    • +
      +
      All Known Implementing Classes:
      +
      TimestampValidationStrategy
      +
      +
      +
      public interface NodeValidatorPlugin
      +
      Applies pluggable validation when validating Node values against + the schema of a Shape (e.g., when validating that the values + provided for a trait in the model are valid for the shape of the trait).
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          EMPTY_STRING_ARRAY

          +
          static final java.lang.String[] EMPTY_STRING_ARRAY
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          apply

          +
          void apply​(Shape shape,
+           Node value,
+           NodeValidatorPlugin.Context context,
+           NodeValidatorPlugin.Emitter emitter)
          +
          Applies the plugin to the given shape, node value, and model.
          +
          +
          Parameters:
          +
          shape - Shape being checked.
          +
          value - Value being evaluated.
          +
          context - Evaluation context.
          +
          emitter - Consumer to notify of validation event locations and messages.
          +
          +
          • +
        + + + +
          +
        • +

          getBuiltins

          +
          static java.util.List<NodeValidatorPlugin> getBuiltins()
          +
          +
          Returns:
          +
          Gets the built-in Node validation plugins.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/node/TimestampValidationStrategy.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/node/TimestampValidationStrategy.html new file mode 100644 index 00000000000..3005c5e1183 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/node/TimestampValidationStrategy.html @@ -0,0 +1,433 @@ + + + + + +TimestampValidationStrategy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.node
    +

    Enum TimestampValidationStrategy

    +
    +
    +
      +
    • java.lang.Object
      • +
    • + +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        EPOCH_SECONDS +
        Requires that the value provided for all timestamp shapes is a + unix timestamp.
        +
        FORMAT +
        Validates timestamps by requiring that the value uses matches the + resolved timestamp format, or is a unix timestamp or integer in the + case that a member or shape does not have a timestampFormat + trait.
        +
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static TimestampValidationStrategyvalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static TimestampValidationStrategy[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        + +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + +
          +
        • +

          FORMAT

          +
          public static final TimestampValidationStrategy FORMAT
          +
          Validates timestamps by requiring that the value uses matches the + resolved timestamp format, or is a unix timestamp or integer in the + case that a member or shape does not have a timestampFormat + trait.
          +
          • +
        + + + +
          +
        • +

          EPOCH_SECONDS

          +
          public static final TimestampValidationStrategy EPOCH_SECONDS
          +
          Requires that the value provided for all timestamp shapes is a + unix timestamp.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static TimestampValidationStrategy[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (TimestampValidationStrategy c : TimestampValidationStrategy.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static TimestampValidationStrategy valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/node/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/node/package-summary.html new file mode 100644 index 00000000000..8b8e9bedc3f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/node/package-summary.html @@ -0,0 +1,206 @@ + + + + + +software.amazon.smithy.model.validation.node (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.model.validation.node

    +
    +
    +
      +
    • + + + + + + + + + + + + + + + + +
      Interface Summary 
      InterfaceDescription
      NodeValidatorPlugin +
      Applies pluggable validation when validating Node values against + the schema of a Shape (e.g., when validating that the values + provided for a trait in the model are valid for the shape of the trait).
      +
      NodeValidatorPlugin.Emitter 
      +
      • +
    • + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      NodeValidatorPlugin.Context +
      Validation context to pass to each NodeValidatorPlugin.
      +
      +
      • +
    • + + + + + + + + + + + + +
      Enum Summary 
      EnumDescription
      TimestampValidationStrategy +
      Defines how timestamps are validated.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/node/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/node/package-tree.html new file mode 100644 index 00000000000..3bb710961b1 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/node/package-tree.html @@ -0,0 +1,182 @@ + + + + + +software.amazon.smithy.model.validation.node Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.model.validation.node

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +

    Enum Hierarchy

    +
      +
    • java.lang.Object +
        +
      • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
        • +
      +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/package-summary.html new file mode 100644 index 00000000000..496ecc1f8cc --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/package-summary.html @@ -0,0 +1,307 @@ + + + + + +software.amazon.smithy.model.validation (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.model.validation

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/package-tree.html new file mode 100644 index 00000000000..bfaeda5044a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/package-tree.html @@ -0,0 +1,208 @@ + + + + + +software.amazon.smithy.model.validation Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.model.validation

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +

    Enum Hierarchy

    +
      +
    • java.lang.Object +
        +
      • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
        • +
      +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/suppressions/ModelBasedEventDecorator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/suppressions/ModelBasedEventDecorator.html new file mode 100644 index 00000000000..642554fb41e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/suppressions/ModelBasedEventDecorator.html @@ -0,0 +1,365 @@ + + + + + +ModelBasedEventDecorator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.suppressions
    +

    Class ModelBasedEventDecorator

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.validation.suppressions.ModelBasedEventDecorator
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class ModelBasedEventDecorator
+extends java.lang.Object
      +
      Creates a ValidationEventDecorator that applies custom suppressions, custom severity overrides, + suppressions parsed from model metadata, and severity overrides parsed from model metadata.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ModelBasedEventDecorator

          +
          public ModelBasedEventDecorator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          suppressions

          +
          public ModelBasedEventDecorator suppressions​(java.util.Collection<? extends Suppression> suppressions)
          +
          Sets custom suppressions not found in the model.
          +
          +
          Parameters:
          +
          suppressions - Suppressions to set.
          +
          Returns:
          +
          Returns the ModelBasedEventDecorator.
          +
          +
          • +
        + + + +
          +
        • +

          severityOverrides

          +
          public ModelBasedEventDecorator severityOverrides​(java.util.Collection<? extends SeverityOverride> severityOverrides)
          +
          Sets custom severity overrides not found in the model.
          +
          +
          Parameters:
          +
          severityOverrides - Severity overrides to set.
          +
          Returns:
          +
          Returns the ModelBasedEventDecorator.
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/suppressions/SeverityOverride.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/suppressions/SeverityOverride.html new file mode 100644 index 00000000000..062db33782b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/suppressions/SeverityOverride.html @@ -0,0 +1,288 @@ + + + + + +SeverityOverride (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.suppressions
    +

    Interface SeverityOverride

    +
    +
    +
    +
      +
    • +
      +
      Functional Interface:
      +
      This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
      +
      +
      +
      @FunctionalInterface
+public interface SeverityOverride
      +
      Changes the severity of a validation event.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          apply

          +
          Severity apply​(ValidationEvent event)
          +
          Returns the severity to apply to the validation event.
          +
          +
          Parameters:
          +
          event - Event to modify.
          +
          Returns:
          +
          Returns the severity to use with the event.
          +
          +
          • +
        + + + +
          +
        • +

          fromMetadata

          +
          static SeverityOverride fromMetadata​(Node node)
          +
          Creates a severity override from a Node found in the "severityOverrides" metadata of a Smithy model.
          +
          +
          Parameters:
          +
          node - Node to parse.
          +
          Returns:
          +
          Returns the loaded override.
          +
          Throws:
          +
          ExpectationNotMetException - if the override node is malformed.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/suppressions/Suppression.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/suppressions/Suppression.html new file mode 100644 index 00000000000..39cf6274d7f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/suppressions/Suppression.html @@ -0,0 +1,338 @@ + + + + + +Suppression (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.suppressions
    +

    Interface Suppression

    +
    +
    +
    +
      +
    • +
      +
      Functional Interface:
      +
      This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
      +
      +
      +
      @FunctionalInterface
+public interface Suppression
      +
      Suppresses ValidationEvents emitted from Validators.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          test

          +
          boolean test​(ValidationEvent event)
          +
          Determines if the suppression applies to the given event.
          +
          +
          Parameters:
          +
          event - Event to test.
          +
          Returns:
          +
          Returns true if the suppression applies.
          +
          +
          • +
        + + + +
          +
        • +

          getReason

          +
          default java.util.Optional<java.lang.String> getReason()
          +
          Gets the optional reason for the suppression.
          +
          +
          Returns:
          +
          Returns the optional suppression reason.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          fromMetadata

          +
          static Suppression fromMetadata​(Node node)
          +
          Creates a suppression from a Node found in the + "suppressions" metadata of a Smithy model.
          +
          +
          Parameters:
          +
          node - Node to parse.
          +
          Returns:
          +
          Returns the loaded suppression.
          +
          Throws:
          +
          ExpectationNotMetException - if the suppression node is malformed.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/suppressions/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/suppressions/package-summary.html new file mode 100644 index 00000000000..cda29257a61 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/suppressions/package-summary.html @@ -0,0 +1,190 @@ + + + + + +software.amazon.smithy.model.validation.suppressions (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.model.validation.suppressions

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/suppressions/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/suppressions/package-tree.html new file mode 100644 index 00000000000..3b8cd6c9a3c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/suppressions/package-tree.html @@ -0,0 +1,168 @@ + + + + + +software.amazon.smithy.model.validation.suppressions Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.model.validation.suppressions

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    +
      +
    • software.amazon.smithy.model.validation.suppressions.SeverityOverride
      • +
    • software.amazon.smithy.model.validation.suppressions.Suppression
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/testrunner/SmithyTestCase.Error.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/testrunner/SmithyTestCase.Error.html new file mode 100644 index 00000000000..15715a4aeb9 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/testrunner/SmithyTestCase.Error.html @@ -0,0 +1,303 @@ + + + + + +SmithyTestCase.Error (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.testrunner
    +

    Class SmithyTestCase.Error

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Throwable
        • +
      • +
          +
        • java.lang.Exception
          • +
        • +
            +
          • java.lang.RuntimeException
            • +
          • +
              +
            • software.amazon.smithy.model.validation.testrunner.SmithyTestCase.Error
              • +
            +
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      Enclosing class:
      +
      SmithyTestCase
      +
      +
      +
      public static final class SmithyTestCase.Error
+extends java.lang.RuntimeException
      +
      Thrown when errors are encountered while unwrapping a test case.
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/testrunner/SmithyTestCase.Result.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/testrunner/SmithyTestCase.Result.html new file mode 100644 index 00000000000..10009011a9c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/testrunner/SmithyTestCase.Result.html @@ -0,0 +1,371 @@ + + + + + +SmithyTestCase.Result (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.testrunner
    +

    Class SmithyTestCase.Result

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.validation.testrunner.SmithyTestCase.Result
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      SmithyTestCase
      +
      +
      +
      public static final class SmithyTestCase.Result
+extends java.lang.Object
      +
      Output of validating a model against a test case.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          isInvalid

          +
          public boolean isInvalid()
          +
          Checks if the result does not match expected results.
          +
          +
          Returns:
          +
          True if there are extra or unmatched events.
          +
          +
          • +
        + + + +
          +
        • +

          getModelLocation

          +
          public java.lang.String getModelLocation()
          +
          +
          Returns:
          +
          Returns a description of where the model was stored.
          +
          +
          • +
        + + + +
          +
        • +

          getUnmatchedEvents

          +
          public java.util.Collection<ValidationEvent> getUnmatchedEvents()
          +
          +
          Returns:
          +
          Returns the events that were expected but not encountered.
          +
          +
          • +
        + + + +
          +
        • +

          getExtraEvents

          +
          public java.util.Collection<ValidationEvent> getExtraEvents()
          +
          +
          Returns:
          +
          Returns the events that were encountered but not expected.
          +
          +
          • +
        + + + +
          +
        • +

          unwrap

          +
          public SmithyTestCase.Result unwrap()
          +
          Throws an exception if the result is invalid, otherwise returns the result.
          +
          +
          Returns:
          +
          Returns the result if it is ok.
          +
          Throws:
          +
          SmithyTestCase.Error - if the result contains invalid events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/testrunner/SmithyTestCase.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/testrunner/SmithyTestCase.html new file mode 100644 index 00000000000..d87319306cc --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/testrunner/SmithyTestCase.html @@ -0,0 +1,437 @@ + + + + + +SmithyTestCase (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.testrunner
    +

    Class SmithyTestCase

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.validation.testrunner.SmithyTestCase
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class SmithyTestCase
+extends java.lang.Object
      +
      Runs a single test case by loading a model and ensuring the resulting + events match the validation events stored in a newline separated file.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          SmithyTestCase

          +
          public SmithyTestCase​(java.lang.String modelLocation,
+                      java.util.List<ValidationEvent> expectedEvents)
          +
          +
          Parameters:
          +
          modelLocation - Location of where the model is stored.
          +
          expectedEvents - The expected validation events to encounter.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          fromModelFile

          +
          public static SmithyTestCase fromModelFile​(java.lang.String modelLocation)
          +
          Creates a test case from a model file. + +

          The error file is expected to be stored in the same directory + as the model file and is assumed to be named the same as the + file with the file extension replaced with ".errors". + +

          The accompanying error file is a newline separated list of error + strings, where each error is defined in the following format: + [SEVERITY] shapeId message | EventId filename:line:column. + A shapeId of "-" means that a specific shape is not targeted.

          +
          +
          Parameters:
          +
          modelLocation - File location of the model.
          +
          Returns:
          +
          Returns the created test case.
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if the file does not contain an extension.
          +
          +
          • +
        + + + +
          +
        • +

          getExpectedEvents

          +
          public java.util.List<ValidationEvent> getExpectedEvents()
          +
          Gets the expected validation events.
          +
          +
          Returns:
          +
          Expected validation events.
          +
          +
          • +
        + + + +
          +
        • +

          getModelLocation

          +
          public java.lang.String getModelLocation()
          +
          Gets the location of the model file.
          +
          +
          Returns:
          +
          Model location.
          +
          +
          • +
        + + + +
          +
        • +

          createResult

          +
          public SmithyTestCase.Result createResult​(ValidatedResult<Model> validatedResult)
          +
          Creates a test case result from a test case and validated model. + +

          The validation events encountered while validating a model are + compared against the expected validation events. An actual event (A) is + considered a match with an expected event (E) if A and E target the + same shape, have the same severity, the eventId of A contains the eventId + of E, and the message of E starts with the suppression reason or message + of A.

          +
          +
          Parameters:
          +
          validatedResult - Result of creating and validating the model.
          +
          Returns:
          +
          Returns the created test case result.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/testrunner/SmithyTestSuite.Error.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/testrunner/SmithyTestSuite.Error.html new file mode 100644 index 00000000000..c6ffbecbf10 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/testrunner/SmithyTestSuite.Error.html @@ -0,0 +1,303 @@ + + + + + +SmithyTestSuite.Error (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.testrunner
    +

    Class SmithyTestSuite.Error

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Throwable
        • +
      • +
          +
        • java.lang.Exception
          • +
        • +
            +
          • java.lang.RuntimeException
            • +
          • +
              +
            • software.amazon.smithy.model.validation.testrunner.SmithyTestSuite.Error
              • +
            +
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      Enclosing class:
      +
      SmithyTestSuite
      +
      +
      +
      public static final class SmithyTestSuite.Error
+extends java.lang.RuntimeException
      +
      Thrown when errors are encountered in the test runner.
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/testrunner/SmithyTestSuite.Result.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/testrunner/SmithyTestSuite.Result.html new file mode 100644 index 00000000000..56a01304152 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/testrunner/SmithyTestSuite.Result.html @@ -0,0 +1,309 @@ + + + + + +SmithyTestSuite.Result (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.testrunner
    +

    Class SmithyTestSuite.Result

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.validation.testrunner.SmithyTestSuite.Result
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      SmithyTestSuite
      +
      +
      +
      public static final class SmithyTestSuite.Result
+extends java.lang.Object
      +
      Value result of executing the test suite.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getSuccessCount

          +
          public int getSuccessCount()
          +
          +
          Returns:
          +
          Returns the number of test cases that passed.
          +
          +
          • +
        + + + +
          +
        • +

          getFailedResults

          +
          public java.util.List<SmithyTestCase.Result> getFailedResults()
          +
          +
          Returns:
          +
          Returns the test cases that failed.
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/testrunner/SmithyTestSuite.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/testrunner/SmithyTestSuite.html new file mode 100644 index 00000000000..e8474be63c2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/testrunner/SmithyTestSuite.html @@ -0,0 +1,613 @@ + + + + + +SmithyTestSuite (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.testrunner
    +

    Class SmithyTestSuite

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.validation.testrunner.SmithyTestSuite
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class SmithyTestSuite
+extends java.lang.Object
      +
      Runs test cases against a directory of models and error files.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          runner

          +
          public static SmithyTestSuite runner()
          +
          Creates a new Smithy test suite.
          +
          +
          Returns:
          +
          Returns the created test suite.
          +
          +
          • +
        + + + +
          +
        • +

          defaultParameterizedTestSource

          +
          public static java.util.stream.Stream<java.lang.Object[]> defaultParameterizedTestSource​(java.lang.Class<?> contextClass)
          +
          Factory method used to easily create a JUnit 5 ParameterizedTest + MethodSource based on the given Class. + +

          This method assumes that there is a resource named errorfiles + relative to the given class that contains test cases. It also assumes + validators and traits should be loaded using the ClassLoader + of the given contextClass, and that model discovery should be + used using the given contextClass. + +

          Each returned Object[] contains the filename of the test as + the first argument, followed by a Callable<SmithyTestCase.Result> + as the second argument. All a parameterized test needs to do is call + call on the provided Callable to execute the test and + fail if the test case is invalid. + +

          For example, the following can be used as a unit test: + + 

          
+ import java.util.concurrent.Callable;
+ import java.util.stream.Stream;
+ import org.junit.jupiter.params.ParameterizedTest;
+ import org.junit.jupiter.params.provider.MethodSource;
+ import software.amazon.smithy.model.validation.testrunner.SmithyTestCase;
+ import software.amazon.smithy.model.validation.testrunner.SmithyTestSuite;
+
+ public class TestRunnerTest {
+     \@ParameterizedTest(name = "\{0\}")
+     \@MethodSource("source")
+     public void testRunner(String filename, Callable&lt;SmithyTestCase.Result&gt; callable) throws Exception {
+         callable.call();
+     }
+
+     public static Stream&lt;?&gt; source() {
+         return SmithyTestSuite.defaultParameterizedTestSource(TestRunnerTest.class);
+     }
+ }
+
          +
          +
          Parameters:
          +
          contextClass - The class to use for loading errorfiles and model discovery.
          +
          Returns:
          +
          Returns the Stream that should be used as a JUnit 5 MethodSource return value.
          +
          +
          • +
        + + + +
          +
        • +

          parameterizedTestSource

          +
          public java.util.stream.Stream<java.lang.Object[]> parameterizedTestSource()
          +
          Factory method used to create a JUnit 5 ParameterizedTest + MethodSource. + +

          Test cases need to be added to the test suite before calling this, + for example by using addTestCasesFromDirectory(Path). + +

          Each returned Object[] contains the filename of the test as + the first argument, followed by a Callable<SmithyTestCase.Result> + as the second argument. All a parameterized test needs to do is call + call on the provided Callable to execute the test and + fail if the test case is invalid. + +

          For example, the following can be used as a unit test: + + 

          
+ import java.util.concurrent.Callable;
+ import java.util.stream.Stream;
+ import org.junit.jupiter.params.ParameterizedTest;
+ import org.junit.jupiter.params.provider.MethodSource;
+ import software.amazon.smithy.model.validation.testrunner.SmithyTestCase;
+ import software.amazon.smithy.model.validation.testrunner.SmithyTestSuite;
+
+ public class TestRunnerTest {
+     \@ParameterizedTest(name = "\{0\}")
+     \@MethodSource("source")
+     public void testRunner(String filename, Callable&lt;SmithyTestCase.Result&gt; callable) throws Exception {
+         callable.call();
+     }
+
+     public static Stream&lt;?&gt; source() {
+         ModelAssembler assembler = Model.assembler(TestRunnerTest.class.getClassLoader());
+         return SmithyTestSuite.runner()
+                 .setModelAssemblerFactory(assembler::copy)
+                 .addTestCasesFromUrl(TestRunnerTest.class.getResource("errorfiles"))
+                 .parameterizedTestSource();
+     }
+ }
+
          +
          +
          Returns:
          +
          Returns the Stream that should be used as a JUnit 5 MethodSource return value.
          +
          +
          • +
        + + + +
          +
        • +

          addTestCase

          +
          public SmithyTestSuite addTestCase​(SmithyTestCase testCase)
          +
          Adds a test case to the test suite.
          +
          +
          Parameters:
          +
          testCase - Test case to add.
          +
          Returns:
          +
          Returns the test suite.
          +
          +
          • +
        + + + +
          +
        • +

          addTestCasesFromDirectory

          +
          public SmithyTestSuite addTestCasesFromDirectory​(java.nio.file.Path modelDirectory)
          +
          Adds test cases by crawling a directory and looking for model files + that end with ".json" and ".smithy". A corresponding ".errors" file is + expected to be found for each found model file. + +

          See SmithyTestCase.fromModelFile(java.lang.String) for a description of how + the errors file is expected to be formatted.

          +
          +
          Parameters:
          +
          modelDirectory - Directory that contains models.
          +
          Returns:
          +
          Returns the test suite.
          +
          See Also:
          +
          SmithyTestCase.fromModelFile(java.lang.String)
          +
          +
          • +
        + + + +
          +
        • +

          addTestCasesFromUrl

          +
          public SmithyTestSuite addTestCasesFromUrl​(java.net.URL url)
          +
          Convenience method for supplying a directory using a class loader.
          +
          +
          Parameters:
          +
          url - URL that contains models.
          +
          Returns:
          +
          Returns the test suite.
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if a non-file scheme URL is provided.
          +
          See Also:
          +
          addTestCasesFromDirectory(java.nio.file.Path)
          +
          +
          • +
        + + + +
          +
        • +

          setModelAssemblerFactory

          +
          public SmithyTestSuite setModelAssemblerFactory​(java.util.function.Supplier<ModelAssembler> modelAssemblerFactory)
          +
          Sets a custom ModelAssembler factory to use to create a + ModelAssembler for each test case. + +

          The supplier must return a new instance of a Model assembler + each time it is called. Model assemblers are mutated and execute + in parallel.

          +
          +
          Parameters:
          +
          modelAssemblerFactory - Model assembler factory to use.
          +
          Returns:
          +
          Returns the test suite.
          +
          +
          • +
        + + + +
          +
        • +

          testCaseCallables

          +
          public java.util.stream.Stream<java.util.concurrent.Callable<SmithyTestCase.Result>> testCaseCallables()
          +
          Creates a Stream of Callable objects that can be used + to execute each test case. + +

          The SmithyTestCase.Result.unwrap() method must be called on + the result of each callable in order to actually assert that the test + case result is OK.

          +
          +
          Returns:
          +
          Returns a stream of test case callables.
          +
          +
          • +
        + + + +
          +
        • +

          run

          +
          public SmithyTestSuite.Result run()
          +
          Executes the test runner.
          +
          +
          Returns:
          +
          Returns the test case result object on success.
          +
          Throws:
          +
          SmithyTestSuite.Error - if the validation events do not match expectations.
          +
          +
          • +
        + + + +
          +
        • +

          run

          +
          public SmithyTestSuite.Result run​(java.util.concurrent.ExecutorService executorService)
          +
          Executes the test runner with a specific ExecutorService. + +

          Tests ideally should use JUnit 5's ParameterizedTest as described + in parameterizedTestSource(). However, this method can be + used to run tests in parallel in other scenarios (like if you aren't + using JUnit, or not running tests cases during unit tests).

          +
          +
          Parameters:
          +
          executorService - Executor service to execute tests with.
          +
          Returns:
          +
          Returns the test case result object on success.
          +
          Throws:
          +
          SmithyTestSuite.Error - if the validation events do not match expectations.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/testrunner/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/testrunner/package-summary.html new file mode 100644 index 00000000000..9fdc16f9058 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/testrunner/package-summary.html @@ -0,0 +1,208 @@ + + + + + +software.amazon.smithy.model.validation.testrunner (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.model.validation.testrunner

    +
    +
    +
      +
    • + + + + + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      SmithyTestCase +
      Runs a single test case by loading a model and ensuring the resulting + events match the validation events stored in a newline separated file.
      +
      SmithyTestCase.Result +
      Output of validating a model against a test case.
      +
      SmithyTestSuite +
      Runs test cases against a directory of models and error files.
      +
      SmithyTestSuite.Result +
      Value result of executing the test suite.
      +
      +
      • +
    • + + + + + + + + + + + + + + + + +
      Exception Summary 
      ExceptionDescription
      SmithyTestCase.Error +
      Thrown when errors are encountered while unwrapping a test case.
      +
      SmithyTestSuite.Error +
      Thrown when errors are encountered in the test runner.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/testrunner/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/testrunner/package-tree.html new file mode 100644 index 00000000000..717bb4f8714 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/testrunner/package-tree.html @@ -0,0 +1,178 @@ + + + + + +software.amazon.smithy.model.validation.testrunner Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.model.validation.testrunner

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    +
      +
    • java.lang.Object + +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/AuthTraitValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/AuthTraitValidator.html new file mode 100644 index 00000000000..431a1805cf9 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/AuthTraitValidator.html @@ -0,0 +1,350 @@ + + + + + +AuthTraitValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class AuthTraitValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class AuthTraitValidator
+extends AbstractValidator
      +
      All @auth trait values referenced from an operation must refer + to authentication traits applied to service shapes that enclose the + operation.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          AuthTraitValidator

          +
          public AuthTraitValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/DefaultTraitValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/DefaultTraitValidator.html new file mode 100644 index 00000000000..44f03032539 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/DefaultTraitValidator.html @@ -0,0 +1,347 @@ + + + + + +DefaultTraitValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class DefaultTraitValidator

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          DefaultTraitValidator

          +
          public DefaultTraitValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/DefaultValueInUpdateValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/DefaultValueInUpdateValidator.html new file mode 100644 index 00000000000..f195a93ccae --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/DefaultValueInUpdateValidator.html @@ -0,0 +1,350 @@ + + + + + +DefaultValueInUpdateValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class DefaultValueInUpdateValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class DefaultValueInUpdateValidator
+extends AbstractValidator
      +
      Finds operations that are meant to partially update a resource, but that use + members with default values in their input shapes, making it impossible + to know if the member was provided explicitly or defaulted.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          DefaultValueInUpdateValidator

          +
          public DefaultValueInUpdateValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/DeprecatedTraitValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/DeprecatedTraitValidator.html new file mode 100644 index 00000000000..93fb06a4f65 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/DeprecatedTraitValidator.html @@ -0,0 +1,348 @@ + + + + + +DeprecatedTraitValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class DeprecatedTraitValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class DeprecatedTraitValidator
+extends AbstractValidator
      +
      Emits a validation event if a model contains shapes that are bound to deprecated traits.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          DeprecatedTraitValidator

          +
          public DeprecatedTraitValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/EnumShapeValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/EnumShapeValidator.html new file mode 100644 index 00000000000..6349845f672 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/EnumShapeValidator.html @@ -0,0 +1,353 @@ + + + + + +EnumShapeValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class EnumShapeValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class EnumShapeValidator
+extends AbstractValidator
      +
      Emits an error validation event if an enum member's enumValue trait has the wrong type, + if there are any duplicate values in a single enum, if the enum's default value is + set using the enumValue trait, or if an intEnum member lacks an enumValue trait. + +

      Additionally, emits warning events when enum member names don't follow the recommended + naming convention of all upper case letters separated by underscores.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          EnumShapeValidator

          +
          public EnumShapeValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/EnumTraitValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/EnumTraitValidator.html new file mode 100644 index 00000000000..5f05fb31a72 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/EnumTraitValidator.html @@ -0,0 +1,352 @@ + + + + + +EnumTraitValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class EnumTraitValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class EnumTraitValidator
+extends AbstractValidator
      +
      Ensures that enum traits are valid. + +

      If one enum definition contains a name, then all definitions must contain + a name. All enum values and names must be unique across the list of + definitions.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          EnumTraitValidator

          +
          public EnumTraitValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/EventPayloadTraitValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/EventPayloadTraitValidator.html new file mode 100644 index 00000000000..9da4bee8b80 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/EventPayloadTraitValidator.html @@ -0,0 +1,352 @@ + + + + + +EventPayloadTraitValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class EventPayloadTraitValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class EventPayloadTraitValidator
+extends AbstractValidator
      +
      Ensures that when an event structure contains an eventPayload member, + that all other members are bound to headers. + +

      Only a single member can be marked with the eventPayload trait, and + this is validated using ExclusiveStructureMemberTraitValidator.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          EventPayloadTraitValidator

          +
          public EventPayloadTraitValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ExamplesTraitValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ExamplesTraitValidator.html new file mode 100644 index 00000000000..759296e1924 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ExamplesTraitValidator.html @@ -0,0 +1,348 @@ + + + + + +ExamplesTraitValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class ExamplesTraitValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class ExamplesTraitValidator
+extends AbstractValidator
      +
      Validates that examples traits are valid for their operations.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ExamplesTraitValidator

          +
          public ExamplesTraitValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ExclusiveStructureMemberTraitValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ExclusiveStructureMemberTraitValidator.html new file mode 100644 index 00000000000..9315c99ec8b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ExclusiveStructureMemberTraitValidator.html @@ -0,0 +1,348 @@ + + + + + +ExclusiveStructureMemberTraitValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class ExclusiveStructureMemberTraitValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class ExclusiveStructureMemberTraitValidator
+extends AbstractValidator
      +
      Validates traits that can only be applied to a single structure member.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ExclusiveStructureMemberTraitValidator

          +
          public ExclusiveStructureMemberTraitValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HostLabelTraitValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HostLabelTraitValidator.html new file mode 100644 index 00000000000..673003870d4 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HostLabelTraitValidator.html @@ -0,0 +1,363 @@ + + + + + +HostLabelTraitValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class HostLabelTraitValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class HostLabelTraitValidator
+extends AbstractValidator
      +
      Validates that hostLabel traits are applied correctly for operation inputs. + +
        +
      • Validates that if an operation's endpoint hostPrefix has labels + then it must have input.
        • +
      • Validates that a corresponding top-level input member can be found + for each label in each operation endpoint hostPrefix.
        • +
      • Validates that the correct type target type and traits are used for + labels.
        • +
      • Validates that all labels in the endpoint hostPrefix of each + operation have corresponding hostLabel traits.
        • +
      • Validates that an expanded version of each endpoint hostPrefix of + each operation is a valid RFC 3896 host.
        • +
      • Validates that the host prefix SHOULD end in a period if it contains + host labels.
        • +
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HostLabelTraitValidator

          +
          public HostLabelTraitValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpApiKeyAuthTraitValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpApiKeyAuthTraitValidator.html new file mode 100644 index 00000000000..3e075553fe5 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpApiKeyAuthTraitValidator.html @@ -0,0 +1,350 @@ + + + + + +HttpApiKeyAuthTraitValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class HttpApiKeyAuthTraitValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class HttpApiKeyAuthTraitValidator
+extends AbstractValidator
      +
      Validates that if an HttpApiKeyAuth trait's scheme field is present then + the 'in' field must specify "header". Scheme should only be used with the + "Authorization" http header.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpApiKeyAuthTraitValidator

          +
          public HttpApiKeyAuthTraitValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpBindingTraitIgnoredValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpBindingTraitIgnoredValidator.html new file mode 100644 index 00000000000..b5467d8b22e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpBindingTraitIgnoredValidator.html @@ -0,0 +1,358 @@ + + + + + +HttpBindingTraitIgnoredValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class HttpBindingTraitIgnoredValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public class HttpBindingTraitIgnoredValidator
+extends AbstractValidator
      +
      Emits warnings when a structure member has an HTTP binding trait that will be ignored + in some contexts to which it is bound. + +
        +
      • When httpLabel, httpQueryParams, or httpQuery is applied to a member of a shape that + * is not used as operation inputs.
        • +
      • When httpResponseCode is applied to a member of a shape that is not used as an + * operation output.
        • +
      • When any other HTTP member binding trait is applied to a member of a shape that is + * not used as a top-level operation input, output, or error.
        • +
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpBindingTraitIgnoredValidator

          +
          public HttpBindingTraitIgnoredValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpBindingsMissingValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpBindingsMissingValidator.html new file mode 100644 index 00000000000..00b3c01e3a7 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpBindingsMissingValidator.html @@ -0,0 +1,349 @@ + + + + + +HttpBindingsMissingValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class HttpBindingsMissingValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class HttpBindingsMissingValidator
+extends AbstractValidator
      +
      Validates that if any operation in a service uses the http trait, + then all operations use them.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpBindingsMissingValidator

          +
          public HttpBindingsMissingValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpHeaderTraitValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpHeaderTraitValidator.html new file mode 100644 index 00000000000..beacd5f502f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpHeaderTraitValidator.html @@ -0,0 +1,348 @@ + + + + + +HttpHeaderTraitValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class HttpHeaderTraitValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class HttpHeaderTraitValidator
+extends AbstractValidator
      +
      Validates that httpHeader traits are case-insensitively unique.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpHeaderTraitValidator

          +
          public HttpHeaderTraitValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpLabelTraitValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpLabelTraitValidator.html new file mode 100644 index 00000000000..302b2529209 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpLabelTraitValidator.html @@ -0,0 +1,360 @@ + + + + + +HttpLabelTraitValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class HttpLabelTraitValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class HttpLabelTraitValidator
+extends AbstractValidator
      +
      Validates that httpLabel traits are applied correctly for operation inputs. + +
        +
      • Validates that if an operation has labels then it must have + input.
        • +
      • Validates that a corresponding input member can be found for each + label in each operation.
        • +
      • Validates that the correct target type is used for greedy and + non-greedy labels.
        • +
      • Validates that all labels in the URI of each operation that + references the structure, have a corresponding member with the + httpLabel trait.
        • +
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpLabelTraitValidator

          +
          public HttpLabelTraitValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpMethodSemanticsValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpMethodSemanticsValidator.html new file mode 100644 index 00000000000..04751837c9c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpMethodSemanticsValidator.html @@ -0,0 +1,349 @@ + + + + + +HttpMethodSemanticsValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class HttpMethodSemanticsValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class HttpMethodSemanticsValidator
+extends AbstractValidator
      +
      Validates that `http` traits applied to operation shapes use the most + semantically appropriate HTTP method according to RFC 7231.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpMethodSemanticsValidator

          +
          public HttpMethodSemanticsValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpPayloadValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpPayloadValidator.html new file mode 100644 index 00000000000..09003021912 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpPayloadValidator.html @@ -0,0 +1,349 @@ + + + + + +HttpPayloadValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class HttpPayloadValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class HttpPayloadValidator
+extends AbstractValidator
      +
      Validates that if a payload trait is present then all members of the + input of an operation are bound to part of the message.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpPayloadValidator

          +
          public HttpPayloadValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpPrefixHeadersTraitValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpPrefixHeadersTraitValidator.html new file mode 100644 index 00000000000..0437613be51 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpPrefixHeadersTraitValidator.html @@ -0,0 +1,349 @@ + + + + + +HttpPrefixHeadersTraitValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class HttpPrefixHeadersTraitValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class HttpPrefixHeadersTraitValidator
+extends AbstractValidator
      +
      Validates that httpHeader traits do not case-insensitively start with an + httpPrefixHeader on the same structure.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpPrefixHeadersTraitValidator

          +
          public HttpPrefixHeadersTraitValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpQueryParamsTraitValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpQueryParamsTraitValidator.html new file mode 100644 index 00000000000..60ab1631a7f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpQueryParamsTraitValidator.html @@ -0,0 +1,349 @@ + + + + + +HttpQueryParamsTraitValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class HttpQueryParamsTraitValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class HttpQueryParamsTraitValidator
+extends AbstractValidator
      +
      When the `httpQueryParams` trait is used, this validator emits a NOTE when another member of the container shape + applies the `httpQuery` trait which may result in a conflict within the query string.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpQueryParamsTraitValidator

          +
          public HttpQueryParamsTraitValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpQueryTraitValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpQueryTraitValidator.html new file mode 100644 index 00000000000..5bcf640b4f5 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpQueryTraitValidator.html @@ -0,0 +1,348 @@ + + + + + +HttpQueryTraitValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class HttpQueryTraitValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class HttpQueryTraitValidator
+extends AbstractValidator
      +
      Validates that httpQuery trait bindings are case-sensitively unique.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpQueryTraitValidator

          +
          public HttpQueryTraitValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpResponseCodeSemanticsValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpResponseCodeSemanticsValidator.html new file mode 100644 index 00000000000..5787857001a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpResponseCodeSemanticsValidator.html @@ -0,0 +1,348 @@ + + + + + +HttpResponseCodeSemanticsValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class HttpResponseCodeSemanticsValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class HttpResponseCodeSemanticsValidator
+extends AbstractValidator
      +
      Ensures that HTTP response codes are appropriate for operations and errors.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpResponseCodeSemanticsValidator

          +
          public HttpResponseCodeSemanticsValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpUriConflictValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpUriConflictValidator.html new file mode 100644 index 00000000000..01dfd7fc4d8 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpUriConflictValidator.html @@ -0,0 +1,348 @@ + + + + + +HttpUriConflictValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class HttpUriConflictValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class HttpUriConflictValidator
+extends AbstractValidator
      +
      Validates that no two URIs in a service conflict with each other.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpUriConflictValidator

          +
          public HttpUriConflictValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpUriFormatValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpUriFormatValidator.html new file mode 100644 index 00000000000..9ea8d54b0b9 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/HttpUriFormatValidator.html @@ -0,0 +1,347 @@ + + + + + +HttpUriFormatValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class HttpUriFormatValidator

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpUriFormatValidator

          +
          public HttpUriFormatValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/JsonNameValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/JsonNameValidator.html new file mode 100644 index 00000000000..2e741aec440 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/JsonNameValidator.html @@ -0,0 +1,347 @@ + + + + + +JsonNameValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class JsonNameValidator

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          JsonNameValidator

          +
          public JsonNameValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/LengthTraitValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/LengthTraitValidator.html new file mode 100644 index 00000000000..cd9887856a6 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/LengthTraitValidator.html @@ -0,0 +1,347 @@ + + + + + +LengthTraitValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class LengthTraitValidator

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          LengthTraitValidator

          +
          public LengthTraitValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/MediaTypeValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/MediaTypeValidator.html new file mode 100644 index 00000000000..11dc477a23d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/MediaTypeValidator.html @@ -0,0 +1,347 @@ + + + + + +MediaTypeValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class MediaTypeValidator

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          MediaTypeValidator

          +
          public MediaTypeValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/NoInlineDocumentSupportValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/NoInlineDocumentSupportValidator.html new file mode 100644 index 00000000000..c2a01f2ca34 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/NoInlineDocumentSupportValidator.html @@ -0,0 +1,349 @@ + + + + + +NoInlineDocumentSupportValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class NoInlineDocumentSupportValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class NoInlineDocumentSupportValidator
+extends AbstractValidator
      +
      Detects when a protocol indicates that it does not support inline documents, + yet the protocol trait is attached to a service that uses inline documents.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          NoInlineDocumentSupportValidator

          +
          public NoInlineDocumentSupportValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/OperationValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/OperationValidator.html new file mode 100644 index 00000000000..c8c85b0be23 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/OperationValidator.html @@ -0,0 +1,362 @@ + + + + + +OperationValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class OperationValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class OperationValidator
+extends AbstractValidator
      +
      Validates operation inputs, outputs, and the use of input + and output traits. + +
        +
      • Emits an OperationInputOutputMisuse ERROR when a structure + marked with the input trait or output trait is used in + other contexts than input or output, or reused by multiple operations.
        • +
      • Emits an OperationInputOutputName WARNING when the input or + output shape name does not start with the name of the operation that + targets it (if any).
        • +
      • Emits an OperationNameAmbiguity WARNING when a shape has a + name that starts with the name of an operation and the name ends with + Input, Output, Request, or Response but is not used as the input or + output of an operation.
        • +
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          OperationValidator

          +
          public OperationValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/PaginatedTraitValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/PaginatedTraitValidator.html new file mode 100644 index 00000000000..f31e19803ab --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/PaginatedTraitValidator.html @@ -0,0 +1,362 @@ + + + + + +PaginatedTraitValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class PaginatedTraitValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class PaginatedTraitValidator
+extends AbstractValidator
      +
      Validates paginated traits. + +
        +
      • The inputToken and outputToken properties must be set when an + operation's properties are optionally merged with a service's.
        • +
      • The items property, if set, must reference a list or map + output member.
        • +
      • The pageSize property, if set, should reference an optional integer + input member. It may, but should not reference an optional byte, short, + or long.
        • +
      • The inputToken property should reference an optional string input + member. It may, but should not reference an optional map.
        • +
      • The outputToken property should reference an optional string output + member. It may, but should not reference an optional map.
        • +
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          PaginatedTraitValidator

          +
          public PaginatedTraitValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/PatternTraitValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/PatternTraitValidator.html new file mode 100644 index 00000000000..2bdbab42448 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/PatternTraitValidator.html @@ -0,0 +1,348 @@ + + + + + +PatternTraitValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class PatternTraitValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class PatternTraitValidator
+extends AbstractValidator
      +
      Emits a validation event if a pattern trait is not anchored.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          PatternTraitValidator

          +
          public PatternTraitValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/PrivateAccessValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/PrivateAccessValidator.html new file mode 100644 index 00000000000..e477722aaa2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/PrivateAccessValidator.html @@ -0,0 +1,349 @@ + + + + + +PrivateAccessValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class PrivateAccessValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class PrivateAccessValidator
+extends AbstractValidator
      +
      Ensures that shapes in separate namespaces don't refer to shapes in other + namespaces that are marked as private.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          PrivateAccessValidator

          +
          public PrivateAccessValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/RangeTraitValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/RangeTraitValidator.html new file mode 100644 index 00000000000..5dd8f3a9120 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/RangeTraitValidator.html @@ -0,0 +1,348 @@ + + + + + +RangeTraitValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class RangeTraitValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class RangeTraitValidator
+extends AbstractValidator
      +
      Ensures that range traits are valid.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          RangeTraitValidator

          +
          public RangeTraitValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ReferencesTraitValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ReferencesTraitValidator.html new file mode 100644 index 00000000000..c5f56367964 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ReferencesTraitValidator.html @@ -0,0 +1,348 @@ + + + + + +ReferencesTraitValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class ReferencesTraitValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class ReferencesTraitValidator
+extends AbstractValidator
      +
      Validates that references are correct.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ReferencesTraitValidator

          +
          public ReferencesTraitValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/RequestCompressionTraitValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/RequestCompressionTraitValidator.html new file mode 100644 index 00000000000..75ffdd70a02 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/RequestCompressionTraitValidator.html @@ -0,0 +1,353 @@ + + + + + +RequestCompressionTraitValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class RequestCompressionTraitValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class RequestCompressionTraitValidator
+extends AbstractValidator
      +
      Validates the requestCompression trait. + + - Validates that the operation input has no member with both streaming and + requiresLength traits applied + - Validate encodings has at least one compression algorithm + - Validate encodings are all supported compression algorithms
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          RequestCompressionTraitValidator

          +
          public RequestCompressionTraitValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ResourceCycleValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ResourceCycleValidator.html new file mode 100644 index 00000000000..616a462f52c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ResourceCycleValidator.html @@ -0,0 +1,348 @@ + + + + + +ResourceCycleValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class ResourceCycleValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class ResourceCycleValidator
+extends AbstractValidator
      +
      Validates that resource references do not introduce circular hierarchies.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ResourceCycleValidator

          +
          public ResourceCycleValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ResourceIdentifierBindingValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ResourceIdentifierBindingValidator.html new file mode 100644 index 00000000000..867c9b532ee --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ResourceIdentifierBindingValidator.html @@ -0,0 +1,352 @@ + + + + + +ResourceIdentifierBindingValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class ResourceIdentifierBindingValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class ResourceIdentifierBindingValidator
+extends AbstractValidator
      +
      Validates that operations bound to resource shapes have identifier + bindings for all the identifiers of the parent of the binding resource, + that operations bound to a resource with the collection + trait are bound using a collection binding, and operations bound with + no collection trait are bound using an instance binding.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ResourceIdentifierBindingValidator

          +
          public ResourceIdentifierBindingValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ResourceIdentifierValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ResourceIdentifierValidator.html new file mode 100644 index 00000000000..b8100a862c0 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ResourceIdentifierValidator.html @@ -0,0 +1,349 @@ + + + + + +ResourceIdentifierValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class ResourceIdentifierValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class ResourceIdentifierValidator
+extends AbstractValidator
      +
      Validates that the resource identifiers of children of a resource contain + all of the identifiers as their parents.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ResourceIdentifierValidator

          +
          public ResourceIdentifierValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ResourceLifecycleValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ResourceLifecycleValidator.html new file mode 100644 index 00000000000..522054af7b3 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ResourceLifecycleValidator.html @@ -0,0 +1,348 @@ + + + + + +ResourceLifecycleValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class ResourceLifecycleValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class ResourceLifecycleValidator
+extends AbstractValidator
      +
      Validates that resource are applied appropriately to resources.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ResourceLifecycleValidator

          +
          public ResourceLifecycleValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ResourceOperationInputOutputValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ResourceOperationInputOutputValidator.html new file mode 100644 index 00000000000..4c130f32889 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ResourceOperationInputOutputValidator.html @@ -0,0 +1,348 @@ + + + + + +ResourceOperationInputOutputValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class ResourceOperationInputOutputValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class ResourceOperationInputOutputValidator
+extends AbstractValidator
      +
      Validates that resource properties are correctly used in resource-bound operations.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ResourceOperationInputOutputValidator

          +
          public ResourceOperationInputOutputValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ServiceAuthDefinitionsValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ServiceAuthDefinitionsValidator.html new file mode 100644 index 00000000000..2b1fb3d8b17 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ServiceAuthDefinitionsValidator.html @@ -0,0 +1,348 @@ + + + + + +ServiceAuthDefinitionsValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class ServiceAuthDefinitionsValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public class ServiceAuthDefinitionsValidator
+extends AbstractValidator
      +
      Validates the @authDefinition traits applied to service shapes.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ServiceAuthDefinitionsValidator

          +
          public ServiceAuthDefinitionsValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ServiceValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ServiceValidator.html new file mode 100644 index 00000000000..1de823e00f2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ServiceValidator.html @@ -0,0 +1,360 @@ + + + + + +ServiceValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class ServiceValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class ServiceValidator
+extends AbstractValidator
      +
      Validates that service closures do not contain duplicate case-insensitive + shape names. The rename property of the service is used to deconflict + shapes. + +

      This validator allows some kinds of conflicts when they are likely + inconsequential. Some classes of conflicts are permitted, and in those + cases a WARNING or NOTE is emitted. A conflict is permitted if the shapes + are the same type; the two shapes are either a simple shape, list, or set; + both shapes have the same exact traits; and both shapes have equivalent + members (that is, the members follow these same rules). Permitted conflicts + detected between simple shapes are emitted as a NOTE, permitted conflicts + detected on other shapes are emitted as a WARNING, and other conflicts are + emitted as ERROR.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ServiceValidator

          +
          public ServiceValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/SetValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/SetValidator.html new file mode 100644 index 00000000000..d88d98f0720 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/SetValidator.html @@ -0,0 +1,347 @@ + + + + + +SetValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class SetValidator

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          SetValidator

          +
          public SetValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ShapeIdConflictValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ShapeIdConflictValidator.html new file mode 100644 index 00000000000..422e50ea3f9 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ShapeIdConflictValidator.html @@ -0,0 +1,349 @@ + + + + + +ShapeIdConflictValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class ShapeIdConflictValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class ShapeIdConflictValidator
+extends AbstractValidator
      +
      Ensures that no two shapes in the model have the same case-insensitive + shape ID.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ShapeIdConflictValidator

          +
          public ShapeIdConflictValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ShapeRecursionValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ShapeRecursionValidator.html new file mode 100644 index 00000000000..d9da51903d1 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/ShapeRecursionValidator.html @@ -0,0 +1,356 @@ + + + + + +ShapeRecursionValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class ShapeRecursionValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class ShapeRecursionValidator
+extends AbstractValidator
      +
      Ensures that list, set, and map shapes are not directly recursive, + meaning that if they do have a recursive reference to themselves, + one or more references that form the recursive path travels through + a structure or union shape. And ensures that structure members are + not infinitely mutually recursive using the required trait. + +

      This check removes an entire class of problems from things like + code generators where a list of itself or a list of maps of itself + is impossible to define.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ShapeRecursionValidator

          +
          public ShapeRecursionValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/SingleOperationBindingValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/SingleOperationBindingValidator.html new file mode 100644 index 00000000000..827a1cb3511 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/SingleOperationBindingValidator.html @@ -0,0 +1,349 @@ + + + + + +SingleOperationBindingValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class SingleOperationBindingValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class SingleOperationBindingValidator
+extends AbstractValidator
      +
      Validates that an operation is only bound to once in an entire + service closure.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          SingleOperationBindingValidator

          +
          public SingleOperationBindingValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/SingleResourceBindingValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/SingleResourceBindingValidator.html new file mode 100644 index 00000000000..3e59f507e82 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/SingleResourceBindingValidator.html @@ -0,0 +1,349 @@ + + + + + +SingleResourceBindingValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class SingleResourceBindingValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class SingleResourceBindingValidator
+extends AbstractValidator
      +
      Validates that a resource is only bound to once in an entire + service closure.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          SingleResourceBindingValidator

          +
          public SingleResourceBindingValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/StreamingTraitValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/StreamingTraitValidator.html new file mode 100644 index 00000000000..79e789b9141 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/StreamingTraitValidator.html @@ -0,0 +1,355 @@ + + + + + +StreamingTraitValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class StreamingTraitValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class StreamingTraitValidator
+extends AbstractValidator
      +
      Validates the streaming trait. + +

      Ensures that the targeted shapes are only referenced by top level input/output structures. + +

      If the targeted shape is a union, ensures that all members are structures. + +

      If used in the scope of any service that supports HttpPayloadTrait, + ensures that any blobs targeted also have @httpPayload applied.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          StreamingTraitValidator

          +
          public StreamingTraitValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/TargetValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/TargetValidator.html new file mode 100644 index 00000000000..254d2133bf7 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/TargetValidator.html @@ -0,0 +1,348 @@ + + + + + +TargetValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class TargetValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class TargetValidator
+extends AbstractValidator
      +
      Validates that neighbors target resolvable shapes of the correct type.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          TargetValidator

          +
          public TargetValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/TraitBreakingChangesValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/TraitBreakingChangesValidator.html new file mode 100644 index 00000000000..e95de7afbee --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/TraitBreakingChangesValidator.html @@ -0,0 +1,349 @@ + + + + + +TraitBreakingChangesValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class TraitBreakingChangesValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class TraitBreakingChangesValidator
+extends AbstractValidator
      +
      Validates that the JSON pointer paths of the breakingChanges property + of a trait refers to valid parts of the model.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          TraitBreakingChangesValidator

          +
          public TraitBreakingChangesValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/TraitConflictValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/TraitConflictValidator.html new file mode 100644 index 00000000000..177f83bb4e6 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/TraitConflictValidator.html @@ -0,0 +1,348 @@ + + + + + +TraitConflictValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class TraitConflictValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class TraitConflictValidator
+extends AbstractValidator
      +
      Validates that traits do not conflict.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          TraitConflictValidator

          +
          public TraitConflictValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/TraitTargetValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/TraitTargetValidator.html new file mode 100644 index 00000000000..fd5e7231e74 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/TraitTargetValidator.html @@ -0,0 +1,354 @@ + + + + + +TraitTargetValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class TraitTargetValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class TraitTargetValidator
+extends AbstractValidator
      +
      Validates that traits are only applied to compatible shapes. + +

      A shape must be present in the return value of a selector in order + for the shape to be considered compatible with the selector. + +

      This validator emits ERROR events when a trait is applied to a shape + that is not compatible with the trait selector.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          TraitTargetValidator

          +
          public TraitTargetValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/TraitValidatorsValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/TraitValidatorsValidator.html new file mode 100644 index 00000000000..9d4aeb3cb23 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/TraitValidatorsValidator.html @@ -0,0 +1,347 @@ + + + + + +TraitValidatorsValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class TraitValidatorsValidator

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          TraitValidatorsValidator

          +
          public TraitValidatorsValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/TraitValueValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/TraitValueValidator.html new file mode 100644 index 00000000000..2e650f458d7 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/TraitValueValidator.html @@ -0,0 +1,375 @@ + + + + + +TraitValueValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class TraitValueValidator

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.model.validation.validators.TraitValueValidator
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class TraitValueValidator
+extends java.lang.Object
+implements Validator
      +
      Validates that trait values are valid for their trait definitions.
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.util.List<ValidationEvent>validate​(Model model) +
        Validates a model and returns a list of validation events.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Field Detail

        + + + +
          +
        • +

          VALIDATE_PRELUDE

          +
          public static final java.lang.String VALIDATE_PRELUDE
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          TraitValueValidator

          +
          public TraitValueValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Specified by:
          +
          validate in interface Validator
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/UnionValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/UnionValidator.html new file mode 100644 index 00000000000..830e4a3d6da --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/UnionValidator.html @@ -0,0 +1,347 @@ + + + + + +UnionValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class UnionValidator

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          UnionValidator

          +
          public UnionValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/UnitTypeValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/UnitTypeValidator.html new file mode 100644 index 00000000000..1ed1c3b2941 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/UnitTypeValidator.html @@ -0,0 +1,349 @@ + + + + + +UnitTypeValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class UnitTypeValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class UnitTypeValidator
+extends AbstractValidator
      +
      Ensures that a unit type can only be referenced as operation + input/output or by a tagged union member.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          UnitTypeValidator

          +
          public UnitTypeValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/UnreferencedShapeValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/UnreferencedShapeValidator.html new file mode 100644 index 00000000000..50b68e6d668 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/UnreferencedShapeValidator.html @@ -0,0 +1,359 @@ + + + + + +UnreferencedShapeValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class UnreferencedShapeValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      @Deprecated
+public final class UnreferencedShapeValidator
+extends AbstractValidator
      +
      Deprecated.
      +
      Adds a validation note event for each shape in the model that is not + connected to a service shape. + +

      This validator is deprecated and no longer applied by default. + Use the UnreferencedShapeValidator from smithy-linters instead.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          UnreferencedShapeValidator

          +
          public UnreferencedShapeValidator()
          +
          Deprecated.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Deprecated.
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/UnstableTraitValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/UnstableTraitValidator.html new file mode 100644 index 00000000000..26c5048d3de --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/UnstableTraitValidator.html @@ -0,0 +1,348 @@ + + + + + +UnstableTraitValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class UnstableTraitValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class UnstableTraitValidator
+extends AbstractValidator
      +
      Emits a validation event if a model contains shapes that are bound to unstable traits.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          UnstableTraitValidator

          +
          public UnstableTraitValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/XmlNamespaceTraitValidator.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/XmlNamespaceTraitValidator.html new file mode 100644 index 00000000000..463bf2950b3 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/XmlNamespaceTraitValidator.html @@ -0,0 +1,352 @@ + + + + + +XmlNamespaceTraitValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.model.validation.validators
    +

    Class XmlNamespaceTraitValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class XmlNamespaceTraitValidator
+extends AbstractValidator
      +
      Validates that the xmlNamespace traits are applied correctly for structures. + +
        +
      • Validates that uri is valid.
        • +
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          XmlNamespaceTraitValidator

          +
          public XmlNamespaceTraitValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/package-summary.html new file mode 100644 index 00000000000..32586f236cc --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/package-summary.html @@ -0,0 +1,530 @@ + + + + + +software.amazon.smithy.model.validation.validators (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.model.validation.validators

    +
    +
    +
    + + +
    Smithy validators. All validator implementations in this package + should be considered internal. They are subject to change and + should not be used directly outside of the Smithy project. For + example, some of these validators may get removed and replaced + with mode-only validation.
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/package-tree.html new file mode 100644 index 00000000000..2e332911e4d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/model/validation/validators/package-tree.html @@ -0,0 +1,222 @@ + + + + + +software.amazon.smithy.model.validation.validators Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.model.validation.validators

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/MqttJsonTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/MqttJsonTrait.Provider.html new file mode 100644 index 00000000000..42e703f8572 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/MqttJsonTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +MqttJsonTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.mqtt.traits
    +

    Class MqttJsonTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/MqttJsonTrait.html b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/MqttJsonTrait.html new file mode 100644 index 00000000000..8eba8efbd5e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/MqttJsonTrait.html @@ -0,0 +1,367 @@ + + + + + +MqttJsonTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.mqtt.traits
    +

    Class MqttJsonTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          MqttJsonTrait

          +
          public MqttJsonTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          MqttJsonTrait

          +
          public MqttJsonTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/PublishTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/PublishTrait.Provider.html new file mode 100644 index 00000000000..71f95dd37ff --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/PublishTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +PublishTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.mqtt.traits
    +

    Class PublishTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/PublishTrait.html b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/PublishTrait.html new file mode 100644 index 00000000000..767da454275 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/PublishTrait.html @@ -0,0 +1,427 @@ + + + + + +PublishTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.mqtt.traits
    +

    Class PublishTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          PublishTrait

          +
          public PublishTrait​(java.lang.String topic,
+                    SourceLocation sourceLocation)
          +
          • +
        + + + +
          +
        • +

          PublishTrait

          +
          public PublishTrait​(java.lang.String topic)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getTopic

          +
          public Topic getTopic()
          +
          Gets the parsed topic of the trait.
          +
          +
          Returns:
          +
          Returns the topic.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/ResolvedTopicIndex.html b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/ResolvedTopicIndex.html new file mode 100644 index 00000000000..1853909bf56 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/ResolvedTopicIndex.html @@ -0,0 +1,446 @@ + + + + + +ResolvedTopicIndex (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.mqtt.traits
    +

    Class ResolvedTopicIndex

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.mqtt.traits.ResolvedTopicIndex
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      KnowledgeIndex
      +
      +
      +
      public final class ResolvedTopicIndex
+extends java.lang.Object
+implements KnowledgeIndex
      +
      Computes all of the MQTT TopicBindings in a model. + +

      This index is useful for things like finding the payload of an MQTT + topic on an operation and grabbing the event stream information of a + subscribe operation. + + 

      + 
+ ResolvedTopicIndex resolvedIndex = ResolvedTopicIndex.of(model);
+ TopicBinding<PublishTrait> binding = resolvedIndex.getPublishBinding(myOperation).get();
+
+ assert(binding.getTopic() instanceOf Topic);
+ assert(binding.getMqttTrait() instanceOf PublishTrait);
+ System.out.println(binding.getPayloadShape());
+ 
+
      +
      +
      See Also:
      +
      TopicBinding
      +
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ResolvedTopicIndex

          +
          public ResolvedTopicIndex​(Model model)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getOperationBindings

          +
          public java.util.List<TopicBinding<? extends Trait>> getOperationBindings​(ToShapeId operation)
          +
          Get all of the MQTT topic bindings of a specific operation.
          +
          +
          Parameters:
          +
          operation - Operation that has MQTT bindings.
          +
          Returns:
          +
          Returns the found MQTT bindings.
          +
          +
          • +
        + + + +
          +
        • +

          topicBindings

          +
          public java.util.stream.Stream<TopicBinding<? extends Trait>> topicBindings()
          +
          Gets all resolved MQTT topic bindings in the model.
          +
          +
          Returns:
          +
          Returns the stream of MQTT topic bindings in the model.
          +
          +
          • +
        + + + +
          +
        • +

          getPublishBinding

          +
          public java.util.Optional<TopicBinding<PublishTrait>> getPublishBinding​(ToShapeId operation)
          +
          Gets the MQTT publish binding of an operation.
          +
          +
          Parameters:
          +
          operation - Operation that has MQTT bindings.
          +
          Returns:
          +
          Returns the optionally found MQTT publish bindings.
          +
          +
          • +
        + + + +
          +
        • +

          getSubscribeBinding

          +
          public java.util.Optional<TopicBinding<SubscribeTrait>> getSubscribeBinding​(ToShapeId operation)
          +
          Gets the MQTT subscribe binding of an operation.
          +
          +
          Parameters:
          +
          operation - Operation that has MQTT bindings.
          +
          Returns:
          +
          Returns the optionally found MQTT subscribe bindings.
          +
          +
          • +
        + + + +
          +
        • +

          getSubcribeEventStreamInfo

          +
          public java.util.Optional<EventStreamInfo> getSubcribeEventStreamInfo​(ToShapeId operation)
          +
          Get subscribe event stream info. + +

          This information describes if the event stream contains a single + event, multiple events, and if there are any initial-request or + response members.

          +
          +
          Parameters:
          +
          operation - Operation to get the event stream info o.
          +
          Returns:
          +
          Returns the optionally found event stream info.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/SubscribeTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/SubscribeTrait.Provider.html new file mode 100644 index 00000000000..a3fda5e1e9b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/SubscribeTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +SubscribeTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.mqtt.traits
    +

    Class SubscribeTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/SubscribeTrait.html b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/SubscribeTrait.html new file mode 100644 index 00000000000..39ae9d8a673 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/SubscribeTrait.html @@ -0,0 +1,427 @@ + + + + + +SubscribeTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.mqtt.traits
    +

    Class SubscribeTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          SubscribeTrait

          +
          public SubscribeTrait​(java.lang.String topic,
+                      SourceLocation sourceLocation)
          +
          • +
        + + + +
          +
        • +

          SubscribeTrait

          +
          public SubscribeTrait​(java.lang.String topic)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getTopic

          +
          public Topic getTopic()
          +
          Gets the parsed topic of the trait.
          +
          +
          Returns:
          +
          Returns the topic.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/Topic.Level.html b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/Topic.Level.html new file mode 100644 index 00000000000..2d7483dcb04 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/Topic.Level.html @@ -0,0 +1,418 @@ + + + + + +Topic.Level (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.mqtt.traits
    +

    Class Topic.Level

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.mqtt.traits.Topic.Level
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      Topic
      +
      +
      +
      public static final class Topic.Level
+extends java.lang.Object
      +
      Represents a level in a topic.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Level​(java.lang.String value) 
        Level​(java.lang.String value, + boolean isLabel) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        booleanequals​(java.lang.Object o) 
        java.lang.StringgetContent() +
        Gets the content of the topic.
        +
        inthashCode() 
        booleanisLabel() +
        Check if the level is a label.
        +
        java.lang.StringtoString() 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Level

          +
          public Level​(java.lang.String value,
+             boolean isLabel)
          +
          +
          Parameters:
          +
          value - The value of the topic.
          +
          isLabel - True if the value is a label.
          +
          +
          • +
        + + + +
          +
        • +

          Level

          +
          public Level​(java.lang.String value)
          +
          +
          Parameters:
          +
          value - The value of the topic.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getContent

          +
          public java.lang.String getContent()
          +
          Gets the content of the topic. + +

          Label levels do not contain the wrapping "{" and "}" + characters.

          +
          +
          Returns:
          +
          Returns the level value text.
          +
          +
          • +
        + + + +
          +
        • +

          isLabel

          +
          public boolean isLabel()
          +
          Check if the level is a label.
          +
          +
          Returns:
          +
          Returns true if the level is a label.
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/Topic.html b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/Topic.html new file mode 100644 index 00000000000..3ec89d39b71 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/Topic.html @@ -0,0 +1,443 @@ + + + + + +Topic (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.mqtt.traits
    +

    Class Topic

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.mqtt.traits.Topic
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class Topic
+extends java.lang.Object
      +
      Represents a parsed MQTT topic.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static class Topic.Level +
        Represents a level in a topic.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        booleanconflictsWith​(Topic other) +
        Determines if this topic conflicts with another topic.
        +
        booleanequals​(java.lang.Object o) 
        java.util.List<Topic.Level>getLabels() +
        Gets all of the label levels in the topic.
        +
        java.util.List<Topic.Level>getLevels() +
        Gets all of the hierarchical levels of the topic.
        +
        inthashCode() 
        booleanhasLabel​(java.lang.String label) +
        Returns true if the topic contains the given label string.
        +
        static Topicparse​(java.lang.String topic) +
        Parses an MQTT topic and labels.
        +
        java.lang.StringtoString() 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          parse

          +
          public static Topic parse​(java.lang.String topic)
          +
          Parses an MQTT topic and labels.
          +
          +
          Parameters:
          +
          topic - Topic to parse.
          +
          Returns:
          +
          Returns the parsed topic.
          +
          Throws:
          +
          TopicSyntaxException - if the topic is malformed.
          +
          +
          • +
        + + + +
          +
        • +

          getLevels

          +
          public java.util.List<Topic.Level> getLevels()
          +
          Gets all of the hierarchical levels of the topic.
          +
          +
          Returns:
          +
          Returns the topic levels.
          +
          +
          • +
        + + + +
          +
        • +

          getLabels

          +
          public java.util.List<Topic.Level> getLabels()
          +
          Gets all of the label levels in the topic.
          +
          +
          Returns:
          +
          Returns the label levels.
          +
          +
          • +
        + + + +
          +
        • +

          hasLabel

          +
          public boolean hasLabel​(java.lang.String label)
          +
          Returns true if the topic contains the given label string.
          +
          +
          Parameters:
          +
          label - Label to check for.
          +
          Returns:
          +
          Returns true if the label exists in the topic.
          +
          +
          • +
        + + + +
          +
        • +

          conflictsWith

          +
          public boolean conflictsWith​(Topic other)
          +
          Determines if this topic conflicts with another topic.
          +
          +
          Parameters:
          +
          other - Topic to check against.
          +
          Returns:
          +
          Returns true if there is a conflict.
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/TopicBinding.html b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/TopicBinding.html new file mode 100644 index 00000000000..4799c14579d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/TopicBinding.html @@ -0,0 +1,533 @@ + + + + + +TopicBinding (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.mqtt.traits
    +

    Class TopicBinding<T extends Trait>

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.mqtt.traits.TopicBinding<T>
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class TopicBinding<T extends Trait>
+extends java.lang.Object
      +
      Contains computed information about the resolved MQTT topic bindings + of an operation. + +

      Smithy models can contain a number of MQTT topics that are formed by + the publish and subscribe traits. Each of these + traits resolves to a single MQTT topic. + +

      This class abstracts away the process of computing the payload of an + MQTT operation. Each topic binding provides the following information: + +

        +
      • The operation in the model that created the binding.
        • +
      • The MQTT topic.
        • +
      • The payload shape that forms the payload of the topic.
        • +
      • The optionally present input structure of the operation, which + provides information like topic label bindings.
        • +
      + +

      @smithy.mqtt#publish topics

      + + Operations marked with @smithy.mqtt#publish resolve to a single topic that + is defined by topic property of the trait. + +

      subscribe topics

      + + Operations marked with subscribe resolve to a single topic + that is defined by the topic property of the trait. + +

      Payload resolution

      + + The payload binding of a topic binding can be resolved to either no + payload (e.g., publish operations with no input shape), a structure + payload, or a member of a structure. The target of a specific event + shape member can be used as a payload in subscribe + operations where an event member is marked with the eventPayload + trait.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getOperationMqttTrait

          +
          public static java.util.Optional<? extends Trait> getOperationMqttTrait​(Shape operation)
          +
          Finds the MQTT binding trait associated with an operation.
          +
          +
          Parameters:
          +
          operation - Operation to check.
          +
          Returns:
          +
          Returns the optionally found MQTT binding trait.
          +
          +
          • +
        + + + +
          +
        • +

          getMqttTrait

          +
          public T getMqttTrait()
          +
          Gets the trait that formed the binding of the operation to MQTT + for this topic. + +

          The provided trait will be either an instance of + PublishTrait or SubscribeTrait.

          +
          +
          Returns:
          +
          Returns the MQTT trait binding.
          +
          +
          • +
        + + + +
          +
        • +

          getOperation

          +
          public OperationShape getOperation()
          +
          Gets the operation shape related to the topic bindings.
          +
          +
          Returns:
          +
          Returns the operation that has topic bindings.
          +
          +
          • +
        + + + +
          +
        • +

          getTopic

          +
          public Topic getTopic()
          +
          Gets the resolved topic of the binding.
          +
          +
          Returns:
          +
          Returns the resolved topic.
          +
          +
          • +
        + + + +
          +
        • +

          getInput

          +
          @Deprecated
+public java.util.Optional<StructureShape> getInput()
          +
          Deprecated. +
          Use getInputShape instead.
          +
          +
          Gets the input shape related to this operation.
          +
          +
          Returns:
          +
          Returns the optional input shape.
          +
          +
          • +
        + + + +
          +
        • +

          getInputShape

          +
          public StructureShape getInputShape()
          +
          Gets the input shape related to this operation.
          +
          +
          Returns:
          +
          Returns the input shape.
          +
          +
          • +
        + + + +
          +
        • +

          getPayloadShape

          +
          public java.util.Optional<Shape> getPayloadShape()
          +
          Gets the payload shape of the topic. + +

          The payload shape is either a structure for a single-event + event stream, or a union for a multi-event event stream.

          +
          +
          Returns:
          +
          Returns the optional payload target.
          +
          +
          • +
        + + + +
          +
        • +

          conflictsWith

          +
          public boolean conflictsWith​(TopicBinding<?> other)
          +
          Returns true if the topic binding conflicts with another. + +

          A topic binding is considered conflicting if both bindings have + conflicting topics determined through Topic.conflictsWith(software.amazon.smithy.mqtt.traits.Topic) + and the topic bindings utilize a different payload. If both topics + do not have a payload then they are not conflicting. If both topics + have a payload, but they target the same shape, then they are not + conflicting.

          +
          +
          Parameters:
          +
          other - Other topic binding to compare against.
          +
          Returns:
          +
          Returns true if the topic bindings conflict.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/TopicLabelTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/TopicLabelTrait.Provider.html new file mode 100644 index 00000000000..a3728ccce4e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/TopicLabelTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +TopicLabelTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.mqtt.traits
    +

    Class TopicLabelTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/TopicLabelTrait.html b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/TopicLabelTrait.html new file mode 100644 index 00000000000..9b759551dbd --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/TopicLabelTrait.html @@ -0,0 +1,368 @@ + + + + + +TopicLabelTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.mqtt.traits
    +

    Class TopicLabelTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          TopicLabelTrait

          +
          public TopicLabelTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          TopicLabelTrait

          +
          public TopicLabelTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/TopicSyntaxException.html b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/TopicSyntaxException.html new file mode 100644 index 00000000000..af18ef11c45 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/TopicSyntaxException.html @@ -0,0 +1,297 @@ + + + + + +TopicSyntaxException (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.mqtt.traits
    +

    Class TopicSyntaxException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Throwable
        • +
      • +
          +
        • java.lang.Exception
          • +
        • +
            +
          • java.lang.RuntimeException
            • +
          • +
              +
            • software.amazon.smithy.mqtt.traits.TopicSyntaxException
              • +
            +
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      public class TopicSyntaxException
+extends java.lang.RuntimeException
      +
      Thrown when an MQTT topic is malformed.
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        TopicSyntaxException​(java.lang.String message) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          TopicSyntaxException

          +
          public TopicSyntaxException​(java.lang.String message)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/package-summary.html new file mode 100644 index 00000000000..d8bb5a28057 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/package-summary.html @@ -0,0 +1,245 @@ + + + + + +software.amazon.smithy.mqtt.traits (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.mqtt.traits

    +
    +
    +
    + + +
    Defines MQTT bindings for Smithy.
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/package-tree.html new file mode 100644 index 00000000000..177d93d2699 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/package-tree.html @@ -0,0 +1,209 @@ + + + + + +software.amazon.smithy.mqtt.traits Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.mqtt.traits

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/validators/MqttTopicConflictValidator.html b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/validators/MqttTopicConflictValidator.html new file mode 100644 index 00000000000..598a7a9c448 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/validators/MqttTopicConflictValidator.html @@ -0,0 +1,351 @@ + + + + + +MqttTopicConflictValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.mqtt.traits.validators
    +

    Class MqttTopicConflictValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class MqttTopicConflictValidator
+extends AbstractValidator
      +
      Validates that no two MQTT topics conflict. + +

      MQTT topics are allowed to conflict if both topics target the + same shape.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          MqttTopicConflictValidator

          +
          public MqttTopicConflictValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/validators/MqttTopicLabelValidator.html b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/validators/MqttTopicLabelValidator.html new file mode 100644 index 00000000000..0dcdb38a275 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/validators/MqttTopicLabelValidator.html @@ -0,0 +1,355 @@ + + + + + +MqttTopicLabelValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.mqtt.traits.validators
    +

    Class MqttTopicLabelValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public class MqttTopicLabelValidator
+extends AbstractValidator
      +
      Validates that labels are correct for MQTT topics on + subscribe and publish operations. + +
        +
      • Operation input is required when a topic has labels.
        • +
      • Topic labels must be found in the input.
        • +
      • The input must not contain extraneous labels.
        • +
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          MqttTopicLabelValidator

          +
          public MqttTopicLabelValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/validators/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/validators/package-summary.html new file mode 100644 index 00000000000..acc76e6e7f2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/validators/package-summary.html @@ -0,0 +1,173 @@ + + + + + +software.amazon.smithy.mqtt.traits.validators (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.mqtt.traits.validators

    +
    +
    +
      +
    • + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      MqttTopicConflictValidator +
      Validates that no two MQTT topics conflict.
      +
      MqttTopicLabelValidator +
      Validates that labels are correct for MQTT topics on + subscribe and publish operations.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/validators/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/validators/package-tree.html new file mode 100644 index 00000000000..1be7c4148c4 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/mqtt/traits/validators/package-tree.html @@ -0,0 +1,166 @@ + + + + + +software.amazon.smithy.mqtt.traits.validators Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.mqtt.traits.validators

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/OpenApiConfig.ErrorStatusConflictHandlingStrategy.html b/javadoc/1.47.0/software/amazon/smithy/openapi/OpenApiConfig.ErrorStatusConflictHandlingStrategy.html new file mode 100644 index 00000000000..d2c7e9bd5a3 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/OpenApiConfig.ErrorStatusConflictHandlingStrategy.html @@ -0,0 +1,389 @@ + + + + + +OpenApiConfig.ErrorStatusConflictHandlingStrategy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi
    +

    Enum OpenApiConfig.ErrorStatusConflictHandlingStrategy

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        ONE_OF +
        The default setting that uses OpenAPI's oneOf keyword to combine multiple schemas for same media type.
        +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static OpenApiConfig.ErrorStatusConflictHandlingStrategy[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (OpenApiConfig.ErrorStatusConflictHandlingStrategy c : OpenApiConfig.ErrorStatusConflictHandlingStrategy.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static OpenApiConfig.ErrorStatusConflictHandlingStrategy valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/OpenApiConfig.HttpPrefixHeadersStrategy.html b/javadoc/1.47.0/software/amazon/smithy/openapi/OpenApiConfig.HttpPrefixHeadersStrategy.html new file mode 100644 index 00000000000..c890695a38b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/OpenApiConfig.HttpPrefixHeadersStrategy.html @@ -0,0 +1,387 @@ + + + + + +OpenApiConfig.HttpPrefixHeadersStrategy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi
    +

    Enum OpenApiConfig.HttpPrefixHeadersStrategy

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        FAIL +
        The default setting that causes the build to fail.
        +
        WARN +
        The header is omitted from the OpenAPI model and a warning is logged.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static OpenApiConfig.HttpPrefixHeadersStrategyvalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static OpenApiConfig.HttpPrefixHeadersStrategy[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static OpenApiConfig.HttpPrefixHeadersStrategy[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (OpenApiConfig.HttpPrefixHeadersStrategy c : OpenApiConfig.HttpPrefixHeadersStrategy.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static OpenApiConfig.HttpPrefixHeadersStrategy valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/OpenApiConfig.html b/javadoc/1.47.0/software/amazon/smithy/openapi/OpenApiConfig.html new file mode 100644 index 00000000000..5ac043164a6 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/OpenApiConfig.html @@ -0,0 +1,1013 @@ + + + + + +OpenApiConfig (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi
    +

    Class OpenApiConfig

    +
    +
    + +
    +
      +
    • +
      +
      public class OpenApiConfig
+extends JsonSchemaConfig
      +
      "openapi" smithy-build plugin configuration settings.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          OpenApiConfig

          +
          public OpenApiConfig()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getProtocol

          +
          public ShapeId getProtocol()
          +
          • +
        + + + +
          +
        • +

          setProtocol

          +
          public void setProtocol​(ShapeId protocol)
          +
          Sets the protocol shape ID to use when converting Smithy to OpenAPI. + +

          For example, aws.protocols#restJson1. + +

          Smithy will try to match the provided protocol name with an + implementation of OpenApiProtocol registered with a + service provider implementation of Smithy2OpenApiExtension. + +

          This property is required if a service supports multiple protocols.

          +
          +
          Parameters:
          +
          protocol - The protocol shape ID to use.
          +
          +
          • +
        + + + +
          +
        • +

          getDefaultBlobFormat

          +
          public java.lang.String getDefaultBlobFormat()
          +
          • +
        + + + +
          +
        • +

          setDefaultBlobFormat

          +
          public void setDefaultBlobFormat​(java.lang.String defaultBlobFormat)
          +
          Sets the default OpenAPI format property used when converting blob + shapes in Smithy to strings in OpenAPI. + +

          Defaults to "byte", meaning Base64 encoded.

          +
          +
          Parameters:
          +
          defaultBlobFormat - Default blob OpenAPI format to use.
          +
          +
          • +
        + + + +
          +
        • +

          getTags

          +
          public boolean getTags()
          +
          • +
        + + + +
          +
        • +

          setTags

          +
          public void setTags​(boolean tags)
          +
          Sets whether or not to include Smithy tags in the result as + OpenAPI tags.
          +
          +
          Parameters:
          +
          tags - Set to true to enable tags.
          +
          +
          • +
        + + + +
          +
        • +

          getSupportedTags

          +
          public java.util.List<java.lang.String> getSupportedTags()
          +
          • +
        + + + +
          +
        • +

          setSupportedTags

          +
          public void setSupportedTags​(java.util.List<java.lang.String> supportedTags)
          +
          Limits the exported tags to a specific set of tags. + +

          The value must be a list of strings. This property requires that + getTags() is set to true in order to have an effect.

          +
          +
          Parameters:
          +
          supportedTags - The set of tags to export.
          +
          +
          • +
        + + + +
          +
        • +

          getKeepUnusedComponents

          +
          public boolean getKeepUnusedComponents()
          +
          • +
        + + + +
          +
        • +

          setKeepUnusedComponents

          +
          public void setKeepUnusedComponents​(boolean keepUnusedComponents)
          +
          Set to true to prevent unused OpenAPI components from being + removed from the created specification.
          +
          +
          Parameters:
          +
          keepUnusedComponents - Set to true to keep unused components.
          +
          +
          • +
        + + + +
          +
        • +

          getJsonContentType

          +
          public java.lang.String getJsonContentType()
          +
          • +
        + + + +
          +
        • +

          setJsonContentType

          +
          public void setJsonContentType​(java.lang.String jsonContentType)
          +
          Sets a custom media-type to associate with the JSON payload of + JSON-based protocols.
          +
          +
          Parameters:
          +
          jsonContentType - Content-Type to use for JSON protocols by default.
          +
          +
          • +
        + + + +
          +
        • +

          getForbidGreedyLabels

          +
          public boolean getForbidGreedyLabels()
          +
          • +
        + + + +
          +
        • +

          setForbidGreedyLabels

          +
          public void setForbidGreedyLabels​(boolean forbidGreedyLabels)
          +
          Set to true to forbid greedy URI labels. + +

          By default, greedy labels will appear as-is in the path generated + for an operation. For example, "/{foo+}".

          +
          +
          Parameters:
          +
          forbidGreedyLabels - Set to true to forbid greedy labels.
          +
          +
          • +
        + + + +
          +
        • +

          getRemoveGreedyParameterSuffix

          +
          public boolean getRemoveGreedyParameterSuffix()
          +
          • +
        + + + +
          +
        • +

          setRemoveGreedyParameterSuffix

          +
          public void setRemoveGreedyParameterSuffix​(boolean removeGreedyParameterSuffix)
          +
          Set to true to remove the "+" suffix that is added to the generated + parameter name for greedy labels. + +

          By default, greedy labels will have a parameter name generated that + matches the label, including the "+" suffix.

          +
          +
          Parameters:
          +
          removeGreedyParameterSuffix - Set to true to remove the "+" suffix + on generated parameter name.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          setOnHttpPrefixHeaders

          +
          public void setOnHttpPrefixHeaders​(OpenApiConfig.HttpPrefixHeadersStrategy onHttpPrefixHeaders)
          +
          Specifies what to do when the httpPrefixHeaders} trait is + found in a model. + +

          OpenAPI does not support httpPrefixHeaders. By default, the + conversion will fail when this trait is encountered, but this + behavior can be customized. By default, the conversion fails when + prefix headers are encountered.

          +
          +
          Parameters:
          +
          onHttpPrefixHeaders - Strategy to use for prefix headers.
          +
          +
          • +
        + + + +
          +
        • +

          getIgnoreUnsupportedTraits

          +
          public boolean getIgnoreUnsupportedTraits()
          +
          • +
        + + + +
          +
        • +

          setIgnoreUnsupportedTraits

          +
          public void setIgnoreUnsupportedTraits​(boolean ignoreUnsupportedTraits)
          +
          Set to true to emit warnings rather than failing when unsupported + traits like endpoint and hostLabel are encountered.
          +
          +
          Parameters:
          +
          ignoreUnsupportedTraits - True to ignore unsupported traits.
          +
          +
          • +
        + + + +
          +
        • +

          getSubstitutions

          +
          public java.util.Map<java.lang.String,​Node> getSubstitutions()
          +
          • +
        + + + +
          +
        • +

          setSubstitutions

          +
          public void setSubstitutions​(java.util.Map<java.lang.String,​Node> substitutions)
          +
          Defines a map of strings to any JSON value to find and replace in the + generated OpenAPI model. + +

          String values are replaced if the string in its entirety matches one + of the keys provided in the substitutions map. The + corresponding value is then substituted for the string; this could + even result in a string changing into an object, array, etc.

          +
          +
          Parameters:
          +
          substitutions - Map of substitutions.
          +
          +
          • +
        + + + +
          +
        • +

          getJsonAdd

          +
          public java.util.Map<java.lang.String,​Node> getJsonAdd()
          +
          • +
        + + + +
          +
        • +

          setJsonAdd

          +
          public void setJsonAdd​(java.util.Map<java.lang.String,​Node> jsonAdd)
          +
          Adds or replaces the JSON value in the generated OpenAPI document + at the given JSON pointer locations with a different JSON value. + +

          The value must be a map where each key is a valid JSON pointer + string as defined in RFC 6901. Each value in the map is the JSON + value to add or replace at the given target. + +

          Values are added using similar semantics of the "add" operation + of JSON Patch, as specified in RFC 6902, with the exception that + adding properties to an undefined object will create nested + objects in the result as needed.

          +
          +
          Parameters:
          +
          jsonAdd - Map of JSON path to values to patch in.
          +
          +
          • +
        + + + +
          +
        • +

          getExternalDocs

          +
          public java.util.List<java.lang.String> getExternalDocs()
          +
          • +
        + + + +
          +
        • +

          setExternalDocs

          +
          public void setExternalDocs​(java.util.List<java.lang.String> externalDocs)
          +
          Limits the source of converted "externalDocs" fields to the specified + priority ordered list of names in an externalDocumentation trait. + +

          This list is case insensitive. By default, this is a list of the + following values: "Homepage", "API Reference", "User Guide", + "Developer Guide", "Reference", and "Guide".

          +
          +
          Parameters:
          +
          externalDocs - External docs to look for and convert, in order.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          setVersion

          +
          public void setVersion​(OpenApiVersion version)
          +
          • +
        + + + +
          +
        • +

          getDisableIntegerFormat

          +
          public boolean getDisableIntegerFormat()
          +
          • +
        + + + +
          +
        • +

          setDisableIntegerFormat

          +
          public void setDisableIntegerFormat​(boolean disableIntegerFormat)
          +
          Set to true to disable setting the `format` property on integer types.
          +
          +
          Parameters:
          +
          disableIntegerFormat - True to disable setting format on integer types.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          setOnErrorStatusConflict

          +
          public void setOnErrorStatusConflict​(OpenApiConfig.ErrorStatusConflictHandlingStrategy onErrorStatusConflict)
          +
          Specifies what to do when multiple error responses share the same HTTP status code.
          +
          +
          Parameters:
          +
          onErrorStatusConflict - Strategy to use for multiple errors with same status code.
          +
          +
          • +
        + + + +
          +
        • +

          fromNode

          +
          public static OpenApiConfig fromNode​(Node input)
          +
          Creates an OpenApiConfig from a Node value. + +

          This method first converts deprecated keys into their new locations and + formats, and then uses the NodeMapper on the converted input + object. Note that this class can be deserialized using a NodeMapper too + since the NodeMapper will look for a static, public, fromNode method. + +

          This method also serializes unknown properties into the + "extensions" map so that they are accessible to OpenAPI mappers.

          +
          +
          Parameters:
          +
          input - Input to deserialize.
          +
          Returns:
          +
          Returns the deserialized OpenApiConfig.
          +
          +
          • +
        + + + +
          +
        • +

          setJsonSchemaVersion

          +
          public void setJsonSchemaVersion​(JsonSchemaVersion schemaVersion)
          +
          Description copied from class: JsonSchemaConfig
          +
          Set the JSON schema version to use when converting Smithy shapes into Json Schema.
          +
          +
          Overrides:
          +
          setJsonSchemaVersion in class JsonSchemaConfig
          +
          Parameters:
          +
          schemaVersion - JSON Schema version to use for generated schema
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/OpenApiException.html b/javadoc/1.47.0/software/amazon/smithy/openapi/OpenApiException.html new file mode 100644 index 00000000000..589dbaa848d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/OpenApiException.html @@ -0,0 +1,324 @@ + + + + + +OpenApiException (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi
    +

    Class OpenApiException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Throwable
        • +
      • +
          +
        • java.lang.Exception
          • +
        • +
            +
          • java.lang.RuntimeException
            • +
          • +
              +
            • software.amazon.smithy.openapi.OpenApiException
              • +
            +
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      public class OpenApiException
+extends java.lang.RuntimeException
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        OpenApiException​(java.lang.RuntimeException e) 
        OpenApiException​(java.lang.String message) 
        OpenApiException​(java.lang.String message, + java.lang.Throwable previous) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          OpenApiException

          +
          public OpenApiException​(java.lang.RuntimeException e)
          +
          • +
        + + + +
          +
        • +

          OpenApiException

          +
          public OpenApiException​(java.lang.String message)
          +
          • +
        + + + +
          +
        • +

          OpenApiException

          +
          public OpenApiException​(java.lang.String message,
+                        java.lang.Throwable previous)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/OpenApiUtils.html b/javadoc/1.47.0/software/amazon/smithy/openapi/OpenApiUtils.html new file mode 100644 index 00000000000..62b2a72da1c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/OpenApiUtils.html @@ -0,0 +1,304 @@ + + + + + +OpenApiUtils (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi
    +

    Class OpenApiUtils

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.openapi.OpenApiUtils
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class OpenApiUtils
+extends java.lang.Object
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getSpecificationExtensionName

          +
          public static java.lang.String getSpecificationExtensionName​(ShapeId metaTraitId,
+                                                             SpecificationExtensionTrait specificationExtensionTrait)
          +
          Gets the specification extension name for a given meta trait. + + Either an explicitly configured extension name in specificationExtensionTrait, or a normalization of the shape + ID. The normalization replaces all "." and "#" in a shapeId to "-".
          +
          +
          Parameters:
          +
          metaTraitId - Trait shape to get the extension name.
          +
          Returns:
          +
          Extension name for the given trait shape.
          +
          +
          • +
        + + + +
          +
        • +

          getSpecificationExtensionsMap

          +
          public static java.util.Map<java.lang.String,​Node> getSpecificationExtensionsMap​(Model model,
+                                                                                       Shape shape)
          +
          Return specification extensions attached to a given shape.
          +
          +
          Parameters:
          +
          shape - Shape to get extensions for.
          +
          model - Model the shape belongs to.
          +
          Returns:
          +
          map of specification extension names to node values
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/OpenApiVersion.html b/javadoc/1.47.0/software/amazon/smithy/openapi/OpenApiVersion.html new file mode 100644 index 00000000000..5593838bf8c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/OpenApiVersion.html @@ -0,0 +1,423 @@ + + + + + +OpenApiVersion (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi
    +

    Enum OpenApiVersion

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Enum<OpenApiVersion>
        • +
      • +
          +
        • software.amazon.smithy.openapi.OpenApiVersion
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable, java.lang.Comparable<OpenApiVersion>
      +
      +
      +
      public enum OpenApiVersion
+extends java.lang.Enum<OpenApiVersion>
      +
      OpenAPI versions supported by the converter.
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.util.Set<java.lang.String>getUnsupportedKeywords() 
        booleansupportsContentEncodingKeyword() 
        java.lang.StringtoString() 
        static OpenApiVersionvalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static OpenApiVersion[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static OpenApiVersion[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (OpenApiVersion c : OpenApiVersion.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static OpenApiVersion valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Enum<OpenApiVersion>
          +
          +
          • +
        + + + +
          +
        • +

          supportsContentEncodingKeyword

          +
          public boolean supportsContentEncodingKeyword()
          +
          • +
        + + + +
          +
        • +

          getUnsupportedKeywords

          +
          public java.util.Set<java.lang.String> getUnsupportedKeywords()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/Context.html b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/Context.html new file mode 100644 index 00000000000..8013d01c514 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/Context.html @@ -0,0 +1,647 @@ + + + + + +Context (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.fromsmithy
    +

    Class Context<T extends Trait>

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.openapi.fromsmithy.Context<T>
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class Context<T extends Trait>
+extends java.lang.Object
      +
      Smithy to OpenAPI conversion context object.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        SchemacreateRef​(ToShapeId shapeId) +
        Creates a schema that contains a $ref that points to a schema component.
        +
        java.util.Set<java.lang.String>getAllSecuritySchemeRequestHeaders() +
        Gets an alphabetically sorted set of request headers used by every + security scheme associated with the API.
        +
        java.util.Set<java.lang.String>getAllSecuritySchemeResponseHeaders() +
        Gets an alphabetically sorted set of response headers used by every + security scheme associated with the API.
        +
        OpenApiConfiggetConfig() +
        Gets the configuration object used for the conversion.
        +
        JsonSchemaConvertergetJsonSchemaConverter() +
        Gets the JSON schema converter.
        +
        ModelgetModel() +
        Gets the Smithy model being converted.
        +
        OpenApiProtocol<T>getOpenApiProtocol() +
        Gets the OpenAPI protocol conversion object.
        +
        java.lang.StringgetPointer​(ToShapeId shapeId) +
        Gets the JSON pointer string to a specific shape.
        +
        TgetProtocolTrait() +
        Gets the protocol trait that is being converted.
        +
        SchemagetSchema​(java.lang.String pointer) +
        Gets a converted schema from the context object by JSON pointer + and throws if the schema does not exist.
        +
        java.util.List<SecuritySchemeConverter<? extends Trait>>getSecuritySchemeConverters() +
        Gets the security scheme converters that are compatible with the + selected protocol.
        +
        ServiceShapegetService() +
        Gets the service shape being converted.
        +
        java.util.Map<java.lang.String,​Schema>getSynthesizedSchemas() +
        Gets all of the synthesized schemas that needed to be created while + generating the OpenAPI artifact.
        +
        SchemainlineOrReferenceSchema​(MemberShape member) +
        Gets the exiting schema of the shape if it's meant to be inlined, + otherwise creates a $ref to the shape if it is meant to be reused + across the generated schema.
        +
        java.lang.StringputSynthesizedSchema​(java.lang.String name, + Schema schema) +
        Puts a new synthesized schema that is needed to convert to OpenAPI.
        +
        booleanusesHttpCredentials() +
        Reports if any authentication mechanisms in the entire model use HTTP + credentials, such as cookies, browser-managed usernames and passwords, + or TLS client certificates.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + +
          +
        • +

          getModel

          +
          public Model getModel()
          +
          Gets the Smithy model being converted.
          +
          +
          Returns:
          +
          Returns the Smithy model.
          +
          +
          • +
        + + + +
          +
        • +

          getService

          +
          public ServiceShape getService()
          +
          Gets the service shape being converted.
          +
          +
          Returns:
          +
          Returns the service shape.
          +
          +
          • +
        + + + +
          +
        • +

          getConfig

          +
          public OpenApiConfig getConfig()
          +
          Gets the configuration object used for the conversion. + +

          Plugins can query this object for configuration values.

          +
          +
          Returns:
          +
          Returns the configuration object.
          +
          +
          • +
        + + + +
          +
        • +

          getJsonSchemaConverter

          +
          public JsonSchemaConverter getJsonSchemaConverter()
          +
          Gets the JSON schema converter.
          +
          +
          Returns:
          +
          Returns the JSON Schema converter.
          +
          +
          • +
        + + + +
          +
        • +

          getProtocolTrait

          +
          public T getProtocolTrait()
          +
          Gets the protocol trait that is being converted.
          +
          +
          Returns:
          +
          Returns the protocol ID.
          +
          +
          • +
        + + + +
          +
        • +

          getOpenApiProtocol

          +
          public OpenApiProtocol<T> getOpenApiProtocol()
          +
          Gets the OpenAPI protocol conversion object.
          +
          +
          Returns:
          +
          Returns the OpenAPI protocol.
          +
          +
          • +
        + + + +
          +
        • +

          getSchema

          +
          public Schema getSchema​(java.lang.String pointer)
          +
          Gets a converted schema from the context object by JSON pointer + and throws if the schema does not exist.
          +
          +
          Parameters:
          +
          pointer - Schema to retrieve by JSON pointer (e.g., "#/components/schemas/foo").
          +
          Returns:
          +
          Returns the found schema.
          +
          Throws:
          +
          OpenApiException - if the schema cannot be found.
          +
          +
          • +
        + + + +
          +
        • +

          getPointer

          +
          public java.lang.String getPointer​(ToShapeId shapeId)
          +
          Gets the JSON pointer string to a specific shape.
          +
          +
          Parameters:
          +
          shapeId - Shape ID to convert into a JSON pointer to a schema component.
          +
          Returns:
          +
          Returns the JSON pointer to this shape as a schema component.
          +
          +
          • +
        + + + +
          +
        • +

          createRef

          +
          public Schema createRef​(ToShapeId shapeId)
          +
          Creates a schema that contains a $ref that points to a schema component.
          +
          +
          Parameters:
          +
          shapeId - Shape ID to point to with a $ref schema.
          +
          Returns:
          +
          Returns the creates schema.
          +
          +
          • +
        + + + +
          +
        • +

          inlineOrReferenceSchema

          +
          public Schema inlineOrReferenceSchema​(MemberShape member)
          +
          Gets the exiting schema of the shape if it's meant to be inlined, + otherwise creates a $ref to the shape if it is meant to be reused + across the generated schema.
          +
          +
          Parameters:
          +
          member - Member to inline or reference.
          +
          Returns:
          +
          Returns the schema for the member.
          +
          +
          • +
        + + + +
          +
        • +

          getSecuritySchemeConverters

          +
          public java.util.List<SecuritySchemeConverter<? extends Trait>> getSecuritySchemeConverters()
          +
          Gets the security scheme converters that are compatible with the + selected protocol.
          +
          +
          Returns:
          +
          Returns the security scheme converters.
          +
          +
          • +
        + + + +
          +
        • +

          usesHttpCredentials

          +
          public boolean usesHttpCredentials()
          +
          Reports if any authentication mechanisms in the entire model use HTTP + credentials, such as cookies, browser-managed usernames and passwords, + or TLS client certificates. + +

          This is useful when integrating with things like CORS.

          +
          +
          Returns:
          +
          Whether any authentication mechanism relies on browser-managed credentials.
          +
          See Also:
          +
          Browser-managed credentials
          +
          +
          • +
        + + + +
          +
        • +

          getAllSecuritySchemeRequestHeaders

          +
          public java.util.Set<java.lang.String> getAllSecuritySchemeRequestHeaders()
          +
          Gets an alphabetically sorted set of request headers used by every + security scheme associated with the API. + +

          This is useful when integrating with things like CORS.

          +
          +
          Returns:
          +
          Returns the set of every request header used by every security scheme.
          +
          +
          • +
        + + + +
          +
        • +

          getAllSecuritySchemeResponseHeaders

          +
          public java.util.Set<java.lang.String> getAllSecuritySchemeResponseHeaders()
          +
          Gets an alphabetically sorted set of response headers used by every + security scheme associated with the API. + +

          This is useful when integrating with things like CORS.

          +
          +
          Returns:
          +
          Returns the set of every response header used by every security scheme.
          +
          +
          • +
        + + + +
          +
        • +

          getSynthesizedSchemas

          +
          public java.util.Map<java.lang.String,​Schema> getSynthesizedSchemas()
          +
          Gets all of the synthesized schemas that needed to be created while + generating the OpenAPI artifact.
          +
          +
          Returns:
          +
          Returns the "synthesized" schemas as an immutable map.
          +
          +
          • +
        + + + +
          +
        • +

          putSynthesizedSchema

          +
          public java.lang.String putSynthesizedSchema​(java.lang.String name,
+                                             Schema schema)
          +
          Puts a new synthesized schema that is needed to convert to OpenAPI. + +

          Synthesized schemas are used when ad-hoc schemas are necessary in + order to materialize some change in OpenAPI while still providing an + explicit name. For example, when generating many of the RESTful + protocols, members from the input of an operation might come together + to form the payload of a request. In Smithy, it's fine to use only + part of the input to derive the payload, whereas in OpenAPI, you need + a schema that's dedicated to the payload. + +

          The primary alternative to synthesized schemas is inlined schema + definitions. The problem with inline schemas is that they don't + have an explicit or even deterministic name when used with other + platforms (for example, API Gateway will generate a random name for + an object if one is not given). + +

          This method is thread-safe.

          +
          +
          Parameters:
          +
          name - Name of the schema to put into components/schemas. Nested + pointers are not supported.
          +
          schema - The schema to put.
          +
          Returns:
          +
          Returns a JSON pointer to the created schema.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/CoreExtension.html b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/CoreExtension.html new file mode 100644 index 00000000000..5cdc7b02c61 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/CoreExtension.html @@ -0,0 +1,398 @@ + + + + + +CoreExtension (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.fromsmithy
    +

    Class CoreExtension

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.openapi.fromsmithy.CoreExtension
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        CoreExtension() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/OpenApiConverter.html b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/OpenApiConverter.html new file mode 100644 index 00000000000..20550653d1d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/OpenApiConverter.html @@ -0,0 +1,425 @@ + + + + + +OpenApiConverter (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.fromsmithy
    +

    Class OpenApiConverter

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.openapi.fromsmithy.OpenApiConverter
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class OpenApiConverter
+extends java.lang.Object
      +
      Converts a Smithy model to OpenAPI.
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/OpenApiJsonSchemaMapper.html b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/OpenApiJsonSchemaMapper.html new file mode 100644 index 00000000000..c37409b6f5a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/OpenApiJsonSchemaMapper.html @@ -0,0 +1,339 @@ + + + + + +OpenApiJsonSchemaMapper (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.fromsmithy
    +

    Class OpenApiJsonSchemaMapper

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.openapi.fromsmithy.OpenApiJsonSchemaMapper
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/OpenApiMapper.html b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/OpenApiMapper.html new file mode 100644 index 00000000000..fe3ff1ef14a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/OpenApiMapper.html @@ -0,0 +1,691 @@ + + + + + +OpenApiMapper (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.fromsmithy
    +

    Interface OpenApiMapper

    +
    +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/OpenApiProtocol.Operation.html b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/OpenApiProtocol.Operation.html new file mode 100644 index 00000000000..9cd77848ca2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/OpenApiProtocol.Operation.html @@ -0,0 +1,338 @@ + + + + + +OpenApiProtocol.Operation (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.fromsmithy
    +

    Class OpenApiProtocol.Operation

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.openapi.fromsmithy.OpenApiProtocol.Operation
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing interface:
      +
      OpenApiProtocol<T extends Trait>
      +
      +
      +
      public static final class OpenApiProtocol.Operation
+extends java.lang.Object
      +
      Represents an operation entry to add to an OpenApi.Builder.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          create

          +
          public static OpenApiProtocol.Operation create​(java.lang.String method,
+                                               java.lang.String uri,
+                                               OperationObject.Builder operation)
          +
          Creates a new operation entry.
          +
          +
          Parameters:
          +
          method - HTTP method used for the operation.
          +
          uri - HTTP URI of the operation.
          +
          operation - Operation builder to return.
          +
          Returns:
          +
          Returns the created Operation entry.
          +
          +
          • +
        + + + +
          +
        • +

          getMethod

          +
          public java.lang.String getMethod()
          +
          +
          Returns:
          +
          Gets the HTTP method.
          +
          +
          • +
        + + + +
          +
        • +

          getUri

          +
          public java.lang.String getUri()
          +
          +
          Returns:
          +
          Gets the HTTP URI.
          +
          +
          • +
        + + + +
          +
        • +

          getOperation

          +
          public OperationObject.Builder getOperation()
          +
          +
          Returns:
          +
          Gets the OperationOperation builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/OpenApiProtocol.html b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/OpenApiProtocol.html new file mode 100644 index 00000000000..99d2119f422 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/OpenApiProtocol.html @@ -0,0 +1,510 @@ + + + + + +OpenApiProtocol (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.fromsmithy
    +

    Interface OpenApiProtocol<T extends Trait>

    +
    +
    +
    +
      +
    • +
      +
      Type Parameters:
      +
      T - Type of Smithy protocol to convert.
      +
      +
      +
      All Known Implementing Classes:
      +
      AwsRestJson1Protocol
      +
      +
      +
      public interface OpenApiProtocol<T extends Trait>
      +
      An OpenAPI protocol is used to convert a Smithy protocol into + HTTP-specific bindings. + +

      Instances of OpenApiProtocol are discovered using SPI and + matched with configuration settings based on the result of matching + a protocol against getProtocolType().

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getProtocolType

          +
          java.lang.Class<T> getProtocolType()
          +
          Gets the protocol type that this converter handles.
          +
          +
          Returns:
          +
          Returns the shape ID.
          +
          +
          • +
        + + + +
          +
        • +

          updateDefaultSettings

          +
          default void updateDefaultSettings​(Model model,
+                                   OpenApiConfig config)
          +
          Sets protocol-specific default values on the OpenAPI configuration + object.
          +
          +
          Parameters:
          +
          model - Model being converted.
          +
          config - Configuration object to modify.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getOperationUri

          +
          default java.lang.String getOperationUri​(Context<T> context,
+                                         OperationShape operation)
          +
          Gets the URI of an operation. + +

          The default implementation will attempt to get the HTTP URI + defined by the HttpTrait trait. If no HTTP trait can be + found, the default implementation will throw an exception.

          +
          +
          Parameters:
          +
          context - The build context.
          +
          operation - The operation to get the URI of.
          +
          Returns:
          +
          Returns the operation URI.
          +
          +
          • +
        + + + +
          +
        • +

          getOperationMethod

          +
          default java.lang.String getOperationMethod​(Context<T> context,
+                                            OperationShape operation)
          +
          Gets the HTTP method of an operation. + +

          The default implementation will attempt to get the HTTP method + defined by the HttpTrait trait. If no HTTP trait can be + found, the default implementation will throw an exception.

          +
          +
          Parameters:
          +
          context - The build context.
          +
          operation - The operation to get the method of.
          +
          Returns:
          +
          Returns the method.
          +
          +
          • +
        + + + +
          +
        • +

          getOperationResponseStatusCode

          +
          default java.lang.String getOperationResponseStatusCode​(Context<T> context,
+                                                        ToShapeId operationOrError)
          +
          Gets the response status code of an operation or error shape. + +

          The default implementation will attempt to use HTTP binding traits + to determine the HTTP status code of an operation or error structure.

          +
          +
          Parameters:
          +
          context - The build context.
          +
          operationOrError - Operation or error shape ID.
          +
          Returns:
          +
          Returns the status code as a string.
          +
          +
          • +
        + + + +
          +
        • +

          getProtocolRequestHeaders

          +
          default java.util.Set<java.lang.String> getProtocolRequestHeaders​(Context<T> context,
+                                                                  OperationShape operationShape)
          +
          Gets the unmodeled protocol-specific HTTP headers of a request that are + considered significant for the provided operation. + +

          These protocol specific headers are not automatically added to + requests, but are used when integrating with things like CORS.

          +
          +
          Parameters:
          +
          context - OpenAPI context
          +
          operationShape - Smithy operation
          +
          Returns:
          +
          Returns a set of header names.
          +
          +
          • +
        + + + +
          +
        • +

          getProtocolResponseHeaders

          +
          default java.util.Set<java.lang.String> getProtocolResponseHeaders​(Context<T> context,
+                                                                   OperationShape operationShape)
          +
          Gets the unmodeled protocol-specific HTTP headers of a response that + are considered significant for the provided operation. + +

          These protocol specific headers are not automatically added to + responses, but are used when integrating with things like CORS.

          +
          +
          Parameters:
          +
          context - OpenAPI context
          +
          operationShape - Smithy operation
          +
          Returns:
          +
          Returns a set of header names.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/SecuritySchemeConverter.html b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/SecuritySchemeConverter.html new file mode 100644 index 00000000000..6103f30b90f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/SecuritySchemeConverter.html @@ -0,0 +1,475 @@ + + + + + +SecuritySchemeConverter (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.fromsmithy
    +

    Interface SecuritySchemeConverter<T extends Trait>

    +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods Default Methods 
        Modifier and TypeMethodDescription
        default java.util.List<java.lang.String>createSecurityRequirements​(Context<? extends Trait> context, + T authTrait, + Shape shape) +
        Creates a "security" requirements property to apply to an operation + or top-level service using the Smithy auth scheme name as the key.
        +
        SecuritySchemecreateSecurityScheme​(Context<? extends Trait> context, + T authTrait) +
        Creates an OpenAPI security scheme.
        +
        default java.util.Set<java.lang.String>getAuthRequestHeaders​(Context<? extends Trait> context, + T authTrait) +
        Gets the names of the headers set on HTTP requests used by this + authentication scheme.
        +
        default java.util.Set<java.lang.String>getAuthResponseHeaders​(Context<? extends Trait> context, + T authTrait) +
        Gets the names of the headers set on HTTP responses used by this + authentication scheme.
        +
        default ShapeIdgetAuthSchemeId() +
        Gets the shape ID of the auth scheme type.
        +
        java.lang.Class<T>getAuthSchemeType() +
        Get the U that matches this converter.
        +
        default java.lang.StringgetOpenApiAuthSchemeName() +
        Gets the name of OpenApi auth scheme.
        +
        default booleanusesHttpCredentials() +
        Reports if this authentication mechanism uses HTTP credentials, such as + cookies, browser-managed usernames and passwords, or TLS client + certificates.
        +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getAuthSchemeType

          +
          java.lang.Class<T> getAuthSchemeType()
          +
          Get the U that matches this converter.
          +
          +
          Returns:
          +
          The Smithy security auth scheme ID.
          +
          +
          • +
        + + + +
          +
        • +

          getAuthSchemeId

          +
          default ShapeId getAuthSchemeId()
          +
          Gets the shape ID of the auth scheme type. + +

          By default, this operation uses reflection to get the value of + a static property of the auth scheme class named "ID". If that is + not how a specific auth scheme class is implemented, then this + method must be overridden.

          +
          +
          Returns:
          +
          Returns the auth scheme's shape ID.
          +
          +
          • +
        + + + + + +
          +
        • +

          createSecurityScheme

          +
          SecurityScheme createSecurityScheme​(Context<? extends Trait> context,
+                                    T authTrait)
          +
          Creates an OpenAPI security scheme.
          +
          +
          Parameters:
          +
          context - Conversion context.
          +
          authTrait - Authentication trait to convert.
          +
          Returns:
          +
          The generated security scheme
          +
          See Also:
          +
          Security Scheme Object
          +
          +
          • +
        + + + + + +
          +
        • +

          createSecurityRequirements

          +
          default java.util.List<java.lang.String> createSecurityRequirements​(Context<? extends Trait> context,
+                                                                    T authTrait,
+                                                                    Shape shape)
          +
          Creates a "security" requirements property to apply to an operation + or top-level service using the Smithy auth scheme name as the key. + +

          The default implementation will return an empty list.

          +
          +
          Parameters:
          +
          context - OpenAPI context
          +
          authTrait - Authentication trait to convert.
          +
          shape - Service or operation shape.
          +
          Returns:
          +
          The security requirements value.
          +
          +
          • +
        + + + +
          +
        • +

          getOpenApiAuthSchemeName

          +
          default java.lang.String getOpenApiAuthSchemeName()
          +
          Gets the name of OpenApi auth scheme. + +

          For compatibility with Amazon API Gateway, the `#` is replaced with + an `.` when deriving the name from the auth scheme's shape ID.

          +
          +
          Returns:
          +
          Returns the auth scheme's name.
          +
          +
          • +
        + + + + + +
          +
        • +

          getAuthRequestHeaders

          +
          default java.util.Set<java.lang.String> getAuthRequestHeaders​(Context<? extends Trait> context,
+                                                              T authTrait)
          +
          Gets the names of the headers set on HTTP requests used by this + authentication scheme. + +

          This is useful when integrating with things like CORS.

          +
          +
          Parameters:
          +
          context - Context for the conversion.
          +
          authTrait - The auth trait that is being used.
          +
          Returns:
          +
          A set of header names.
          +
          +
          • +
        + + + + + +
          +
        • +

          getAuthResponseHeaders

          +
          default java.util.Set<java.lang.String> getAuthResponseHeaders​(Context<? extends Trait> context,
+                                                               T authTrait)
          +
          Gets the names of the headers set on HTTP responses used by this + authentication scheme. + +

          This is useful when integrating with things like CORS.

          +
          +
          Parameters:
          +
          context - Context for the conversion.
          +
          authTrait - The auth trait that is being used.
          +
          Returns:
          +
          A set of header names.
          +
          +
          • +
        + + + +
          +
        • +

          usesHttpCredentials

          +
          default boolean usesHttpCredentials()
          +
          Reports if this authentication mechanism uses HTTP credentials, such as + cookies, browser-managed usernames and passwords, or TLS client + certificates. + +

          This is useful when integrating with things like CORS.

          +
          +
          Returns:
          +
          Whether this authentication mechanism relies on browser-managed credentials
          +
          See Also:
          +
          Browser-managed credentials
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/Smithy2OpenApi.html b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/Smithy2OpenApi.html new file mode 100644 index 00000000000..eee219322b7 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/Smithy2OpenApi.html @@ -0,0 +1,356 @@ + + + + + +Smithy2OpenApi (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.fromsmithy
    +

    Class Smithy2OpenApi

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.openapi.fromsmithy.Smithy2OpenApi
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      SmithyBuildPlugin
      +
      +
      +
      public final class Smithy2OpenApi
+extends java.lang.Object
+implements SmithyBuildPlugin
      +
      Converts Smithy to an OpenAPI model and saves it as a JSON file. + +

      This plugin requires a setting named "service" that is the + Shape ID of the Smithy service shape to convert to OpenAPI. + +

      This plugin is configured using OpenApiConfig.

      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Smithy2OpenApi() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidexecute​(PluginContext context) +
        Executes the plugin, creating any number of artifacts.
        +
        java.lang.StringgetName() +
        Gets the name of the plugin.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          Smithy2OpenApi

          +
          public Smithy2OpenApi()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getName

          +
          public java.lang.String getName()
          +
          Description copied from interface: SmithyBuildPlugin
          +
          Gets the name of the plugin.
          +
          +
          Specified by:
          +
          getName in interface SmithyBuildPlugin
          +
          Returns:
          +
          Returns the name (e.g., "MyPlugin").
          +
          +
          • +
        + + + +
          +
        • +

          execute

          +
          public void execute​(PluginContext context)
          +
          Description copied from interface: SmithyBuildPlugin
          +
          Executes the plugin, creating any number of artifacts.
          +
          +
          Specified by:
          +
          execute in interface SmithyBuildPlugin
          +
          Parameters:
          +
          context - Plugin context for build execution.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/Smithy2OpenApiExtension.html b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/Smithy2OpenApiExtension.html new file mode 100644 index 00000000000..ba406241a75 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/Smithy2OpenApiExtension.html @@ -0,0 +1,332 @@ + + + + + +Smithy2OpenApiExtension (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.fromsmithy
    +

    Interface Smithy2OpenApiExtension

    +
    +
    +
    +
      +
    • +
      +
      All Known Implementing Classes:
      +
      ApiGatewayExtension, CoreExtension
      +
      +
      +
      public interface Smithy2OpenApiExtension
      +
      An extension mechanism used to influence how Smithy models are converted + to OpenAPI models. + +

      Implementations of this interface are discovered through Java SPI.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getSecuritySchemeConverters

          +
          default java.util.List<SecuritySchemeConverter<? extends Trait>> getSecuritySchemeConverters()
          +
          Registers additional security scheme converters.
          +
          +
          Returns:
          +
          Returns the converters to register.
          +
          +
          • +
        + + + +
          +
        • +

          getProtocols

          +
          default java.util.List<OpenApiProtocol<? extends Trait>> getProtocols()
          +
          Registers additional protocols that handle serialization and + deserialization.
          +
          +
          Returns:
          +
          Returns the protocols to register.
          +
          +
          • +
        + + + +
          +
        • +

          getOpenApiMappers

          +
          default java.util.List<OpenApiMapper> getOpenApiMappers()
          +
          Registers OpenAPI mappers, classes used to modify and extend the + process of converting a Smithy model to OpenAPI.
          +
          +
          Returns:
          +
          Returns the mappers to register.
          +
          +
          • +
        + + + +
          +
        • +

          getJsonSchemaMappers

          +
          default java.util.List<JsonSchemaMapper> getJsonSchemaMappers()
          +
          Registers JsonSchema mappers that are used to modify JsonSchema + definitions created from a Smithy model.
          +
          +
          Returns:
          +
          Returns the mappers to register.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/CheckForGreedyLabels.html b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/CheckForGreedyLabels.html new file mode 100644 index 00000000000..15d551720d4 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/CheckForGreedyLabels.html @@ -0,0 +1,364 @@ + + + + + +CheckForGreedyLabels (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.fromsmithy.mappers
    +

    Class CheckForGreedyLabels

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.openapi.fromsmithy.mappers.CheckForGreedyLabels
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      OpenApiMapper
      +
      +
      +
      public class CheckForGreedyLabels
+extends java.lang.Object
+implements OpenApiMapper
      +
      Checks for greedy labels and fails/warns depending on configuration. + +

      Some vendors like API Gateway support greedy labels in the form of + "{foo+}", while others do not.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CheckForGreedyLabels

          +
          public CheckForGreedyLabels()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getOrder

          +
          public byte getOrder()
          +
          Description copied from interface: OpenApiMapper
          +
          Gets the sort order of the plugin from -128 to 127. + +

          Plugins are applied according to this sort order. Lower values + are executed before higher values (for example, -128 comes before 0, + comes before 127). Plugins default to 0, which is the middle point + between the minimum and maximum order values.

          +
          +
          Specified by:
          +
          getOrder in interface OpenApiMapper
          +
          Returns:
          +
          Returns the sort order, defaulting to 0.
          +
          +
          • +
        + + + +
          +
        • +

          after

          +
          public OpenApi after​(Context<? extends Trait> context,
+                     OpenApi openApi)
          +
          Description copied from interface: OpenApiMapper
          +
          Updates an OpenApi object after it is built.
          +
          +
          Specified by:
          +
          after in interface OpenApiMapper
          +
          Parameters:
          +
          context - Conversion context.
          +
          openApi - OpenAPI object to modify.
          +
          Returns:
          +
          Returns the updated OpenApi object.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/CheckForPrefixHeaders.html b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/CheckForPrefixHeaders.html new file mode 100644 index 00000000000..066028592a7 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/CheckForPrefixHeaders.html @@ -0,0 +1,364 @@ + + + + + +CheckForPrefixHeaders (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.fromsmithy.mappers
    +

    Class CheckForPrefixHeaders

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.openapi.fromsmithy.mappers.CheckForPrefixHeaders
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      OpenApiMapper
      +
      +
      +
      public class CheckForPrefixHeaders
+extends java.lang.Object
+implements OpenApiMapper
      +
      Checks for prefix headers in the input or output of an operation, + and handles the settings for throwing an exception or warning if + they're found. + +

      Custom values for this setting need to be handled in a + OpenApiProtocol.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CheckForPrefixHeaders

          +
          public CheckForPrefixHeaders()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getOrder

          +
          public byte getOrder()
          +
          Description copied from interface: OpenApiMapper
          +
          Gets the sort order of the plugin from -128 to 127. + +

          Plugins are applied according to this sort order. Lower values + are executed before higher values (for example, -128 comes before 0, + comes before 127). Plugins default to 0, which is the middle point + between the minimum and maximum order values.

          +
          +
          Specified by:
          +
          getOrder in interface OpenApiMapper
          +
          Returns:
          +
          Returns the sort order, defaulting to 0.
          +
          +
          • +
        + + + +
          +
        • +

          before

          +
          public void before​(Context<? extends Trait> context,
+                   OpenApi.Builder builder)
          +
          Description copied from interface: OpenApiMapper
          +
          Updates an OpenApi.Builder before converting the model.
          +
          +
          Specified by:
          +
          before in interface OpenApiMapper
          +
          Parameters:
          +
          context - Conversion context.
          +
          builder - OpenAPI builder to modify.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/OpenApiJsonAdd.html b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/OpenApiJsonAdd.html new file mode 100644 index 00000000000..b8df0c7e7e4 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/OpenApiJsonAdd.html @@ -0,0 +1,369 @@ + + + + + +OpenApiJsonAdd (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.fromsmithy.mappers
    +

    Class OpenApiJsonAdd

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.openapi.fromsmithy.mappers.OpenApiJsonAdd
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      OpenApiMapper
      +
      +
      +
      public final class OpenApiJsonAdd
+extends java.lang.Object
+implements OpenApiMapper
      +
      Adds JSON values into the generated OpenAPI model using a JSON Patch + like "add" operation that also generated intermediate objects as needed. + Any existing property is overwritten. + +

      This mapper is applied using the contents of openapi.jsonAdd. + This is run after substitutions so it is unaffected by them.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          OpenApiJsonAdd

          +
          public OpenApiJsonAdd()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getOrder

          +
          public byte getOrder()
          +
          Description copied from interface: OpenApiMapper
          +
          Gets the sort order of the plugin from -128 to 127. + +

          Plugins are applied according to this sort order. Lower values + are executed before higher values (for example, -128 comes before 0, + comes before 127). Plugins default to 0, which is the middle point + between the minimum and maximum order values.

          +
          +
          Specified by:
          +
          getOrder in interface OpenApiMapper
          +
          Returns:
          +
          Returns the sort order, defaulting to 0.
          +
          +
          • +
        + + + +
          +
        • +

          updateNode

          +
          public ObjectNode updateNode​(Context<? extends Trait> context,
+                             OpenApi openapi,
+                             ObjectNode node)
          +
          Description copied from interface: OpenApiMapper
          +
          Modifies the Node/JSON representation of an OpenAPI object.
          +
          +
          Specified by:
          +
          updateNode in interface OpenApiMapper
          +
          Parameters:
          +
          context - Conversion context.
          +
          openapi - OpenAPI object being converted to a node.
          +
          node - OpenAPI object node.
          +
          Returns:
          +
          Returns the updated ObjectNode.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/OpenApiJsonSubstitutions.html b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/OpenApiJsonSubstitutions.html new file mode 100644 index 00000000000..994ead42b16 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/OpenApiJsonSubstitutions.html @@ -0,0 +1,365 @@ + + + + + +OpenApiJsonSubstitutions (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.fromsmithy.mappers
    +

    Class OpenApiJsonSubstitutions

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.openapi.fromsmithy.mappers.OpenApiJsonSubstitutions
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      OpenApiMapper
      +
      +
      +
      public final class OpenApiJsonSubstitutions
+extends java.lang.Object
+implements OpenApiMapper
      +
      Substitutes JSON string values using the mapping defined in + openapi.substitutions.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          OpenApiJsonSubstitutions

          +
          public OpenApiJsonSubstitutions()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getOrder

          +
          public byte getOrder()
          +
          Description copied from interface: OpenApiMapper
          +
          Gets the sort order of the plugin from -128 to 127. + +

          Plugins are applied according to this sort order. Lower values + are executed before higher values (for example, -128 comes before 0, + comes before 127). Plugins default to 0, which is the middle point + between the minimum and maximum order values.

          +
          +
          Specified by:
          +
          getOrder in interface OpenApiMapper
          +
          Returns:
          +
          Returns the sort order, defaulting to 0.
          +
          +
          • +
        + + + +
          +
        • +

          updateNode

          +
          public ObjectNode updateNode​(Context<? extends Trait> context,
+                             OpenApi openapi,
+                             ObjectNode node)
          +
          Description copied from interface: OpenApiMapper
          +
          Modifies the Node/JSON representation of an OpenAPI object.
          +
          +
          Specified by:
          +
          updateNode in interface OpenApiMapper
          +
          Parameters:
          +
          context - Conversion context.
          +
          openapi - OpenAPI object being converted to a node.
          +
          node - OpenAPI object node.
          +
          Returns:
          +
          Returns the updated ObjectNode.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/RemoveEmptyComponents.html b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/RemoveEmptyComponents.html new file mode 100644 index 00000000000..5f96d890bf8 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/RemoveEmptyComponents.html @@ -0,0 +1,365 @@ + + + + + +RemoveEmptyComponents (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.fromsmithy.mappers
    +

    Class RemoveEmptyComponents

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.openapi.fromsmithy.mappers.RemoveEmptyComponents
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      OpenApiMapper
      +
      +
      +
      public final class RemoveEmptyComponents
+extends java.lang.Object
+implements OpenApiMapper
      +
      Removes empty key-value pairs in the "components" of a model if empty, and + removes the "components" key-value pair of a model if it is empty.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          RemoveEmptyComponents

          +
          public RemoveEmptyComponents()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getOrder

          +
          public byte getOrder()
          +
          Description copied from interface: OpenApiMapper
          +
          Gets the sort order of the plugin from -128 to 127. + +

          Plugins are applied according to this sort order. Lower values + are executed before higher values (for example, -128 comes before 0, + comes before 127). Plugins default to 0, which is the middle point + between the minimum and maximum order values.

          +
          +
          Specified by:
          +
          getOrder in interface OpenApiMapper
          +
          Returns:
          +
          Returns the sort order, defaulting to 0.
          +
          +
          • +
        + + + +
          +
        • +

          updateNode

          +
          public ObjectNode updateNode​(Context<? extends Trait> context,
+                             OpenApi openapi,
+                             ObjectNode node)
          +
          Description copied from interface: OpenApiMapper
          +
          Modifies the Node/JSON representation of an OpenAPI object.
          +
          +
          Specified by:
          +
          updateNode in interface OpenApiMapper
          +
          Parameters:
          +
          context - Conversion context.
          +
          openapi - OpenAPI object being converted to a node.
          +
          node - OpenAPI object node.
          +
          Returns:
          +
          Returns the updated ObjectNode.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/RemoveUnusedComponents.html b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/RemoveUnusedComponents.html new file mode 100644 index 00000000000..c5007cf77bf --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/RemoveUnusedComponents.html @@ -0,0 +1,367 @@ + + + + + +RemoveUnusedComponents (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.fromsmithy.mappers
    +

    Class RemoveUnusedComponents

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.openapi.fromsmithy.mappers.RemoveUnusedComponents
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      OpenApiMapper
      +
      +
      +
      public final class RemoveUnusedComponents
+extends java.lang.Object
+implements OpenApiMapper
      +
      Removes unused components from the OpenAPI model. + +

      This plugin will take effect by default, but can be disabled by setting + "openapi.keepUnusedComponents" to true. Refs are removed in rounds until + a round of removals has no effect. + +

      TODO: This plugin currently only supports the removal of schemas and security schemes.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          RemoveUnusedComponents

          +
          public RemoveUnusedComponents()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getOrder

          +
          public byte getOrder()
          +
          Description copied from interface: OpenApiMapper
          +
          Gets the sort order of the plugin from -128 to 127. + +

          Plugins are applied according to this sort order. Lower values + are executed before higher values (for example, -128 comes before 0, + comes before 127). Plugins default to 0, which is the middle point + between the minimum and maximum order values.

          +
          +
          Specified by:
          +
          getOrder in interface OpenApiMapper
          +
          Returns:
          +
          Returns the sort order, defaulting to 0.
          +
          +
          • +
        + + + +
          +
        • +

          after

          +
          public OpenApi after​(Context<? extends Trait> context,
+                     OpenApi openapi)
          +
          Description copied from interface: OpenApiMapper
          +
          Updates an OpenApi object after it is built.
          +
          +
          Specified by:
          +
          after in interface OpenApiMapper
          +
          Parameters:
          +
          context - Conversion context.
          +
          openapi - OpenAPI object to modify.
          +
          Returns:
          +
          Returns the updated OpenApi object.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/SpecificationExtensionsMapper.html b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/SpecificationExtensionsMapper.html new file mode 100644 index 00000000000..973e35605c9 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/SpecificationExtensionsMapper.html @@ -0,0 +1,368 @@ + + + + + +SpecificationExtensionsMapper (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.fromsmithy.mappers
    +

    Class SpecificationExtensionsMapper

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.openapi.fromsmithy.mappers.SpecificationExtensionsMapper
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          SpecificationExtensionsMapper

          +
          public SpecificationExtensionsMapper()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          after

          +
          public OpenApi after​(Context<? extends Trait> context,
+                     OpenApi openapi)
          +
          Attach Specification Extensions to Service.
          +
          +
          Specified by:
          +
          after in interface OpenApiMapper
          +
          Parameters:
          +
          context - Conversion context.
          +
          openapi - OpenAPI object to modify.
          +
          Returns:
          +
          Returns the updated OpenApi object.
          +
          +
          • +
        + + + +
          +
        • +

          updateOperation

          +
          public OperationObject updateOperation​(Context<? extends Trait> context,
+                                       OperationShape shape,
+                                       OperationObject operation,
+                                       java.lang.String httpMethodName,
+                                       java.lang.String path)
          +
          Attach Specification Extensions to Operation.
          +
          +
          Specified by:
          +
          updateOperation in interface OpenApiMapper
          +
          Parameters:
          +
          context - Conversion context.
          +
          shape - Operation being converted.
          +
          operation - OperationObject being built.
          +
          httpMethodName - The HTTP method of the operation.
          +
          path - The HTTP URI of the operation.
          +
          Returns:
          +
          Returns the updated operation object.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/UnsupportedTraits.html b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/UnsupportedTraits.html new file mode 100644 index 00000000000..f5b7d261b6e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/UnsupportedTraits.html @@ -0,0 +1,360 @@ + + + + + +UnsupportedTraits (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.fromsmithy.mappers
    +

    Class UnsupportedTraits

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.openapi.fromsmithy.mappers.UnsupportedTraits
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      OpenApiMapper
      +
      +
      +
      public final class UnsupportedTraits
+extends java.lang.Object
+implements OpenApiMapper
      +
      Logs each instance of traits and features that are known to not + work in OpenAPI.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          UnsupportedTraits

          +
          public UnsupportedTraits()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getOrder

          +
          public byte getOrder()
          +
          Description copied from interface: OpenApiMapper
          +
          Gets the sort order of the plugin from -128 to 127. + +

          Plugins are applied according to this sort order. Lower values + are executed before higher values (for example, -128 comes before 0, + comes before 127). Plugins default to 0, which is the middle point + between the minimum and maximum order values.

          +
          +
          Specified by:
          +
          getOrder in interface OpenApiMapper
          +
          Returns:
          +
          Returns the sort order, defaulting to 0.
          +
          +
          • +
        + + + +
          +
        • +

          before

          +
          public void before​(Context<? extends Trait> context,
+                   OpenApi.Builder builder)
          +
          Description copied from interface: OpenApiMapper
          +
          Updates an OpenApi.Builder before converting the model.
          +
          +
          Specified by:
          +
          before in interface OpenApiMapper
          +
          Parameters:
          +
          context - Conversion context.
          +
          builder - OpenAPI builder to modify.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/package-summary.html new file mode 100644 index 00000000000..c6ba2ddd20b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/package-summary.html @@ -0,0 +1,214 @@ + + + + + +software.amazon.smithy.openapi.fromsmithy.mappers (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.openapi.fromsmithy.mappers

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/package-tree.html new file mode 100644 index 00000000000..cf73c88036b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/mappers/package-tree.html @@ -0,0 +1,168 @@ + + + + + +software.amazon.smithy.openapi.fromsmithy.mappers Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.openapi.fromsmithy.mappers

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/package-summary.html new file mode 100644 index 00000000000..c8867bc80f3 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/package-summary.html @@ -0,0 +1,236 @@ + + + + + +software.amazon.smithy.openapi.fromsmithy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.openapi.fromsmithy

    +
    +
    +
      +
    • + + + + + + + + + + + + + + + + + + + + + + + + +
      Interface Summary 
      InterfaceDescription
      OpenApiMapper +
      Provides a plugin infrastructure used to hook into the Smithy to OpenAPI + conversion process and map over the result.
      +
      OpenApiProtocol<T extends Trait> +
      An OpenAPI protocol is used to convert a Smithy protocol into + HTTP-specific bindings.
      +
      SecuritySchemeConverter<T extends Trait> +
      Converts a Smithy authentication scheme to an OpenAPI security + scheme and applies security requirements to operations.
      +
      Smithy2OpenApiExtension +
      An extension mechanism used to influence how Smithy models are converted + to OpenAPI models.
      +
      +
      • +
    • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      Context<T extends Trait> +
      Smithy to OpenAPI conversion context object.
      +
      CoreExtension +
      Registers the core Smithy2OpenApi functionality.
      +
      OpenApiConverter +
      Converts a Smithy model to OpenAPI.
      +
      OpenApiJsonSchemaMapper +
      Applies OpenAPI extensions to a Schema using configuration settings + found in OpenApiConfig.
      +
      OpenApiProtocol.Operation +
      Represents an operation entry to add to an OpenApi.Builder.
      +
      Smithy2OpenApi +
      Converts Smithy to an OpenAPI model and saves it as a JSON file.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/package-tree.html new file mode 100644 index 00000000000..343b461e6dd --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/package-tree.html @@ -0,0 +1,175 @@ + + + + + +software.amazon.smithy.openapi.fromsmithy Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.openapi.fromsmithy

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/protocols/AwsRestJson1Protocol.html b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/protocols/AwsRestJson1Protocol.html new file mode 100644 index 00000000000..23b18ead07b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/protocols/AwsRestJson1Protocol.html @@ -0,0 +1,507 @@ + + + + + +AwsRestJson1Protocol (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.fromsmithy.protocols
    +

    Class AwsRestJson1Protocol

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.openapi.fromsmithy.protocols.AwsRestJson1Protocol
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      OpenApiProtocol<RestJson1Trait>
      +
      +
      +
      public final class AwsRestJson1Protocol
+extends java.lang.Object
      +
      Converts the aws.protocols#restJson1 protocol to OpenAPI.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          AwsRestJson1Protocol

          +
          public AwsRestJson1Protocol()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getProtocolType

          +
          public java.lang.Class<RestJson1Trait> getProtocolType()
          +
          Description copied from interface: OpenApiProtocol
          +
          Gets the protocol type that this converter handles.
          +
          +
          Returns:
          +
          Returns the shape ID.
          +
          +
          • +
        + + + +
          +
        • +

          getProtocolRequestHeaders

          +
          public java.util.Set<java.lang.String> getProtocolRequestHeaders​(Context<RestJson1Trait> context,
+                                                                 OperationShape operationShape)
          +
          Description copied from interface: OpenApiProtocol
          +
          Gets the unmodeled protocol-specific HTTP headers of a request that are + considered significant for the provided operation. + +

          These protocol specific headers are not automatically added to + requests, but are used when integrating with things like CORS.

          +
          +
          Specified by:
          +
          getProtocolRequestHeaders in interface OpenApiProtocol<RestJson1Trait>
          +
          Parameters:
          +
          context - OpenAPI context
          +
          operationShape - Smithy operation
          +
          Returns:
          +
          Returns a set of header names.
          +
          +
          • +
        + + + +
          +
        • +

          getProtocolResponseHeaders

          +
          public java.util.Set<java.lang.String> getProtocolResponseHeaders​(Context<RestJson1Trait> context,
+                                                                  OperationShape operationShape)
          +
          Description copied from interface: OpenApiProtocol
          +
          Gets the unmodeled protocol-specific HTTP headers of a response that + are considered significant for the provided operation. + +

          These protocol specific headers are not automatically added to + responses, but are used when integrating with things like CORS.

          +
          +
          Specified by:
          +
          getProtocolResponseHeaders in interface OpenApiProtocol<RestJson1Trait>
          +
          Parameters:
          +
          context - OpenAPI context
          +
          operationShape - Smithy operation
          +
          Returns:
          +
          Returns a set of header names.
          +
          +
          • +
        + + + +
          +
        • +

          updateDefaultSettings

          +
          public void updateDefaultSettings​(Model model,
+                                  OpenApiConfig config)
          +
          Description copied from interface: OpenApiProtocol
          +
          Sets protocol-specific default values on the OpenAPI configuration + object.
          +
          +
          Parameters:
          +
          model - Model being converted.
          +
          config - Configuration object to modify.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getEventStreamMediaType

          +
          protected java.lang.String getEventStreamMediaType​(Context<T> context,
+                                                   EventStreamInfo info)
          +
          Gets the media type of an event stream for the protocol. + +

          By default, this method returns the binary AWS event stream + media type, application/vnd.amazon.eventstream.

          +
          +
          Parameters:
          +
          context - Conversion context.
          +
          info - Event stream info to provide the media type for.
          +
          Returns:
          +
          Returns the media type of the event stream.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/protocols/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/protocols/package-summary.html new file mode 100644 index 00000000000..a1ea0608ed4 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/protocols/package-summary.html @@ -0,0 +1,166 @@ + + + + + +software.amazon.smithy.openapi.fromsmithy.protocols (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.openapi.fromsmithy.protocols

    +
    +
    +
      +
    • + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      AwsRestJson1Protocol +
      Converts the aws.protocols#restJson1 protocol to OpenAPI.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/protocols/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/protocols/package-tree.html new file mode 100644 index 00000000000..9fce07a0c9a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/protocols/package-tree.html @@ -0,0 +1,161 @@ + + + + + +software.amazon.smithy.openapi.fromsmithy.protocols Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.openapi.fromsmithy.protocols

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    +
      +
    • java.lang.Object + +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/security/AwsV4Converter.html b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/security/AwsV4Converter.html new file mode 100644 index 00000000000..7cd5cf25c57 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/security/AwsV4Converter.html @@ -0,0 +1,391 @@ + + + + + +AwsV4Converter (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.fromsmithy.security
    +

    Class AwsV4Converter

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.openapi.fromsmithy.security.AwsV4Converter
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/security/HttpApiKeyAuthConverter.html b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/security/HttpApiKeyAuthConverter.html new file mode 100644 index 00000000000..8cee597c75c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/security/HttpApiKeyAuthConverter.html @@ -0,0 +1,397 @@ + + + + + +HttpApiKeyAuthConverter (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.fromsmithy.security
    +

    Class HttpApiKeyAuthConverter

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.openapi.fromsmithy.security.HttpApiKeyAuthConverter
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/security/HttpBasicConverter.html b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/security/HttpBasicConverter.html new file mode 100644 index 00000000000..c5fd3d98488 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/security/HttpBasicConverter.html @@ -0,0 +1,358 @@ + + + + + +HttpBasicConverter (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.fromsmithy.security
    +

    Class HttpBasicConverter

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.openapi.fromsmithy.security.HttpBasicConverter
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/security/HttpBearerConverter.html b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/security/HttpBearerConverter.html new file mode 100644 index 00000000000..7838a787354 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/security/HttpBearerConverter.html @@ -0,0 +1,358 @@ + + + + + +HttpBearerConverter (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.fromsmithy.security
    +

    Class HttpBearerConverter

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.openapi.fromsmithy.security.HttpBearerConverter
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/security/HttpDigestConverter.html b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/security/HttpDigestConverter.html new file mode 100644 index 00000000000..382e4dc4237 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/security/HttpDigestConverter.html @@ -0,0 +1,358 @@ + + + + + +HttpDigestConverter (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.fromsmithy.security
    +

    Class HttpDigestConverter

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.openapi.fromsmithy.security.HttpDigestConverter
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/security/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/security/package-summary.html new file mode 100644 index 00000000000..41c76b69116 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/security/package-summary.html @@ -0,0 +1,190 @@ + + + + + +software.amazon.smithy.openapi.fromsmithy.security (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.openapi.fromsmithy.security

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/security/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/security/package-tree.html new file mode 100644 index 00000000000..e931073fa5c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/fromsmithy/security/package-tree.html @@ -0,0 +1,165 @@ + + + + + +software.amazon.smithy.openapi.fromsmithy.security Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.openapi.fromsmithy.security

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/CallbackObject.Builder.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/CallbackObject.Builder.html new file mode 100644 index 00000000000..047b83f7cd5 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/CallbackObject.Builder.html @@ -0,0 +1,324 @@ + + + + + +CallbackObject.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class CallbackObject.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/CallbackObject.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/CallbackObject.html new file mode 100644 index 00000000000..de25bc1bffe --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/CallbackObject.html @@ -0,0 +1,362 @@ + + + + + +CallbackObject (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class CallbackObject

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/Component.Builder.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/Component.Builder.html new file mode 100644 index 00000000000..a6ced7d797b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/Component.Builder.html @@ -0,0 +1,430 @@ + + + + + +Component.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class Component.Builder<B extends Component.Builder,​C extends Component>

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.openapi.model.Component.Builder<B,​C>
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Builder() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getExtensions

          +
          public java.util.Map<java.lang.String,​Node> getExtensions()
          +
          • +
        + + + +
          +
        • +

          extensions

          +
          public B extensions​(java.util.Map<java.lang.String,​Node> extensions)
          +
          • +
        + + + +
          +
        • +

          extensions

          +
          public B extensions​(ObjectNode extensions)
          +
          • +
        + + + +
          +
        • +

          putExtension

          +
          public B putExtension​(java.lang.String key,
+                      Node value)
          +
          • +
        + + + +
          +
        • +

          putExtension

          +
          public B putExtension​(java.lang.String key,
+                      java.lang.String value)
          +
          • +
        + + + +
          +
        • +

          putExtension

          +
          public B putExtension​(java.lang.String key,
+                      java.lang.Boolean value)
          +
          • +
        + + + +
          +
        • +

          putExtension

          +
          public B putExtension​(java.lang.String key,
+                      java.lang.Number value)
          +
          • +
        + + + +
          +
        • +

          removeExtension

          +
          public B removeExtension​(java.lang.String key)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/Component.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/Component.html new file mode 100644 index 00000000000..6e46393cdd0 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/Component.html @@ -0,0 +1,434 @@ + + + + + +Component (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class Component

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.openapi.model.Component
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getExtension

          +
          public final java.util.Optional<Node> getExtension​(java.lang.String name)
          +
          • +
        + + + +
          +
        • +

          getExtensions

          +
          public final java.util.Map<java.lang.String,​Node> getExtensions()
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public final Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          equals

          +
          public final boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public final int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/ComponentsObject.Builder.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/ComponentsObject.Builder.html new file mode 100644 index 00000000000..2dea0c92d29 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/ComponentsObject.Builder.html @@ -0,0 +1,562 @@ + + + + + +ComponentsObject.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class ComponentsObject.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/ComponentsObject.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/ComponentsObject.html new file mode 100644 index 00000000000..ac694ec2ef1 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/ComponentsObject.html @@ -0,0 +1,460 @@ + + + + + +ComponentsObject (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class ComponentsObject

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/EncodingObject.Builder.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/EncodingObject.Builder.html new file mode 100644 index 00000000000..e5ee631db07 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/EncodingObject.Builder.html @@ -0,0 +1,380 @@ + + + + + +EncodingObject.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class EncodingObject.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/EncodingObject.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/EncodingObject.html new file mode 100644 index 00000000000..67dae70814d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/EncodingObject.html @@ -0,0 +1,418 @@ + + + + + +EncodingObject (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class EncodingObject

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getHeaders

          +
          public java.util.Map<java.lang.String,​ParameterObject> getHeaders()
          +
          • +
        + + + +
          +
        • +

          getContentType

          +
          public java.util.Optional<java.lang.String> getContentType()
          +
          • +
        + + + +
          +
        • +

          getStyle

          +
          public java.util.Optional<java.lang.String> getStyle()
          +
          • +
        + + + +
          +
        • +

          isExplode

          +
          public boolean isExplode()
          +
          • +
        + + + +
          +
        • +

          isAllowReserved

          +
          public boolean isAllowReserved()
          +
          • +
        + + + + + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/ExampleObject.Builder.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/ExampleObject.Builder.html new file mode 100644 index 00000000000..4f25595de5c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/ExampleObject.Builder.html @@ -0,0 +1,350 @@ + + + + + +ExampleObject.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class ExampleObject.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/ExampleObject.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/ExampleObject.html new file mode 100644 index 00000000000..2e8716aedeb --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/ExampleObject.html @@ -0,0 +1,418 @@ + + + + + +ExampleObject (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class ExampleObject

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getSummary

          +
          public java.util.Optional<java.lang.String> getSummary()
          +
          • +
        + + + +
          +
        • +

          getDescription

          +
          public java.util.Optional<java.lang.String> getDescription()
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public java.util.Optional<Node> getValue()
          +
          • +
        + + + +
          +
        • +

          getExternalValue

          +
          public java.util.Optional<java.lang.String> getExternalValue()
          +
          • +
        + + + + + + + + + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/ExternalDocumentation.Builder.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/ExternalDocumentation.Builder.html new file mode 100644 index 00000000000..dd3e40b7b40 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/ExternalDocumentation.Builder.html @@ -0,0 +1,322 @@ + + + + + +ExternalDocumentation.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class ExternalDocumentation.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/ExternalDocumentation.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/ExternalDocumentation.html new file mode 100644 index 00000000000..961f1435426 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/ExternalDocumentation.html @@ -0,0 +1,394 @@ + + + + + +ExternalDocumentation (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class ExternalDocumentation

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/InfoObject.Builder.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/InfoObject.Builder.html new file mode 100644 index 00000000000..d235c34c8b6 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/InfoObject.Builder.html @@ -0,0 +1,378 @@ + + + + + +InfoObject.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class InfoObject.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/InfoObject.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/InfoObject.html new file mode 100644 index 00000000000..1487f9bf57e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/InfoObject.html @@ -0,0 +1,432 @@ + + + + + +InfoObject (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class InfoObject

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getTitle

          +
          public java.lang.String getTitle()
          +
          • +
        + + + +
          +
        • +

          getVersion

          +
          public java.lang.String getVersion()
          +
          • +
        + + + +
          +
        • +

          getDescription

          +
          public java.util.Optional<java.lang.String> getDescription()
          +
          • +
        + + + +
          +
        • +

          getTermsOfService

          +
          public java.util.Optional<java.lang.String> getTermsOfService()
          +
          • +
        + + + +
          +
        • +

          getLicense

          +
          public java.util.Optional<ObjectNode> getLicense()
          +
          • +
        + + + +
          +
        • +

          getContact

          +
          public java.util.Optional<ObjectNode> getContact()
          +
          • +
        + + + + + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/LinkObject.Builder.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/LinkObject.Builder.html new file mode 100644 index 00000000000..392a1564077 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/LinkObject.Builder.html @@ -0,0 +1,378 @@ + + + + + +LinkObject.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class LinkObject.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/LinkObject.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/LinkObject.html new file mode 100644 index 00000000000..3b7e459847f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/LinkObject.html @@ -0,0 +1,432 @@ + + + + + +LinkObject (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class LinkObject

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getParameters

          +
          public java.util.Map<java.lang.String,​Node> getParameters()
          +
          • +
        + + + +
          +
        • +

          getOperationRef

          +
          public java.util.Optional<java.lang.String> getOperationRef()
          +
          • +
        + + + +
          +
        • +

          getOperationId

          +
          public java.util.Optional<java.lang.String> getOperationId()
          +
          • +
        + + + +
          +
        • +

          getRequestBody

          +
          public java.util.Optional<Node> getRequestBody()
          +
          • +
        + + + +
          +
        • +

          getDescription

          +
          public java.util.Optional<java.lang.String> getDescription()
          +
          • +
        + + + +
          +
        • +

          getServer

          +
          public java.util.Optional<ServerObject> getServer()
          +
          • +
        + + + + + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/MediaTypeObject.Builder.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/MediaTypeObject.Builder.html new file mode 100644 index 00000000000..d8e8c70b50b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/MediaTypeObject.Builder.html @@ -0,0 +1,382 @@ + + + + + +MediaTypeObject.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class MediaTypeObject.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/MediaTypeObject.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/MediaTypeObject.html new file mode 100644 index 00000000000..6bc168971d3 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/MediaTypeObject.html @@ -0,0 +1,404 @@ + + + + + +MediaTypeObject (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class MediaTypeObject

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/OpenApi.Builder.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/OpenApi.Builder.html new file mode 100644 index 00000000000..5e2c957e96c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/OpenApi.Builder.html @@ -0,0 +1,492 @@ + + + + + +OpenApi.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class OpenApi.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/OpenApi.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/OpenApi.html new file mode 100644 index 00000000000..b2551a8bcb9 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/OpenApi.html @@ -0,0 +1,460 @@ + + + + + +OpenApi (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class OpenApi

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getOpenapi

          +
          public java.lang.String getOpenapi()
          +
          • +
        + + + + + + + +
          +
        • +

          getServers

          +
          public java.util.List<ServerObject> getServers()
          +
          • +
        + + + +
          +
        • +

          getPaths

          +
          public java.util.Map<java.lang.String,​PathItem> getPaths()
          +
          • +
        + + + + + + + +
          +
        • +

          getSecurity

          +
          public java.util.List<java.util.Map<java.lang.String,​java.util.List<java.lang.String>>> getSecurity()
          +
          • +
        + + + +
          +
        • +

          getTags

          +
          public java.util.List<TagObject> getTags()
          +
          • +
        + + + + + + + +
          +
        • +

          toBuilder

          +
          public OpenApi.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<OpenApi>
          +
          Returns:
          +
          a builder for type T
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/OperationObject.Builder.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/OperationObject.Builder.html new file mode 100644 index 00000000000..60186e4f1f8 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/OperationObject.Builder.html @@ -0,0 +1,550 @@ + + + + + +OperationObject.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class OperationObject.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/OperationObject.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/OperationObject.html new file mode 100644 index 00000000000..bf349a4d547 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/OperationObject.html @@ -0,0 +1,516 @@ + + + + + +OperationObject (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class OperationObject

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getTags

          +
          public java.util.List<java.lang.String> getTags()
          +
          • +
        + + + +
          +
        • +

          getSummary

          +
          public java.util.Optional<java.lang.String> getSummary()
          +
          • +
        + + + +
          +
        • +

          getDescription

          +
          public java.util.Optional<java.lang.String> getDescription()
          +
          • +
        + + + + + + + +
          +
        • +

          getOperationId

          +
          public java.util.Optional<java.lang.String> getOperationId()
          +
          • +
        + + + +
          +
        • +

          getParameters

          +
          public java.util.List<ParameterObject> getParameters()
          +
          • +
        + + + +
          +
        • +

          getRequestBody

          +
          public java.util.Optional<RequestBodyObject> getRequestBody()
          +
          • +
        + + + +
          +
        • +

          getResponses

          +
          public java.util.Map<java.lang.String,​ResponseObject> getResponses()
          +
          • +
        + + + +
          +
        • +

          getCallbacks

          +
          public java.util.Map<java.lang.String,​CallbackObject> getCallbacks()
          +
          • +
        + + + +
          +
        • +

          isDeprecated

          +
          public boolean isDeprecated()
          +
          • +
        + + + +
          +
        • +

          getSecurity

          +
          public java.util.Optional<java.util.List<java.util.Map<java.lang.String,​java.util.List<java.lang.String>>>> getSecurity()
          +
          • +
        + + + +
          +
        • +

          getServers

          +
          public java.util.List<ServerObject> getServers()
          +
          • +
        + + + + + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/ParameterObject.Builder.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/ParameterObject.Builder.html new file mode 100644 index 00000000000..7ea6d914bdf --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/ParameterObject.Builder.html @@ -0,0 +1,508 @@ + + + + + +ParameterObject.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class ParameterObject.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/ParameterObject.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/ParameterObject.html new file mode 100644 index 00000000000..ff2b49f0d9f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/ParameterObject.html @@ -0,0 +1,530 @@ + + + + + +ParameterObject (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class ParameterObject

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getName

          +
          public java.util.Optional<java.lang.String> getName()
          +
          • +
        + + + +
          +
        • +

          getIn

          +
          public java.util.Optional<java.lang.String> getIn()
          +
          • +
        + + + +
          +
        • +

          getExamples

          +
          public java.util.Map<java.lang.String,​ExampleObject> getExamples()
          +
          • +
        + + + +
          +
        • +

          getContent

          +
          public java.util.Map<java.lang.String,​MediaTypeObject> getContent()
          +
          • +
        + + + +
          +
        • +

          isRequired

          +
          public boolean isRequired()
          +
          • +
        + + + +
          +
        • +

          isDeprecated

          +
          public boolean isDeprecated()
          +
          • +
        + + + +
          +
        • +

          isAllowEmptyValue

          +
          public boolean isAllowEmptyValue()
          +
          • +
        + + + +
          +
        • +

          isExplode

          +
          public boolean isExplode()
          +
          • +
        + + + +
          +
        • +

          isAllowReserved

          +
          public boolean isAllowReserved()
          +
          • +
        + + + +
          +
        • +

          getDescription

          +
          public java.util.Optional<java.lang.String> getDescription()
          +
          • +
        + + + +
          +
        • +

          getStyle

          +
          public java.util.Optional<java.lang.String> getStyle()
          +
          • +
        + + + +
          +
        • +

          getSchema

          +
          public java.util.Optional<Schema> getSchema()
          +
          • +
        + + + +
          +
        • +

          getExample

          +
          public java.util.Optional<ExampleObject> getExample()
          +
          • +
        + + + + + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/PathItem.Builder.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/PathItem.Builder.html new file mode 100644 index 00000000000..b293be4889e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/PathItem.Builder.html @@ -0,0 +1,504 @@ + + + + + +PathItem.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class PathItem.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/PathItem.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/PathItem.html new file mode 100644 index 00000000000..7ae8f6a5332 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/PathItem.html @@ -0,0 +1,544 @@ + + + + + +PathItem (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class PathItem

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/Ref.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/Ref.html new file mode 100644 index 00000000000..9e9cf5e30aa --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/Ref.html @@ -0,0 +1,400 @@ + + + + + +Ref (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class Ref<T extends ToNode>

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.openapi.model.Ref<T>
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ToNode
      +
      +
      +
      public abstract class Ref<T extends ToNode>
+extends java.lang.Object
+implements ToNode
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Ref() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
        Modifier and TypeMethodDescription
        abstract Tderef​(ComponentsObject components) +
        Dereferences the value stored in a ref.
        +
        abstract java.util.Optional<java.lang.String>getPointer() +
        Gets the JSON pointer to the component.
        +
        static <T extends ToNode>
        Ref<T>        		local​(T value) +
        Creates a local ref to a value that is inlined.
        +
        static <T extends ToNode>
        Ref<T>        		remote​(java.lang.String pointer) +
        Creates a remote reference using a JSON pointer.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

          Methods inherited from interface software.amazon.smithy.model.node.ToNode

          +toNode
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Ref

          +
          public Ref()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          deref

          +
          public abstract T deref​(ComponentsObject components)
          +
          Dereferences the value stored in a ref.
          +
          +
          Parameters:
          +
          components - Components object to query for pointers.
          +
          Returns:
          +
          Returns the dereferenced value.
          +
          +
          • +
        + + + +
          +
        • +

          getPointer

          +
          public abstract java.util.Optional<java.lang.String> getPointer()
          +
          Gets the JSON pointer to the component. + +

          The return value is empty if this is an inline component.

          +
          +
          Returns:
          +
          Returns the optional pointer.
          +
          +
          • +
        + + + +
          +
        • +

          remote

          +
          public static <T extends ToNode> Ref<T> remote​(java.lang.String pointer)
          +
          Creates a remote reference using a JSON pointer.
          +
          +
          Type Parameters:
          +
          T - Type of value being created.
          +
          Parameters:
          +
          pointer - Pointer to the actual value.
          +
          Returns:
          +
          Returns the created Ref.
          +
          +
          • +
        + + + + + +
          +
        • +

          local

          +
          public static <T extends ToNode> Ref<T> local​(T value)
          +
          Creates a local ref to a value that is inlined.
          +
          +
          Type Parameters:
          +
          T - Type of value that is inlined.
          +
          Parameters:
          +
          value - Inline value.
          +
          Returns:
          +
          Returns the created Ref.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/RequestBodyObject.Builder.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/RequestBodyObject.Builder.html new file mode 100644 index 00000000000..baf7e334d4f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/RequestBodyObject.Builder.html @@ -0,0 +1,352 @@ + + + + + +RequestBodyObject.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class RequestBodyObject.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/RequestBodyObject.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/RequestBodyObject.html new file mode 100644 index 00000000000..82c47c15561 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/RequestBodyObject.html @@ -0,0 +1,390 @@ + + + + + +RequestBodyObject (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class RequestBodyObject

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/ResponseObject.Builder.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/ResponseObject.Builder.html new file mode 100644 index 00000000000..920823c9d57 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/ResponseObject.Builder.html @@ -0,0 +1,414 @@ + + + + + +ResponseObject.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class ResponseObject.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/ResponseObject.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/ResponseObject.html new file mode 100644 index 00000000000..8dd2f9d1c07 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/ResponseObject.html @@ -0,0 +1,427 @@ + + + + + +ResponseObject (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class ResponseObject

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getDescription

          +
          public java.lang.String getDescription()
          +
          • +
        + + + +
          +
        • +

          getHeader

          +
          public java.util.Optional<Ref<ParameterObject>> getHeader​(java.lang.String header)
          +
          Gets a header by case-insensitive header name.
          +
          +
          Parameters:
          +
          header - Header to retrieve.
          +
          Returns:
          +
          Returns the optionally found header.
          +
          +
          • +
        + + + +
          +
        • +

          getHeaders

          +
          public java.util.Map<java.lang.String,​Ref<ParameterObject>> getHeaders()
          +
          • +
        + + + +
          +
        • +

          getContent

          +
          public java.util.Map<java.lang.String,​MediaTypeObject> getContent()
          +
          • +
        + + + +
          +
        • +

          getLinks

          +
          public java.util.Map<java.lang.String,​Ref<LinkObject>> getLinks()
          +
          • +
        + + + + + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/SecurityScheme.Builder.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/SecurityScheme.Builder.html new file mode 100644 index 00000000000..171716143c6 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/SecurityScheme.Builder.html @@ -0,0 +1,446 @@ + + + + + +SecurityScheme.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class SecurityScheme.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/SecurityScheme.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/SecurityScheme.html new file mode 100644 index 00000000000..281681d7b3a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/SecurityScheme.html @@ -0,0 +1,460 @@ + + + + + +SecurityScheme (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class SecurityScheme

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getType

          +
          public java.lang.String getType()
          +
          • +
        + + + +
          +
        • +

          getDescription

          +
          public java.util.Optional<java.lang.String> getDescription()
          +
          • +
        + + + +
          +
        • +

          getName

          +
          public java.util.Optional<java.lang.String> getName()
          +
          • +
        + + + +
          +
        • +

          getIn

          +
          public java.util.Optional<java.lang.String> getIn()
          +
          • +
        + + + +
          +
        • +

          getScheme

          +
          public java.util.Optional<java.lang.String> getScheme()
          +
          • +
        + + + +
          +
        • +

          getBearerFormat

          +
          public java.util.Optional<java.lang.String> getBearerFormat()
          +
          • +
        + + + +
          +
        • +

          getOpenIdConnectUrl

          +
          public java.util.Optional<java.lang.String> getOpenIdConnectUrl()
          +
          • +
        + + + +
          +
        • +

          getFlows

          +
          public java.util.Optional<ObjectNode> getFlows()
          +
          • +
        + + + + + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/ServerObject.Builder.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/ServerObject.Builder.html new file mode 100644 index 00000000000..a5b66b60ab7 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/ServerObject.Builder.html @@ -0,0 +1,376 @@ + + + + + +ServerObject.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class ServerObject.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/ServerObject.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/ServerObject.html new file mode 100644 index 00000000000..cfaac2bfef3 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/ServerObject.html @@ -0,0 +1,404 @@ + + + + + +ServerObject (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class ServerObject

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/TagObject.Builder.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/TagObject.Builder.html new file mode 100644 index 00000000000..0451911687f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/TagObject.Builder.html @@ -0,0 +1,336 @@ + + + + + +TagObject.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class TagObject.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/TagObject.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/TagObject.html new file mode 100644 index 00000000000..108ad709c40 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/TagObject.html @@ -0,0 +1,408 @@ + + + + + +TagObject (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class TagObject

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/XmlObject.Builder.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/XmlObject.Builder.html new file mode 100644 index 00000000000..54cb5ff9f48 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/XmlObject.Builder.html @@ -0,0 +1,364 @@ + + + + + +XmlObject.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class XmlObject.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public XmlObject build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        + + + + + + + +
          +
        • +

          namespace

          +
          public XmlObject.Builder namespace​(java.lang.String namespace)
          +
          • +
        + + + + + + + + + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/XmlObject.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/XmlObject.html new file mode 100644 index 00000000000..90851648e0a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/XmlObject.html @@ -0,0 +1,418 @@ + + + + + +XmlObject (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.model
    +

    Class XmlObject

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getName

          +
          public java.util.Optional<java.lang.String> getName()
          +
          • +
        + + + +
          +
        • +

          getNamespace

          +
          public java.util.Optional<java.lang.String> getNamespace()
          +
          • +
        + + + +
          +
        • +

          getPrefix

          +
          public java.util.Optional<java.lang.String> getPrefix()
          +
          • +
        + + + +
          +
        • +

          isAttribute

          +
          public boolean isAttribute()
          +
          • +
        + + + +
          +
        • +

          isWrapped

          +
          public boolean isWrapped()
          +
          • +
        + + + + + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/package-summary.html new file mode 100644 index 00000000000..3fded4cceef --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/package-summary.html @@ -0,0 +1,318 @@ + + + + + +software.amazon.smithy.openapi.model (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.openapi.model

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/model/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/openapi/model/package-tree.html new file mode 100644 index 00000000000..b3d26d8c54d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/model/package-tree.html @@ -0,0 +1,205 @@ + + + + + +software.amazon.smithy.openapi.model Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.openapi.model

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/openapi/package-summary.html new file mode 100644 index 00000000000..5a3e4705edd --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/package-summary.html @@ -0,0 +1,214 @@ + + + + + +software.amazon.smithy.openapi (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.openapi

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/openapi/package-tree.html new file mode 100644 index 00000000000..c1b48a2a78b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/package-tree.html @@ -0,0 +1,195 @@ + + + + + +software.amazon.smithy.openapi Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.openapi

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    +
      +
    • java.lang.Object +
        +
      • software.amazon.smithy.jsonschema.JsonSchemaConfig + +
        • +
      • software.amazon.smithy.openapi.OpenApiUtils
        • +
      • java.lang.Throwable (implements java.io.Serializable) +
          +
        • java.lang.Exception +
            +
          • java.lang.RuntimeException + +
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    +

    Enum Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/traits/SpecificationExtensionTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/openapi/traits/SpecificationExtensionTrait.Builder.html new file mode 100644 index 00000000000..2b7971ecb38 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/traits/SpecificationExtensionTrait.Builder.html @@ -0,0 +1,318 @@ + + + + + +SpecificationExtensionTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.traits
    +

    Class SpecificationExtensionTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public SpecificationExtensionTrait build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        + + + +
          +
        • +

          as

          +
          public SpecificationExtensionTrait.Builder as​(java.lang.String as)
          +
          Set the explicit name for the target specification extension.
          +
          +
          Parameters:
          +
          as - Explicit name for the target specification extension, or null.
          +
          Returns:
          +
          This builder instance.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/traits/SpecificationExtensionTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/openapi/traits/SpecificationExtensionTrait.Provider.html new file mode 100644 index 00000000000..ced802da890 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/traits/SpecificationExtensionTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +SpecificationExtensionTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.traits
    +

    Class SpecificationExtensionTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/traits/SpecificationExtensionTrait.html b/javadoc/1.47.0/software/amazon/smithy/openapi/traits/SpecificationExtensionTrait.html new file mode 100644 index 00000000000..a0e6e3c3f2e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/traits/SpecificationExtensionTrait.html @@ -0,0 +1,434 @@ + + + + + +SpecificationExtensionTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.openapi.traits
    +

    Class SpecificationExtensionTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getAs

          +
          public java.util.Optional<java.lang.String> getAs()
          +
          Gets the specification extension header value in "as".
          +
          +
          Returns:
          +
          Returns the optionally present "as".
          +
          +
          • +
        + + + + + + + +
          +
        • +

          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.
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/traits/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/openapi/traits/package-summary.html new file mode 100644 index 00000000000..ec6f5127e17 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/traits/package-summary.html @@ -0,0 +1,176 @@ + + + + + +software.amazon.smithy.openapi.traits (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.openapi.traits

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/openapi/traits/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/openapi/traits/package-tree.html new file mode 100644 index 00000000000..f5aa5efb970 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/openapi/traits/package-tree.html @@ -0,0 +1,175 @@ + + + + + +software.amazon.smithy.openapi.traits Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.openapi.traits

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/protocol/traits/Rpcv2CborTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/protocol/traits/Rpcv2CborTrait.Builder.html new file mode 100644 index 00000000000..2169695e8ba --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/protocol/traits/Rpcv2CborTrait.Builder.html @@ -0,0 +1,381 @@ + + + + + +Rpcv2CborTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.protocol.traits
    +

    Class Rpcv2CborTrait.Builder

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Builder() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public Rpcv2CborTrait build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        + + + +
          +
        • +

          http

          +
          public Rpcv2CborTrait.Builder http​(java.util.List<java.lang.String> http)
          +
          Sets the list of supported HTTP protocols.
          +
          +
          Parameters:
          +
          http - HTTP protocols to set and replace.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          eventStreamHttp

          +
          public Rpcv2CborTrait.Builder eventStreamHttp​(java.util.List<java.lang.String> eventStreamHttp)
          +
          Sets the list of supported event stream HTTP protocols.
          +
          +
          Parameters:
          +
          eventStreamHttp - Event stream HTTP protocols to set and replace.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/protocol/traits/Rpcv2CborTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/protocol/traits/Rpcv2CborTrait.Provider.html new file mode 100644 index 00000000000..d7692b792ad --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/protocol/traits/Rpcv2CborTrait.Provider.html @@ -0,0 +1,338 @@ + + + + + +Rpcv2CborTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.protocol.traits
    +

    Class Rpcv2CborTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/protocol/traits/Rpcv2CborTrait.html b/javadoc/1.47.0/software/amazon/smithy/protocol/traits/Rpcv2CborTrait.html new file mode 100644 index 00000000000..93be432f308 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/protocol/traits/Rpcv2CborTrait.html @@ -0,0 +1,484 @@ + + + + + +Rpcv2CborTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.protocol.traits
    +

    Class Rpcv2CborTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          fromNode

          +
          public static Rpcv2CborTrait fromNode​(Node node)
          +
          Updates the builder from a Node.
          +
          +
          Parameters:
          +
          node - Node object that must be a valid ObjectNode.
          +
          Returns:
          +
          Returns the updated builder.
          +
          +
          • +
        + + + +
          +
        • +

          getHttp

          +
          public java.util.List<java.lang.String> getHttp()
          +
          Gets the priority ordered list of supported HTTP protocol versions.
          +
          +
          Returns:
          +
          Returns the supported HTTP protocol versions.
          +
          +
          • +
        + + + +
          +
        • +

          getEventStreamHttp

          +
          public java.util.List<java.lang.String> getEventStreamHttp()
          +
          Gets the priority ordered list of supported HTTP protocol versions that are required when + using event streams.
          +
          +
          Returns:
          +
          Returns the supported event stream HTTP protocol versions.
          +
          +
          • +
        + + + +
          +
        • +

          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.
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/protocol/traits/Rpcv2CborTraitValidator.html b/javadoc/1.47.0/software/amazon/smithy/protocol/traits/Rpcv2CborTraitValidator.html new file mode 100644 index 00000000000..e6e8ddfd1bf --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/protocol/traits/Rpcv2CborTraitValidator.html @@ -0,0 +1,351 @@ + + + + + +Rpcv2CborTraitValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.protocol.traits
    +

    Class Rpcv2CborTraitValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class Rpcv2CborTraitValidator
+extends AbstractValidator
      +
      Validates models implementing the Rpcv2CborTrait against its constraints by: + + - Ensuring that every entry in eventStreamHttp also appears in the http property + of a protocol trait.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Rpcv2CborTraitValidator

          +
          public Rpcv2CborTraitValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/protocol/traits/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/protocol/traits/package-summary.html new file mode 100644 index 00000000000..0639a2652d9 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/protocol/traits/package-summary.html @@ -0,0 +1,190 @@ + + + + + +software.amazon.smithy.protocol.traits (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.protocol.traits

    +
    +
    +
    + + +
    Defines protocols for Smithy.
    +
    +
      +
    • + + + + + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      Rpcv2CborTrait 
      Rpcv2CborTrait.Builder +
      Builder for creating a Rpcv2CborTrait.
      +
      Rpcv2CborTrait.Provider +
      Implements the AbstractTrait.Provider.
      +
      Rpcv2CborTraitValidator +
      Validates models implementing the Rpcv2CborTrait against its constraints by: + + - Ensuring that every entry in eventStreamHttp also appears in the http property + of a protocol trait.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/protocol/traits/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/protocol/traits/package-tree.html new file mode 100644 index 00000000000..7c860503bbe --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/protocol/traits/package-tree.html @@ -0,0 +1,180 @@ + + + + + +software.amazon.smithy.protocol.traits Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.protocol.traits

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/AppliesTo.html b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/AppliesTo.html new file mode 100644 index 00000000000..d79a213bfd4 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/AppliesTo.html @@ -0,0 +1,435 @@ + + + + + +AppliesTo (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.protocoltests.traits
    +

    Enum AppliesTo

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Enum<AppliesTo>
        • +
      • +
          +
        • software.amazon.smithy.protocoltests.traits.AppliesTo
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable, java.lang.Comparable<AppliesTo>, ToNode
      +
      +
      +
      public enum AppliesTo
+extends java.lang.Enum<AppliesTo>
+implements ToNode
      +
      Indicates that a compliance test case is only to be implemented by + "client" or "server" implementations.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        CLIENT 
        SERVER 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static AppliesTofromNode​(Node node) 
        NodetoNode() +
        Converts a value to a Node.
        +
        java.lang.StringtoString() 
        static AppliesTovalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static AppliesTo[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + +
          +
        • +

          CLIENT

          +
          public static final AppliesTo CLIENT
          +
          • +
        + + + +
          +
        • +

          SERVER

          +
          public static final AppliesTo SERVER
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static AppliesTo[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (AppliesTo c : AppliesTo.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static AppliesTo valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Enum<AppliesTo>
          +
          +
          • +
        + + + +
          +
        • +

          fromNode

          +
          public static AppliesTo fromNode​(Node node)
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedRequestDefinition.Builder.html b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedRequestDefinition.Builder.html new file mode 100644 index 00000000000..5c1dd25b418 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedRequestDefinition.Builder.html @@ -0,0 +1,386 @@ + + + + + +HttpMalformedRequestDefinition.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.protocoltests.traits
    +

    Class HttpMalformedRequestDefinition.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.protocoltests.traits.HttpMalformedRequestDefinition.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedRequestDefinition.html b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedRequestDefinition.html new file mode 100644 index 00000000000..81e0b2639a8 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedRequestDefinition.html @@ -0,0 +1,457 @@ + + + + + +HttpMalformedRequestDefinition (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.protocoltests.traits
    +

    Class HttpMalformedRequestDefinition

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.protocoltests.traits.HttpMalformedRequestDefinition
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getBody

          +
          public java.util.Optional<java.lang.String> getBody()
          +
          • +
        + + + +
          +
        • +

          getHeaders

          +
          public java.util.Map<java.lang.String,​java.lang.String> getHeaders()
          +
          • +
        + + + +
          +
        • +

          getHost

          +
          public java.util.Optional<java.lang.String> getHost()
          +
          • +
        + + + +
          +
        • +

          getMethod

          +
          public java.lang.String getMethod()
          +
          • +
        + + + +
          +
        • +

          getQueryParams

          +
          public java.util.List<java.lang.String> getQueryParams()
          +
          • +
        + + + +
          +
        • +

          getUri

          +
          public java.util.Optional<java.lang.String> getUri()
          +
          • +
        + + + +
          +
        • +

          expectUri

          +
          public java.lang.String expectUri()
          +
          • +
        + + + + + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + + + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedRequestTestCase.Builder.html b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedRequestTestCase.Builder.html new file mode 100644 index 00000000000..fa5b2cceaeb --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedRequestTestCase.Builder.html @@ -0,0 +1,370 @@ + + + + + +HttpMalformedRequestTestCase.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.protocoltests.traits
    +

    Class HttpMalformedRequestTestCase.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.protocoltests.traits.HttpMalformedRequestTestCase.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedRequestTestCase.html b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedRequestTestCase.html new file mode 100644 index 00000000000..0107a0043dc --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedRequestTestCase.html @@ -0,0 +1,422 @@ + + + + + +HttpMalformedRequestTestCase (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.protocoltests.traits
    +

    Class HttpMalformedRequestTestCase

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.protocoltests.traits.HttpMalformedRequestTestCase
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedRequestTestsTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedRequestTestsTrait.Provider.html new file mode 100644 index 00000000000..20b52919695 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedRequestTestsTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +HttpMalformedRequestTestsTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.protocoltests.traits
    +

    Class HttpMalformedRequestTestsTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedRequestTestsTrait.html b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedRequestTestsTrait.html new file mode 100644 index 00000000000..53d5719b4b3 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedRequestTestsTrait.html @@ -0,0 +1,434 @@ + + + + + +HttpMalformedRequestTestsTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.protocoltests.traits
    +

    Class HttpMalformedRequestTestsTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpMalformedRequestTestsTrait

          +
          public HttpMalformedRequestTestsTrait​(java.util.List<software.amazon.smithy.protocoltests.traits.ParameterizedHttpMalformedRequestTestCase> testCases)
          +
          • +
        + + + +
          +
        • +

          HttpMalformedRequestTestsTrait

          +
          public HttpMalformedRequestTestsTrait​(SourceLocation sourceLocation,
+                                      java.util.List<software.amazon.smithy.protocoltests.traits.ParameterizedHttpMalformedRequestTestCase> testCases)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          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.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedRequestTestsValidator.html b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedRequestTestsValidator.html new file mode 100644 index 00000000000..f9f5c9564b9 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedRequestTestsValidator.html @@ -0,0 +1,348 @@ + + + + + +HttpMalformedRequestTestsValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.protocoltests.traits
    +

    Class HttpMalformedRequestTestsValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class HttpMalformedRequestTestsValidator
+extends AbstractValidator
      +
      Ensures that parameters attached to @httpMalformedRequestTest cases are well-formed.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpMalformedRequestTestsValidator

          +
          public HttpMalformedRequestTestsValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedResponseBodyDefinition.Builder.html b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedResponseBodyDefinition.Builder.html new file mode 100644 index 00000000000..3165706c5b2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedResponseBodyDefinition.Builder.html @@ -0,0 +1,328 @@ + + + + + +HttpMalformedResponseBodyDefinition.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.protocoltests.traits
    +

    Class HttpMalformedResponseBodyDefinition.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.protocoltests.traits.HttpMalformedResponseBodyDefinition.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedResponseBodyDefinition.html b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedResponseBodyDefinition.html new file mode 100644 index 00000000000..c0a8132c1e1 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedResponseBodyDefinition.html @@ -0,0 +1,401 @@ + + + + + +HttpMalformedResponseBodyDefinition (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.protocoltests.traits
    +

    Class HttpMalformedResponseBodyDefinition

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.protocoltests.traits.HttpMalformedResponseBodyDefinition
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedResponseDefinition.Builder.html b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedResponseDefinition.Builder.html new file mode 100644 index 00000000000..d878e2edd2d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedResponseDefinition.Builder.html @@ -0,0 +1,344 @@ + + + + + +HttpMalformedResponseDefinition.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.protocoltests.traits
    +

    Class HttpMalformedResponseDefinition.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.protocoltests.traits.HttpMalformedResponseDefinition.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedResponseDefinition.html b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedResponseDefinition.html new file mode 100644 index 00000000000..222d8415bbf --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMalformedResponseDefinition.html @@ -0,0 +1,401 @@ + + + + + +HttpMalformedResponseDefinition (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.protocoltests.traits
    +

    Class HttpMalformedResponseDefinition

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.protocoltests.traits.HttpMalformedResponseDefinition
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMessageTestCase.html b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMessageTestCase.html new file mode 100644 index 00000000000..6d1a0732d57 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpMessageTestCase.html @@ -0,0 +1,532 @@ + + + + + +HttpMessageTestCase (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.protocoltests.traits
    +

    Class HttpMessageTestCase

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.protocoltests.traits.HttpMessageTestCase
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getId

          +
          public java.lang.String getId()
          +
          • +
        + + + +
          +
        • +

          getDocumentation

          +
          public java.util.Optional<java.lang.String> getDocumentation()
          +
          • +
        + + + +
          +
        • +

          getProtocol

          +
          public ShapeId getProtocol()
          +
          • +
        + + + +
          +
        • +

          getAuthScheme

          +
          public java.util.Optional<ShapeId> getAuthScheme()
          +
          • +
        + + + +
          +
        • +

          getBody

          +
          public java.util.Optional<java.lang.String> getBody()
          +
          • +
        + + + +
          +
        • +

          getBodyMediaType

          +
          public java.util.Optional<java.lang.String> getBodyMediaType()
          +
          • +
        + + + +
          +
        • +

          getParams

          +
          public ObjectNode getParams()
          +
          • +
        + + + +
          +
        • +

          getVendorParamsShape

          +
          public java.util.Optional<ShapeId> getVendorParamsShape()
          +
          • +
        + + + +
          +
        • +

          getVendorParams

          +
          public ObjectNode getVendorParams()
          +
          • +
        + + + +
          +
        • +

          getHeaders

          +
          public java.util.Map<java.lang.String,​java.lang.String> getHeaders()
          +
          • +
        + + + +
          +
        • +

          getForbidHeaders

          +
          public java.util.List<java.lang.String> getForbidHeaders()
          +
          • +
        + + + +
          +
        • +

          getRequireHeaders

          +
          public java.util.List<java.lang.String> getRequireHeaders()
          +
          • +
        + + + +
          +
        • +

          getTags

          +
          public java.util.List<java.lang.String> getTags()
          +
          Description copied from interface: Tagged
          +
          Gets the tags applied to an object.
          +
          +
          Specified by:
          +
          getTags in interface Tagged
          +
          Returns:
          +
          Returns the tag values.
          +
          +
          • +
        + + + +
          +
        • +

          getAppliesTo

          +
          public java.util.Optional<AppliesTo> getAppliesTo()
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpRequestTestCase.Builder.html b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpRequestTestCase.Builder.html new file mode 100644 index 00000000000..37843eb6a52 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpRequestTestCase.Builder.html @@ -0,0 +1,593 @@ + + + + + +HttpRequestTestCase.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.protocoltests.traits
    +

    Class HttpRequestTestCase.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.protocoltests.traits.HttpRequestTestCase.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + + + + + + + + + + + + + +
          +
        • +

          forbidQueryParams

          +
          public HttpRequestTestCase.Builder forbidQueryParams​(java.util.List<java.lang.String> forbidQueryParams)
          +
          • +
        + + + +
          +
        • +

          requireQueryParams

          +
          public HttpRequestTestCase.Builder requireQueryParams​(java.util.List<java.lang.String> requireQueryParams)
          +
          • +
        + + + +
          +
        • +

          build

          +
          public HttpRequestTestCase build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        + + + +
          +
        • +

          id

          +
          public B id​(java.lang.String id)
          +
          • +
        + + + +
          +
        • +

          documentation

          +
          public B documentation​(java.lang.String documentation)
          +
          • +
        + + + +
          +
        • +

          protocol

          +
          public B protocol​(ShapeId protocol)
          +
          • +
        + + + +
          +
        • +

          authScheme

          +
          public B authScheme​(ShapeId authScheme)
          +
          • +
        + + + +
          +
        • +

          body

          +
          public B body​(java.lang.String body)
          +
          • +
        + + + +
          +
        • +

          bodyMediaType

          +
          public B bodyMediaType​(java.lang.String bodyMediaType)
          +
          • +
        + + + +
          +
        • +

          params

          +
          public B params​(ObjectNode params)
          +
          • +
        + + + +
          +
        • +

          vendorParamsShape

          +
          public B vendorParamsShape​(ShapeId vendorParamsShape)
          +
          • +
        + + + +
          +
        • +

          vendorParams

          +
          public B vendorParams​(ObjectNode vendorParams)
          +
          • +
        + + + +
          +
        • +

          headers

          +
          public B headers​(java.util.Map<java.lang.String,​java.lang.String> headers)
          +
          • +
        + + + +
          +
        • +

          putHeader

          +
          public B putHeader​(java.lang.String key,
+                   java.lang.String value)
          +
          • +
        + + + +
          +
        • +

          forbidHeaders

          +
          public B forbidHeaders​(java.util.List<java.lang.String> forbidHeaders)
          +
          • +
        + + + +
          +
        • +

          requireHeaders

          +
          public B requireHeaders​(java.util.List<java.lang.String> requireHeaders)
          +
          • +
        + + + +
          +
        • +

          tags

          +
          public B tags​(java.util.List<java.lang.String> tags)
          +
          • +
        + + + +
          +
        • +

          appliesTo

          +
          public B appliesTo​(AppliesTo appliesTo)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpRequestTestCase.html b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpRequestTestCase.html new file mode 100644 index 00000000000..cf1d362c406 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpRequestTestCase.html @@ -0,0 +1,478 @@ + + + + + +HttpRequestTestCase (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.protocoltests.traits
    +

    Class HttpRequestTestCase

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getMethod

          +
          public java.lang.String getMethod()
          +
          • +
        + + + +
          +
        • +

          getUri

          +
          public java.lang.String getUri()
          +
          • +
        + + + +
          +
        • +

          getHost

          +
          public java.util.Optional<java.lang.String> getHost()
          +
          • +
        + + + +
          +
        • +

          getResolvedHost

          +
          public java.util.Optional<java.lang.String> getResolvedHost()
          +
          • +
        + + + +
          +
        • +

          getQueryParams

          +
          public java.util.List<java.lang.String> getQueryParams()
          +
          • +
        + + + +
          +
        • +

          getForbidQueryParams

          +
          public java.util.List<java.lang.String> getForbidQueryParams()
          +
          • +
        + + + +
          +
        • +

          getRequireQueryParams

          +
          public java.util.List<java.lang.String> getRequireQueryParams()
          +
          • +
        + + + + + + + + + + + + + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpRequestTestsInputValidator.html b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpRequestTestsInputValidator.html new file mode 100644 index 00000000000..024ca592b1d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpRequestTestsInputValidator.html @@ -0,0 +1,349 @@ + + + + + +HttpRequestTestsInputValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.protocoltests.traits
    +

    Class HttpRequestTestsInputValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class HttpRequestTestsInputValidator
+extends AbstractValidator
      +
      Ensures that input parameters of protocol request test cases are + valid for the attached operation.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpRequestTestsInputValidator

          +
          public HttpRequestTestsInputValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpRequestTestsTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpRequestTestsTrait.Provider.html new file mode 100644 index 00000000000..440da94f507 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpRequestTestsTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +HttpRequestTestsTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.protocoltests.traits
    +

    Class HttpRequestTestsTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpRequestTestsTrait.html b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpRequestTestsTrait.html new file mode 100644 index 00000000000..1477e2e05e0 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpRequestTestsTrait.html @@ -0,0 +1,462 @@ + + + + + +HttpRequestTestsTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.protocoltests.traits
    +

    Class HttpRequestTestsTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getTestCasesFor

          +
          public java.util.List<HttpRequestTestCase> 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. Is 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.
          +
          +
          • +
        + + + +
          +
        • +

          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.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpResponseTestCase.Builder.html b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpResponseTestCase.Builder.html new file mode 100644 index 00000000000..54794c89cd2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpResponseTestCase.Builder.html @@ -0,0 +1,509 @@ + + + + + +HttpResponseTestCase.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.protocoltests.traits
    +

    Class HttpResponseTestCase.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.protocoltests.traits.HttpResponseTestCase.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          build

          +
          public HttpResponseTestCase build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        + + + +
          +
        • +

          id

          +
          public B id​(java.lang.String id)
          +
          • +
        + + + +
          +
        • +

          documentation

          +
          public B documentation​(java.lang.String documentation)
          +
          • +
        + + + +
          +
        • +

          protocol

          +
          public B protocol​(ShapeId protocol)
          +
          • +
        + + + +
          +
        • +

          authScheme

          +
          public B authScheme​(ShapeId authScheme)
          +
          • +
        + + + +
          +
        • +

          body

          +
          public B body​(java.lang.String body)
          +
          • +
        + + + +
          +
        • +

          bodyMediaType

          +
          public B bodyMediaType​(java.lang.String bodyMediaType)
          +
          • +
        + + + +
          +
        • +

          params

          +
          public B params​(ObjectNode params)
          +
          • +
        + + + +
          +
        • +

          vendorParamsShape

          +
          public B vendorParamsShape​(ShapeId vendorParamsShape)
          +
          • +
        + + + +
          +
        • +

          vendorParams

          +
          public B vendorParams​(ObjectNode vendorParams)
          +
          • +
        + + + +
          +
        • +

          headers

          +
          public B headers​(java.util.Map<java.lang.String,​java.lang.String> headers)
          +
          • +
        + + + +
          +
        • +

          putHeader

          +
          public B putHeader​(java.lang.String key,
+                   java.lang.String value)
          +
          • +
        + + + +
          +
        • +

          forbidHeaders

          +
          public B forbidHeaders​(java.util.List<java.lang.String> forbidHeaders)
          +
          • +
        + + + +
          +
        • +

          requireHeaders

          +
          public B requireHeaders​(java.util.List<java.lang.String> requireHeaders)
          +
          • +
        + + + +
          +
        • +

          tags

          +
          public B tags​(java.util.List<java.lang.String> tags)
          +
          • +
        + + + +
          +
        • +

          appliesTo

          +
          public B appliesTo​(AppliesTo appliesTo)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpResponseTestCase.html b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpResponseTestCase.html new file mode 100644 index 00000000000..e206372b46a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpResponseTestCase.html @@ -0,0 +1,380 @@ + + + + + +HttpResponseTestCase (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.protocoltests.traits
    +

    Class HttpResponseTestCase

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpResponseTestsErrorValidator.html b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpResponseTestsErrorValidator.html new file mode 100644 index 00000000000..38fa2a3f336 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpResponseTestsErrorValidator.html @@ -0,0 +1,353 @@ + + + + + +HttpResponseTestsErrorValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.protocoltests.traits
    +

    Class HttpResponseTestsErrorValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class HttpResponseTestsErrorValidator
+extends HttpResponseTestsOutputValidator
      +
      Validates that protocol tests on errors use the correct params.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpResponseTestsErrorValidator

          +
          public HttpResponseTestsErrorValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpResponseTestsOutputValidator.html b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpResponseTestsOutputValidator.html new file mode 100644 index 00000000000..db1a8185fbe --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpResponseTestsOutputValidator.html @@ -0,0 +1,352 @@ + + + + + +HttpResponseTestsOutputValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.protocoltests.traits
    +

    Class HttpResponseTestsOutputValidator

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          HttpResponseTestsOutputValidator

          +
          public HttpResponseTestsOutputValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpResponseTestsTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpResponseTestsTrait.Provider.html new file mode 100644 index 00000000000..4804e1f33cd --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpResponseTestsTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +HttpResponseTestsTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.protocoltests.traits
    +

    Class HttpResponseTestsTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpResponseTestsTrait.html b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpResponseTestsTrait.html new file mode 100644 index 00000000000..44ecb93e35e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/HttpResponseTestsTrait.html @@ -0,0 +1,462 @@ + + + + + +HttpResponseTestsTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.protocoltests.traits
    +

    Class HttpResponseTestsTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getTestCasesFor

          +
          public java.util.List<HttpResponseTestCase> 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. Is 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.
          +
          +
          • +
        + + + +
          +
        • +

          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.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/UniqueProtocolTestCaseIdValidator.html b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/UniqueProtocolTestCaseIdValidator.html new file mode 100644 index 00000000000..7402f336494 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/UniqueProtocolTestCaseIdValidator.html @@ -0,0 +1,350 @@ + + + + + +UniqueProtocolTestCaseIdValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.protocoltests.traits
    +

    Class UniqueProtocolTestCaseIdValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public class UniqueProtocolTestCaseIdValidator
+extends AbstractValidator
      +
      Validates that the "id" property of smithy.test#httpRequestTests, + smithy.test#httpResponseTests, and smithy.test#httpMalformedRequestTests + are unique across all test cases.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          UniqueProtocolTestCaseIdValidator

          +
          public UniqueProtocolTestCaseIdValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/package-summary.html new file mode 100644 index 00000000000..4d3b28063bf --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/package-summary.html @@ -0,0 +1,317 @@ + + + + + +software.amazon.smithy.protocoltests.traits (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.protocoltests.traits

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/package-tree.html new file mode 100644 index 00000000000..652af707c6a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/protocoltests/traits/package-tree.html @@ -0,0 +1,216 @@ + + + + + +software.amazon.smithy.protocoltests.traits Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.protocoltests.traits

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Enum Hierarchy

    +
      +
    • java.lang.Object +
        +
      • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) +
          +
        • software.amazon.smithy.protocoltests.traits.AppliesTo (implements software.amazon.smithy.model.node.ToNode)
          • +
        +
        • +
      +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/analysis/CoverageChecker.CoverageResult.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/analysis/CoverageChecker.CoverageResult.html new file mode 100644 index 00000000000..69d2ed0b10e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/analysis/CoverageChecker.CoverageResult.html @@ -0,0 +1,368 @@ + + + + + +CoverageChecker.CoverageResult (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.analysis
    +

    Class CoverageChecker.CoverageResult

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.analysis.CoverageChecker.CoverageResult
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      CoverageChecker
      +
      +
      +
      public static class CoverageChecker.CoverageResult
+extends java.lang.Object
      +
      A container for a specific condition's coverage result.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        CoverageResult​(Condition condition, + boolean result) +
        Constructs a new coverage result container for the given condition and result.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        ConditiongetCondition() +
        Gets the condition that is covered.
        +
        booleangetResult() +
        Gets if the condition is covered or not.
        +
        java.lang.Stringpretty() +
        Pretty prints this CoverageResult.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          CoverageResult

          +
          public CoverageResult​(Condition condition,
+                      boolean result)
          +
          Constructs a new coverage result container for the given condition and result.
          +
          +
          Parameters:
          +
          condition - the condition being covered.
          +
          result - if the condition is covered by test cases or not.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getCondition

          +
          public Condition getCondition()
          +
          Gets the condition that is covered.
          +
          +
          Returns:
          +
          the condition being covered.
          +
          +
          • +
        + + + +
          +
        • +

          getResult

          +
          public boolean getResult()
          +
          Gets if the condition is covered or not.
          +
          +
          Returns:
          +
          returns true if the condition is covered, false otherwise.
          +
          +
          • +
        + + + +
          +
        • +

          pretty

          +
          public java.lang.String pretty()
          +
          Pretty prints this CoverageResult.
          +
          +
          Returns:
          +
          A pretty representation of the condition and result.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/analysis/CoverageChecker.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/analysis/CoverageChecker.html new file mode 100644 index 00000000000..8a6825342e4 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/analysis/CoverageChecker.html @@ -0,0 +1,379 @@ + + + + + +CoverageChecker (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.analysis
    +

    Class CoverageChecker

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.analysis.CoverageChecker
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class CoverageChecker
+extends java.lang.Object
      +
      Analyzer for determining coverage of a rule-set.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static class CoverageChecker.CoverageResult +
        A container for a specific condition's coverage result.
        +
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.util.stream.Stream<CoverageChecker.CoverageResult>checkCoverage() +
        Analyze coverage for the rule-set, providing results when coverage is found.
        +
        voidevaluateInput​(java.util.Map<Identifier,​Value> input) +
        Evaluates the rule-set with the given inputs to determine rule coverage.
        +
        voidevaluateTestCase​(EndpointTestCase testCase) +
        Evaluate the rule-set using the given test case to determine rule coverage.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          CoverageChecker

          +
          public CoverageChecker​(EndpointRuleSet ruleSet)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          evaluateInput

          +
          public void evaluateInput​(java.util.Map<Identifier,​Value> input)
          +
          Evaluates the rule-set with the given inputs to determine rule coverage.
          +
          +
          Parameters:
          +
          input - the map parameters and inputs to test coverage.
          +
          +
          • +
        + + + +
          +
        • +

          evaluateTestCase

          +
          public void evaluateTestCase​(EndpointTestCase testCase)
          +
          Evaluate the rule-set using the given test case to determine rule coverage.
          +
          +
          Parameters:
          +
          testCase - the test case to evaluate.
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/analysis/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/analysis/package-summary.html new file mode 100644 index 00000000000..614836ca880 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/analysis/package-summary.html @@ -0,0 +1,172 @@ + + + + + +software.amazon.smithy.rulesengine.analysis (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.rulesengine.analysis

    +
    +
    +
      +
    • + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      CoverageChecker +
      Analyzer for determining coverage of a rule-set.
      +
      CoverageChecker.CoverageResult +
      A container for a specific condition's coverage result.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/analysis/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/analysis/package-tree.html new file mode 100644 index 00000000000..e9f2b670ba1 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/analysis/package-tree.html @@ -0,0 +1,162 @@ + + + + + +software.amazon.smithy.rulesengine.analysis Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.rulesengine.analysis

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/AwsArn.Builder.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/AwsArn.Builder.html new file mode 100644 index 00000000000..d2c82d495e7 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/AwsArn.Builder.html @@ -0,0 +1,356 @@ + + + + + +AwsArn.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.language.functions
    +

    Class AwsArn.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.aws.language.functions.AwsArn.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          partition

          +
          public AwsArn.Builder partition​(java.lang.String partition)
          +
          • +
        + + + +
          +
        • +

          service

          +
          public AwsArn.Builder service​(java.lang.String service)
          +
          • +
        + + + +
          +
        • +

          region

          +
          public AwsArn.Builder region​(java.lang.String region)
          +
          • +
        + + + +
          +
        • +

          accountId

          +
          public AwsArn.Builder accountId​(java.lang.String accountId)
          +
          • +
        + + + +
          +
        • +

          resource

          +
          public AwsArn.Builder resource​(java.util.List<java.lang.String> resource)
          +
          • +
        + + + +
          +
        • +

          build

          +
          public AwsArn build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Specified by:
          +
          build in interface SmithyBuilder<AwsArn>
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/AwsArn.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/AwsArn.html new file mode 100644 index 00000000000..cc61a3d9b4e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/AwsArn.html @@ -0,0 +1,510 @@ + + + + + +AwsArn (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.language.functions
    +

    Class AwsArn

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.aws.language.functions.AwsArn
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static class AwsArn.Builder +
        A builder used to create an AwsArn class.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static AwsArn.Builderbuilder() +
        Builder to create an AwsArn instance.
        +
        booleanequals​(java.lang.Object o) 
        java.lang.StringgetAccountId() +
        Gets the ARN's accountId.
        +
        java.lang.StringgetPartition() +
        Gets the ARN's partition.
        +
        java.lang.StringgetRegion() +
        Gets the ARN's region.
        +
        java.util.List<java.lang.String>getResource() +
        Gets the ARN's resource components.
        +
        java.lang.StringgetService() +
        Gets the ARN's service.
        +
        inthashCode() 
        static java.util.Optional<AwsArn>parse​(java.lang.String arn) +
        Parses and returns the ARN components if the provided value is a valid AWS ARN.
        +
        AwsArn.BuildertoBuilder() +
        Take this object and create a builder that contains all of the + current property values of this object.
        +
        java.lang.StringtoString() 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          parse

          +
          public static java.util.Optional<AwsArn> parse​(java.lang.String arn)
          +
          Parses and returns the ARN components if the provided value is a valid AWS ARN.
          +
          +
          Parameters:
          +
          arn - the value to parse.
          +
          Returns:
          +
          the optional ARN.
          +
          +
          • +
        + + + +
          +
        • +

          builder

          +
          public static AwsArn.Builder builder()
          +
          Builder to create an AwsArn instance.
          +
          +
          Returns:
          +
          returns a new Builder.
          +
          +
          • +
        + + + +
          +
        • +

          getPartition

          +
          public java.lang.String getPartition()
          +
          Gets the ARN's partition.
          +
          +
          Returns:
          +
          returns the ARN's partition.
          +
          +
          • +
        + + + +
          +
        • +

          getService

          +
          public java.lang.String getService()
          +
          Gets the ARN's service.
          +
          +
          Returns:
          +
          returns the ARN's service.
          +
          +
          • +
        + + + +
          +
        • +

          getRegion

          +
          public java.lang.String getRegion()
          +
          Gets the ARN's region.
          +
          +
          Returns:
          +
          returns the ARN's region.
          +
          +
          • +
        + + + +
          +
        • +

          getAccountId

          +
          public java.lang.String getAccountId()
          +
          Gets the ARN's accountId.
          +
          +
          Returns:
          +
          returns the ARN's accountId.
          +
          +
          • +
        + + + +
          +
        • +

          getResource

          +
          public java.util.List<java.lang.String> getResource()
          +
          Gets the ARN's resource components.
          +
          +
          Returns:
          +
          returns the ARN's resource components.
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toBuilder

          +
          public AwsArn.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<AwsArn>
          +
          Returns:
          +
          a builder for type T
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/AwsBuiltIns.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/AwsBuiltIns.html new file mode 100644 index 00000000000..69b32058a97 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/AwsBuiltIns.html @@ -0,0 +1,476 @@ + + + + + +AwsBuiltIns (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.language.functions
    +

    Class AwsBuiltIns

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.aws.language.functions.AwsBuiltIns
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class AwsBuiltIns
+extends java.lang.Object
      +
      AWS-specific built-in parameters for EndpointRules.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          DUALSTACK

          +
          public static final Parameter DUALSTACK
          +
          Built-in parameter representing the DualStack parameter for SDKs.
          +
          • +
        + + + +
          +
        • +

          FIPS

          +
          public static final Parameter FIPS
          +
          Built-in parameter representing whether the endpoint must be FIPS-compliant.
          +
          • +
        + + + +
          +
        • +

          REGION

          +
          public static final Parameter REGION
          +
          Built-in parameter representing Region eg. `us-east-1`.
          +
          • +
        + + + +
          +
        • +

          ACCOUNT_ID

          +
          public static final Parameter ACCOUNT_ID
          +
          Built-in parameter representing the AccountId.
          +
          • +
        + + + +
          +
        • +

          ACCOUNT_ID_ENDPOINT_MODE

          +
          public static final Parameter ACCOUNT_ID_ENDPOINT_MODE
          +
          Built-in parameter representing the AccountId Endpoint Mode.
          +
          • +
        + + + +
          +
        • +

          CREDENTIAL_SCOPE

          +
          public static final Parameter CREDENTIAL_SCOPE
          +
          Built-in parameter representing the Credential Scope.
          +
          • +
        + + + +
          +
        • +

          S3_ACCELERATE

          +
          public static final Parameter S3_ACCELERATE
          +
          This MUST only be used by the S3 rules.
          +
          • +
        + + + +
          +
        • +

          S3_DISABLE_MRAP

          +
          public static final Parameter S3_DISABLE_MRAP
          +
          This MUST only be used by the S3 rules.
          +
          • +
        + + + +
          +
        • +

          S3_FORCE_PATH_STYLE

          +
          public static final Parameter S3_FORCE_PATH_STYLE
          +
          This MUST only be used by the S3 rules.
          +
          • +
        + + + +
          +
        • +

          S3_USE_ARN_REGION

          +
          public static final Parameter S3_USE_ARN_REGION
          +
          This MUST only be used by the S3 rules.
          +
          • +
        + + + +
          +
        • +

          S3_USE_GLOBAL_ENDPOINT

          +
          public static final Parameter S3_USE_GLOBAL_ENDPOINT
          +
          This MUST only be used by the S3 rules.
          +
          • +
        + + + +
          +
        • +

          S3_CONTROL_USE_ARN_REGION

          +
          public static final Parameter S3_CONTROL_USE_ARN_REGION
          +
          This MUST only be used by the S3Control rules.
          +
          • +
        + + + +
          +
        • +

          STS_USE_GLOBAL_ENDPOINT

          +
          public static final Parameter STS_USE_GLOBAL_ENDPOINT
          +
          This MUST only be used by the STS rules.
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/AwsPartition.Definition.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/AwsPartition.Definition.html new file mode 100644 index 00000000000..e1c4c60299e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/AwsPartition.Definition.html @@ -0,0 +1,382 @@ + + + + + +AwsPartition.Definition (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.language.functions
    +

    Class AwsPartition.Definition

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.aws.language.functions.AwsPartition.Definition
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/AwsPartition.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/AwsPartition.html new file mode 100644 index 00000000000..fc61d72c2b5 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/AwsPartition.html @@ -0,0 +1,567 @@ + + + + + +AwsPartition (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.language.functions
    +

    Class AwsPartition

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + + + + + +
          +
        • +

          NAME

          +
          public static final Identifier NAME
          +
          • +
        + + + +
          +
        • +

          DNS_SUFFIX

          +
          public static final Identifier DNS_SUFFIX
          +
          • +
        + + + +
          +
        • +

          DUAL_STACK_DNS_SUFFIX

          +
          public static final Identifier DUAL_STACK_DNS_SUFFIX
          +
          • +
        + + + +
          +
        • +

          SUPPORTS_FIPS

          +
          public static final Identifier SUPPORTS_FIPS
          +
          • +
        + + + +
          +
        • +

          SUPPORTS_DUAL_STACK

          +
          public static final Identifier SUPPORTS_DUAL_STACK
          +
          • +
        + + + +
          +
        • +

          IMPLICIT_GLOBAL_REGION

          +
          public static final Identifier IMPLICIT_GLOBAL_REGION
          +
          • +
        + + + +
          +
        • +

          INFERRED

          +
          public static final Identifier INFERRED
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          overridePartitions

          +
          public static void overridePartitions​(Partitions partitions)
          +
          Overrides the partitions provided by default.
          +
          +
          Parameters:
          +
          partitions - A list of partitions to set.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          ofExpressions

          +
          public static AwsPartition ofExpressions​(ToExpression arg1)
          +
          Creates a AwsPartition function from the given expressions.
          +
          +
          Parameters:
          +
          arg1 - the region to retrieve partition information from.
          +
          Returns:
          +
          The resulting AwsPartition function.
          +
          +
          • +
        + + + +
          +
        • +

          accept

          +
          public <T> T accept​(ExpressionVisitor<T> visitor)
          +
          Description copied from class: Expression
          +
          Invoke the ExpressionVisitor functions for this expression.
          +
          +
          Specified by:
          +
          accept in class Expression
          +
          Type Parameters:
          +
          T - the visitor return type.
          +
          Parameters:
          +
          visitor - the visitor to be invoked.
          +
          Returns:
          +
          the return value of the visitor.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/AwsRuleSetExtension.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/AwsRuleSetExtension.html new file mode 100644 index 00000000000..1180f9a63c1 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/AwsRuleSetExtension.html @@ -0,0 +1,368 @@ + + + + + +AwsRuleSetExtension (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.language.functions
    +

    Class AwsRuleSetExtension

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.aws.language.functions.AwsRuleSetExtension
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/EndpointAuthUtils.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/EndpointAuthUtils.html new file mode 100644 index 00000000000..673d1e1f3e0 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/EndpointAuthUtils.html @@ -0,0 +1,309 @@ + + + + + +EndpointAuthUtils (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.language.functions
    +

    Class EndpointAuthUtils

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.aws.language.functions.EndpointAuthUtils
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class EndpointAuthUtils
+extends java.lang.Object
      +
      Utilities for constructing and validating AWS-specific authentication components for rule-sets.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          sigv4

          +
          public static Endpoint.Builder sigv4​(Endpoint.Builder builder,
+                                     Literal signingRegion,
+                                     Literal signingService)
          +
          Adds SigV4 authentication to the provided endpoint builder.
          +
          +
          Parameters:
          +
          builder - the endpoint builder to augment.
          +
          signingRegion - the signing region to use when signing.
          +
          signingService - the name of the service to sign with.
          +
          Returns:
          +
          the updated endpoint builder.
          +
          +
          • +
        + + + +
          +
        • +

          sigv4a

          +
          public static Endpoint.Builder sigv4a​(Endpoint.Builder builder,
+                                      java.util.List<Literal> signingRegionSet,
+                                      Literal signingService)
          +
          Adds SigV4a authentication to the provided endpoint builder.
          +
          +
          Parameters:
          +
          builder - the endpoint builder to augment.
          +
          signingRegionSet - the set of signing regions to use when signing.
          +
          signingService - the name of the service to sign with.
          +
          Returns:
          +
          the updated endpoint builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/IsVirtualHostableS3Bucket.Definition.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/IsVirtualHostableS3Bucket.Definition.html new file mode 100644 index 00000000000..4b18e37e61e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/IsVirtualHostableS3Bucket.Definition.html @@ -0,0 +1,382 @@ + + + + + +IsVirtualHostableS3Bucket.Definition (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.language.functions
    +

    Class IsVirtualHostableS3Bucket.Definition

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.aws.language.functions.IsVirtualHostableS3Bucket.Definition
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/IsVirtualHostableS3Bucket.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/IsVirtualHostableS3Bucket.html new file mode 100644 index 00000000000..450c111c7bf --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/IsVirtualHostableS3Bucket.html @@ -0,0 +1,477 @@ + + + + + +IsVirtualHostableS3Bucket (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.language.functions
    +

    Class IsVirtualHostableS3Bucket

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/ParseArn.Definition.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/ParseArn.Definition.html new file mode 100644 index 00000000000..abcba083ba0 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/ParseArn.Definition.html @@ -0,0 +1,382 @@ + + + + + +ParseArn.Definition (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.language.functions
    +

    Class ParseArn.Definition

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.aws.language.functions.ParseArn.Definition
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/ParseArn.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/ParseArn.html new file mode 100644 index 00000000000..3cff3382065 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/ParseArn.html @@ -0,0 +1,504 @@ + + + + + +ParseArn (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.language.functions
    +

    Class ParseArn

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          ofExpressions

          +
          public static ParseArn ofExpressions​(ToExpression arg1)
          +
          Creates a ParseArn function from the given expressions.
          +
          +
          Parameters:
          +
          arg1 - the ARN to parse.
          +
          Returns:
          +
          The resulting ParseArn function.
          +
          +
          • +
        + + + +
          +
        • +

          accept

          +
          public <T> T accept​(ExpressionVisitor<T> visitor)
          +
          Description copied from class: Expression
          +
          Invoke the ExpressionVisitor functions for this expression.
          +
          +
          Specified by:
          +
          accept in class Expression
          +
          Type Parameters:
          +
          T - the visitor return type.
          +
          Parameters:
          +
          visitor - the visitor to be invoked.
          +
          Returns:
          +
          the return value of the visitor.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/package-summary.html new file mode 100644 index 00000000000..e6085ec772b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/package-summary.html @@ -0,0 +1,226 @@ + + + + + +software.amazon.smithy.rulesengine.aws.language.functions (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.rulesengine.aws.language.functions

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/package-tree.html new file mode 100644 index 00000000000..60adfb0e566 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/package-tree.html @@ -0,0 +1,183 @@ + + + + + +software.amazon.smithy.rulesengine.aws.language.functions Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.rulesengine.aws.language.functions

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    +
      +
    • java.lang.Object + +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/Partition.Builder.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/Partition.Builder.html new file mode 100644 index 00000000000..b08e7b2a797 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/Partition.Builder.html @@ -0,0 +1,407 @@ + + + + + +Partition.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.language.functions.partition
    +

    Class Partition.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/Partition.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/Partition.html new file mode 100644 index 00000000000..d71be855c1c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/Partition.html @@ -0,0 +1,519 @@ + + + + + +Partition (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.language.functions.partition
    +

    Class Partition

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.aws.language.functions.partition.Partition
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          builder

          +
          public static Partition.Builder builder()
          +
          Builder to create a Partition instance.
          +
          +
          Returns:
          +
          returns a new Builder.
          +
          +
          • +
        + + + +
          +
        • +

          fromNode

          +
          public static Partition fromNode​(Node node)
          +
          Creates a Partition instance from the given Node information.
          +
          +
          Parameters:
          +
          node - the node to deserialize.
          +
          Returns:
          +
          the created Partition.
          +
          +
          • +
        + + + +
          +
        • +

          getId

          +
          public java.lang.String getId()
          +
          Gets the ID of the partition.
          +
          +
          Returns:
          +
          returns the partition's ID.
          +
          +
          • +
        + + + +
          +
        • +

          getRegionRegex

          +
          public java.lang.String getRegionRegex()
          +
          Gets the regular expression to match regions in this partition.
          +
          +
          Returns:
          +
          returns the regular expression to match regions in this partition.
          +
          +
          • +
        + + + +
          +
        • +

          getRegions

          +
          public java.util.Map<java.lang.String,​RegionOverride> getRegions()
          +
          Gets this partition's map of region names to region-specific overriding data.
          +
          +
          Returns:
          +
          returns a map of region names to region-specific overriding data.
          +
          +
          • +
        + + + +
          +
        • +

          getOutputs

          +
          public PartitionOutputs getOutputs()
          +
          Gets the supported configuration output for this partition.
          +
          +
          Returns:
          +
          returns the partition's configuration outputs.
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/PartitionOutputs.Builder.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/PartitionOutputs.Builder.html new file mode 100644 index 00000000000..eddaf7880ba --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/PartitionOutputs.Builder.html @@ -0,0 +1,419 @@ + + + + + +PartitionOutputs.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.language.functions.partition
    +

    Class PartitionOutputs.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/PartitionOutputs.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/PartitionOutputs.html new file mode 100644 index 00000000000..9e49cbe71e8 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/PartitionOutputs.html @@ -0,0 +1,563 @@ + + + + + +PartitionOutputs (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.language.functions.partition
    +

    Class PartitionOutputs

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.aws.language.functions.partition.PartitionOutputs
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          fromNode

          +
          public static PartitionOutputs fromNode​(Node node)
          +
          Creates a PartitionOutputs instance from the given Node information.
          +
          +
          Parameters:
          +
          node - the node to deserialize.
          +
          Returns:
          +
          the created PartitionOutputs.
          +
          +
          • +
        + + + +
          +
        • +

          getName

          +
          public java.util.Optional<java.lang.String> getName()
          +
          Gets this partition's name.
          +
          +
          Returns:
          +
          returns the partition's name.
          +
          +
          • +
        + + + +
          +
        • +

          getDnsSuffix

          +
          public java.lang.String getDnsSuffix()
          +
          Gets this partition's default DNS suffix.
          +
          +
          Returns:
          +
          returns the DNS suffix.
          +
          +
          • +
        + + + +
          +
        • +

          getDualStackDnsSuffix

          +
          public java.lang.String getDualStackDnsSuffix()
          +
          Gets this partition's dual stack DNS suffix.
          +
          +
          Returns:
          +
          returns the DNS suffix for dual stack endpoints.
          +
          +
          • +
        + + + +
          +
        • +

          supportsFips

          +
          public boolean supportsFips()
          +
          Returns true if the partition supports FIPS.
          +
          +
          Returns:
          +
          returns true of FIPS is supported.
          +
          +
          • +
        + + + +
          +
        • +

          supportsDualStack

          +
          public boolean supportsDualStack()
          +
          Returns true if the partition supports dual stack.
          +
          +
          Returns:
          +
          returns true of dual stack is supported.
          +
          +
          • +
        + + + +
          +
        • +

          getImplicitGlobalRegion

          +
          public java.lang.String getImplicitGlobalRegion()
          +
          Gets this partition's implicit global region: the region that + non-regionalized (global) services should use for signing.
          +
          +
          Returns:
          +
          returns the partition's implicit global region.
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/Partitions.Builder.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/Partitions.Builder.html new file mode 100644 index 00000000000..0e28aea9ece --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/Partitions.Builder.html @@ -0,0 +1,377 @@ + + + + + +Partitions.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.language.functions.partition
    +

    Class Partitions.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/Partitions.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/Partitions.html new file mode 100644 index 00000000000..55d5b5427df --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/Partitions.html @@ -0,0 +1,495 @@ + + + + + +Partitions (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.language.functions.partition
    +

    Class Partitions

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.aws.language.functions.partition.Partitions
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          builder

          +
          public static Partitions.Builder builder()
          +
          Builder to create a Partitions instance.
          +
          +
          Returns:
          +
          returns a new Builder.
          +
          +
          • +
        + + + +
          +
        • +

          fromNode

          +
          public static Partitions fromNode​(Node node)
          +
          Creates a Partitions instance from the given Node information.
          +
          +
          Parameters:
          +
          node - the node to deserialize.
          +
          Returns:
          +
          the created Partitions.
          +
          +
          • +
        + + + +
          +
        • +

          getVersion

          +
          public java.lang.String getVersion()
          +
          Gets the version of the partitions file.
          +
          +
          Returns:
          +
          returns the version of the partitions file.
          +
          +
          • +
        + + + +
          +
        • +

          getPartitions

          +
          public java.util.List<Partition> getPartitions()
          +
          Gets the list of loaded partitions.
          +
          +
          Returns:
          +
          returns the list of partitions.
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/RegionOverride.Builder.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/RegionOverride.Builder.html new file mode 100644 index 00000000000..2bcc0553a2d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/RegionOverride.Builder.html @@ -0,0 +1,334 @@ + + + + + +RegionOverride.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.language.functions.partition
    +

    Class RegionOverride.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          public RegionOverride build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/RegionOverride.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/RegionOverride.html new file mode 100644 index 00000000000..de54a0ac675 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/RegionOverride.html @@ -0,0 +1,433 @@ + + + + + +RegionOverride (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.language.functions.partition
    +

    Class RegionOverride

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.aws.language.functions.partition.RegionOverride
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          fromNode

          +
          public static RegionOverride fromNode​(Node node)
          +
          Creates a RegionOverride instance from the given Node information.
          +
          +
          Parameters:
          +
          node - the node to deserialize.
          +
          Returns:
          +
          the created RegionOverride.
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object obj)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/package-summary.html new file mode 100644 index 00000000000..63659240047 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/package-summary.html @@ -0,0 +1,206 @@ + + + + + +software.amazon.smithy.rulesengine.aws.language.functions.partition (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.rulesengine.aws.language.functions.partition

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/package-tree.html new file mode 100644 index 00000000000..aa35c649bcb --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/language/functions/partition/package-tree.html @@ -0,0 +1,172 @@ + + + + + +software.amazon.smithy.rulesengine.aws.language.functions.partition Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.rulesengine.aws.language.functions.partition

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/DualStackOnlyEndpointsTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/DualStackOnlyEndpointsTrait.Provider.html new file mode 100644 index 00000000000..c2470d4a467 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/DualStackOnlyEndpointsTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +DualStackOnlyEndpointsTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.traits
    +

    Class DualStackOnlyEndpointsTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/DualStackOnlyEndpointsTrait.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/DualStackOnlyEndpointsTrait.html new file mode 100644 index 00000000000..f8ccf1274f4 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/DualStackOnlyEndpointsTrait.html @@ -0,0 +1,369 @@ + + + + + +DualStackOnlyEndpointsTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.traits
    +

    Class DualStackOnlyEndpointsTrait

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      FromSourceLocation, ToNode, ToShapeId, Trait
      +
      +
      +
      public final class DualStackOnlyEndpointsTrait
+extends AnnotationTrait
      +
      An endpoints modifier trait that indicates a service has only dual stack endpoints, + does not support IPV4 only endpoints, and should not have the useDualStackEndpoint endpoint parameter.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          DualStackOnlyEndpointsTrait

          +
          public DualStackOnlyEndpointsTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          DualStackOnlyEndpointsTrait

          +
          public DualStackOnlyEndpointsTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/EndpointModifierIndex.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/EndpointModifierIndex.html new file mode 100644 index 00000000000..a8879ec7790 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/EndpointModifierIndex.html @@ -0,0 +1,335 @@ + + + + + +EndpointModifierIndex (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.traits
    +

    Class EndpointModifierIndex

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.aws.traits.EndpointModifierIndex
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      KnowledgeIndex
      +
      +
      +
      public final class EndpointModifierIndex
+extends java.lang.Object
+implements KnowledgeIndex
      +
      Locates the endpoint modifier traits applied to services. + + Endpoint modifier traits are traits that are marked by EndpointModifierTrait
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          EndpointModifierIndex

          +
          public EndpointModifierIndex​(Model model)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getEndpointModifierTraits

          +
          public java.util.Map<ShapeId,​Trait> getEndpointModifierTraits​(ToShapeId toShapeId)
          +
          Gets all endpoint modifier traits applied to a service.
          +
          +
          Parameters:
          +
          toShapeId - Service shape to query
          +
          Returns:
          +
          Map of endpoint modifier trait ID to the trait
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/EndpointModifierTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/EndpointModifierTrait.Provider.html new file mode 100644 index 00000000000..45dc400dc57 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/EndpointModifierTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +EndpointModifierTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.traits
    +

    Class EndpointModifierTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/EndpointModifierTrait.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/EndpointModifierTrait.html new file mode 100644 index 00000000000..be94891e6a2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/EndpointModifierTrait.html @@ -0,0 +1,371 @@ + + + + + +EndpointModifierTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.traits
    +

    Class EndpointModifierTrait

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      FromSourceLocation, ToNode, ToShapeId, Trait
      +
      +
      +
      public final class EndpointModifierTrait
+extends AnnotationTrait
      +
      A meta-trait that marks a trait as an endpoint modifier. + + Traits that are marked with this trait are applied to service shapes or operation shapes to + indicate how a client can resolve endpoints for that service or operation.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          EndpointModifierTrait

          +
          public EndpointModifierTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          EndpointModifierTrait

          +
          public EndpointModifierTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/EndpointPatternType.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/EndpointPatternType.html new file mode 100644 index 00000000000..ab4282f0e6d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/EndpointPatternType.html @@ -0,0 +1,418 @@ + + + + + +EndpointPatternType (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.traits
    +

    Enum EndpointPatternType

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Enum<EndpointPatternType>
        • +
      • +
          +
        • software.amazon.smithy.rulesengine.aws.traits.EndpointPatternType
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable, java.lang.Comparable<EndpointPatternType>
      +
      +
      +
      public enum EndpointPatternType
+extends java.lang.Enum<EndpointPatternType>
      +
      The pattern type to use for the partitional services.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        SERVICE_DNSSUFFIX +
        An endpoint with pattern `{service}.{dnsSuffix}`.
        +
        SERVICE_REGION_DNSSUFFIX +
        An endpoint with pattern `{service}.{region}.{dnsSuffix}`.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static EndpointPatternTypefromNode​(Node node) 
        java.lang.StringgetName() +
        Gets the name of a partitional service pattern type.
        +
        static EndpointPatternTypevalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static EndpointPatternType[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + +
          +
        • +

          SERVICE_DNSSUFFIX

          +
          public static final EndpointPatternType SERVICE_DNSSUFFIX
          +
          An endpoint with pattern `{service}.{dnsSuffix}`.
          +
          • +
        + + + +
          +
        • +

          SERVICE_REGION_DNSSUFFIX

          +
          public static final EndpointPatternType SERVICE_REGION_DNSSUFFIX
          +
          An endpoint with pattern `{service}.{region}.{dnsSuffix}`.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static EndpointPatternType[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (EndpointPatternType c : EndpointPatternType.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static EndpointPatternType valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          getName

          +
          public java.lang.String getName()
          +
          Gets the name of a partitional service pattern type.
          +
          +
          Returns:
          +
          Returns a partitional service pattern type name.
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/PartitionEndpointSpecialCase.Builder.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/PartitionEndpointSpecialCase.Builder.html new file mode 100644 index 00000000000..12980f76339 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/PartitionEndpointSpecialCase.Builder.html @@ -0,0 +1,417 @@ + + + + + +PartitionEndpointSpecialCase.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.traits
    +

    Class PartitionEndpointSpecialCase.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.aws.traits.PartitionEndpointSpecialCase.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/PartitionEndpointSpecialCase.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/PartitionEndpointSpecialCase.html new file mode 100644 index 00000000000..23309dd0a21 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/PartitionEndpointSpecialCase.html @@ -0,0 +1,475 @@ + + + + + +PartitionEndpointSpecialCase (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.traits
    +

    Class PartitionEndpointSpecialCase

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.aws.traits.PartitionEndpointSpecialCase
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getEndpoint

          +
          public java.lang.String getEndpoint()
          +
          Gets the endpoint.
          +
          +
          Returns:
          +
          Returns the endpoint
          +
          +
          • +
        + + + +
          +
        • +

          getDualStack

          +
          public java.lang.Boolean getDualStack()
          +
          Gets the dualStack.
          +
          +
          Returns:
          +
          Returns the dualStack
          +
          +
          • +
        + + + +
          +
        • +

          getFips

          +
          public java.lang.Boolean getFips()
          +
          Gets the fips.
          +
          +
          Returns:
          +
          Returns the fips
          +
          +
          • +
        + + + +
          +
        • +

          getRegion

          +
          public java.lang.String getRegion()
          +
          Gets the region.
          +
          +
          Returns:
          +
          Returns the region
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + + + + + + + + + + + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/PartitionSpecialCase.Builder.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/PartitionSpecialCase.Builder.html new file mode 100644 index 00000000000..8718039aac2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/PartitionSpecialCase.Builder.html @@ -0,0 +1,394 @@ + + + + + +PartitionSpecialCase.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.traits
    +

    Class PartitionSpecialCase.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.aws.traits.PartitionSpecialCase.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          endpoint

          +
          public PartitionSpecialCase.Builder endpoint​(java.lang.String endpoint)
          +
          Sets the special case endpoint template.
          +
          +
          Parameters:
          +
          endpoint - Special case endpoint template to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          dualStack

          +
          public PartitionSpecialCase.Builder dualStack​(java.lang.Boolean dualStack)
          +
          Sets the dualstack.
          +
          +
          Parameters:
          +
          dualStack - dualstack to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          fips

          +
          public PartitionSpecialCase.Builder fips​(java.lang.Boolean fips)
          +
          Sets the fips.
          +
          +
          Parameters:
          +
          fips - fips to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/PartitionSpecialCase.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/PartitionSpecialCase.html new file mode 100644 index 00000000000..245b0ae2bef --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/PartitionSpecialCase.html @@ -0,0 +1,453 @@ + + + + + +PartitionSpecialCase (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.traits
    +

    Class PartitionSpecialCase

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.aws.traits.PartitionSpecialCase
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getEndpoint

          +
          public java.lang.String getEndpoint()
          +
          Gets the endpoint.
          +
          +
          Returns:
          +
          Returns the endpoint
          +
          +
          • +
        + + + +
          +
        • +

          getDualStack

          +
          public java.lang.Boolean getDualStack()
          +
          Gets the dualStack.
          +
          +
          Returns:
          +
          Returns the dualStack
          +
          +
          • +
        + + + +
          +
        • +

          getFips

          +
          public java.lang.Boolean getFips()
          +
          Gets the fips.
          +
          +
          Returns:
          +
          Returns the fips
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          fromNode

          +
          public static PartitionSpecialCase fromNode​(Node node)
          +
          Creates a PartitionSpecialCase instance from the given Node information.
          +
          +
          Parameters:
          +
          node - the node to deserialize.
          +
          Returns:
          +
          Returns a PartitionSpecialCase
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/RegionSpecialCase.Builder.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/RegionSpecialCase.Builder.html new file mode 100644 index 00000000000..f5921e1443c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/RegionSpecialCase.Builder.html @@ -0,0 +1,431 @@ + + + + + +RegionSpecialCase.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.traits
    +

    Class RegionSpecialCase.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.aws.traits.RegionSpecialCase.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          endpoint

          +
          public RegionSpecialCase.Builder endpoint​(java.lang.String endpoint)
          +
          Sets the special case endpoint template.
          +
          +
          Parameters:
          +
          endpoint - Special case endpoint template to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          dualStack

          +
          public RegionSpecialCase.Builder dualStack​(java.lang.Boolean dualStack)
          +
          Sets the dualstack.
          +
          +
          Parameters:
          +
          dualStack - dualstack to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          fips

          +
          public RegionSpecialCase.Builder fips​(java.lang.Boolean fips)
          +
          Sets the fips.
          +
          +
          Parameters:
          +
          fips - fips to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          signingRegion

          +
          public RegionSpecialCase.Builder signingRegion​(java.lang.String signingRegion)
          +
          Sets the signing region.
          +
          +
          Parameters:
          +
          signingRegion - region to set.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/RegionSpecialCase.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/RegionSpecialCase.html new file mode 100644 index 00000000000..94e3f1abede --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/RegionSpecialCase.html @@ -0,0 +1,474 @@ + + + + + +RegionSpecialCase (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.traits
    +

    Class RegionSpecialCase

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.aws.traits.RegionSpecialCase
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getEndpoint

          +
          public java.lang.String getEndpoint()
          +
          Gets the endpoint.
          +
          +
          Returns:
          +
          Returns the endpoint
          +
          +
          • +
        + + + +
          +
        • +

          getDualStack

          +
          public java.lang.Boolean getDualStack()
          +
          Gets the dualStack.
          +
          +
          Returns:
          +
          Returns the dualStack
          +
          +
          • +
        + + + +
          +
        • +

          getFips

          +
          public java.lang.Boolean getFips()
          +
          Gets the fips.
          +
          +
          Returns:
          +
          Returns the fips
          +
          +
          • +
        + + + +
          +
        • +

          getSigningRegion

          +
          public java.lang.String getSigningRegion()
          +
          Gets the signing region.
          +
          +
          Returns:
          +
          Returns the signing region
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          fromNode

          +
          public static RegionSpecialCase fromNode​(Node node)
          +
          Creates a RegionSpecialCase instance from the given Node information.
          +
          +
          Parameters:
          +
          node - the node to deserialize.
          +
          Returns:
          +
          Returns a RegionSpecialCase
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/RuleBasedEndpointsTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/RuleBasedEndpointsTrait.Provider.html new file mode 100644 index 00000000000..4d078d31deb --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/RuleBasedEndpointsTrait.Provider.html @@ -0,0 +1,298 @@ + + + + + +RuleBasedEndpointsTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.traits
    +

    Class RuleBasedEndpointsTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/RuleBasedEndpointsTrait.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/RuleBasedEndpointsTrait.html new file mode 100644 index 00000000000..dea49239f0a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/RuleBasedEndpointsTrait.html @@ -0,0 +1,373 @@ + + + + + +RuleBasedEndpointsTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.traits
    +

    Class RuleBasedEndpointsTrait

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      FromSourceLocation, ToNode, ToShapeId, Trait
      +
      +
      +
      public final class RuleBasedEndpointsTrait
+extends AnnotationTrait
      +
      A trait that indicates that a service has handwritten endpoint rules. + + Services marked with this trait have handwritten endpoint rules that + extend or replace their standard generated endpoint rules through an external mechanism. + This trait marks the presence of handwritten rules, which are added to the model by a transformer, + but does not specify their behavior.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          RuleBasedEndpointsTrait

          +
          public RuleBasedEndpointsTrait​(ObjectNode node)
          +
          • +
        + + + +
          +
        • +

          RuleBasedEndpointsTrait

          +
          public RuleBasedEndpointsTrait()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/StandardPartitionalEndpointsTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/StandardPartitionalEndpointsTrait.Builder.html new file mode 100644 index 00000000000..1cbb0fbbc91 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/StandardPartitionalEndpointsTrait.Builder.html @@ -0,0 +1,406 @@ + + + + + +StandardPartitionalEndpointsTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.traits
    +

    Class StandardPartitionalEndpointsTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/StandardPartitionalEndpointsTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/StandardPartitionalEndpointsTrait.Provider.html new file mode 100644 index 00000000000..1c00ba0adcf --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/StandardPartitionalEndpointsTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +StandardPartitionalEndpointsTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.traits
    +

    Class StandardPartitionalEndpointsTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/StandardPartitionalEndpointsTrait.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/StandardPartitionalEndpointsTrait.html new file mode 100644 index 00000000000..b21c9d179a3 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/StandardPartitionalEndpointsTrait.html @@ -0,0 +1,530 @@ + + + + + +StandardPartitionalEndpointsTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.traits
    +

    Class StandardPartitionalEndpointsTrait

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/StandardRegionalEndpointsTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/StandardRegionalEndpointsTrait.Builder.html new file mode 100644 index 00000000000..ab08b57f54d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/StandardRegionalEndpointsTrait.Builder.html @@ -0,0 +1,432 @@ + + + + + +StandardRegionalEndpointsTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.traits
    +

    Class StandardRegionalEndpointsTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Builder

          +
          public Builder()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/StandardRegionalEndpointsTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/StandardRegionalEndpointsTrait.Provider.html new file mode 100644 index 00000000000..20374122074 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/StandardRegionalEndpointsTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +StandardRegionalEndpointsTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.traits
    +

    Class StandardRegionalEndpointsTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/StandardRegionalEndpointsTrait.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/StandardRegionalEndpointsTrait.html new file mode 100644 index 00000000000..1320ccffcc2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/StandardRegionalEndpointsTrait.html @@ -0,0 +1,530 @@ + + + + + +StandardRegionalEndpointsTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.traits
    +

    Class StandardRegionalEndpointsTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        + + + +
          +
        • +

          PARTITION_SPECIAL_CASES

          +
          public static final java.lang.String PARTITION_SPECIAL_CASES
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        + + + +
          +
        • +

          REGION_SPECIAL_CASES

          +
          public static final java.lang.String REGION_SPECIAL_CASES
          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        +
        • +
      +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getPartitionSpecialCases

          +
          public java.util.Map<java.lang.String,​java.util.List<PartitionSpecialCase>> getPartitionSpecialCases()
          +
          Gets the map of partition string to a list of partition special cases defined in the trait.
          +
          +
          Returns:
          +
          Returns a map of partition string to a list of PartitionSpecialCase
          +
          +
          • +
        + + + +
          +
        • +

          getRegionSpecialCases

          +
          public java.util.Map<java.lang.String,​java.util.List<RegionSpecialCase>> getRegionSpecialCases()
          +
          Gets the map of partition string to a list of region special cases defined in the trait.
          +
          +
          Returns:
          +
          Returns a map of region string to a list of RegionSpecialCase
          +
          +
          • +
        + + + +
          +
        • +

          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.
          +
          +
          • +
        + + + + + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/package-summary.html new file mode 100644 index 00000000000..2902e11ca82 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/package-summary.html @@ -0,0 +1,275 @@ + + + + + +software.amazon.smithy.rulesengine.aws.traits (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.rulesengine.aws.traits

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/package-tree.html new file mode 100644 index 00000000000..7631e0849e7 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/traits/package-tree.html @@ -0,0 +1,213 @@ + + + + + +software.amazon.smithy.rulesengine.aws.traits Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.rulesengine.aws.traits

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Enum Hierarchy

    +
      +
    • java.lang.Object +
        +
      • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) + +
        • +
      +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/validators/AwsSpecialCaseEndpointValidator.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/validators/AwsSpecialCaseEndpointValidator.html new file mode 100644 index 00000000000..3e6d4fab2e9 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/validators/AwsSpecialCaseEndpointValidator.html @@ -0,0 +1,348 @@ + + + + + +AwsSpecialCaseEndpointValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.validators
    +

    Class AwsSpecialCaseEndpointValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class AwsSpecialCaseEndpointValidator
+extends AbstractValidator
      +
      Validate special case endpoints from endpoint traits that are applied on a service.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          AwsSpecialCaseEndpointValidator

          +
          public AwsSpecialCaseEndpointValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/validators/RuleSetAwsBuiltInValidator.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/validators/RuleSetAwsBuiltInValidator.html new file mode 100644 index 00000000000..36939c918b8 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/validators/RuleSetAwsBuiltInValidator.html @@ -0,0 +1,348 @@ + + + + + +RuleSetAwsBuiltInValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.aws.validators
    +

    Class RuleSetAwsBuiltInValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public class RuleSetAwsBuiltInValidator
+extends AbstractValidator
      +
      Validator that AWS built-ins used in RuleSet parameters are supported.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          RuleSetAwsBuiltInValidator

          +
          public RuleSetAwsBuiltInValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/validators/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/validators/package-summary.html new file mode 100644 index 00000000000..5d397dfd808 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/validators/package-summary.html @@ -0,0 +1,172 @@ + + + + + +software.amazon.smithy.rulesengine.aws.validators (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.rulesengine.aws.validators

    +
    +
    +
      +
    • + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      AwsSpecialCaseEndpointValidator +
      Validate special case endpoints from endpoint traits that are applied on a service.
      +
      RuleSetAwsBuiltInValidator +
      Validator that AWS built-ins used in RuleSet parameters are supported.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/validators/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/validators/package-tree.html new file mode 100644 index 00000000000..a55718dcd88 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/aws/validators/package-tree.html @@ -0,0 +1,166 @@ + + + + + +software.amazon.smithy.rulesengine.aws.validators Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.rulesengine.aws.validators

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/CoreExtension.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/CoreExtension.html new file mode 100644 index 00000000000..396baf8243a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/CoreExtension.html @@ -0,0 +1,351 @@ + + + + + +CoreExtension (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language
    +

    Class CoreExtension

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.CoreExtension
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/Endpoint.Builder.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/Endpoint.Builder.html new file mode 100644 index 00000000000..d9f1952514d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/Endpoint.Builder.html @@ -0,0 +1,473 @@ + + + + + +Endpoint.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language
    +

    Class Endpoint.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/Endpoint.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/Endpoint.html new file mode 100644 index 00000000000..e7ed7ff15a9 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/Endpoint.html @@ -0,0 +1,542 @@ + + + + + +Endpoint (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language
    +

    Class Endpoint

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.Endpoint
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          builder

          +
          public static Endpoint.Builder builder()
          +
          Create a new EndpointType builder.
          +
          +
          Returns:
          +
          EndpointType builder
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getUrl

          +
          public Expression getUrl()
          +
          Returns the EndpointType URL as an expression.
          +
          +
          Returns:
          +
          the endpoint URL expression.
          +
          +
          • +
        + + + +
          +
        • +

          getHeaders

          +
          public java.util.Map<java.lang.String,​java.util.List<Expression>> getHeaders()
          +
          Get the endpoint headers as a map of String to list of Expression values.
          +
          +
          Returns:
          +
          the endpoint headers.
          +
          +
          • +
        + + + +
          +
        • +

          getProperties

          +
          public java.util.Map<Identifier,​Literal> getProperties()
          +
          Get the endpoint properties as a map of Identifier to Literal values.
          +
          +
          Returns:
          +
          the endpoint properties.
          +
          +
          • +
        + + + +
          +
        • +

          toBuilder

          +
          public Endpoint.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<Endpoint>
          +
          Returns:
          +
          a builder for type T
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          typeCheck

          +
          public Type typeCheck​(Scope<Type> scope)
          +
          Description copied from interface: TypeCheck
          +
          Checks whether the given types within a scope satisfy the constraints.
          +
          +
          Specified by:
          +
          typeCheck in interface TypeCheck
          +
          Parameters:
          +
          scope - the scope to evaluate.
          +
          Returns:
          +
          the type validated by the scope check.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/EndpointComponentFactory.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/EndpointComponentFactory.html new file mode 100644 index 00000000000..955be1f02f4 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/EndpointComponentFactory.html @@ -0,0 +1,353 @@ + + + + + +EndpointComponentFactory (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language
    +

    Interface EndpointComponentFactory

    +
    +
    +
    +
      +
    • +
      +
      public interface EndpointComponentFactory
      +
      Provides access to endpoint components loaded through EndpointRuleSetExtensions.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          hasBuiltIn

          +
          boolean hasBuiltIn​(java.lang.String name)
          +
          Returns true if a built-in of the provided name has been registered.
          +
          +
          Parameters:
          +
          name - the name of the built-in to check for.
          +
          Returns:
          +
          true if the built-in is present, false otherwise.
          +
          +
          • +
        + + + +
          +
        • +

          getKeyString

          +
          java.lang.String getKeyString()
          +
          Gets the built-in names as a joined string.
          +
          +
          Returns:
          +
          a string of the built-in names.
          +
          +
          • +
        + + + +
          +
        • +

          createFunctionFactory

          +
          java.util.function.Function<FunctionNode,​java.util.Optional<LibraryFunction>> createFunctionFactory()
          +
          Creates a LibraryFunction factory function using the loaded function definitions.
          +
          +
          Returns:
          +
          the created factory.
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          createServiceFactory

          +
          static EndpointComponentFactory createServiceFactory​(java.lang.ClassLoader classLoader)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/EndpointRuleSet.Builder.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/EndpointRuleSet.Builder.html new file mode 100644 index 00000000000..f54380227a6 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/EndpointRuleSet.Builder.html @@ -0,0 +1,461 @@ + + + + + +EndpointRuleSet.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language
    +

    Class EndpointRuleSet.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/EndpointRuleSet.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/EndpointRuleSet.html new file mode 100644 index 00000000000..3be3228463d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/EndpointRuleSet.html @@ -0,0 +1,645 @@ + + + + + +EndpointRuleSet (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language
    +

    Class EndpointRuleSet

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.EndpointRuleSet
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          fromNode

          +
          public static EndpointRuleSet fromNode​(Node node)
+                                throws RuleError
          +
          Creates an EndpointRuleSet of a specific type from the given Node information.
          +
          +
          Parameters:
          +
          node - the node to deserialize.
          +
          Returns:
          +
          the created EndpointRuleSet.
          +
          Throws:
          +
          RuleError
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getParameters

          +
          public Parameters getParameters()
          +
          Gets the Parameters defined in this rule-set.
          +
          +
          Returns:
          +
          the parameters defined in the rule-set.
          +
          +
          • +
        + + + +
          +
        • +

          getRules

          +
          public java.util.List<Rule> getRules()
          +
          Gets the list of Rules defined in this rule-set.
          +
          +
          Returns:
          +
          the rules defined in this rule-set.
          +
          +
          • +
        + + + +
          +
        • +

          getVersion

          +
          public java.lang.String getVersion()
          +
          Gets the version of this rule-set.
          +
          +
          Returns:
          +
          the rule-set version.
          +
          +
          • +
        + + + +
          +
        • +

          typeCheck

          +
          public Type typeCheck()
          +
          • +
        + + + +
          +
        • +

          typeCheck

          +
          public Type typeCheck​(Scope<Type> scope)
          +
          Description copied from interface: TypeCheck
          +
          Checks whether the given types within a scope satisfy the constraints.
          +
          +
          Specified by:
          +
          typeCheck in interface TypeCheck
          +
          Parameters:
          +
          scope - the scope to evaluate.
          +
          Returns:
          +
          the type validated by the scope check.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hasBuiltIn

          +
          public static boolean hasBuiltIn​(java.lang.String name)
          +
          Returns true if a built-in of the provided name has been registered.
          +
          +
          Parameters:
          +
          name - the name of the built-in to check for.
          +
          Returns:
          +
          true if the built-in is present, false otherwise.
          +
          +
          • +
        + + + +
          +
        • +

          getKeyString

          +
          public static java.lang.String getKeyString()
          +
          Gets the built-in names as a joined string.
          +
          +
          Returns:
          +
          a string of the built-in names.
          +
          +
          • +
        + + + +
          +
        • +

          createFunctionFactory

          +
          public static java.util.function.Function<FunctionNode,​java.util.Optional<LibraryFunction>> createFunctionFactory()
          +
          Creates a LibraryFunction factory function using the loaded function definitions.
          +
          +
          Returns:
          +
          the created factory.
          +
          +
          • +
        + + + +
          +
        • +

          getAuthSchemeValidators

          +
          public static java.util.List<AuthSchemeValidator> getAuthSchemeValidators()
          +
          Gets loaded authentication scheme validators.
          +
          +
          Returns:
          +
          a list of AuthSchemeValidators.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/EndpointRuleSetExtension.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/EndpointRuleSetExtension.html new file mode 100644 index 00000000000..c73eb5c89cf --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/EndpointRuleSetExtension.html @@ -0,0 +1,302 @@ + + + + + +EndpointRuleSetExtension (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language
    +

    Interface EndpointRuleSetExtension

    +
    +
    +
    +
      +
    • +
      +
      All Known Implementing Classes:
      +
      AwsRuleSetExtension, CoreExtension
      +
      +
      +
      public interface EndpointRuleSetExtension
      +
      An interface to provide components to endpoints rule-sets.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getBuiltIns

          +
          default java.util.List<Parameter> getBuiltIns()
          +
          Provides built-in parameters to the rules engine.
          +
          +
          Returns:
          +
          A list of built-in parameters this extension provides.
          +
          +
          • +
        + + + +
          +
        • +

          getLibraryFunctions

          +
          default java.util.List<FunctionDefinition> getLibraryFunctions()
          +
          Provides library functions to the rules engine.
          +
          +
          Returns:
          +
          A list of library functions this extension provides.
          +
          +
          • +
        + + + +
          +
        • +

          getAuthSchemeValidators

          +
          default java.util.List<AuthSchemeValidator> getAuthSchemeValidators()
          +
          Provides authentication scheme validators to the rules engine.
          +
          +
          Returns:
          +
          A list of authentication scheme validators this extension provides.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/RulesComponentBuilder.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/RulesComponentBuilder.html new file mode 100644 index 00000000000..f5e7443ee38 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/RulesComponentBuilder.html @@ -0,0 +1,392 @@ + + + + + +RulesComponentBuilder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language
    +

    Class RulesComponentBuilder<B extends RulesComponentBuilder<?,​?>,​T>

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.RulesComponentBuilder<B,​T>
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          RulesComponentBuilder

          +
          public RulesComponentBuilder​(FromSourceLocation fromSourceLocation)
          +
          Creates a builder with the given source location.
          +
          +
          Parameters:
          +
          fromSourceLocation - the source location for the builder.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          sourceLocation

          +
          public B sourceLocation​(FromSourceLocation fromSourceLocation)
          +
          Sets the source location for the builder.
          +
          +
          Parameters:
          +
          fromSourceLocation - the source location to set.
          +
          Returns:
          +
          the updated builder.
          +
          +
          • +
        + + + +
          +
        • +

          javaLocation

          +
          public static SourceLocation javaLocation()
          +
          Returns the source code location of the caller. This is very helpful when determining where rules generated + from Java-based builders originated. + +

          Library-local and JDK stack frames are discarded. If no relevant location can be found, + `SourceLocation.none()` is returned.

          +
          +
          Returns:
          +
          The SourceLocation.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/TraversingVisitor.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/TraversingVisitor.html new file mode 100644 index 00000000000..dc307016d39 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/TraversingVisitor.html @@ -0,0 +1,494 @@ + + + + + +TraversingVisitor (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language
    +

    Class TraversingVisitor<R>

    +
    +
    + +
    +
      +
    • +
      +
      Type Parameters:
      +
      R - the return type.
      +
      +
      +
      All Implemented Interfaces:
      +
      ExpressionVisitor<java.util.stream.Stream<R>>, RuleValueVisitor<java.util.stream.Stream<R>>
      +
      +
      +
      public class TraversingVisitor<R>
+extends ExpressionVisitor.Default<java.util.stream.Stream<R>>
+implements RuleValueVisitor<java.util.stream.Stream<R>>
      +
      A visitor for traversing the rules and conditions of a rule-set.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          TraversingVisitor

          +
          public TraversingVisitor()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          visitRuleset

          +
          public java.util.stream.Stream<R> visitRuleset​(EndpointRuleSet ruleset)
          +
          Given an EndpointRuleSet will invoke the visitor methods for each rule.
          +
          +
          Parameters:
          +
          ruleset - the endpoint rule-set to traverse.
          +
          Returns:
          +
          a stream of values.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          visitTreeRule

          +
          public java.util.stream.Stream<R> visitTreeRule​(java.util.List<Rule> rules)
          +
          Description copied from interface: RuleValueVisitor
          +
          Invoked when reaching a tree rule.
          +
          +
          Specified by:
          +
          visitTreeRule in interface RuleValueVisitor<R>
          +
          Parameters:
          +
          rules - the sub-rules within a tree rule.
          +
          Returns:
          +
          the visitor return type.
          +
          +
          • +
        + + + +
          +
        • +

          visitErrorRule

          +
          public java.util.stream.Stream<R> visitErrorRule​(Expression error)
          +
          Description copied from interface: RuleValueVisitor
          +
          Invoked when reaching an error rule.
          +
          +
          Specified by:
          +
          visitErrorRule in interface RuleValueVisitor<R>
          +
          Parameters:
          +
          error - the error expression for the rule.
          +
          Returns:
          +
          the visitor return type.
          +
          +
          • +
        + + + +
          +
        • +

          visitEndpointRule

          +
          public java.util.stream.Stream<R> visitEndpointRule​(Endpoint endpoint)
          +
          Description copied from interface: RuleValueVisitor
          +
          Invoked when reaching an endpoint rule.
          +
          +
          Specified by:
          +
          visitEndpointRule in interface RuleValueVisitor<R>
          +
          Parameters:
          +
          endpoint - the endpoint of the rule.
          +
          Returns:
          +
          the visitor return type.
          +
          +
          • +
        + + + +
          +
        • +

          visitEndpoint

          +
          public java.util.stream.Stream<R> visitEndpoint​(Endpoint endpoint)
          +
          Endpoint visitor method.
          +
          +
          Parameters:
          +
          endpoint - the endpoint to visit.
          +
          Returns:
          +
          a stream of values.
          +
          +
          • +
        + + + +
          +
        • +

          visitConditions

          +
          public java.util.stream.Stream<R> visitConditions​(java.util.List<Condition> conditions)
          +
          Endpoint visitor method.
          +
          +
          Parameters:
          +
          conditions - the conditions to visit.
          +
          Returns:
          +
          a stream of values.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/error/InnerParseError.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/error/InnerParseError.html new file mode 100644 index 00000000000..8001b74c9de --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/error/InnerParseError.html @@ -0,0 +1,297 @@ + + + + + +InnerParseError (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.error
    +

    Class InnerParseError

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Throwable
        • +
      • +
          +
        • java.lang.Exception
          • +
        • +
            +
          • java.lang.RuntimeException
            • +
          • +
              +
            • software.amazon.smithy.rulesengine.language.error.InnerParseError
              • +
            +
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      public final class InnerParseError
+extends java.lang.RuntimeException
      +
      Represents an error encountered when parsing a rule-set expression.
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        InnerParseError​(java.lang.String message) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          InnerParseError

          +
          public InnerParseError​(java.lang.String message)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/error/InvalidRulesException.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/error/InvalidRulesException.html new file mode 100644 index 00000000000..a3066c26b29 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/error/InvalidRulesException.html @@ -0,0 +1,356 @@ + + + + + +InvalidRulesException (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.error
    +

    Class InvalidRulesException

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Throwable
        • +
      • +
          +
        • java.lang.Exception
          • +
        • +
            +
          • java.lang.RuntimeException
            • +
          • +
              +
            • software.amazon.smithy.rulesengine.language.error.InvalidRulesException
              • +
            +
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable, FromSourceLocation
      +
      +
      +
      public final class InvalidRulesException
+extends java.lang.RuntimeException
+implements FromSourceLocation
      +
      Exception thrown when a rule-set is invalid.
      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        InvalidRulesException​(java.lang.String message, + FromSourceLocation location) +
        Constructs a new invalid rule exception with the given message and source location.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        SourceLocationgetSourceLocation() +
        Gets the source location of a value.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          InvalidRulesException

          +
          public InvalidRulesException​(java.lang.String message,
+                             FromSourceLocation location)
          +
          Constructs a new invalid rule exception with the given message and source location.
          +
          +
          Parameters:
          +
          message - the detail message.
          +
          location - the location of the invalid rule.
          +
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/error/RuleError.Evaluator.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/error/RuleError.Evaluator.html new file mode 100644 index 00000000000..723b293af51 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/error/RuleError.Evaluator.html @@ -0,0 +1,262 @@ + + + + + +RuleError.Evaluator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.error
    +

    Interface RuleError.Evaluator<T>

    +
    +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      RuleError
      +
      +
      +
      Functional Interface:
      +
      This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
      +
      +
      +
      @FunctionalInterface
+public static interface RuleError.Evaluator<T>
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/error/RuleError.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/error/RuleError.html new file mode 100644 index 00000000000..1e754416687 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/error/RuleError.html @@ -0,0 +1,514 @@ + + + + + +RuleError (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.error
    +

    Class RuleError

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Throwable
        • +
      • +
          +
        • java.lang.Exception
          • +
        • +
            +
          • java.lang.RuntimeException
            • +
          • +
              +
            • software.amazon.smithy.rulesengine.language.error.RuleError
              • +
            +
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable
      +
      +
      +
      public final class RuleError
+extends java.lang.RuntimeException
      +
      An exception that can be thrown when a rule-set is invalid. + +

      Used for providing meaningful contextual information when + an invalid rule-set is encountered.

      +
      +
      See Also:
      +
      Serialized Form
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static interface RuleError.Evaluator<T> 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        RuleError​(SourceException root) +
        Constructs a new RuleError from the source exception.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static voidcontext​(java.lang.String message, + java.lang.Runnable runnable) +
        Evaluates the runnable and creates a RuleError with the provided context if there's an error.
        +
        static voidcontext​(java.lang.String message, + FromSourceLocation sourceLocation, + java.lang.Runnable runnable) +
        Evaluates the runnable and creates a RuleError with the provided context if there's an error.
        +
        static <T> Tcontext​(java.lang.String message, + FromSourceLocation sourceLocation, + RuleError.Evaluator<T> runnable) +
        Evaluates the runnable and creates a RuleError with the provided context if there's an error.
        +
        static <T> Tcontext​(java.lang.String message, + RuleError.Evaluator<T> runnable) +
        Evaluates the runnable and creates a RuleError with the provided context if there's an error.
        +
        java.lang.StringtoString() 
        RuleErrorwithContext​(java.lang.String context, + SourceLocation location) +
        Sets a piece of context on this error.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Throwable

          +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          RuleError

          +
          public RuleError​(SourceException root)
          +
          Constructs a new RuleError from the source exception.
          +
          +
          Parameters:
          +
          root - the exception this rule error is based on.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          context

          +
          public static void context​(java.lang.String message,
+                           java.lang.Runnable runnable)
          +
          Evaluates the runnable and creates a RuleError with the provided context if there's an error.
          +
          +
          Parameters:
          +
          message - a message representing the context for this runnable statement's evaluation.
          +
          runnable - a runnable to evaluate a statement in the current context.
          +
          +
          • +
        + + + +
          +
        • +

          context

          +
          public static <T> T context​(java.lang.String message,
+                            RuleError.Evaluator<T> runnable)
+                     throws RuleError
          +
          Evaluates the runnable and creates a RuleError with the provided context if there's an error.
          +
          +
          Type Parameters:
          +
          T - the type of the value returned by the runnable.
          +
          Parameters:
          +
          message - a message representing the context for this runnable statement's evaluation.
          +
          runnable - a runnable to evaluate a statement in the current context.
          +
          Returns:
          +
          the value returned by the runnable.
          +
          Throws:
          +
          RuleError - when the rule being evaluated in the context fails.
          +
          +
          • +
        + + + +
          +
        • +

          context

          +
          public static void context​(java.lang.String message,
+                           FromSourceLocation sourceLocation,
+                           java.lang.Runnable runnable)
          +
          Evaluates the runnable and creates a RuleError with the provided context if there's an error.
          +
          +
          Parameters:
          +
          message - a message representing the context for this runnable statement's evaluation.
          +
          sourceLocation - the source location for this runnable statement's evaluation.
          +
          runnable - a runnable to evaluate a statement in the current context.
          +
          +
          • +
        + + + +
          +
        • +

          context

          +
          public static <T> T context​(java.lang.String message,
+                            FromSourceLocation sourceLocation,
+                            RuleError.Evaluator<T> runnable)
+                     throws RuleError
          +
          Evaluates the runnable and creates a RuleError with the provided context if there's an error.
          +
          +
          Type Parameters:
          +
          T - the type of the value returned by the runnable.
          +
          Parameters:
          +
          message - a message representing the context for this runnable statement's evaluation.
          +
          sourceLocation - the source location for this runnable statement's evaluation.
          +
          runnable - a runnable to evaluate a statement in the current context.
          +
          Returns:
          +
          the value returned by the runnable.
          +
          Throws:
          +
          RuleError - when the rule being evaluated in the context fails.
          +
          +
          • +
        + + + +
          +
        • +

          withContext

          +
          public RuleError withContext​(java.lang.String context,
+                             SourceLocation location)
          +
          Sets a piece of context on this error.
          +
          +
          Parameters:
          +
          context - the context to add to the error.
          +
          location - the source location of the context being added.
          +
          Returns:
          +
          returns this error with the added context.
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Throwable
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/error/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/error/package-summary.html new file mode 100644 index 00000000000..8e7b874b28a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/error/package-summary.html @@ -0,0 +1,193 @@ + + + + + +software.amazon.smithy.rulesengine.language.error (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.rulesengine.language.error

    +
    +
    +
      +
    • + + + + + + + + + + + + +
      Interface Summary 
      InterfaceDescription
      RuleError.Evaluator<T> 
      +
      • +
    • + + + + + + + + + + + + + + + + + + + + +
      Exception Summary 
      ExceptionDescription
      InnerParseError +
      Represents an error encountered when parsing a rule-set expression.
      +
      InvalidRulesException +
      Exception thrown when a rule-set is invalid.
      +
      RuleError +
      An exception that can be thrown when a rule-set is invalid.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/error/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/error/package-tree.html new file mode 100644 index 00000000000..e68bbb2e901 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/error/package-tree.html @@ -0,0 +1,181 @@ + + + + + +software.amazon.smithy.rulesengine.language.error Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.rulesengine.language.error

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    +
      +
    • java.lang.Object +
        +
      • java.lang.Throwable (implements java.io.Serializable) +
          +
        • java.lang.Exception + +
          • +
        +
        • +
      +
      • +
    +
    +
    +

    Interface Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/RuleEvaluator.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/RuleEvaluator.html new file mode 100644 index 00000000000..2406dfdfa20 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/RuleEvaluator.html @@ -0,0 +1,609 @@ + + + + + +RuleEvaluator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.evaluation
    +

    Class RuleEvaluator

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.evaluation.RuleEvaluator
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          RuleEvaluator

          +
          public RuleEvaluator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          evaluate

          +
          public static Value evaluate​(EndpointRuleSet ruleset,
+                             java.util.Map<Identifier,​Value> parameterArguments)
          +
          Initializes a new RuleEvaluator instances, and evaluates + the provided ruleset and parameter arguments.
          +
          +
          Parameters:
          +
          ruleset - The endpoint ruleset.
          +
          parameterArguments - The rule-set parameter identifiers and + values to evaluate the rule-set against.
          +
          Returns:
          +
          The resulting value from the final matched rule.
          +
          +
          • +
        + + + +
          +
        • +

          evaluateRuleSet

          +
          public Value evaluateRuleSet​(EndpointRuleSet ruleset,
+                             java.util.Map<Identifier,​Value> parameterArguments)
          +
          Evaluate the provided ruleset and parameter arguments.
          +
          +
          Parameters:
          +
          ruleset - The endpoint ruleset.
          +
          parameterArguments - The rule-set parameter identifiers and + values to evaluate the rule-set against.
          +
          Returns:
          +
          The resulting value from the final matched rule.
          +
          +
          • +
        + + + +
          +
        • +

          evaluateCondition

          +
          public Value evaluateCondition​(Condition condition)
          +
          Evaluates the given condition in the current scope.
          +
          +
          Parameters:
          +
          condition - the condition to evaluate.
          +
          Returns:
          +
          the value returned by the condition.
          +
          +
          • +
        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          +
        • +

          visitGetAttr

          +
          public Value visitGetAttr​(GetAttr getAttr)
          +
          Description copied from interface: ExpressionVisitor
          +
          Visits a GetAttr function.
          +
          +
          Specified by:
          +
          visitGetAttr in interface ExpressionVisitor<Value>
          +
          Parameters:
          +
          getAttr - the GetAttr function to visit.
          +
          Returns:
          +
          the value from the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          visitLibraryFunction

          +
          public Value visitLibraryFunction​(FunctionDefinition definition,
+                                  java.util.List<Expression> arguments)
          +
          Description copied from interface: ExpressionVisitor
          +
          Visits a library function.
          +
          +
          Specified by:
          +
          visitLibraryFunction in interface ExpressionVisitor<Value>
          +
          Parameters:
          +
          definition - the library function to visit.
          +
          arguments - the arguments to the function being visited.
          +
          Returns:
          +
          the value from the visitor.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/Scope.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/Scope.html new file mode 100644 index 00000000000..88ec64cb76f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/Scope.html @@ -0,0 +1,568 @@ + + + + + +Scope (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.evaluation
    +

    Class Scope<T>

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.evaluation.Scope<T>
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Type Parameters:
      +
      T - The type of values in scope.
      +
      +
      +
      public final class Scope<T>
+extends java.lang.Object
      +
      Scope is a stack for tracking facts for named values of the given type.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Scope() +
        Crates a new, empty scope with a single layer.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        TexpectValue​(Identifier name) +
        Gets the first value in scope for the specified identifier, throwing + InnerParseError if the identifier is undefined in all the scope.
        +
        static Scope<Value>fromNode​(Node node) +
        Creates a Scope instance from the given Node information.
        +
        java.util.Optional<java.util.Map.Entry<Identifier,​T>>getDeclaration​(Identifier name) +
        Gets the first declaration in scope for the specified identifier.
        +
        java.util.Optional<T>getValue​(Identifier name) +
        Gets the first value in scope for the specified identifier.
        +
        <U> UinScope​(java.util.function.Supplier<U> supplier) +
        Assesses a value supplier in the current scope.
        +
        voidinsert​(java.lang.String name, + T value) +
        Inserts a named value into the current scope.
        +
        voidinsert​(Identifier name, + T value) +
        Inserts a named value into the current scope.
        +
        booleanisNonNull​(Reference reference) +
        Gets if a reference is non-null in the current scope.
        +
        voidpop() +
        Pops the most recent ScopeLayer out of the current scope.
        +
        voidpush() +
        Pushes an empty ScopeLayer into the current scope.
        +
        voidsetNonNull​(Reference name) +
        Inserts a non-null reference into the current scope.
        +
        java.lang.StringtoString() 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Scope

          +
          public Scope()
          +
          Crates a new, empty scope with a single layer.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          fromNode

          +
          public static Scope<Value> fromNode​(Node node)
          +
          Creates a Scope instance from the given Node information.
          +
          +
          Parameters:
          +
          node - the node to deserialize.
          +
          Returns:
          +
          the created Scope.
          +
          +
          • +
        + + + +
          +
        • +

          inScope

          +
          public <U> U inScope​(java.util.function.Supplier<U> supplier)
          +
          Assesses a value supplier in the current scope.
          +
          +
          Type Parameters:
          +
          U - the type of the value returned by the supplier.
          +
          Parameters:
          +
          supplier - the value supplier to assess.
          +
          Returns:
          +
          the value returned by the supplier.
          +
          +
          • +
        + + + +
          +
        • +

          push

          +
          public void push()
          +
          Pushes an empty ScopeLayer into the current scope.
          +
          • +
        + + + +
          +
        • +

          pop

          +
          public void pop()
          +
          Pops the most recent ScopeLayer out of the current scope.
          +
          • +
        + + + + + +
          +
        • +

          insert

          +
          public void insert​(java.lang.String name,
+                   T value)
          +
          Inserts a named value into the current scope.
          +
          +
          Parameters:
          +
          name - the name of the value to insert.
          +
          value - the value to insert.
          +
          +
          • +
        + + + + + +
          +
        • +

          insert

          +
          public void insert​(Identifier name,
+                   T value)
          +
          Inserts a named value into the current scope.
          +
          +
          Parameters:
          +
          name - the name of the value to insert.
          +
          value - the value to insert.
          +
          +
          • +
        + + + +
          +
        • +

          setNonNull

          +
          public void setNonNull​(Reference name)
          +
          Inserts a non-null reference into the current scope.
          +
          +
          Parameters:
          +
          name - the name of the reference to insert.
          +
          +
          • +
        + + + +
          +
        • +

          isNonNull

          +
          public boolean isNonNull​(Reference reference)
          +
          Gets if a reference is non-null in the current scope.
          +
          +
          Parameters:
          +
          reference - the reference to check nullability for.
          +
          Returns:
          +
          true if the reference is non-null, false otherwise.
          +
          +
          • +
        + + + +
          +
        • +

          getDeclaration

          +
          public java.util.Optional<java.util.Map.Entry<Identifier,​T>> getDeclaration​(Identifier name)
          +
          Gets the first declaration in scope for the specified identifier.
          +
          +
          Parameters:
          +
          name - the identifier to retrieve a declaration for.
          +
          Returns:
          +
          an optional of the declaration for the identifier, or empty otherwise.
          +
          +
          • +
        + + + +
          +
        • +

          expectValue

          +
          public T expectValue​(Identifier name)
+              throws InnerParseError
          +
          Gets the first value in scope for the specified identifier, throwing + InnerParseError if the identifier is undefined in all the scope.
          +
          +
          Parameters:
          +
          name - the identifier to retrieve a declaration for.
          +
          Returns:
          +
          the value for the identifier.
          +
          Throws:
          +
          InnerParseError - when the identifier has no value in the scope.
          +
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public java.util.Optional<T> getValue​(Identifier name)
          +
          Gets the first value in scope for the specified identifier.
          +
          +
          Parameters:
          +
          name - the identifier to retrieve a value for.
          +
          Returns:
          +
          an optional of the value for the identifier, or empty otherwise.
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/TestEvaluator.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/TestEvaluator.html new file mode 100644 index 00000000000..a4635dc06bf --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/TestEvaluator.html @@ -0,0 +1,276 @@ + + + + + +TestEvaluator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.evaluation
    +

    Class TestEvaluator

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.evaluation.TestEvaluator
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class TestEvaluator
+extends java.lang.Object
      +
      Provides facilities for evaluating an endpoint rule-set and tests.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static voidevaluate​(EndpointRuleSet ruleset, + EndpointTestCase testCase) +
        Evaluate the given rule-set and test case.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + +
          +
        • +

          evaluate

          +
          public static void evaluate​(EndpointRuleSet ruleset,
+                            EndpointTestCase testCase)
          +
          Evaluate the given rule-set and test case. Throws an exception in the event + the test case does not pass.
          +
          +
          Parameters:
          +
          ruleset - The rule-set to be tested.
          +
          testCase - The test case.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/TypeCheck.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/TypeCheck.html new file mode 100644 index 00000000000..58aff6cd301 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/TypeCheck.html @@ -0,0 +1,267 @@ + + + + + +TypeCheck (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.evaluation
    +

    Interface TypeCheck

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          typeCheck

          +
          Type typeCheck​(Scope<Type> scope)
          +
          Checks whether the given types within a scope satisfy the constraints.
          +
          +
          Parameters:
          +
          scope - the scope to evaluate.
          +
          Returns:
          +
          the type validated by the scope check.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/package-summary.html new file mode 100644 index 00000000000..ee3212bb269 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/package-summary.html @@ -0,0 +1,196 @@ + + + + + +software.amazon.smithy.rulesengine.language.evaluation (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.rulesengine.language.evaluation

    +
    +
    +
      +
    • + + + + + + + + + + + + +
      Interface Summary 
      InterfaceDescription
      TypeCheck +
      TypeCheck provides an interface for determining whether the given types within scope + satisfy the associated constraints.
      +
      +
      • +
    • + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      RuleEvaluator +
      A runtime implementation of a rule-set evaluation engine.
      +
      Scope<T> +
      Scope is a stack for tracking facts for named values of the given type.
      +
      TestEvaluator +
      Provides facilities for evaluating an endpoint rule-set and tests.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/package-tree.html new file mode 100644 index 00000000000..7f0ba0b83c0 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/package-tree.html @@ -0,0 +1,169 @@ + + + + + +software.amazon.smithy.rulesengine.language.evaluation Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.rulesengine.language.evaluation

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    +
      +
    • java.lang.Object +
        +
      • software.amazon.smithy.rulesengine.language.evaluation.RuleEvaluator (implements software.amazon.smithy.rulesengine.language.syntax.expressions.ExpressionVisitor<R>)
        • +
      • software.amazon.smithy.rulesengine.language.evaluation.Scope<T>
        • +
      • software.amazon.smithy.rulesengine.language.evaluation.TestEvaluator
        • +
      +
      • +
    +
    +
    +

    Interface Hierarchy

    +
      +
    • software.amazon.smithy.rulesengine.language.evaluation.TypeCheck
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/AnyType.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/AnyType.html new file mode 100644 index 00000000000..09ba20b7acd --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/AnyType.html @@ -0,0 +1,355 @@ + + + + + +AnyType (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.evaluation.type
    +

    Class AnyType

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.evaluation.type.AnyType
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Type
      +
      +
      +
      public final class AnyType
+extends java.lang.Object
      +
      The "any" type, which matches all other types.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          isA

          +
          public boolean isA​(Type type)
          +
          Description copied from interface: Type
          +
          Returns true if this type matches the target type.
          +
          +
          Parameters:
          +
          type - the target type to match.
          +
          Returns:
          +
          true if the types match, false otherwise.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object obj)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/ArrayType.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/ArrayType.html new file mode 100644 index 00000000000..f0670c1ff06 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/ArrayType.html @@ -0,0 +1,339 @@ + + + + + +ArrayType (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.evaluation.type
    +

    Class ArrayType

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.evaluation.type.ArrayType
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Type
      +
      +
      +
      public final class ArrayType
+extends java.lang.Object
      +
      The "array" type, which contains entries of a member type.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getMember

          +
          public Type getMember()
          +
          Gets the type of the member in this array.
          +
          +
          Returns:
          +
          the type of the member in this array.
          +
          +
          • +
        + + + +
          +
        • +

          expectArrayType

          +
          public ArrayType expectArrayType()
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object obj)
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/BooleanType.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/BooleanType.html new file mode 100644 index 00000000000..ecc29426423 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/BooleanType.html @@ -0,0 +1,330 @@ + + + + + +BooleanType (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.evaluation.type
    +

    Class BooleanType

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.evaluation.type.BooleanType
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Type
      +
      +
      +
      public final class BooleanType
+extends java.lang.Object
      +
      The "boolean" type.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          expectBooleanType

          +
          public BooleanType expectBooleanType()
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object obj)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/EmptyType.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/EmptyType.html new file mode 100644 index 00000000000..d34e79311fe --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/EmptyType.html @@ -0,0 +1,331 @@ + + + + + +EmptyType (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.evaluation.type
    +

    Class EmptyType

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.evaluation.type.EmptyType
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Type
      +
      +
      +
      public final class EmptyType
+extends java.lang.Object
      +
      The "empty" type.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object obj)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/EndpointType.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/EndpointType.html new file mode 100644 index 00000000000..d8ca32aac0a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/EndpointType.html @@ -0,0 +1,331 @@ + + + + + +EndpointType (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.evaluation.type
    +

    Class EndpointType

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.evaluation.type.EndpointType
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Type
      +
      +
      +
      public final class EndpointType
+extends java.lang.Object
      +
      The "endpoint" type, representing a valid client endpoint.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object obj)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/IntegerType.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/IntegerType.html new file mode 100644 index 00000000000..e21f4af613d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/IntegerType.html @@ -0,0 +1,330 @@ + + + + + +IntegerType (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.evaluation.type
    +

    Class IntegerType

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.evaluation.type.IntegerType
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Type
      +
      +
      +
      public final class IntegerType
+extends java.lang.Object
      +
      The "integer" type.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          expectIntegerType

          +
          public IntegerType expectIntegerType()
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object obj)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/OptionalType.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/OptionalType.html new file mode 100644 index 00000000000..b4db16fd73b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/OptionalType.html @@ -0,0 +1,426 @@ + + + + + +OptionalType (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.evaluation.type
    +

    Class OptionalType

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.evaluation.type.OptionalType
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Type
      +
      +
      +
      public final class OptionalType
+extends java.lang.Object
      +
      The "optional" type, a container for a type that may or may not be present.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          isA

          +
          public boolean isA​(Type type)
          +
          Description copied from interface: Type
          +
          Returns true if this type matches the target type.
          +
          +
          Parameters:
          +
          type - the target type to match.
          +
          Returns:
          +
          true if the types match, false otherwise.
          +
          +
          • +
        + + + +
          +
        • +

          provenTruthy

          +
          public Type provenTruthy()
          +
          Description copied from interface: Type
          +
          When used in the context of a condition, the condition can only match if the + value was truthful. This means that a certain expression can be a different + type, for example, OptionalType<T> will become T.
          +
          +
          Returns:
          +
          The type, given that it has been proven truthy
          +
          +
          • +
        + + + +
          +
        • +

          inner

          +
          public Type inner()
          +
          Gets the optional's contained value.
          +
          +
          Returns:
          +
          the optional's value.
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          expectOptionalType

          +
          public OptionalType expectOptionalType()
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object obj)
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/RecordType.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/RecordType.html new file mode 100644 index 00000000000..c6c5e53eac4 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/RecordType.html @@ -0,0 +1,362 @@ + + + + + +RecordType (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.evaluation.type
    +

    Class RecordType

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.evaluation.type.RecordType
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Type
      +
      +
      +
      public final class RecordType
+extends java.lang.Object
      +
      The "record" type, a map of identifiers to other types.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          get

          +
          public java.util.Optional<Type> get​(Identifier name)
          +
          Gets the type for the specified identifier.
          +
          +
          Parameters:
          +
          name - the identifier to get the type of.
          +
          Returns:
          +
          the type of the specified identifier.
          +
          +
          • +
        + + + +
          +
        • +

          getShape

          +
          public java.util.Map<Identifier,​Type> getShape()
          +
          Gets the map of identifiers to their types.
          +
          +
          Returns:
          +
          the map of identifiers to their types.
          +
          +
          • +
        + + + +
          +
        • +

          expectRecordType

          +
          public RecordType expectRecordType​(java.lang.String message)
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object obj)
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/StringType.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/StringType.html new file mode 100644 index 00000000000..05f5923ea2b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/StringType.html @@ -0,0 +1,330 @@ + + + + + +StringType (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.evaluation.type
    +

    Class StringType

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.evaluation.type.StringType
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Type
      +
      +
      +
      public final class StringType
+extends java.lang.Object
      +
      The "string" type.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          expectStringType

          +
          public StringType expectStringType()
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object obj)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/TupleType.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/TupleType.html new file mode 100644 index 00000000000..8b50a2e809c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/TupleType.html @@ -0,0 +1,344 @@ + + + + + +TupleType (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.evaluation.type
    +

    Class TupleType

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.evaluation.type.TupleType
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Type
      +
      +
      +
      public final class TupleType
+extends java.lang.Object
      +
      A "tuple" type, containing members of varying types.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getMemberTypes

          +
          public java.util.List<Type> getMemberTypes()
          +
          Gets the types of each member in the tuple.
          +
          +
          Returns:
          +
          the types of each member in the tuple.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object obj)
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/Type.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/Type.html new file mode 100644 index 00000000000..d8339d1607f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/Type.html @@ -0,0 +1,630 @@ + + + + + +Type (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.evaluation.type
    +

    Interface Type

    +
    +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/package-summary.html new file mode 100644 index 00000000000..11281d88407 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/package-summary.html @@ -0,0 +1,237 @@ + + + + + +software.amazon.smithy.rulesengine.language.evaluation.type (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.rulesengine.language.evaluation.type

    +
    +
    +
      +
    • + + + + + + + + + + + + +
      Interface Summary 
      InterfaceDescription
      Type +
      Types used to construct conditions out of values in the rules engine.
      +
      +
      • +
    • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      AnyType +
      The "any" type, which matches all other types.
      +
      ArrayType +
      The "array" type, which contains entries of a member type.
      +
      BooleanType +
      The "boolean" type.
      +
      EmptyType +
      The "empty" type.
      +
      EndpointType +
      The "endpoint" type, representing a valid client endpoint.
      +
      IntegerType +
      The "integer" type.
      +
      OptionalType +
      The "optional" type, a container for a type that may or may not be present.
      +
      RecordType +
      The "record" type, a map of identifiers to other types.
      +
      StringType +
      The "string" type.
      +
      TupleType +
      A "tuple" type, containing members of varying types.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/package-tree.html new file mode 100644 index 00000000000..ad97e772139 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/type/package-tree.html @@ -0,0 +1,176 @@ + + + + + +software.amazon.smithy.rulesengine.language.evaluation.type Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.rulesengine.language.evaluation.type

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    +
      +
    • java.lang.Object +
        +
      • software.amazon.smithy.rulesengine.language.evaluation.type.AnyType
        • +
      • software.amazon.smithy.rulesengine.language.evaluation.type.ArrayType
        • +
      • software.amazon.smithy.rulesengine.language.evaluation.type.BooleanType
        • +
      • software.amazon.smithy.rulesengine.language.evaluation.type.EmptyType
        • +
      • software.amazon.smithy.rulesengine.language.evaluation.type.EndpointType
        • +
      • software.amazon.smithy.rulesengine.language.evaluation.type.IntegerType
        • +
      • software.amazon.smithy.rulesengine.language.evaluation.type.OptionalType
        • +
      • software.amazon.smithy.rulesengine.language.evaluation.type.RecordType
        • +
      • software.amazon.smithy.rulesengine.language.evaluation.type.StringType
        • +
      • software.amazon.smithy.rulesengine.language.evaluation.type.TupleType
        • +
      +
      • +
    +
    +
    +

    Interface Hierarchy

    +
      +
    • software.amazon.smithy.rulesengine.language.evaluation.type.Type
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/ArrayValue.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/ArrayValue.html new file mode 100644 index 00000000000..9faa35eacd6 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/ArrayValue.html @@ -0,0 +1,431 @@ + + + + + +ArrayValue (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.evaluation.value
    +

    Class ArrayValue

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      FromSourceLocation, ToNode
      +
      +
      +
      public final class ArrayValue
+extends Value
      +
      An array of values of the same type.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getValues

          +
          public java.util.List<Value> getValues()
          +
          Gets all the values in the array.
          +
          +
          Returns:
          +
          the values in the array.
          +
          +
          • +
        + + + +
          +
        • +

          get

          +
          public Value get​(int index)
          +
          Gets the value at the index, or an empty value if none is present.
          +
          +
          Parameters:
          +
          index - the index to get the value of.
          +
          Returns:
          +
          the value at the index, or an empty value if not present.
          +
          +
          • +
        + + + +
          +
        • +

          getType

          +
          public Type getType()
          +
          +
          Specified by:
          +
          getType in class Value
          +
          +
          • +
        + + + +
          +
        • +

          expectArrayValue

          +
          public ArrayValue expectArrayValue()
          +
          Description copied from class: Value
          +
          Returns the current value as an ArrayValue, throwing + RuntimeException when the value is the wrong type.
          +
          +
          Overrides:
          +
          expectArrayValue in class Value
          +
          Returns:
          +
          returns an array value.
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/BooleanValue.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/BooleanValue.html new file mode 100644 index 00000000000..95c6f41d345 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/BooleanValue.html @@ -0,0 +1,408 @@ + + + + + +BooleanValue (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.evaluation.value
    +

    Class BooleanValue

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      FromSourceLocation, ToNode
      +
      +
      +
      public final class BooleanValue
+extends Value
      +
      A boolean value of true or false.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getValue

          +
          public boolean getValue()
          +
          Gets the true or false value of this boolean.
          +
          +
          Returns:
          +
          the value true or false.
          +
          +
          • +
        + + + +
          +
        • +

          getType

          +
          public Type getType()
          +
          +
          Specified by:
          +
          getType in class Value
          +
          +
          • +
        + + + +
          +
        • +

          expectBooleanValue

          +
          public BooleanValue expectBooleanValue()
          +
          Description copied from class: Value
          +
          Returns the current value as an ArrayValue, throwing + RuntimeException when the value is the wrong type.
          +
          +
          Overrides:
          +
          expectBooleanValue in class Value
          +
          Returns:
          +
          returns a boolean value.
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/EmptyValue.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/EmptyValue.html new file mode 100644 index 00000000000..58ca3418d9a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/EmptyValue.html @@ -0,0 +1,383 @@ + + + + + +EmptyValue (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.evaluation.value
    +

    Class EmptyValue

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          EmptyValue

          +
          public EmptyValue()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getType

          +
          public Type getType()
          +
          +
          Specified by:
          +
          getType in class Value
          +
          +
          • +
        + + + +
          +
        • +

          isEmpty

          +
          public boolean isEmpty()
          +
          +
          Overrides:
          +
          isEmpty in class Value
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/EndpointValue.Builder.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/EndpointValue.Builder.html new file mode 100644 index 00000000000..d1fa35fa83c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/EndpointValue.Builder.html @@ -0,0 +1,409 @@ + + + + + +EndpointValue.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.evaluation.value
    +

    Class EndpointValue.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          headers

          +
          public EndpointValue.Builder headers​(java.util.Map<java.lang.String,​java.util.List<java.lang.String>> headers)
          +
          • +
        + + + +
          +
        • +

          putHeader

          +
          public EndpointValue.Builder putHeader​(java.lang.String name,
+                                       java.util.List<java.lang.String> values)
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          build

          +
          public EndpointValue build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/EndpointValue.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/EndpointValue.html new file mode 100644 index 00000000000..cae3beba006 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/EndpointValue.html @@ -0,0 +1,519 @@ + + + + + +EndpointValue (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.evaluation.value
    +

    Class EndpointValue

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      FromSourceLocation, ToNode
      +
      +
      +
      public final class EndpointValue
+extends Value
      +
      An endpoint value, containing a URL as well as headers that MUST be sent.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          fromNode

          +
          public static EndpointValue fromNode​(Node node)
          +
          Creates an EndpointValue instance from the given Node information.
          +
          +
          Parameters:
          +
          node - the node to deserialize.
          +
          Returns:
          +
          the created EndpointValue.
          +
          +
          • +
        + + + +
          +
        • +

          getProperties

          +
          public java.util.Map<java.lang.String,​Value> getProperties()
          +
          Gets the properties of this endpoint.
          +
          +
          Returns:
          +
          the properties of this endpoint.
          +
          +
          • +
        + + + +
          +
        • +

          getUrl

          +
          public java.lang.String getUrl()
          +
          Gets the URL of this endpoint.
          +
          +
          Returns:
          +
          the URL of this endpoint.
          +
          +
          • +
        + + + +
          +
        • +

          getHeaders

          +
          public java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getHeaders()
          +
          Gets the headers to set when sending HTTP requests to the URL.
          +
          +
          Returns:
          +
          a map of header names to a list of values to set on those headers.
          +
          +
          • +
        + + + +
          +
        • +

          getType

          +
          public Type getType()
          +
          +
          Specified by:
          +
          getType in class Value
          +
          +
          • +
        + + + +
          +
        • +

          expectEndpointValue

          +
          public EndpointValue expectEndpointValue()
          +
          Description copied from class: Value
          +
          Returns the current value as an ArrayValue, throwing + RuntimeException when the value is the wrong type.
          +
          +
          Overrides:
          +
          expectEndpointValue in class Value
          +
          Returns:
          +
          returns an endpoint value
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/IntegerValue.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/IntegerValue.html new file mode 100644 index 00000000000..95ba56a02e6 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/IntegerValue.html @@ -0,0 +1,354 @@ + + + + + +IntegerValue (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.evaluation.value
    +

    Class IntegerValue

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getValue

          +
          public int getValue()
          +
          Gets the value of the integer.
          +
          +
          Returns:
          +
          the value of the integer.
          +
          +
          • +
        + + + +
          +
        • +

          getType

          +
          public Type getType()
          +
          +
          Specified by:
          +
          getType in class Value
          +
          +
          • +
        + + + +
          +
        • +

          expectIntegerValue

          +
          public IntegerValue expectIntegerValue()
          +
          Description copied from class: Value
          +
          Returns the current value as an ArrayValue, throwing + RuntimeException when the value is the wrong type.
          +
          +
          Overrides:
          +
          expectIntegerValue in class Value
          +
          Returns:
          +
          returns an integer value.
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/RecordValue.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/RecordValue.html new file mode 100644 index 00000000000..ea714c872c6 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/RecordValue.html @@ -0,0 +1,454 @@ + + + + + +RecordValue (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.evaluation.value
    +

    Class RecordValue

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      FromSourceLocation, ToNode
      +
      +
      +
      public final class RecordValue
+extends Value
      +
      A record value, containing a map of identifiers to other values.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getValue

          +
          public java.util.Map<Identifier,​Value> getValue()
          +
          Gets the map of identifiers to other values.
          +
          +
          Returns:
          +
          the map of identifiers to other values.
          +
          +
          • +
        + + + +
          +
        • +

          get

          +
          public Value get​(java.lang.String key)
          +
          Gets the value in the record for the provided key.
          +
          +
          Parameters:
          +
          key - the key to retrieve a value for.
          +
          Returns:
          +
          the value for the provided key, or null if the key is not present.
          +
          +
          • +
        + + + +
          +
        • +

          get

          +
          public Value get​(Identifier key)
          +
          Gets the value in the record for the provided key.
          +
          +
          Parameters:
          +
          key - the key to retrieve a value for.
          +
          Returns:
          +
          the value for the provided key, or null if the key is not present.
          +
          +
          • +
        + + + +
          +
        • +

          getType

          +
          public Type getType()
          +
          +
          Specified by:
          +
          getType in class Value
          +
          +
          • +
        + + + +
          +
        • +

          expectRecordValue

          +
          public RecordValue expectRecordValue()
          +
          Description copied from class: Value
          +
          Returns the current value as an ArrayValue, throwing + RuntimeException when the value is the wrong type.
          +
          +
          Overrides:
          +
          expectRecordValue in class Value
          +
          Returns:
          +
          returns a record value.
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/StringValue.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/StringValue.html new file mode 100644 index 00000000000..1150161846a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/StringValue.html @@ -0,0 +1,408 @@ + + + + + +StringValue (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.evaluation.value
    +

    Class StringValue

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getValue

          +
          public java.lang.String getValue()
          +
          Gets the value of the string.
          +
          +
          Returns:
          +
          the value of the string.
          +
          +
          • +
        + + + +
          +
        • +

          getType

          +
          public Type getType()
          +
          +
          Specified by:
          +
          getType in class Value
          +
          +
          • +
        + + + +
          +
        • +

          expectStringValue

          +
          public StringValue expectStringValue()
          +
          Description copied from class: Value
          +
          Returns the current value as an ArrayValue, throwing + RuntimeException when the value is the wrong type.
          +
          +
          Overrides:
          +
          expectStringValue in class Value
          +
          Returns:
          +
          returns a string value.
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/Value.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/Value.html new file mode 100644 index 00000000000..e0bd0a5fbd5 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/Value.html @@ -0,0 +1,639 @@ + + + + + +Value (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.evaluation.value
    +

    Class Value

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.evaluation.value.Value
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getType

          +
          public abstract Type getType()
          +
          • +
        + + + +
          +
        • +

          fromNode

          +
          public static Value fromNode​(Node source)
          +
          Creates a Value of a specific type from the given Node information.
          +
          +
          Parameters:
          +
          source - the node to deserialize.
          +
          Returns:
          +
          the created Value.
          +
          +
          • +
        + + + +
          +
        • +

          isEmpty

          +
          public boolean isEmpty()
          +
          • +
        + + + + + + + +
          +
        • +

          arrayValue

          +
          public static ArrayValue arrayValue​(java.util.List<Value> value)
          +
          Creates an ArrayValue from a list of values.
          +
          +
          Parameters:
          +
          value - the list of values for the array.
          +
          Returns:
          +
          returns the created ArrayValue.
          +
          +
          • +
        + + + +
          +
        • +

          booleanValue

          +
          public static BooleanValue booleanValue​(boolean value)
          +
          Creates an BooleanValue from a boolean.
          +
          +
          Parameters:
          +
          value - the value for the boolean.
          +
          Returns:
          +
          returns the created BooleanValue.
          +
          +
          • +
        + + + +
          +
        • +

          emptyValue

          +
          public static EmptyValue emptyValue()
          +
          Creates an EmptyValue.
          +
          +
          Returns:
          +
          returns the created EmptyValue.
          +
          +
          • +
        + + + +
          +
        • +

          endpointValue

          +
          public static EndpointValue endpointValue​(Node source)
          +
          Creates an EndpointValue from a node.
          +
          +
          Parameters:
          +
          source - the node to create an endpoint from.
          +
          Returns:
          +
          returns the created EndpointValue.
          +
          +
          • +
        + + + +
          +
        • +

          integerValue

          +
          public static IntegerValue integerValue​(int value)
          +
          Creates an IntegerValue from an integer.
          +
          +
          Parameters:
          +
          value - the value for the integer.
          +
          Returns:
          +
          returns the created IntegerValue.
          +
          +
          • +
        + + + +
          +
        • +

          recordValue

          +
          public static RecordValue recordValue​(java.util.Map<Identifier,​Value> value)
          +
          Creates an RecordValue from a map of identifiers to values.
          +
          +
          Parameters:
          +
          value - the map to create a record from.
          +
          Returns:
          +
          returns the created RecordValue.
          +
          +
          • +
        + + + +
          +
        • +

          stringValue

          +
          public static StringValue stringValue​(java.lang.String value)
          +
          Creates an StringValue from a string.
          +
          +
          Parameters:
          +
          value - the value for the string.
          +
          Returns:
          +
          returns the created StringValue.
          +
          +
          • +
        + + + +
          +
        • +

          expectArrayValue

          +
          public ArrayValue expectArrayValue()
          +
          Returns the current value as an ArrayValue, throwing + RuntimeException when the value is the wrong type.
          +
          +
          Returns:
          +
          returns an array value.
          +
          +
          • +
        + + + +
          +
        • +

          expectBooleanValue

          +
          public BooleanValue expectBooleanValue()
          +
          Returns the current value as an ArrayValue, throwing + RuntimeException when the value is the wrong type.
          +
          +
          Returns:
          +
          returns a boolean value.
          +
          +
          • +
        + + + +
          +
        • +

          expectEndpointValue

          +
          public EndpointValue expectEndpointValue()
          +
          Returns the current value as an ArrayValue, throwing + RuntimeException when the value is the wrong type.
          +
          +
          Returns:
          +
          returns an endpoint value
          +
          +
          • +
        + + + +
          +
        • +

          expectIntegerValue

          +
          public IntegerValue expectIntegerValue()
          +
          Returns the current value as an ArrayValue, throwing + RuntimeException when the value is the wrong type.
          +
          +
          Returns:
          +
          returns an integer value.
          +
          +
          • +
        + + + +
          +
        • +

          expectRecordValue

          +
          public RecordValue expectRecordValue()
          +
          Returns the current value as an ArrayValue, throwing + RuntimeException when the value is the wrong type.
          +
          +
          Returns:
          +
          returns a record value.
          +
          +
          • +
        + + + +
          +
        • +

          expectStringValue

          +
          public StringValue expectStringValue()
          +
          Returns the current value as an ArrayValue, throwing + RuntimeException when the value is the wrong type.
          +
          +
          Returns:
          +
          returns a string value.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/package-summary.html new file mode 100644 index 00000000000..a73d693337d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/package-summary.html @@ -0,0 +1,214 @@ + + + + + +software.amazon.smithy.rulesengine.language.evaluation.value (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.rulesengine.language.evaluation.value

    +
    +
    +
      +
    • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      ArrayValue +
      An array of values of the same type.
      +
      BooleanValue +
      A boolean value of true or false.
      +
      EmptyValue +
      An empty value.
      +
      EndpointValue +
      An endpoint value, containing a URL as well as headers that MUST be sent.
      +
      EndpointValue.Builder +
      A builder used to create an EndpointValue class.
      +
      IntegerValue +
      An integer value.
      +
      RecordValue +
      A record value, containing a map of identifiers to other values.
      +
      StringValue +
      A string value.
      +
      Value +
      An abstract representing a typed value.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/package-tree.html new file mode 100644 index 00000000000..cc40f82cb58 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/evaluation/value/package-tree.html @@ -0,0 +1,176 @@ + + + + + +software.amazon.smithy.rulesengine.language.evaluation.value Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.rulesengine.language.evaluation.value

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    +
      +
    • java.lang.Object +
        +
      • software.amazon.smithy.rulesengine.language.RulesComponentBuilder<B,​T> (implements software.amazon.smithy.model.FromSourceLocation, software.amazon.smithy.utils.SmithyBuilder<T>) + +
        • +
      • software.amazon.smithy.rulesengine.language.evaluation.value.Value (implements software.amazon.smithy.model.FromSourceLocation, software.amazon.smithy.model.node.ToNode) +
          +
        • software.amazon.smithy.rulesengine.language.evaluation.value.ArrayValue
          • +
        • software.amazon.smithy.rulesengine.language.evaluation.value.BooleanValue
          • +
        • software.amazon.smithy.rulesengine.language.evaluation.value.EmptyValue
          • +
        • software.amazon.smithy.rulesengine.language.evaluation.value.EndpointValue
          • +
        • software.amazon.smithy.rulesengine.language.evaluation.value.IntegerValue
          • +
        • software.amazon.smithy.rulesengine.language.evaluation.value.RecordValue
          • +
        • software.amazon.smithy.rulesengine.language.evaluation.value.StringValue
          • +
        +
        • +
      +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/package-summary.html new file mode 100644 index 00000000000..10a947eccc3 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/package-summary.html @@ -0,0 +1,225 @@ + + + + + +software.amazon.smithy.rulesengine.language (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.rulesengine.language

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/package-tree.html new file mode 100644 index 00000000000..683364a8b88 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/package-tree.html @@ -0,0 +1,181 @@ + + + + + +software.amazon.smithy.rulesengine.language Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.rulesengine.language

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/Identifier.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/Identifier.html new file mode 100644 index 00000000000..4306e915520 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/Identifier.html @@ -0,0 +1,425 @@ + + + + + +Identifier (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax
    +

    Class Identifier

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.syntax.Identifier
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          of

          +
          public static Identifier of​(java.lang.String name)
          +
          Creates an Identifier from the given name.
          +
          +
          Parameters:
          +
          name - the name of the identifier to create.
          +
          Returns:
          +
          the created Identifier.
          +
          +
          • +
        + + + +
          +
        • +

          of

          +
          public static Identifier of​(StringNode name)
          +
          Creates an Identifier from the given name.
          +
          +
          Parameters:
          +
          name - the name of the identifier to create.
          +
          Returns:
          +
          the created Identifier.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getName

          +
          public StringNode getName()
          +
          Gets the name of this identifier.
          +
          +
          Returns:
          +
          a node containing the name of the identifier.
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object obj)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/SyntaxElement.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/SyntaxElement.html new file mode 100644 index 00000000000..de09e9e8326 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/SyntaxElement.html @@ -0,0 +1,544 @@ + + + + + +SyntaxElement (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax
    +

    Class SyntaxElement

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.syntax.SyntaxElement
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        SyntaxElement() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        BooleanEqualsbooleanEqual​(boolean value) +
        Returns a BooleanEquals expression comparing this expression to the provided boolean value.
        +
        GetAttrgetAttr​(java.lang.String path) +
        Returns a GetAttr function containing the given path string.
        +
        GetAttrgetAttr​(Identifier path) +
        Returns a GetAttr function containing the given identifier.
        +
        IsSetisSet() +
        Returns an IsSet expression for this instance.
        +
        IsValidHostLabelisValidHostLabel​(boolean allowDots) +
        Returns an isValidHostLabel expression of this expression.
        +
        Notnot() +
        Returns a Not expression of this instance.
        +
        ParseUrlparseUrl() +
        Returns a parseUrl expression of this expression.
        +
        StringEqualsstringEqual​(java.lang.String value) +
        Returns a StringEquals function of this expression and the given string value.
        +
        Substringsubstring​(int startIndex, + int stopIndex, + boolean reverse) +
        Returns a Substring expression of this expression.
        +
        java.lang.Stringtemplate() +
        Converts this expression to a string template.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          SyntaxElement

          +
          public SyntaxElement()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          booleanEqual

          +
          public final BooleanEquals booleanEqual​(boolean value)
          +
          Returns a BooleanEquals expression comparing this expression to the provided boolean value.
          +
          +
          Parameters:
          +
          value - the value to compare against.
          +
          Returns:
          +
          the BooleanEquals function.
          +
          +
          • +
        + + + +
          +
        • +

          stringEqual

          +
          public final StringEquals stringEqual​(java.lang.String value)
          +
          Returns a StringEquals function of this expression and the given string value.
          +
          +
          Parameters:
          +
          value - the string value to compare this expression to.
          +
          Returns:
          +
          the StringEquals function.
          +
          +
          • +
        + + + +
          +
        • +

          getAttr

          +
          public final GetAttr getAttr​(java.lang.String path)
          +
          Returns a GetAttr function containing the given path string.
          +
          +
          Parameters:
          +
          path - the path.
          +
          Returns:
          +
          the GetAttr function.
          +
          +
          • +
        + + + +
          +
        • +

          getAttr

          +
          public final GetAttr getAttr​(Identifier path)
          +
          Returns a GetAttr function containing the given identifier.
          +
          +
          Parameters:
          +
          path - the path.
          +
          Returns:
          +
          the GetAttr function.
          +
          +
          • +
        + + + +
          +
        • +

          isSet

          +
          public final IsSet isSet()
          +
          Returns an IsSet expression for this instance.
          +
          +
          Returns:
          +
          the IsSet function.
          +
          +
          • +
        + + + +
          +
        • +

          isValidHostLabel

          +
          public final IsValidHostLabel isValidHostLabel​(boolean allowDots)
          +
          Returns an isValidHostLabel expression of this expression.
          +
          +
          Parameters:
          +
          allowDots - whether the UTF-8 . is considered valid within a host label.
          +
          Returns:
          +
          the IsValidHostLabel function.
          +
          +
          • +
        + + + +
          +
        • +

          not

          +
          public final Not not()
          +
          Returns a Not expression of this instance.
          +
          +
          Returns:
          +
          the Not function.
          +
          +
          • +
        + + + +
          +
        • +

          parseUrl

          +
          public final ParseUrl parseUrl()
          +
          Returns a parseUrl expression of this expression.
          +
          +
          Returns:
          +
          the ParseUrl function.
          +
          +
          • +
        + + + +
          +
        • +

          substring

          +
          public final Substring substring​(int startIndex,
+                                 int stopIndex,
+                                 boolean reverse)
          +
          Returns a Substring expression of this expression.
          +
          +
          Parameters:
          +
          startIndex - the starting index of the string.
          +
          stopIndex - the ending index of the string.
          +
          reverse - whether the indexing is should start from end of the string to start.
          +
          Returns:
          +
          the Substring function.
          +
          +
          • +
        + + + +
          +
        • +

          template

          +
          public java.lang.String template()
          +
          Converts this expression to a string template. + By default, this implementation returns a RuntimeException.
          +
          +
          Returns:
          +
          the String template.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/ToCondition.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/ToCondition.html new file mode 100644 index 00000000000..562f0be16b0 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/ToCondition.html @@ -0,0 +1,305 @@ + + + + + +ToCondition (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax
    +

    Interface ToCondition

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          toConditionBuilder

          +
          Condition.Builder toConditionBuilder()
          +
          Convert this into a condition builder for compositional use.
          +
          +
          Returns:
          +
          the condition builder.
          +
          +
          • +
        + + + +
          +
        • +

          toCondition

          +
          default Condition toCondition()
          +
          Convert this into a condition.
          +
          +
          Returns:
          +
          the condition.
          +
          +
          • +
        + + + +
          +
        • +

          toCondition

          +
          default Condition toCondition​(java.lang.String result)
          +
          Converts this function into a condition which stores the output in the named result.
          +
          +
          Parameters:
          +
          result - the name of the result parameter.
          +
          Returns:
          +
          the function as a condition.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/ToExpression.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/ToExpression.html new file mode 100644 index 00000000000..caad728333c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/ToExpression.html @@ -0,0 +1,261 @@ + + + + + +ToExpression (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax
    +

    Interface ToExpression

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          toExpression

          +
          Expression toExpression()
          +
          Convert this into an expression.
          +
          +
          Returns:
          +
          the expression.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/Expression.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/Expression.html new file mode 100644 index 00000000000..93b2837d89d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/Expression.html @@ -0,0 +1,684 @@ + + + + + +Expression (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions
    +

    Class Expression

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Expression

          +
          public Expression​(SourceLocation sourceLocation)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          of

          +
          public static Literal of​(boolean value)
          +
          • +
        + + + +
          +
        • +

          of

          +
          public static Literal of​(int value)
          +
          Construct an integer literal for the given value, and returns it as an expression.
          +
          +
          Parameters:
          +
          value - the integer value.
          +
          Returns:
          +
          the integer value as a literal expression.
          +
          +
          • +
        + + + +
          +
        • +

          of

          +
          public static Literal of​(java.lang.String value)
          +
          Constructs a string literal for the given values.
          +
          +
          Parameters:
          +
          value - the string value.
          +
          Returns:
          +
          the string value as a literal.
          +
          +
          • +
        + + + +
          +
        • +

          fromNode

          +
          public static Expression fromNode​(Node node)
          +
          Constructs an expression from the provided Node.
          +
          +
          Parameters:
          +
          node - the node to construct the expression from.
          +
          Returns:
          +
          the expression.
          +
          +
          • +
        + + + +
          +
        • +

          parseShortform

          +
          public static Expression parseShortform​(java.lang.String shortForm,
+                                        FromSourceLocation context)
          +
          Parse a value from a "short form" used within a template.
          +
          +
          Parameters:
          +
          shortForm - the shortform value
          +
          Returns:
          +
          the parsed expression
          +
          +
          • +
        + + + +
          +
        • +

          getReference

          +
          public static Reference getReference​(Identifier name,
+                                     FromSourceLocation context)
          +
          Constructs a Reference for the given Identifier at the given location.
          +
          +
          Parameters:
          +
          name - the referenced identifier.
          +
          context - the source location.
          +
          Returns:
          +
          the reference.
          +
          +
          • +
        + + + +
          +
        • +

          getLiteral

          +
          public static Literal getLiteral​(StringNode node)
          +
          Constructs a Literal from the given StringNode.
          +
          +
          Parameters:
          +
          node - the node to construct the literal from.
          +
          Returns:
          +
          the string node as a literal.
          +
          +
          • +
        + + + +
          +
        • +

          accept

          +
          public abstract <R> R accept​(ExpressionVisitor<R> visitor)
          +
          Invoke the ExpressionVisitor functions for this expression.
          +
          +
          Type Parameters:
          +
          R - the visitor return type.
          +
          Parameters:
          +
          visitor - the visitor to be invoked.
          +
          Returns:
          +
          the return value of the visitor.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          type

          +
          public Type type()
          +
          Returns the type for this expression, throws a runtime exception if typeCheck has not been invoked.
          +
          +
          Returns:
          +
          the type.
          +
          +
          • +
        + + + +
          +
        • +

          toConditionBuilder

          +
          public Condition.Builder toConditionBuilder()
          +
          Description copied from interface: ToCondition
          +
          Convert this into a condition builder for compositional use.
          +
          +
          Specified by:
          +
          toConditionBuilder in interface ToCondition
          +
          Returns:
          +
          the condition builder.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          hashCode

          +
          public abstract int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public abstract boolean equals​(java.lang.Object obj)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + + + + + +
          +
        • +

          typeCheck

          +
          public Type typeCheck​(Scope<Type> scope)
          +
          Description copied from interface: TypeCheck
          +
          Checks whether the given types within a scope satisfy the constraints.
          +
          +
          Specified by:
          +
          typeCheck in interface TypeCheck
          +
          Parameters:
          +
          scope - the scope to evaluate.
          +
          Returns:
          +
          the type validated by the scope check.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/ExpressionVisitor.Default.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/ExpressionVisitor.Default.html new file mode 100644 index 00000000000..b16a8732887 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/ExpressionVisitor.Default.html @@ -0,0 +1,551 @@ + + + + + +ExpressionVisitor.Default (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions
    +

    Class ExpressionVisitor.Default<R>

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.syntax.expressions.ExpressionVisitor.Default<R>
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Default

          +
          public Default()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getDefault

          +
          public abstract R getDefault()
          +
          • +
        + + + +
          +
        • +

          visitLiteral

          +
          public R visitLiteral​(Literal literal)
          +
          Description copied from interface: ExpressionVisitor
          +
          Visits a literal.
          +
          +
          Specified by:
          +
          visitLiteral in interface ExpressionVisitor<R>
          +
          Parameters:
          +
          literal - the literal to visit.
          +
          Returns:
          +
          the value from the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          visitRef

          +
          public R visitRef​(Reference reference)
          +
          Description copied from interface: ExpressionVisitor
          +
          Visits a reference.
          +
          +
          Specified by:
          +
          visitRef in interface ExpressionVisitor<R>
          +
          Parameters:
          +
          reference - the reference to visit.
          +
          Returns:
          +
          the value from the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          visitGetAttr

          +
          public R visitGetAttr​(GetAttr getAttr)
          +
          Description copied from interface: ExpressionVisitor
          +
          Visits a GetAttr function.
          +
          +
          Specified by:
          +
          visitGetAttr in interface ExpressionVisitor<R>
          +
          Parameters:
          +
          getAttr - the GetAttr function to visit.
          +
          Returns:
          +
          the value from the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          visitIsSet

          +
          public R visitIsSet​(Expression fn)
          +
          Description copied from interface: ExpressionVisitor
          +
          Visits an isSet function.
          +
          +
          Specified by:
          +
          visitIsSet in interface ExpressionVisitor<R>
          +
          Parameters:
          +
          fn - the isSet function to visit.
          +
          Returns:
          +
          the value from the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          visitNot

          +
          public R visitNot​(Expression not)
          +
          Description copied from interface: ExpressionVisitor
          +
          Visits a not function.
          +
          +
          Specified by:
          +
          visitNot in interface ExpressionVisitor<R>
          +
          Parameters:
          +
          not - the not function to visit.
          +
          Returns:
          +
          the value from the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          visitBoolEquals

          +
          public R visitBoolEquals​(Expression left,
+                         Expression right)
          +
          Description copied from interface: ExpressionVisitor
          +
          Does a boolean equality check.
          +
          +
          Specified by:
          +
          visitBoolEquals in interface ExpressionVisitor<R>
          +
          Parameters:
          +
          left - the first value to compare.
          +
          right - the second value to compare.
          +
          Returns:
          +
          the value from the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          visitStringEquals

          +
          public R visitStringEquals​(Expression left,
+                           Expression right)
          +
          Description copied from interface: ExpressionVisitor
          +
          Does a string equality check.
          +
          +
          Specified by:
          +
          visitStringEquals in interface ExpressionVisitor<R>
          +
          Parameters:
          +
          left - the first value to compare.
          +
          right - the second value to compare.
          +
          Returns:
          +
          the value from the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          visitLibraryFunction

          +
          public R visitLibraryFunction​(FunctionDefinition fn,
+                              java.util.List<Expression> args)
          +
          Description copied from interface: ExpressionVisitor
          +
          Visits a library function.
          +
          +
          Specified by:
          +
          visitLibraryFunction in interface ExpressionVisitor<R>
          +
          Parameters:
          +
          fn - the library function to visit.
          +
          args - the arguments to the function being visited.
          +
          Returns:
          +
          the value from the visitor.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/ExpressionVisitor.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/ExpressionVisitor.html new file mode 100644 index 00000000000..039e4bd8a96 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/ExpressionVisitor.html @@ -0,0 +1,459 @@ + + + + + +ExpressionVisitor (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions
    +

    Interface ExpressionVisitor<R>

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          visitLiteral

          +
          R visitLiteral​(Literal literal)
          +
          Visits a literal.
          +
          +
          Parameters:
          +
          literal - the literal to visit.
          +
          Returns:
          +
          the value from the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          visitRef

          +
          R visitRef​(Reference reference)
          +
          Visits a reference.
          +
          +
          Parameters:
          +
          reference - the reference to visit.
          +
          Returns:
          +
          the value from the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          visitGetAttr

          +
          R visitGetAttr​(GetAttr getAttr)
          +
          Visits a GetAttr function.
          +
          +
          Parameters:
          +
          getAttr - the GetAttr function to visit.
          +
          Returns:
          +
          the value from the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          visitIsSet

          +
          R visitIsSet​(Expression fn)
          +
          Visits an isSet function.
          +
          +
          Parameters:
          +
          fn - the isSet function to visit.
          +
          Returns:
          +
          the value from the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          visitNot

          +
          R visitNot​(Expression not)
          +
          Visits a not function.
          +
          +
          Parameters:
          +
          not - the not function to visit.
          +
          Returns:
          +
          the value from the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          visitBoolEquals

          +
          R visitBoolEquals​(Expression left,
+                  Expression right)
          +
          Does a boolean equality check.
          +
          +
          Parameters:
          +
          left - the first value to compare.
          +
          right - the second value to compare.
          +
          Returns:
          +
          the value from the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          visitStringEquals

          +
          R visitStringEquals​(Expression left,
+                    Expression right)
          +
          Does a string equality check.
          +
          +
          Parameters:
          +
          left - the first value to compare.
          +
          right - the second value to compare.
          +
          Returns:
          +
          the value from the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          visitLibraryFunction

          +
          R visitLibraryFunction​(FunctionDefinition fn,
+                       java.util.List<Expression> args)
          +
          Visits a library function.
          +
          +
          Parameters:
          +
          fn - the library function to visit.
          +
          args - the arguments to the function being visited.
          +
          Returns:
          +
          the value from the visitor.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/Reference.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/Reference.html new file mode 100644 index 00000000000..9f9e9535983 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/Reference.html @@ -0,0 +1,504 @@ + + + + + +Reference (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions
    +

    Class Reference

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Reference

          +
          public Reference​(Identifier name,
+                 FromSourceLocation sourceLocation)
          +
          Creates a Reference for the identifier from the given source location.
          +
          +
          Parameters:
          +
          name - the identifier being referenced.
          +
          sourceLocation - the source location for the reference.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getName

          +
          public Identifier getName()
          +
          Gets the name of the field being referenced.
          +
          +
          Returns:
          +
          the name of the referenced field.
          +
          +
          • +
        + + + +
          +
        • +

          template

          +
          public java.lang.String template()
          +
          Description copied from class: SyntaxElement
          +
          Converts this expression to a string template. + By default, this implementation returns a RuntimeException.
          +
          +
          Overrides:
          +
          template in class SyntaxElement
          +
          Returns:
          +
          the String template.
          +
          +
          • +
        + + + +
          +
        • +

          accept

          +
          public <R> R accept​(ExpressionVisitor<R> visitor)
          +
          Description copied from class: Expression
          +
          Invoke the ExpressionVisitor functions for this expression.
          +
          +
          Specified by:
          +
          accept in class Expression
          +
          Type Parameters:
          +
          R - the visitor return type.
          +
          Parameters:
          +
          visitor - the visitor to be invoked.
          +
          Returns:
          +
          the return value of the visitor.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Specified by:
          +
          equals in class Expression
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Specified by:
          +
          hashCode in class Expression
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/Template.Literal.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/Template.Literal.html new file mode 100644 index 00000000000..fba88aace6f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/Template.Literal.html @@ -0,0 +1,379 @@ + + + + + +Template.Literal (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions
    +

    Class Template.Literal

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.syntax.expressions.Template.Literal
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      TypeCheck, Template.Part
      +
      +
      +
      Enclosing class:
      +
      Template
      +
      +
      +
      public static final class Template.Literal
+extends java.lang.Object
+implements Template.Part
      +
      A static template value part.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        <T> Taccept​(TemplateVisitor<T> visitor) 
        booleanequals​(java.lang.Object o) 
        java.lang.StringgetValue() +
        Gets the value of this literal.
        +
        inthashCode() 
        java.lang.StringtoString() 
        TypetypeCheck​(Scope<Type> scope) +
        Checks whether the given types within a scope satisfy the constraints.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getValue

          +
          public java.lang.String getValue()
          +
          Gets the value of this literal.
          +
          +
          Returns:
          +
          the literal value.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          typeCheck

          +
          public Type typeCheck​(Scope<Type> scope)
          +
          Description copied from interface: TypeCheck
          +
          Checks whether the given types within a scope satisfy the constraints.
          +
          +
          Specified by:
          +
          typeCheck in interface TypeCheck
          +
          Parameters:
          +
          scope - the scope to evaluate.
          +
          Returns:
          +
          the type validated by the scope check.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/Template.Part.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/Template.Part.html new file mode 100644 index 00000000000..d90f8e43ffc --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/Template.Part.html @@ -0,0 +1,269 @@ + + + + + +Template.Part (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions
    +

    Interface Template.Part

    +
    +
    +
    +
      +
    • +
      +
      All Superinterfaces:
      +
      TypeCheck
      +
      +
      +
      All Known Implementing Classes:
      +
      Template.Literal
      +
      +
      +
      Enclosing class:
      +
      Template
      +
      +
      +
      public static interface Template.Part
+extends TypeCheck
      +
      An interface for parts of a template that can be visited.
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/Template.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/Template.html new file mode 100644 index 00000000000..5d73cce1ce8 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/Template.html @@ -0,0 +1,545 @@ + + + + + +Template (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions
    +

    Class Template

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.syntax.expressions.Template
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      FromSourceLocation, ToNode
      +
      +
      +
      public final class Template
+extends java.lang.Object
+implements FromSourceLocation, ToNode
      +
      Template represents a "Template Literal". This is a literal string within the rules language. A template + can contain 0 or more dynamic sections. The dynamic sections use getAttr short-form: +

      + `https://{Region}.{partition#dnsSuffix}` + -------- ------------ + | | + Dynamic getAttr short form

      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static class Template.Literal +
        A static template value part.
        +
        static interface Template.Part +
        An interface for parts of a template that can be visited.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Template​(StringNode template) 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Template

          +
          public Template​(StringNode template)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          fromString

          +
          public static Template fromString​(java.lang.String s)
          +
          • +
        + + + + + + + +
          +
        • +

          accept

          +
          public <T> java.util.stream.Stream<T> accept​(TemplateVisitor<T> visitor)
          +
          • +
        + + + +
          +
        • +

          getParts

          +
          public java.util.List<Template.Part> getParts()
          +
          • +
        + + + +
          +
        • +

          isStatic

          +
          public boolean isStatic()
          +
          Gets if the template is static or not.
          +
          +
          Returns:
          +
          true if all template parts are literals, false otherwise.
          +
          +
          • +
        + + + +
          +
        • +

          expectLiteral

          +
          public java.lang.String expectLiteral()
          +
          Returns the literal value of this template, throwing + RuntimeException if the template is not static.
          +
          +
          Returns:
          +
          returns the string literal value.
          +
          +
          • +
        + + + +
          +
        • +

          typeCheck

          +
          public Type typeCheck​(Scope<Type> scope)
          +
          Evaluates this template in the provided scope.
          +
          +
          Parameters:
          +
          scope - the scope to check this template within.
          +
          Returns:
          +
          the type of the template.
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/TemplateVisitor.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/TemplateVisitor.html new file mode 100644 index 00000000000..399e011676e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/TemplateVisitor.html @@ -0,0 +1,380 @@ + + + + + +TemplateVisitor (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions
    +

    Interface TemplateVisitor<T>

    +
    +
    +
    +
      +
    • +
      +
      Type Parameters:
      +
      T - The return type of this visitor
      +
      +
      +
      public interface TemplateVisitor<T>
      +
      For code generating from a template, use a `TemplateVisitor`. Template visitor is written to enable optimized + behavior for static templates with no dynamic components.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          visitStaticTemplate

          +
          T visitStaticTemplate​(java.lang.String value)
          +
          The template contains a single static string, eg. "https://mystaticendpoing.com"
          +
          +
          Parameters:
          +
          value - The static value of the template.
          +
          Returns:
          +
          T
          +
          +
          • +
        + + + +
          +
        • +

          visitSingleDynamicTemplate

          +
          T visitSingleDynamicTemplate​(Expression value)
          +
          The template contains a single dynamic element, eg. `{Region}`. In this case, string formatting is not required. + The type of the value is guaranteed to be a string.
          +
          +
          Parameters:
          +
          value - The single expression that represents this template.
          +
          Returns:
          +
          T
          +
          +
          • +
        + + + +
          +
        • +

          visitStaticElement

          +
          T visitStaticElement​(java.lang.String value)
          +
          Visit a static element within a multipart template. This will only be called after + startMultipartTemplate() has been invoked.
          +
          +
          Parameters:
          +
          value - A static element within a larger template
          +
          Returns:
          +
          T
          +
          +
          • +
        + + + +
          +
        • +

          visitDynamicElement

          +
          T visitDynamicElement​(Expression value)
          +
          Visit a dynamic element within a multipart template. This will only be called after + startMultipartTemplate() has been invoked.
          +
          +
          Parameters:
          +
          value - The dynamic template value
          +
          Returns:
          +
          T
          +
          +
          • +
        + + + + + + + +
          +
        • +

          finishMultipartTemplate

          +
          T finishMultipartTemplate()
          +
          Invoked at the conclusion of visiting a multipart template like `https://{Region}.{dnsSuffix}`. This allows + implementations to do something like call `string.join()` or `stringbuilder.toString()`.
          +
          +
          Returns:
          +
          T
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/BooleanEquals.Definition.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/BooleanEquals.Definition.html new file mode 100644 index 00000000000..4d6da50899a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/BooleanEquals.Definition.html @@ -0,0 +1,382 @@ + + + + + +BooleanEquals.Definition (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions.functions
    +

    Class BooleanEquals.Definition

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.syntax.expressions.functions.BooleanEquals.Definition
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/BooleanEquals.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/BooleanEquals.html new file mode 100644 index 00000000000..7c75913ad0f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/BooleanEquals.html @@ -0,0 +1,477 @@ + + + + + +BooleanEquals (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions.functions
    +

    Class BooleanEquals

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          ofExpressions

          +
          public static BooleanEquals ofExpressions​(ToExpression arg1,
+                                          ToExpression arg2)
          +
          Creates a BooleanEquals function from the given expressions.
          +
          +
          Parameters:
          +
          arg1 - the first argument to compare.
          +
          arg2 - the second argument to compare.
          +
          Returns:
          +
          The resulting BooleanEquals function.
          +
          +
          • +
        + + + +
          +
        • +

          ofExpressions

          +
          public static BooleanEquals ofExpressions​(ToExpression arg1,
+                                          boolean arg2)
          +
          Creates a BooleanEquals function from the given expressions.
          +
          +
          Parameters:
          +
          arg1 - the first argument to compare.
          +
          arg2 - the second argument to compare.
          +
          Returns:
          +
          The resulting BooleanEquals function.
          +
          +
          • +
        + + + +
          +
        • +

          accept

          +
          public <R> R accept​(ExpressionVisitor<R> visitor)
          +
          Description copied from class: Expression
          +
          Invoke the ExpressionVisitor functions for this expression.
          +
          +
          Specified by:
          +
          accept in class Expression
          +
          Type Parameters:
          +
          R - the visitor return type.
          +
          Parameters:
          +
          visitor - the visitor to be invoked.
          +
          Returns:
          +
          the return value of the visitor.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/FunctionDefinition.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/FunctionDefinition.html new file mode 100644 index 00000000000..88875d70b41 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/FunctionDefinition.html @@ -0,0 +1,346 @@ + + + + + +FunctionDefinition (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions.functions
    +

    Interface FunctionDefinition

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getId

          +
          java.lang.String getId()
          +
          The ID of this function.
          +
          +
          Returns:
          +
          The ID string
          +
          +
          • +
        + + + +
          +
        • +

          getArguments

          +
          java.util.List<Type> getArguments()
          +
          The arguments to this function.
          +
          +
          Returns:
          +
          The function arguments
          +
          +
          • +
        + + + +
          +
        • +

          getReturnType

          +
          Type getReturnType()
          +
          The return type of this function definition.
          +
          +
          Returns:
          +
          The function return type
          +
          +
          • +
        + + + +
          +
        • +

          evaluate

          +
          Value evaluate​(java.util.List<Value> arguments)
          +
          Evaluate the arguments to a given function to compute a result.
          +
          +
          Returns:
          +
          The resulting value
          +
          +
          • +
        + + + +
          +
        • +

          createFunction

          +
          LibraryFunction createFunction​(FunctionNode functionNode)
          +
          Creates a LibraryFunction implementation from the given FunctionNode.
          +
          +
          Parameters:
          +
          functionNode - the function node to deserialize.
          +
          Returns:
          +
          the created LibraryFunction implementation.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/FunctionNode.Builder.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/FunctionNode.Builder.html new file mode 100644 index 00000000000..82eac65dc82 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/FunctionNode.Builder.html @@ -0,0 +1,323 @@ + + + + + +FunctionNode.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions.functions
    +

    Class FunctionNode.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/FunctionNode.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/FunctionNode.html new file mode 100644 index 00000000000..569a7aeaba8 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/FunctionNode.html @@ -0,0 +1,550 @@ + + + + + +FunctionNode (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions.functions
    +

    Class FunctionNode

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.syntax.expressions.functions.FunctionNode
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          ofExpressions

          +
          public static FunctionNode ofExpressions​(java.lang.String functionName,
+                                         ToExpression... arguments)
          +
          Constructs a FunctionNode for the given function name and arguments.
          +
          +
          Parameters:
          +
          functionName - the function name.
          +
          arguments - zero or more expressions as arguments to the function.
          +
          Returns:
          +
          the FunctionNode.
          +
          +
          • +
        + + + +
          +
        • +

          ofExpressions

          +
          public static FunctionNode ofExpressions​(java.lang.String functionName,
+                                         FromSourceLocation sourceLocation,
+                                         ToExpression... arguments)
          +
          Constructs a FunctionNode for the given function name and arguments.
          +
          +
          Parameters:
          +
          functionName - the function name.
          +
          sourceLocation - the source location for the function.
          +
          arguments - zero or more expressions as arguments to the function.
          +
          Returns:
          +
          the FunctionNode.
          +
          +
          • +
        + + + +
          +
        • +

          builder

          +
          public static FunctionNode.Builder builder()
          +
          Returns a new builder instance.
          +
          +
          Returns:
          +
          the new builder instance.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          createFunction

          +
          public Expression createFunction()
          +
          Returns an expression representing this function.
          +
          +
          Returns:
          +
          this function as an expression.
          +
          +
          • +
        + + + +
          +
        • +

          getName

          +
          public java.lang.String getName()
          +
          Gets the name for the function described in this node.
          +
          +
          Returns:
          +
          the name for the function.
          +
          +
          • +
        + + + +
          +
        • +

          getArguments

          +
          public java.util.List<Expression> getArguments()
          +
          Gets the list of argument Expressions to the function described in this node.
          +
          +
          Returns:
          +
          the list of arguments.
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/GetAttr.Definition.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/GetAttr.Definition.html new file mode 100644 index 00000000000..6cb981879df --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/GetAttr.Definition.html @@ -0,0 +1,382 @@ + + + + + +GetAttr.Definition (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions.functions
    +

    Class GetAttr.Definition

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.syntax.expressions.functions.GetAttr.Definition
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/GetAttr.Part.Index.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/GetAttr.Part.Index.html new file mode 100644 index 00000000000..636addcd134 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/GetAttr.Part.Index.html @@ -0,0 +1,423 @@ + + + + + +GetAttr.Part.Index (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions.functions
    +

    Class GetAttr.Part.Index

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.syntax.expressions.functions.GetAttr.Part.Index
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      GetAttr.Part
      +
      +
      +
      Enclosing interface:
      +
      GetAttr.Part
      +
      +
      +
      public static final class GetAttr.Part.Index
+extends java.lang.Object
+implements GetAttr.Part
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Index​(int index) 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Index

          +
          public Index​(int index)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + +
          +
        • +

          index

          +
          public int index()
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object obj)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/GetAttr.Part.Key.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/GetAttr.Part.Key.html new file mode 100644 index 00000000000..3db7ec974e5 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/GetAttr.Part.Key.html @@ -0,0 +1,437 @@ + + + + + +GetAttr.Part.Key (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions.functions
    +

    Class GetAttr.Part.Key

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.syntax.expressions.functions.GetAttr.Part.Key
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      GetAttr.Part
      +
      +
      +
      Enclosing interface:
      +
      GetAttr.Part
      +
      +
      +
      public static final class GetAttr.Part.Key
+extends java.lang.Object
+implements GetAttr.Part
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + + + + + + + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object obj)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/GetAttr.Part.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/GetAttr.Part.html new file mode 100644 index 00000000000..c8b757dc6a5 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/GetAttr.Part.html @@ -0,0 +1,303 @@ + + + + + +GetAttr.Part (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions.functions
    +

    Interface GetAttr.Part

    +
    +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/GetAttr.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/GetAttr.html new file mode 100644 index 00000000000..78ab421fea5 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/GetAttr.html @@ -0,0 +1,670 @@ + + + + + +GetAttr (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions.functions
    +

    Class GetAttr

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          ofExpressions

          +
          public static GetAttr ofExpressions​(ToExpression arg1,
+                                    ToExpression arg2)
          +
          Creates a GetAttr function from the given expressions.
          +
          +
          Parameters:
          +
          arg1 - the argument to extract from.
          +
          arg2 - the path to extract.
          +
          Returns:
          +
          The resulting GetAttr function.
          +
          +
          • +
        + + + +
          +
        • +

          ofExpressions

          +
          public static GetAttr ofExpressions​(ToExpression arg1,
+                                    java.lang.String arg2)
          +
          Creates a GetAttr function from the given expressions.
          +
          +
          Parameters:
          +
          arg1 - the argument to extract from.
          +
          arg2 - the path to extract.
          +
          Returns:
          +
          The resulting GetAttr function.
          +
          +
          • +
        + + + +
          +
        • +

          evaluate

          +
          public Value evaluate​(Value target)
          +
          Gets the value at the defined path out of the target value.
          +
          +
          Parameters:
          +
          target - the target value to retrieve a value out of.
          +
          Returns:
          +
          the retrieve value.
          +
          +
          • +
        + + + +
          +
        • +

          getTarget

          +
          public Expression getTarget()
          +
          Gets the expression to retrieve an attribute of.
          +
          +
          Returns:
          +
          the expression targeted by this function.
          +
          +
          • +
        + + + +
          +
        • +

          getPath

          +
          public java.util.List<GetAttr.Part> getPath()
          +
          Gets the list of GetAttr.Parts that make up the path to the requested attribute.
          +
          +
          Returns:
          +
          the list of path parts to the requested attribute.
          +
          +
          • +
        + + + +
          +
        • +

          accept

          +
          public <R> R accept​(ExpressionVisitor<R> visitor)
          +
          Description copied from class: Expression
          +
          Invoke the ExpressionVisitor functions for this expression.
          +
          +
          Specified by:
          +
          accept in class Expression
          +
          Type Parameters:
          +
          R - the visitor return type.
          +
          Parameters:
          +
          visitor - the visitor to be invoked.
          +
          Returns:
          +
          the return value of the visitor.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          template

          +
          public java.lang.String template()
          +
          Description copied from class: SyntaxElement
          +
          Converts this expression to a string template. + By default, this implementation returns a RuntimeException.
          +
          +
          Overrides:
          +
          template in class SyntaxElement
          +
          Returns:
          +
          the String template.
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Overrides:
          +
          toNode in class LibraryFunction
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class LibraryFunction
          +
          +
          • +
        + + + + + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/IsSet.Definition.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/IsSet.Definition.html new file mode 100644 index 00000000000..32379ef1eec --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/IsSet.Definition.html @@ -0,0 +1,382 @@ + + + + + +IsSet.Definition (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions.functions
    +

    Class IsSet.Definition

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.syntax.expressions.functions.IsSet.Definition
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/IsSet.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/IsSet.html new file mode 100644 index 00000000000..46068068b14 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/IsSet.html @@ -0,0 +1,466 @@ + + + + + +IsSet (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions.functions
    +

    Class IsSet

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          ofExpressions

          +
          public static IsSet ofExpressions​(ToExpression arg1)
          +
          Creates a IsSet function from the given expressions.
          +
          +
          Parameters:
          +
          arg1 - the expression to negate.
          +
          Returns:
          +
          The resulting IsSet function.
          +
          +
          • +
        + + + +
          +
        • +

          accept

          +
          public <R> R accept​(ExpressionVisitor<R> visitor)
          +
          Description copied from class: Expression
          +
          Invoke the ExpressionVisitor functions for this expression.
          +
          +
          Specified by:
          +
          accept in class Expression
          +
          Type Parameters:
          +
          R - the visitor return type.
          +
          Parameters:
          +
          visitor - the visitor to be invoked.
          +
          Returns:
          +
          the return value of the visitor.
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/IsValidHostLabel.Definition.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/IsValidHostLabel.Definition.html new file mode 100644 index 00000000000..f933b6f97d4 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/IsValidHostLabel.Definition.html @@ -0,0 +1,382 @@ + + + + + +IsValidHostLabel.Definition (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions.functions
    +

    Class IsValidHostLabel.Definition

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.syntax.expressions.functions.IsValidHostLabel.Definition
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/IsValidHostLabel.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/IsValidHostLabel.html new file mode 100644 index 00000000000..22553fded18 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/IsValidHostLabel.html @@ -0,0 +1,477 @@ + + + + + +IsValidHostLabel (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions.functions
    +

    Class IsValidHostLabel

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/LibraryFunction.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/LibraryFunction.html new file mode 100644 index 00000000000..8d01081904a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/LibraryFunction.html @@ -0,0 +1,561 @@ + + + + + +LibraryFunction (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions.functions
    +

    Class LibraryFunction

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getName

          +
          public java.lang.String getName()
          +
          Returns the name of this function, eg. isSet, parseUrl
          +
          +
          Returns:
          +
          The name
          +
          +
          • +
        + + + +
          +
        • +

          getArguments

          +
          public java.util.List<Expression> getArguments()
          +
          +
          Returns:
          +
          The arguments to this function
          +
          +
          • +
        + + + +
          +
        • +

          expectOneArgument

          +
          protected Expression expectOneArgument()
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object obj)
          +
          +
          Specified by:
          +
          equals in class Expression
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Specified by:
          +
          hashCode in class Expression
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/Not.Definition.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/Not.Definition.html new file mode 100644 index 00000000000..cff4ffcb3d2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/Not.Definition.html @@ -0,0 +1,382 @@ + + + + + +Not.Definition (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions.functions
    +

    Class Not.Definition

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.syntax.expressions.functions.Not.Definition
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      +
      • +
    +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/Not.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/Not.html new file mode 100644 index 00000000000..76dabf55a89 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/Not.html @@ -0,0 +1,465 @@ + + + + + +Not (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions.functions
    +

    Class Not

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          ofExpressions

          +
          public static Not ofExpressions​(ToExpression arg1)
          +
          Creates a Not function from the given expressions.
          +
          +
          Parameters:
          +
          arg1 - the expression to negate.
          +
          Returns:
          +
          The resulting Not function.
          +
          +
          • +
        + + + +
          +
        • +

          accept

          +
          public <R> R accept​(ExpressionVisitor<R> visitor)
          +
          Description copied from class: Expression
          +
          Invoke the ExpressionVisitor functions for this expression.
          +
          +
          Specified by:
          +
          accept in class Expression
          +
          Type Parameters:
          +
          R - the visitor return type.
          +
          Parameters:
          +
          visitor - the visitor to be invoked.
          +
          Returns:
          +
          the return value of the visitor.
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/ParseUrl.Definition.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/ParseUrl.Definition.html new file mode 100644 index 00000000000..2b7bd38ccfb --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/ParseUrl.Definition.html @@ -0,0 +1,382 @@ + + + + + +ParseUrl.Definition (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions.functions
    +

    Class ParseUrl.Definition

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.syntax.expressions.functions.ParseUrl.Definition
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/ParseUrl.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/ParseUrl.html new file mode 100644 index 00000000000..5c7f0251249 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/ParseUrl.html @@ -0,0 +1,518 @@ + + + + + +ParseUrl (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions.functions
    +

    Class ParseUrl

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          ofExpressions

          +
          public static ParseUrl ofExpressions​(ToExpression arg1)
          +
          Creates a ParseUrl function from the given expressions.
          +
          +
          Parameters:
          +
          arg1 - the URI to parse.
          +
          Returns:
          +
          The resulting ParseUrl function.
          +
          +
          • +
        + + + +
          +
        • +

          accept

          +
          public <T> T accept​(ExpressionVisitor<T> visitor)
          +
          Description copied from class: Expression
          +
          Invoke the ExpressionVisitor functions for this expression.
          +
          +
          Specified by:
          +
          accept in class Expression
          +
          Type Parameters:
          +
          T - the visitor return type.
          +
          Parameters:
          +
          visitor - the visitor to be invoked.
          +
          Returns:
          +
          the return value of the visitor.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/StringEquals.Definition.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/StringEquals.Definition.html new file mode 100644 index 00000000000..c18c9c75415 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/StringEquals.Definition.html @@ -0,0 +1,382 @@ + + + + + +StringEquals.Definition (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions.functions
    +

    Class StringEquals.Definition

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.syntax.expressions.functions.StringEquals.Definition
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/StringEquals.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/StringEquals.html new file mode 100644 index 00000000000..9e94707b570 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/StringEquals.html @@ -0,0 +1,477 @@ + + + + + +StringEquals (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions.functions
    +

    Class StringEquals

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          ofExpressions

          +
          public static StringEquals ofExpressions​(ToExpression arg1,
+                                         ToExpression arg2)
          +
          Creates a StringEquals function from the given expressions.
          +
          +
          Parameters:
          +
          arg1 - the first argument to compare.
          +
          arg2 - the second argument to compare.
          +
          Returns:
          +
          The resulting StringEquals function.
          +
          +
          • +
        + + + +
          +
        • +

          ofExpressions

          +
          public static StringEquals ofExpressions​(ToExpression arg1,
+                                         java.lang.String arg2)
          +
          Creates a StringEquals function from the given expressions.
          +
          +
          Parameters:
          +
          arg1 - the first argument to compare.
          +
          arg2 - the second argument to compare.
          +
          Returns:
          +
          The resulting StringEquals function.
          +
          +
          • +
        + + + +
          +
        • +

          accept

          +
          public <R> R accept​(ExpressionVisitor<R> visitor)
          +
          Description copied from class: Expression
          +
          Invoke the ExpressionVisitor functions for this expression.
          +
          +
          Specified by:
          +
          accept in class Expression
          +
          Type Parameters:
          +
          R - the visitor return type.
          +
          Parameters:
          +
          visitor - the visitor to be invoked.
          +
          Returns:
          +
          the return value of the visitor.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/Substring.Definition.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/Substring.Definition.html new file mode 100644 index 00000000000..1ef14f924c5 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/Substring.Definition.html @@ -0,0 +1,382 @@ + + + + + +Substring.Definition (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions.functions
    +

    Class Substring.Definition

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.syntax.expressions.functions.Substring.Definition
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/Substring.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/Substring.html new file mode 100644 index 00000000000..906de3a35c1 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/Substring.html @@ -0,0 +1,489 @@ + + + + + +Substring (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions.functions
    +

    Class Substring

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          ofExpressions

          +
          public static Substring ofExpressions​(ToExpression expression,
+                                      ToExpression startIndex,
+                                      ToExpression stopIndex,
+                                      ToExpression reverse)
          +
          Creates a Substring function from the given expressions.
          +
          +
          Parameters:
          +
          expression - the string to extract from.
          +
          startIndex - the starting index.
          +
          stopIndex - the ending index.
          +
          reverse - the reverse order argument.
          +
          Returns:
          +
          The resulting Substring function.
          +
          +
          • +
        + + + +
          +
        • +

          ofExpressions

          +
          public static Substring ofExpressions​(ToExpression expression,
+                                      int startIndex,
+                                      int stopIndex,
+                                      boolean reverse)
          +
          Creates a Substring function from the given expressions.
          +
          +
          Parameters:
          +
          expression - the string to extract from.
          +
          startIndex - the starting index.
          +
          stopIndex - the ending index.
          +
          reverse - the reverse order argument.
          +
          Returns:
          +
          The resulting Substring function.
          +
          +
          • +
        + + + +
          +
        • +

          accept

          +
          public <T> T accept​(ExpressionVisitor<T> visitor)
          +
          Description copied from class: Expression
          +
          Invoke the ExpressionVisitor functions for this expression.
          +
          +
          Specified by:
          +
          accept in class Expression
          +
          Type Parameters:
          +
          T - the visitor return type.
          +
          Parameters:
          +
          visitor - the visitor to be invoked.
          +
          Returns:
          +
          the return value of the visitor.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/UriEncode.Definition.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/UriEncode.Definition.html new file mode 100644 index 00000000000..bf0ce0390e9 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/UriEncode.Definition.html @@ -0,0 +1,382 @@ + + + + + +UriEncode.Definition (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions.functions
    +

    Class UriEncode.Definition

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.syntax.expressions.functions.UriEncode.Definition
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/UriEncode.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/UriEncode.html new file mode 100644 index 00000000000..73ccc43b6fb --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/UriEncode.html @@ -0,0 +1,488 @@ + + + + + +UriEncode (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions.functions
    +

    Class UriEncode

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          UriEncode

          +
          public UriEncode​(FunctionNode functionNode)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          ofExpressions

          +
          public static UriEncode ofExpressions​(ToExpression arg1)
          +
          Creates a UriEncode function from the given expressions.
          +
          +
          Parameters:
          +
          arg1 - the value to URI encode.
          +
          Returns:
          +
          The resulting UriEncode function.
          +
          +
          • +
        + + + +
          +
        • +

          accept

          +
          public <T> T accept​(ExpressionVisitor<T> visitor)
          +
          Description copied from class: Expression
          +
          Invoke the ExpressionVisitor functions for this expression.
          +
          +
          Specified by:
          +
          accept in class Expression
          +
          Type Parameters:
          +
          T - the visitor return type.
          +
          Parameters:
          +
          visitor - the visitor to be invoked.
          +
          Returns:
          +
          the return value of the visitor.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/package-summary.html new file mode 100644 index 00000000000..d985cdbf6c4 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/package-summary.html @@ -0,0 +1,313 @@ + + + + + +software.amazon.smithy.rulesengine.language.syntax.expressions.functions (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.rulesengine.language.syntax.expressions.functions

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/package-tree.html new file mode 100644 index 00000000000..315b4db4fc5 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/package-tree.html @@ -0,0 +1,205 @@ + + + + + +software.amazon.smithy.rulesengine.language.syntax.expressions.functions Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.rulesengine.language.syntax.expressions.functions

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    +
      +
    • java.lang.Object +
        +
      • software.amazon.smithy.rulesengine.language.syntax.expressions.functions.BooleanEquals.Definition (implements software.amazon.smithy.rulesengine.language.syntax.expressions.functions.FunctionDefinition)
        • +
      • software.amazon.smithy.rulesengine.language.syntax.expressions.functions.FunctionNode (implements software.amazon.smithy.model.FromSourceLocation, software.amazon.smithy.model.node.ToNode, software.amazon.smithy.utils.ToSmithyBuilder<T>)
        • +
      • software.amazon.smithy.rulesengine.language.syntax.expressions.functions.GetAttr.Definition (implements software.amazon.smithy.rulesengine.language.syntax.expressions.functions.FunctionDefinition)
        • +
      • software.amazon.smithy.rulesengine.language.syntax.expressions.functions.GetAttr.Part.Index (implements software.amazon.smithy.rulesengine.language.syntax.expressions.functions.GetAttr.Part)
        • +
      • software.amazon.smithy.rulesengine.language.syntax.expressions.functions.GetAttr.Part.Key (implements software.amazon.smithy.rulesengine.language.syntax.expressions.functions.GetAttr.Part)
        • +
      • software.amazon.smithy.rulesengine.language.syntax.expressions.functions.IsSet.Definition (implements software.amazon.smithy.rulesengine.language.syntax.expressions.functions.FunctionDefinition)
        • +
      • software.amazon.smithy.rulesengine.language.syntax.expressions.functions.IsValidHostLabel.Definition (implements software.amazon.smithy.rulesengine.language.syntax.expressions.functions.FunctionDefinition)
        • +
      • software.amazon.smithy.rulesengine.language.syntax.expressions.functions.Not.Definition (implements software.amazon.smithy.rulesengine.language.syntax.expressions.functions.FunctionDefinition)
        • +
      • software.amazon.smithy.rulesengine.language.syntax.expressions.functions.ParseUrl.Definition (implements software.amazon.smithy.rulesengine.language.syntax.expressions.functions.FunctionDefinition)
        • +
      • software.amazon.smithy.rulesengine.language.RulesComponentBuilder<B,​T> (implements software.amazon.smithy.model.FromSourceLocation, software.amazon.smithy.utils.SmithyBuilder<T>) + +
        • +
      • software.amazon.smithy.rulesengine.language.syntax.expressions.functions.StringEquals.Definition (implements software.amazon.smithy.rulesengine.language.syntax.expressions.functions.FunctionDefinition)
        • +
      • software.amazon.smithy.rulesengine.language.syntax.expressions.functions.Substring.Definition (implements software.amazon.smithy.rulesengine.language.syntax.expressions.functions.FunctionDefinition)
        • +
      • software.amazon.smithy.rulesengine.language.syntax.SyntaxElement (implements software.amazon.smithy.rulesengine.language.syntax.ToCondition, software.amazon.smithy.rulesengine.language.syntax.ToExpression) +
          +
        • software.amazon.smithy.rulesengine.language.syntax.expressions.Expression (implements software.amazon.smithy.model.FromSourceLocation, software.amazon.smithy.model.node.ToNode, software.amazon.smithy.rulesengine.language.evaluation.TypeCheck) +
            +
          • software.amazon.smithy.rulesengine.language.syntax.expressions.functions.LibraryFunction +
              +
            • software.amazon.smithy.rulesengine.language.syntax.expressions.functions.BooleanEquals
              • +
            • software.amazon.smithy.rulesengine.language.syntax.expressions.functions.GetAttr
              • +
            • software.amazon.smithy.rulesengine.language.syntax.expressions.functions.IsSet
              • +
            • software.amazon.smithy.rulesengine.language.syntax.expressions.functions.IsValidHostLabel
              • +
            • software.amazon.smithy.rulesengine.language.syntax.expressions.functions.Not
              • +
            • software.amazon.smithy.rulesengine.language.syntax.expressions.functions.ParseUrl
              • +
            • software.amazon.smithy.rulesengine.language.syntax.expressions.functions.StringEquals
              • +
            • software.amazon.smithy.rulesengine.language.syntax.expressions.functions.Substring
              • +
            • software.amazon.smithy.rulesengine.language.syntax.expressions.functions.UriEncode
              • +
            +
            • +
          +
          • +
        +
        • +
      • software.amazon.smithy.rulesengine.language.syntax.expressions.functions.UriEncode.Definition (implements software.amazon.smithy.rulesengine.language.syntax.expressions.functions.FunctionDefinition)
        • +
      +
      • +
    +
    +
    +

    Interface Hierarchy

    +
      +
    • software.amazon.smithy.rulesengine.language.syntax.expressions.functions.FunctionDefinition
      • +
    • software.amazon.smithy.rulesengine.language.syntax.expressions.functions.GetAttr.Part
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/literal/BooleanLiteral.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/literal/BooleanLiteral.html new file mode 100644 index 00000000000..c8bc2a33622 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/literal/BooleanLiteral.html @@ -0,0 +1,431 @@ + + + + + +BooleanLiteral (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions.literal
    +

    Class BooleanLiteral

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          value

          +
          public BooleanNode value()
          +
          Gets the BooleanNode value of this literal.
          +
          +
          Returns:
          +
          the literal's value node.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          asBooleanLiteral

          +
          public java.util.Optional<java.lang.Boolean> asBooleanLiteral()
          +
          +
          Overrides:
          +
          asBooleanLiteral in class Literal
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object obj)
          +
          +
          Specified by:
          +
          equals in class Expression
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Specified by:
          +
          hashCode in class Expression
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/literal/IntegerLiteral.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/literal/IntegerLiteral.html new file mode 100644 index 00000000000..2bef9f65582 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/literal/IntegerLiteral.html @@ -0,0 +1,410 @@ + + + + + +IntegerLiteral (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions.literal
    +

    Class IntegerLiteral

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          asIntegerLiteral

          +
          public java.util.Optional<java.lang.Integer> asIntegerLiteral()
          +
          +
          Overrides:
          +
          asIntegerLiteral in class Literal
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Specified by:
          +
          equals in class Expression
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Specified by:
          +
          hashCode in class Expression
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/literal/Literal.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/literal/Literal.html new file mode 100644 index 00000000000..2b3d2cdcbe4 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/literal/Literal.html @@ -0,0 +1,588 @@ + + + + + +Literal (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions.literal
    +

    Class Literal

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          booleanLiteral

          +
          public static Literal booleanLiteral​(boolean value)
          +
          Constructs a bool literal from a boolean value.
          +
          +
          Parameters:
          +
          value - the boolean value.
          +
          Returns:
          +
          the bool literal.
          +
          +
          • +
        + + + +
          +
        • +

          integerLiteral

          +
          public static Literal integerLiteral​(int value)
          +
          Constructs an integer literal from an integer value.
          +
          +
          Parameters:
          +
          value - the integer value.
          +
          Returns:
          +
          the integer literal.
          +
          +
          • +
        + + + +
          +
        • +

          recordLiteral

          +
          public static Literal recordLiteral​(java.util.Map<Identifier,​Literal> record)
          +
          Constructs a record literal of values.
          +
          +
          Parameters:
          +
          record - a map of values to be converted to a record.
          +
          Returns:
          +
          the record literal.
          +
          +
          • +
        + + + +
          +
        • +

          stringLiteral

          +
          public static Literal stringLiteral​(Template value)
          +
          Constructs a string literal from a Template value.
          +
          +
          Parameters:
          +
          value - the template value.
          +
          Returns:
          +
          the string literal.
          +
          +
          • +
        + + + +
          +
        • +

          tupleLiteral

          +
          public static Literal tupleLiteral​(java.util.List<Literal> values)
          +
          Constructs a tuple literal of values.
          +
          +
          Parameters:
          +
          values - the values.
          +
          Returns:
          +
          the tuple literal.
          +
          +
          • +
        + + + +
          +
        • +

          asBooleanLiteral

          +
          public java.util.Optional<java.lang.Boolean> asBooleanLiteral()
          +
          • +
        + + + +
          +
        • +

          asIntegerLiteral

          +
          public java.util.Optional<java.lang.Integer> asIntegerLiteral()
          +
          • +
        + + + +
          +
        • +

          asRecordLiteral

          +
          public java.util.Optional<java.util.Map<Identifier,​Literal>> asRecordLiteral()
          +
          • +
        + + + +
          +
        • +

          asStringLiteral

          +
          public java.util.Optional<Template> asStringLiteral()
          +
          • +
        + + + +
          +
        • +

          asTupleLiteral

          +
          public java.util.Optional<java.util.List<Literal>> asTupleLiteral()
          +
          • +
        + + + +
          +
        • +

          accept

          +
          public <R> R accept​(ExpressionVisitor<R> visitor)
          +
          Description copied from class: Expression
          +
          Invoke the ExpressionVisitor functions for this expression.
          +
          +
          Specified by:
          +
          accept in class Expression
          +
          Type Parameters:
          +
          R - the visitor return type.
          +
          Parameters:
          +
          visitor - the visitor to be invoked.
          +
          Returns:
          +
          the return value of the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          accept

          +
          public abstract <T> T accept​(LiteralVisitor<T> visitor)
          +
          • +
        + + + +
          +
        • +

          fromNode

          +
          public static Literal fromNode​(Node node)
          +
          Constructs a literal from a Node based on the Node's type.
          +
          +
          Parameters:
          +
          node - a node to construct as a literal.
          +
          Returns:
          +
          the literal representation of the node.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          evaluate

          +
          public Value evaluate​(RuleEvaluator evaluator)
          +
          +
          Parameters:
          +
          evaluator - the rule-set evaluator.
          +
          Returns:
          +
          the resulting value.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/literal/LiteralVisitor.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/literal/LiteralVisitor.html new file mode 100644 index 00000000000..d3d81b0a593 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/literal/LiteralVisitor.html @@ -0,0 +1,354 @@ + + + + + +LiteralVisitor (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions.literal
    +

    Interface LiteralVisitor<T>

    +
    +
    +
    +
      +
    • +
      +
      Type Parameters:
      +
      T - the return type of the visitor.
      +
      +
      +
      public interface LiteralVisitor<T>
      +
      Literal visitor interface.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          visitBoolean

          +
          T visitBoolean​(boolean b)
          +
          Visits a boolean literal.
          +
          +
          Parameters:
          +
          b - the boolean literal value.
          +
          Returns:
          +
          the value from the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          visitString

          +
          T visitString​(Template value)
          +
          Visits a string literal.
          +
          +
          Parameters:
          +
          value - the template value.
          +
          Returns:
          +
          the value from the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          visitRecord

          +
          T visitRecord​(java.util.Map<Identifier,​Literal> members)
          +
          Visits a record literal.
          +
          +
          Parameters:
          +
          members - the map of keys to literal values.
          +
          Returns:
          +
          the value from the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          visitTuple

          +
          T visitTuple​(java.util.List<Literal> members)
          +
          Visits a tuple literal.
          +
          +
          Parameters:
          +
          members - the list of literal values.
          +
          Returns:
          +
          the value from the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          visitInteger

          +
          T visitInteger​(int value)
          +
          Visits a integer literal.
          +
          +
          Parameters:
          +
          value - the value literal value.
          +
          Returns:
          +
          the value from the visitor.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/literal/RecordLiteral.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/literal/RecordLiteral.html new file mode 100644 index 00000000000..60abbadaebb --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/literal/RecordLiteral.html @@ -0,0 +1,431 @@ + + + + + +RecordLiteral (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions.literal
    +

    Class RecordLiteral

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          members

          +
          public java.util.Map<Identifier,​Literal> members()
          +
          Gets the map of identifiers to literals contained within this record.
          +
          +
          Returns:
          +
          the map of identifiers to literals.
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Specified by:
          +
          hashCode in class Expression
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object obj)
          +
          +
          Specified by:
          +
          equals in class Expression
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/literal/StringLiteral.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/literal/StringLiteral.html new file mode 100644 index 00000000000..139bb4bf14b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/literal/StringLiteral.html @@ -0,0 +1,431 @@ + + + + + +StringLiteral (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions.literal
    +

    Class StringLiteral

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          value

          +
          public Template value()
          +
          Gets the template for this literal value.
          +
          +
          Returns:
          +
          the literal's value template.
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Specified by:
          +
          hashCode in class Expression
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object obj)
          +
          +
          Specified by:
          +
          equals in class Expression
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/literal/TupleLiteral.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/literal/TupleLiteral.html new file mode 100644 index 00000000000..0e1c7c8b8bd --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/literal/TupleLiteral.html @@ -0,0 +1,431 @@ + + + + + +TupleLiteral (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.expressions.literal
    +

    Class TupleLiteral

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          members

          +
          public java.util.List<Literal> members()
          +
          Gets the list of literals contained within this tuple.
          +
          +
          Returns:
          +
          the list of literals.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          asTupleLiteral

          +
          public java.util.Optional<java.util.List<Literal>> asTupleLiteral()
          +
          +
          Overrides:
          +
          asTupleLiteral in class Literal
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Specified by:
          +
          hashCode in class Expression
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object obj)
          +
          +
          Specified by:
          +
          equals in class Expression
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/literal/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/literal/package-summary.html new file mode 100644 index 00000000000..a5e7ec500b0 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/literal/package-summary.html @@ -0,0 +1,213 @@ + + + + + +software.amazon.smithy.rulesengine.language.syntax.expressions.literal (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.rulesengine.language.syntax.expressions.literal

    +
    +
    +
      +
    • + + + + + + + + + + + + +
      Interface Summary 
      InterfaceDescription
      LiteralVisitor<T> +
      Literal visitor interface.
      +
      +
      • +
    • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      BooleanLiteral +
      A boolean literal value, containing true or false.
      +
      IntegerLiteral +
      An integer literal value, containing integer values greater than or equal to 0.
      +
      Literal +
      Literals allow rules and properties to define arbitrarily nested JSON structures (e.g.for properties)
      +
      RecordLiteral +
      A record literal value, containing a map of identifiers to other literals.
      +
      StringLiteral +
      A string literal value, containing a template.
      +
      TupleLiteral +
      A tuple value, containing a list of other literals.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/literal/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/literal/package-tree.html new file mode 100644 index 00000000000..637c9e948a8 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/literal/package-tree.html @@ -0,0 +1,183 @@ + + + + + +software.amazon.smithy.rulesengine.language.syntax.expressions.literal Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.rulesengine.language.syntax.expressions.literal

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    +
      +
    • java.lang.Object +
        +
      • software.amazon.smithy.rulesengine.language.syntax.SyntaxElement (implements software.amazon.smithy.rulesengine.language.syntax.ToCondition, software.amazon.smithy.rulesengine.language.syntax.ToExpression) +
          +
        • software.amazon.smithy.rulesengine.language.syntax.expressions.Expression (implements software.amazon.smithy.model.FromSourceLocation, software.amazon.smithy.model.node.ToNode, software.amazon.smithy.rulesengine.language.evaluation.TypeCheck) +
            +
          • software.amazon.smithy.rulesengine.language.syntax.expressions.literal.Literal +
              +
            • software.amazon.smithy.rulesengine.language.syntax.expressions.literal.BooleanLiteral
              • +
            • software.amazon.smithy.rulesengine.language.syntax.expressions.literal.IntegerLiteral
              • +
            • software.amazon.smithy.rulesengine.language.syntax.expressions.literal.RecordLiteral
              • +
            • software.amazon.smithy.rulesengine.language.syntax.expressions.literal.StringLiteral
              • +
            • software.amazon.smithy.rulesengine.language.syntax.expressions.literal.TupleLiteral
              • +
            +
            • +
          +
          • +
        +
        • +
      +
      • +
    +
    +
    +

    Interface Hierarchy

    +
      +
    • software.amazon.smithy.rulesengine.language.syntax.expressions.literal.LiteralVisitor<T>
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/package-summary.html new file mode 100644 index 00000000000..6b6bfd6740e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/package-summary.html @@ -0,0 +1,217 @@ + + + + + +software.amazon.smithy.rulesengine.language.syntax.expressions (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.rulesengine.language.syntax.expressions

    +
    +
    +
      +
    • + + + + + + + + + + + + + + + + + + + + +
      Interface Summary 
      InterfaceDescription
      ExpressionVisitor<R> +
      Expression visitor pattern.
      +
      Template.Part +
      An interface for parts of a template that can be visited.
      +
      TemplateVisitor<T> +
      For code generating from a template, use a `TemplateVisitor`.
      +
      +
      • +
    • + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      Expression +
      A dynamically computed expression.
      +
      ExpressionVisitor.Default<R> 
      Reference +
      A reference to a field.
      +
      Template +
      Template represents a "Template Literal".
      +
      Template.Literal +
      A static template value part.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/package-tree.html new file mode 100644 index 00000000000..c031f953409 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/expressions/package-tree.html @@ -0,0 +1,184 @@ + + + + + +software.amazon.smithy.rulesengine.language.syntax.expressions Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.rulesengine.language.syntax.expressions

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    +
      +
    • java.lang.Object +
        +
      • software.amazon.smithy.rulesengine.language.syntax.expressions.ExpressionVisitor.Default<R> (implements software.amazon.smithy.rulesengine.language.syntax.expressions.ExpressionVisitor<R>)
        • +
      • software.amazon.smithy.rulesengine.language.syntax.SyntaxElement (implements software.amazon.smithy.rulesengine.language.syntax.ToCondition, software.amazon.smithy.rulesengine.language.syntax.ToExpression) +
          +
        • software.amazon.smithy.rulesengine.language.syntax.expressions.Expression (implements software.amazon.smithy.model.FromSourceLocation, software.amazon.smithy.model.node.ToNode, software.amazon.smithy.rulesengine.language.evaluation.TypeCheck) +
            +
          • software.amazon.smithy.rulesengine.language.syntax.expressions.Reference
            • +
          +
          • +
        +
        • +
      • software.amazon.smithy.rulesengine.language.syntax.expressions.Template (implements software.amazon.smithy.model.FromSourceLocation, software.amazon.smithy.model.node.ToNode)
        • +
      • software.amazon.smithy.rulesengine.language.syntax.expressions.Template.Literal (implements software.amazon.smithy.rulesengine.language.syntax.expressions.Template.Part)
        • +
      +
      • +
    +
    +
    +

    Interface Hierarchy

    +
      +
    • software.amazon.smithy.rulesengine.language.syntax.expressions.ExpressionVisitor<R>
      • +
    • software.amazon.smithy.rulesengine.language.syntax.expressions.TemplateVisitor<T>
      • +
    • software.amazon.smithy.rulesengine.language.evaluation.TypeCheck +
        +
      • software.amazon.smithy.rulesengine.language.syntax.expressions.Template.Part
        • +
      +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/package-summary.html new file mode 100644 index 00000000000..eaf2cea454d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/package-summary.html @@ -0,0 +1,198 @@ + + + + + +software.amazon.smithy.rulesengine.language.syntax (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.rulesengine.language.syntax

    +
    +
    +
      +
    • + + + + + + + + + + + + + + + + +
      Interface Summary 
      InterfaceDescription
      ToCondition +
      Supplies functionality to be coercible into Conditions for + use in composing rule-sets in code.
      +
      ToExpression +
      Supplies functionality to be coercible into Expressions for + use in composing rule-sets in code.
      +
      +
      • +
    • + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      Identifier +
      A name used to identify a component of a rule-set.
      +
      SyntaxElement +
      A class that is coercible into Conditions and Expressions for + use in composing rule-sets in code.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/package-tree.html new file mode 100644 index 00000000000..4d207883590 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/package-tree.html @@ -0,0 +1,169 @@ + + + + + +software.amazon.smithy.rulesengine.language.syntax Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.rulesengine.language.syntax

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    +
      +
    • java.lang.Object +
        +
      • software.amazon.smithy.rulesengine.language.syntax.Identifier (implements software.amazon.smithy.model.FromSourceLocation, software.amazon.smithy.model.node.ToNode)
        • +
      • software.amazon.smithy.rulesengine.language.syntax.SyntaxElement (implements software.amazon.smithy.rulesengine.language.syntax.ToCondition, software.amazon.smithy.rulesengine.language.syntax.ToExpression)
        • +
      +
      • +
    +
    +
    +

    Interface Hierarchy

    +
      +
    • software.amazon.smithy.rulesengine.language.syntax.ToCondition
      • +
    • software.amazon.smithy.rulesengine.language.syntax.ToExpression
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/parameters/BuiltIns.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/parameters/BuiltIns.html new file mode 100644 index 00000000000..c9263d582fd --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/parameters/BuiltIns.html @@ -0,0 +1,272 @@ + + + + + +BuiltIns (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.parameters
    +

    Class BuiltIns

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.syntax.parameters.BuiltIns
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class BuiltIns
+extends java.lang.Object
      +
      Built-in parameters for EndpointRules.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        static ParameterSDK_ENDPOINT +
        Built-in parameter that enables a customer to wholesale override the URL used by the SDK.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Field Detail

        + + + +
          +
        • +

          SDK_ENDPOINT

          +
          public static final Parameter SDK_ENDPOINT
          +
          Built-in parameter that enables a customer to wholesale override the URL used by the SDK.
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/parameters/Deprecated.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/parameters/Deprecated.html new file mode 100644 index 00000000000..b96872f7d31 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/parameters/Deprecated.html @@ -0,0 +1,399 @@ + + + + + +Deprecated (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.parameters
    +

    Class Deprecated

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.syntax.parameters.Deprecated
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ToNode
      +
      +
      +
      public final class Deprecated
+extends java.lang.Object
+implements ToNode
      +
      Container for information on a deprecated parameter.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        booleanequals​(java.lang.Object obj) 
        static DeprecatedfromNode​(ObjectNode objectNode) +
        Creates a Deprecated of a specific type from the given Node information.
        +
        java.util.Optional<java.lang.String>getMessage() +
        Gets the deprecation message value.
        +
        java.util.Optional<java.lang.String>getSince() +
        Gets the deprecated since value.
        +
        inthashCode() 
        NodetoNode() +
        Converts a value to a Node.
        +
        java.lang.StringtoString() 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          fromNode

          +
          public static Deprecated fromNode​(ObjectNode objectNode)
          +
          Creates a Deprecated of a specific type from the given Node information.
          +
          +
          Parameters:
          +
          objectNode - the node to deserialize.
          +
          Returns:
          +
          the created Deprecated.
          +
          +
          • +
        + + + +
          +
        • +

          getMessage

          +
          public java.util.Optional<java.lang.String> getMessage()
          +
          Gets the deprecation message value.
          +
          +
          Returns:
          +
          returns the optional deprecation message value.
          +
          +
          • +
        + + + +
          +
        • +

          getSince

          +
          public java.util.Optional<java.lang.String> getSince()
          +
          Gets the deprecated since value.
          +
          +
          Returns:
          +
          returns the optional deprecated since value.
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object obj)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/parameters/Parameter.Builder.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/parameters/Parameter.Builder.html new file mode 100644 index 00000000000..355d72f7d80 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/parameters/Parameter.Builder.html @@ -0,0 +1,475 @@ + + + + + +Parameter.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.parameters
    +

    Class Parameter.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/parameters/Parameter.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/parameters/Parameter.html new file mode 100644 index 00000000000..39359078bad --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/parameters/Parameter.html @@ -0,0 +1,882 @@ + + + + + +Parameter (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.parameters
    +

    Class Parameter

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          fromNode

          +
          public static Parameter fromNode​(StringNode name,
+                                 ObjectNode objectNode)
+                          throws RuleError
          +
          Creates a Parameter instance from the given Node information.
          +
          +
          Parameters:
          +
          name - the name of the parameter being deserialized.
          +
          objectNode - the node to deserialize.
          +
          Returns:
          +
          the created Parameter.
          +
          Throws:
          +
          RuleError
          +
          +
          • +
        + + + +
          +
        • +

          builder

          +
          public static Parameter.Builder builder()
          +
          Builder to create a Parameter instance.
          +
          +
          Returns:
          +
          returns a new Builder.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getName

          +
          public Identifier getName()
          +
          Gets the parameter name.
          +
          +
          Returns:
          +
          returns the parameter name as an Identifier.
          +
          +
          • +
        + + + +
          +
        • +

          getTemplate

          +
          public java.lang.String getTemplate()
          +
          Gets the parameter in template form.
          +
          +
          Returns:
          +
          returns the template form of the parameter.
          +
          +
          • +
        + + + +
          +
        • +

          template

          +
          public java.lang.String template()
          +
          Description copied from class: SyntaxElement
          +
          Converts this expression to a string template. + By default, this implementation returns a RuntimeException.
          +
          +
          Overrides:
          +
          template in class SyntaxElement
          +
          Returns:
          +
          the String template.
          +
          +
          • +
        + + + +
          +
        • +

          isRequired

          +
          public boolean isRequired()
          +
          Gets if the parameter is required or not.
          +
          +
          Returns:
          +
          true if the parameter is required, false otherwise.
          +
          +
          • +
        + + + +
          +
        • +

          getType

          +
          public ParameterType getType()
          +
          Gets the documentation value.
          +
          +
          Returns:
          +
          returns the optional documentation value.
          +
          +
          • +
        + + + +
          +
        • +

          toType

          +
          public Type toType()
          +
          Gets a Type for the parameter's type.
          +
          +
          Returns:
          +
          a Type for the parameter.
          +
          +
          • +
        + + + +
          +
        • +

          getBuiltIn

          +
          public java.util.Optional<java.lang.String> getBuiltIn()
          +
          Gets the built-in parameter name.
          +
          +
          Returns:
          +
          returns the optional built-in parameter name.
          +
          +
          • +
        + + + +
          +
        • +

          isBuiltIn

          +
          public boolean isBuiltIn()
          +
          Gets if the parameter uses a built-in parameter.
          +
          +
          Returns:
          +
          returns true if the parameter uses a built-in, false otherwise.
          +
          +
          • +
        + + + +
          +
        • +

          getDeprecated

          +
          public java.util.Optional<Deprecated> getDeprecated()
          +
          Gets the deprecated status.
          +
          +
          Returns:
          +
          returns the optional deprecated state.
          +
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public java.util.Optional<Value> getValue()
          +
          Gets the parameter's value.
          +
          +
          Returns:
          +
          returns the optional value.
          +
          +
          • +
        + + + +
          +
        • +

          getDocumentation

          +
          public java.util.Optional<java.lang.String> getDocumentation()
          +
          Gets the documentation value.
          +
          +
          Returns:
          +
          returns the optional documentation value.
          +
          +
          • +
        + + + +
          +
        • +

          getDefault

          +
          public java.util.Optional<Value> getDefault()
          +
          Gets the parameter's default value.
          +
          +
          Returns:
          +
          returns the optional default value.
          +
          +
          • +
        + + + +
          +
        • +

          toConditionBuilder

          +
          public Condition.Builder toConditionBuilder()
          +
          Description copied from interface: ToCondition
          +
          Convert this into a condition builder for compositional use.
          +
          +
          Specified by:
          +
          toConditionBuilder in interface ToCondition
          +
          Returns:
          +
          the condition builder.
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/parameters/ParameterType.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/parameters/ParameterType.html new file mode 100644 index 00000000000..8e8fd62c365 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/parameters/ParameterType.html @@ -0,0 +1,503 @@ + + + + + +ParameterType (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.parameters
    +

    Enum ParameterType

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Enum<ParameterType>
        • +
      • +
          +
        • software.amazon.smithy.rulesengine.language.syntax.parameters.ParameterType
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable, java.lang.Comparable<ParameterType>
      +
      +
      +
      public enum ParameterType
+extends java.lang.Enum<ParameterType>
      +
      The types that parameters can be.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + +
          +
        • +

          STRING

          +
          public static final ParameterType STRING
          +
          A "string" parameter type.
          +
          • +
        + + + +
          +
        • +

          BOOLEAN

          +
          public static final ParameterType BOOLEAN
          +
          A "boolean" parameter type.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static ParameterType[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (ParameterType c : ParameterType.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static ParameterType valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          fromNode

          +
          public static ParameterType fromNode​(StringNode node)
+                              throws RuleError
          +
          Creates a ParameterType of a specific type from the given Node information.
          +
          +
          Parameters:
          +
          node - the node to deserialize.
          +
          Returns:
          +
          the created ParameterType.
          +
          Throws:
          +
          RuleError - when the value is not a valid ParameterType.
          +
          +
          • +
        + + + +
          +
        • +

          fromNode

          +
          public static ParameterType fromNode​(Node node)
+                              throws RuleError
          +
          Creates a ParameterType of a specific type from the given Node type.
          +
          +
          Parameters:
          +
          node - the node to deserialize.
          +
          Returns:
          +
          the created ParameterType.
          +
          Throws:
          +
          RuleError - when the node would not create a valid ParameterType.
          +
          +
          • +
        + + + +
          +
        • +

          fromType

          +
          public static ParameterType fromType​(Type type)
          +
          Creates a ParameterType of a specific type from the given parameter Type.
          +
          +
          Parameters:
          +
          type - the Type to create from.
          +
          Returns:
          +
          the created ParameterType.
          +
          Throws:
          +
          java.lang.RuntimeException - when the value would not create a valid ParameterType.
          +
          +
          • +
        + + + +
          +
        • +

          fromShapeType

          +
          public static ParameterType fromShapeType​(ShapeType type)
          +
          Creates a ParameterType of a specific type from the given ShapeType.
          +
          +
          Parameters:
          +
          type - the ShapeType to create from.
          +
          Returns:
          +
          the created ParameterType.
          +
          Throws:
          +
          java.lang.RuntimeException - when the value would not create a valid ParameterType.
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Enum<ParameterType>
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/parameters/Parameters.Builder.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/parameters/Parameters.Builder.html new file mode 100644 index 00000000000..2d6f8f76cff --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/parameters/Parameters.Builder.html @@ -0,0 +1,349 @@ + + + + + +Parameters.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.parameters
    +

    Class Parameters.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          build

          +
          public Parameters build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/parameters/Parameters.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/parameters/Parameters.html new file mode 100644 index 00000000000..38530ac7347 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/parameters/Parameters.html @@ -0,0 +1,552 @@ + + + + + +Parameters (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.parameters
    +

    Class Parameters

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.syntax.parameters.Parameters
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          builder

          +
          public static Parameters.Builder builder()
          +
          Builder to create a Parameters instance.
          +
          +
          Returns:
          +
          returns a new Builder.
          +
          +
          • +
        + + + +
          +
        • +

          fromNode

          +
          public static Parameters fromNode​(ObjectNode node)
+                           throws RuleError
          +
          Creates a Parameters instance from the given Node information.
          +
          +
          Parameters:
          +
          node - the node to deserialize.
          +
          Returns:
          +
          the created Parameters.
          +
          Throws:
          +
          RuleError
          +
          +
          • +
        + + + +
          +
        • +

          writeToScope

          +
          public void writeToScope​(Scope<Type> scope)
          +
          Writes the parameters in this collection to the given scope.
          +
          +
          Parameters:
          +
          scope - the scope
          +
          +
          • +
        + + + + + + + +
          +
        • +

          get

          +
          public java.util.Optional<Parameter> get​(Identifier name)
          +
          Gets the parameter for the given name.
          +
          +
          Returns:
          +
          returns an optional containing the parameter if present, empty otherwise.
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          iterator

          +
          public java.util.Iterator<Parameter> iterator()
          +
          +
          Specified by:
          +
          iterator in interface java.lang.Iterable<Parameter>
          +
          +
          • +
        + + + +
          +
        • +

          forEach

          +
          public void forEach​(java.util.function.Consumer<? super Parameter> action)
          +
          +
          Specified by:
          +
          forEach in interface java.lang.Iterable<Parameter>
          +
          +
          • +
        + + + +
          +
        • +

          spliterator

          +
          public java.util.Spliterator<Parameter> spliterator()
          +
          +
          Specified by:
          +
          spliterator in interface java.lang.Iterable<Parameter>
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/parameters/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/parameters/package-summary.html new file mode 100644 index 00000000000..0d19d7ad3d0 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/parameters/package-summary.html @@ -0,0 +1,213 @@ + + + + + +software.amazon.smithy.rulesengine.language.syntax.parameters (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.rulesengine.language.syntax.parameters

    +
    +
    +
      +
    • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      BuiltIns +
      Built-in parameters for EndpointRules.
      +
      Deprecated +
      Container for information on a deprecated parameter.
      +
      Parameter +
      A rule-set parameter, representing a value usable in conditions and rules.
      +
      Parameter.Builder +
      A builder used to create a Parameter class.
      +
      Parameters +
      An iterable container for Parameters defined in a rule-set.
      +
      Parameters.Builder +
      A builder used to create a Parameters class.
      +
      +
      • +
    • + + + + + + + + + + + + +
      Enum Summary 
      EnumDescription
      ParameterType +
      The types that parameters can be.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/parameters/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/parameters/package-tree.html new file mode 100644 index 00000000000..858cc98cd4a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/parameters/package-tree.html @@ -0,0 +1,188 @@ + + + + + +software.amazon.smithy.rulesengine.language.syntax.parameters Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.rulesengine.language.syntax.parameters

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    +
      +
    • java.lang.Object +
        +
      • software.amazon.smithy.rulesengine.language.syntax.parameters.BuiltIns
        • +
      • software.amazon.smithy.rulesengine.language.syntax.parameters.Deprecated (implements software.amazon.smithy.model.node.ToNode)
        • +
      • software.amazon.smithy.rulesengine.language.syntax.parameters.Parameters (implements software.amazon.smithy.model.FromSourceLocation, java.lang.Iterable<T>, software.amazon.smithy.model.node.ToNode, software.amazon.smithy.utils.ToSmithyBuilder<T>)
        • +
      • software.amazon.smithy.rulesengine.language.RulesComponentBuilder<B,​T> (implements software.amazon.smithy.model.FromSourceLocation, software.amazon.smithy.utils.SmithyBuilder<T>) + +
        • +
      • software.amazon.smithy.rulesengine.language.syntax.SyntaxElement (implements software.amazon.smithy.rulesengine.language.syntax.ToCondition, software.amazon.smithy.rulesengine.language.syntax.ToExpression) + +
        • +
      +
      • +
    +
    +
    +

    Enum Hierarchy

    +
      +
    • java.lang.Object +
        +
      • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) +
          +
        • software.amazon.smithy.rulesengine.language.syntax.parameters.ParameterType
          • +
        +
        • +
      +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/Condition.Builder.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/Condition.Builder.html new file mode 100644 index 00000000000..6f59aafeb6b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/Condition.Builder.html @@ -0,0 +1,368 @@ + + + + + +Condition.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.rule
    +

    Class Condition.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.syntax.rule.Condition.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/Condition.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/Condition.html new file mode 100644 index 00000000000..01d5066eb25 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/Condition.html @@ -0,0 +1,647 @@ + + + + + +Condition (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.rule
    +

    Class Condition

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          builder

          +
          public static Condition.Builder builder()
          +
          Builder to create a Condition instance.
          +
          +
          Returns:
          +
          returns a new Builder.
          +
          +
          • +
        + + + +
          +
        • +

          fromNode

          +
          public static Condition fromNode​(Node node)
          +
          Constructs a condition from the given node.
          +
          +
          Parameters:
          +
          node - the node.
          +
          Returns:
          +
          the condition instance.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getResult

          +
          public java.util.Optional<Identifier> getResult()
          +
          Get the identifier of the parameter that the result is assigned to.
          +
          +
          Returns:
          +
          the optional identifier.
          +
          +
          • +
        + + + +
          +
        • +

          getFunction

          +
          public Expression getFunction()
          +
          Gets the function used to express this condition.
          +
          +
          Returns:
          +
          the function for this condition.
          +
          +
          • +
        + + + +
          +
        • +

          toConditionBuilder

          +
          public Condition.Builder toConditionBuilder()
          +
          Description copied from interface: ToCondition
          +
          Convert this into a condition builder for compositional use.
          +
          +
          Specified by:
          +
          toConditionBuilder in interface ToCondition
          +
          Returns:
          +
          the condition builder.
          +
          +
          • +
        + + + +
          +
        • +

          toCondition

          +
          public Condition toCondition()
          +
          Description copied from interface: ToCondition
          +
          Convert this into a condition.
          +
          +
          Specified by:
          +
          toCondition in interface ToCondition
          +
          Returns:
          +
          the condition.
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          typeCheck

          +
          public Type typeCheck​(Scope<Type> scope)
          +
          Description copied from interface: TypeCheck
          +
          Checks whether the given types within a scope satisfy the constraints.
          +
          +
          Specified by:
          +
          typeCheck in interface TypeCheck
          +
          Parameters:
          +
          scope - the scope to evaluate.
          +
          Returns:
          +
          the type validated by the scope check.
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/EndpointRule.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/EndpointRule.html new file mode 100644 index 00000000000..4de246a50bd --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/EndpointRule.html @@ -0,0 +1,422 @@ + + + + + +EndpointRule (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.rule
    +

    Class EndpointRule

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getEndpoint

          +
          public Endpoint getEndpoint()
          +
          Retrieves the resolved endpoint description.
          +
          +
          Returns:
          +
          the endpoint.
          +
          +
          • +
        + + + +
          +
        • +

          accept

          +
          public <T> T accept​(RuleValueVisitor<T> visitor)
          +
          Description copied from class: Rule
          +
          Invoke the RuleValueVisitor functions for this Rule.
          +
          +
          Specified by:
          +
          accept in class Rule
          +
          Type Parameters:
          +
          T - the visitor return type.
          +
          Parameters:
          +
          visitor - the visitor to be invoked.
          +
          Returns:
          +
          the return value of the visitor.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class Rule
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class Rule
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class Rule
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/ErrorRule.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/ErrorRule.html new file mode 100644 index 00000000000..33abbeb9561 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/ErrorRule.html @@ -0,0 +1,428 @@ + + + + + +ErrorRule (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.rule
    +

    Class ErrorRule

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      FromSourceLocation, ToNode, TypeCheck
      +
      +
      +
      public final class ErrorRule
+extends Rule
      +
      A rule-set rule that is used to indicate an error in evaluation.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getError

          +
          public Expression getError()
          +
          Gets the error expression to return when reaching this rule.
          +
          +
          Returns:
          +
          the error expression.
          +
          +
          • +
        + + + +
          +
        • +

          accept

          +
          public <T> T accept​(RuleValueVisitor<T> visitor)
          +
          Description copied from class: Rule
          +
          Invoke the RuleValueVisitor functions for this Rule.
          +
          +
          Specified by:
          +
          accept in class Rule
          +
          Type Parameters:
          +
          T - the visitor return type.
          +
          Parameters:
          +
          visitor - the visitor to be invoked.
          +
          Returns:
          +
          the return value of the visitor.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class Rule
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/Rule.Builder.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/Rule.Builder.html new file mode 100644 index 00000000000..6e028d38686 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/Rule.Builder.html @@ -0,0 +1,440 @@ + + + + + +Rule.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.rule
    +

    Class Rule.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.syntax.rule.Rule.Builder
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Enclosing class:
      +
      Rule
      +
      +
      +
      public static final class Rule.Builder
+extends java.lang.Object
      +
      A builder used to create a Rule class.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + + + + + +
          +
        • +

          endpoint

          +
          public Rule endpoint​(Endpoint endpoint)
          +
          • +
        + + + +
          +
        • +

          error

          +
          public Rule error​(Node error)
          +
          • +
        + + + +
          +
        • +

          error

          +
          public Rule error​(java.lang.String error)
          +
          • +
        + + + +
          +
        • +

          treeRule

          +
          public Rule treeRule​(Rule... rules)
          +
          • +
        + + + +
          +
        • +

          treeRule

          +
          @SafeVarargs
+public final Rule treeRule​(java.util.List<Rule>... rules)
          +
          • +
        + + + +
          +
        • +

          description

          +
          public Rule.Builder description​(java.lang.String description)
          +
          • +
        + + + +
          +
        • +

          errorOrElse

          +
          public Rule.Builder errorOrElse​(java.lang.String error,
+                                ToCondition... condition)
          +
          If `condition` IS met, return an error. Otherwise, proceed with the rules generated by + the returned builder. +

          + This method returns a new builder that must be used!

          +
          +
          Parameters:
          +
          condition - a coercible Condition
          +
          error - an error description if the condition is not matched
          +
          Returns:
          +
          new builder to attach subsequent rules to
          +
          +
          • +
        + + + +
          +
        • +

          validateOrElse

          +
          public Rule.Builder validateOrElse​(java.lang.String error,
+                                   ToCondition... condition)
          +
          If `condition` IS NOT met, return an error. Otherwise, proceed with the rules generated by + the returned builder. +

          + This method returns a new builder that must be used!

          +
          +
          Parameters:
          +
          condition - a coercible Condition
          +
          error - an error description if the condition is not matched
          +
          Returns:
          +
          new builder to attach subsequent rules to
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/Rule.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/Rule.html new file mode 100644 index 00000000000..9997a6f1fc3 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/Rule.html @@ -0,0 +1,739 @@ + + + + + +Rule (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.rule
    +

    Class Rule

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.language.syntax.rule.Rule
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          builder

          +
          public static Rule.Builder builder()
          +
          Builder to create a Rule instance.
          +
          +
          Returns:
          +
          returns a new Builder.
          +
          +
          • +
        + + + +
          +
        • +

          builder

          +
          public static Rule.Builder builder​(FromSourceLocation sourceLocation)
          +
          Builder to create a Rule instance.
          +
          +
          Parameters:
          +
          sourceLocation - the source of the rule.
          +
          Returns:
          +
          returns a new Builder.
          +
          +
          • +
        + + + +
          +
        • +

          fromNode

          +
          public static Rule fromNode​(Node node)
          +
          Creates a Rule instance from the given Node information.
          +
          +
          Parameters:
          +
          node - the node to deserialize.
          +
          Returns:
          +
          the created Rule.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getConditions

          +
          public java.util.List<Condition> getConditions()
          +
          Gets the conditions required to satisfy this rule.
          +
          +
          Returns:
          +
          the list of conditions.
          +
          +
          • +
        + + + +
          +
        • +

          getDocumentation

          +
          public java.util.Optional<java.lang.String> getDocumentation()
          +
          Gets the documentation value.
          +
          +
          Returns:
          +
          returns the optional documentation value.
          +
          +
          • +
        + + + +
          +
        • +

          accept

          +
          public abstract <T> T accept​(RuleValueVisitor<T> visitor)
          +
          Invoke the RuleValueVisitor functions for this Rule.
          +
          +
          Type Parameters:
          +
          T - the visitor return type.
          +
          Parameters:
          +
          visitor - the visitor to be invoked.
          +
          Returns:
          +
          the return value of the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          typecheckValue

          +
          protected abstract Type typecheckValue​(Scope<Type> scope)
          +
          • +
        + + + +
          +
        • +

          typeCheck

          +
          public Type typeCheck​(Scope<Type> scope)
          +
          Description copied from interface: TypeCheck
          +
          Checks whether the given types within a scope satisfy the constraints.
          +
          +
          Specified by:
          +
          typeCheck in interface TypeCheck
          +
          Parameters:
          +
          scope - the scope to evaluate.
          +
          Returns:
          +
          the type validated by the scope check.
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/RuleValueVisitor.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/RuleValueVisitor.html new file mode 100644 index 00000000000..676fb3d7d8b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/RuleValueVisitor.html @@ -0,0 +1,312 @@ + + + + + +RuleValueVisitor (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.rule
    +

    Interface RuleValueVisitor<R>

    +
    +
    +
    +
      +
    • +
      +
      Type Parameters:
      +
      R - The return type of the visitor
      +
      +
      +
      All Known Implementing Classes:
      +
      TraversingVisitor
      +
      +
      +
      public interface RuleValueVisitor<R>
      +
      Visitor for the right-hand side of rules (tree, error, endpoint).
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          visitTreeRule

          +
          R visitTreeRule​(java.util.List<Rule> rules)
          +
          Invoked when reaching a tree rule.
          +
          +
          Parameters:
          +
          rules - the sub-rules within a tree rule.
          +
          Returns:
          +
          the visitor return type.
          +
          +
          • +
        + + + +
          +
        • +

          visitErrorRule

          +
          R visitErrorRule​(Expression error)
          +
          Invoked when reaching an error rule.
          +
          +
          Parameters:
          +
          error - the error expression for the rule.
          +
          Returns:
          +
          the visitor return type.
          +
          +
          • +
        + + + +
          +
        • +

          visitEndpointRule

          +
          R visitEndpointRule​(Endpoint endpoint)
          +
          Invoked when reaching an endpoint rule.
          +
          +
          Parameters:
          +
          endpoint - the endpoint of the rule.
          +
          Returns:
          +
          the visitor return type.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/TreeRule.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/TreeRule.html new file mode 100644 index 00000000000..7d8a90f9d95 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/TreeRule.html @@ -0,0 +1,386 @@ + + + + + +TreeRule (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.language.syntax.rule
    +

    Class TreeRule

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      FromSourceLocation, ToNode, TypeCheck
      +
      +
      +
      public final class TreeRule
+extends Rule
      +
      A rule-set rule that is used to contain condition based branching rules.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getRules

          +
          public java.util.List<Rule> getRules()
          +
          Gets the rules contained within this tree.
          +
          +
          Returns:
          +
          the rules within this tree.
          +
          +
          • +
        + + + +
          +
        • +

          accept

          +
          public <T> T accept​(RuleValueVisitor<T> visitor)
          +
          Description copied from class: Rule
          +
          Invoke the RuleValueVisitor functions for this Rule.
          +
          +
          Specified by:
          +
          accept in class Rule
          +
          Type Parameters:
          +
          T - the visitor return type.
          +
          Parameters:
          +
          visitor - the visitor to be invoked.
          +
          Returns:
          +
          the return value of the visitor.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class Rule
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/package-summary.html new file mode 100644 index 00000000000..194aee7bc04 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/package-summary.html @@ -0,0 +1,219 @@ + + + + + +software.amazon.smithy.rulesengine.language.syntax.rule (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.rulesengine.language.syntax.rule

    +
    +
    +
      +
    • + + + + + + + + + + + + +
      Interface Summary 
      InterfaceDescription
      RuleValueVisitor<R> +
      Visitor for the right-hand side of rules (tree, error, endpoint).
      +
      +
      • +
    • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      Condition +
      A condition is call to a rule-set function that used to determine whether a rule should be executed.
      +
      Condition.Builder +
      A builder used to create a Condition class.
      +
      EndpointRule +
      A rule-set rule that specifies a resolved endpoint.
      +
      ErrorRule +
      A rule-set rule that is used to indicate an error in evaluation.
      +
      Rule +
      The core functionality of a rule-set rule.
      +
      Rule.Builder +
      A builder used to create a Rule class.
      +
      TreeRule +
      A rule-set rule that is used to contain condition based branching rules.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/package-tree.html new file mode 100644 index 00000000000..a5c238895c9 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/language/syntax/rule/package-tree.html @@ -0,0 +1,180 @@ + + + + + +software.amazon.smithy.rulesengine.language.syntax.rule Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.rulesengine.language.syntax.rule

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    +
      +
    • java.lang.Object +
        +
      • software.amazon.smithy.rulesengine.language.syntax.rule.Condition.Builder (implements software.amazon.smithy.utils.SmithyBuilder<T>)
        • +
      • software.amazon.smithy.rulesengine.language.syntax.rule.Rule (implements software.amazon.smithy.model.FromSourceLocation, software.amazon.smithy.model.node.ToNode, software.amazon.smithy.rulesengine.language.evaluation.TypeCheck) +
          +
        • software.amazon.smithy.rulesengine.language.syntax.rule.EndpointRule
          • +
        • software.amazon.smithy.rulesengine.language.syntax.rule.ErrorRule
          • +
        • software.amazon.smithy.rulesengine.language.syntax.rule.TreeRule
          • +
        +
        • +
      • software.amazon.smithy.rulesengine.language.syntax.rule.Rule.Builder
        • +
      • software.amazon.smithy.rulesengine.language.syntax.SyntaxElement (implements software.amazon.smithy.rulesengine.language.syntax.ToCondition, software.amazon.smithy.rulesengine.language.syntax.ToExpression) +
          +
        • software.amazon.smithy.rulesengine.language.syntax.rule.Condition (implements software.amazon.smithy.model.FromSourceLocation, software.amazon.smithy.model.node.ToNode, software.amazon.smithy.rulesengine.language.evaluation.TypeCheck)
          • +
        +
        • +
      +
      • +
    +
    +
    +

    Interface Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/CleanEndpointTestOperationInput.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/CleanEndpointTestOperationInput.html new file mode 100644 index 00000000000..869b363de66 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/CleanEndpointTestOperationInput.html @@ -0,0 +1,327 @@ + + + + + +CleanEndpointTestOperationInput (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.traits
    +

    Class CleanEndpointTestOperationInput

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.traits.CleanEndpointTestOperationInput
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        ModelonRemove​(ModelTransformer transformer, + java.util.Collection<Shape> removed, + Model model) +
        The method that is invoked each time shapes are removed from a model.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          CleanEndpointTestOperationInput

          +
          public CleanEndpointTestOperationInput()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          onRemove

          +
          public Model onRemove​(ModelTransformer transformer,
+                      java.util.Collection<Shape> removed,
+                      Model model)
          +
          Description copied from interface: ModelTransformerPlugin
          +
          The method that is invoked each time shapes are removed from a model.
          +
          +
          Specified by:
          +
          onRemove in interface ModelTransformerPlugin
          +
          Parameters:
          +
          transformer - Transformer used to replace/remove shapes from the model.
          +
          removed - The of shapes that were removed from the model.
          +
          model - Model that has been altered to remove removed.
          +
          Returns:
          +
          Returns a transformed version of the passed in model.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ClientContextParamDefinition.Builder.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ClientContextParamDefinition.Builder.html new file mode 100644 index 00000000000..ad4f90572d2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ClientContextParamDefinition.Builder.html @@ -0,0 +1,313 @@ + + + + + +ClientContextParamDefinition.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.traits
    +

    Class ClientContextParamDefinition.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.traits.ClientContextParamDefinition.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ClientContextParamDefinition.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ClientContextParamDefinition.html new file mode 100644 index 00000000000..cc8bab655ea --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ClientContextParamDefinition.html @@ -0,0 +1,383 @@ + + + + + +ClientContextParamDefinition (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.traits
    +

    Class ClientContextParamDefinition

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.traits.ClientContextParamDefinition
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ClientContextParamsTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ClientContextParamsTrait.Builder.html new file mode 100644 index 00000000000..e019f657020 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ClientContextParamsTrait.Builder.html @@ -0,0 +1,352 @@ + + + + + +ClientContextParamsTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.traits
    +

    Class ClientContextParamsTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ClientContextParamsTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ClientContextParamsTrait.Provider.html new file mode 100644 index 00000000000..092b77b8b41 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ClientContextParamsTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +ClientContextParamsTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.traits
    +

    Class ClientContextParamsTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ClientContextParamsTrait.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ClientContextParamsTrait.html new file mode 100644 index 00000000000..92f79b62484 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ClientContextParamsTrait.html @@ -0,0 +1,466 @@ + + + + + +ClientContextParamsTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.traits
    +

    Class ClientContextParamsTrait

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ContextIndex.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ContextIndex.html new file mode 100644 index 00000000000..56c97b41f3c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ContextIndex.html @@ -0,0 +1,383 @@ + + + + + +ContextIndex (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.traits
    +

    Class ContextIndex

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.traits.ContextIndex
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      KnowledgeIndex
      +
      +
      +
      public final class ContextIndex
+extends java.lang.Object
+implements KnowledgeIndex
      +
      Resolves an indexes the context parameters in the model.
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ContextParamTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ContextParamTrait.Builder.html new file mode 100644 index 00000000000..4c88eff6390 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ContextParamTrait.Builder.html @@ -0,0 +1,308 @@ + + + + + +ContextParamTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.traits
    +

    Class ContextParamTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          build

          +
          public ContextParamTrait build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ContextParamTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ContextParamTrait.Provider.html new file mode 100644 index 00000000000..02fba05b8f8 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ContextParamTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +ContextParamTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.traits
    +

    Class ContextParamTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ContextParamTrait.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ContextParamTrait.html new file mode 100644 index 00000000000..ec829e29648 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ContextParamTrait.html @@ -0,0 +1,425 @@ + + + + + +ContextParamTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.traits
    +

    Class ContextParamTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getName

          +
          public java.lang.String getName()
          +
          • +
        + + + +
          +
        • +

          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.
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointRuleSetTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointRuleSetTrait.Builder.html new file mode 100644 index 00000000000..8d35b594705 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointRuleSetTrait.Builder.html @@ -0,0 +1,308 @@ + + + + + +EndpointRuleSetTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.traits
    +

    Class EndpointRuleSetTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointRuleSetTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointRuleSetTrait.Provider.html new file mode 100644 index 00000000000..42c9180fd57 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointRuleSetTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +EndpointRuleSetTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.traits
    +

    Class EndpointRuleSetTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointRuleSetTrait.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointRuleSetTrait.html new file mode 100644 index 00000000000..245f963c229 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointRuleSetTrait.html @@ -0,0 +1,439 @@ + + + + + +EndpointRuleSetTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.traits
    +

    Class EndpointRuleSetTrait

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestCase.Builder.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestCase.Builder.html new file mode 100644 index 00000000000..4ace88b03e0 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestCase.Builder.html @@ -0,0 +1,383 @@ + + + + + +EndpointTestCase.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.traits
    +

    Class EndpointTestCase.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.traits.EndpointTestCase.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestCase.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestCase.html new file mode 100644 index 00000000000..15c13b9ad84 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestCase.html @@ -0,0 +1,435 @@ + + + + + +EndpointTestCase (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.traits
    +

    Class EndpointTestCase

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.traits.EndpointTestCase
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestExpectation.Builder.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestExpectation.Builder.html new file mode 100644 index 00000000000..45d29f60e81 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestExpectation.Builder.html @@ -0,0 +1,327 @@ + + + + + +EndpointTestExpectation.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.traits
    +

    Class EndpointTestExpectation.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.traits.EndpointTestExpectation.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestExpectation.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestExpectation.html new file mode 100644 index 00000000000..4e49ff436e8 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestExpectation.html @@ -0,0 +1,407 @@ + + + + + +EndpointTestExpectation (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.traits
    +

    Class EndpointTestExpectation

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.traits.EndpointTestExpectation
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestOperationInput.Builder.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestOperationInput.Builder.html new file mode 100644 index 00000000000..817b2db9c41 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestOperationInput.Builder.html @@ -0,0 +1,395 @@ + + + + + +EndpointTestOperationInput.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.traits
    +

    Class EndpointTestOperationInput.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.traits.EndpointTestOperationInput.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestOperationInput.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestOperationInput.html new file mode 100644 index 00000000000..feb9e675956 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestOperationInput.html @@ -0,0 +1,435 @@ + + + + + +EndpointTestOperationInput (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.traits
    +

    Class EndpointTestOperationInput

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.traits.EndpointTestOperationInput
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestsTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestsTrait.Builder.html new file mode 100644 index 00000000000..dde75770322 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestsTrait.Builder.html @@ -0,0 +1,350 @@ + + + + + +EndpointTestsTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.traits
    +

    Class EndpointTestsTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestsTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestsTrait.Provider.html new file mode 100644 index 00000000000..00f9f289a23 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestsTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +EndpointTestsTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.traits
    +

    Class EndpointTestsTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestsTrait.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestsTrait.html new file mode 100644 index 00000000000..7c4282688f8 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestsTrait.html @@ -0,0 +1,453 @@ + + + + + +EndpointTestsTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.traits
    +

    Class EndpointTestsTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestsTraitValidator.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestsTraitValidator.html new file mode 100644 index 00000000000..b03089a1203 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/EndpointTestsTraitValidator.html @@ -0,0 +1,348 @@ + + + + + +EndpointTestsTraitValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.traits
    +

    Class EndpointTestsTraitValidator

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          EndpointTestsTraitValidator

          +
          public EndpointTestsTraitValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ExpectedEndpoint.Builder.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ExpectedEndpoint.Builder.html new file mode 100644 index 00000000000..50806b2436e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ExpectedEndpoint.Builder.html @@ -0,0 +1,401 @@ + + + + + +ExpectedEndpoint.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.traits
    +

    Class ExpectedEndpoint.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.traits.ExpectedEndpoint.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ExpectedEndpoint.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ExpectedEndpoint.html new file mode 100644 index 00000000000..39a0f1414fd --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/ExpectedEndpoint.html @@ -0,0 +1,479 @@ + + + + + +ExpectedEndpoint (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.traits
    +

    Class ExpectedEndpoint

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.traits.ExpectedEndpoint
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          getUrl

          +
          public java.lang.String getUrl()
          +
          • +
        + + + +
          +
        • +

          getHeaders

          +
          public java.util.Map<java.lang.String,​java.util.List<java.lang.String>> getHeaders()
          +
          • +
        + + + +
          +
        • +

          getProperties

          +
          public java.util.Map<java.lang.String,​Node> getProperties()
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/StaticContextParamDefinition.Builder.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/StaticContextParamDefinition.Builder.html new file mode 100644 index 00000000000..a3ebdc69dba --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/StaticContextParamDefinition.Builder.html @@ -0,0 +1,299 @@ + + + + + +StaticContextParamDefinition.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.traits
    +

    Class StaticContextParamDefinition.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.traits.StaticContextParamDefinition.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/StaticContextParamDefinition.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/StaticContextParamDefinition.html new file mode 100644 index 00000000000..95744e76157 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/StaticContextParamDefinition.html @@ -0,0 +1,369 @@ + + + + + +StaticContextParamDefinition (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.traits
    +

    Class StaticContextParamDefinition

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.rulesengine.traits.StaticContextParamDefinition
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/StaticContextParamsTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/StaticContextParamsTrait.Builder.html new file mode 100644 index 00000000000..5a239d3ba4a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/StaticContextParamsTrait.Builder.html @@ -0,0 +1,352 @@ + + + + + +StaticContextParamsTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.traits
    +

    Class StaticContextParamsTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/StaticContextParamsTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/StaticContextParamsTrait.Provider.html new file mode 100644 index 00000000000..c4caa6ee9b5 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/StaticContextParamsTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +StaticContextParamsTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.traits
    +

    Class StaticContextParamsTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/StaticContextParamsTrait.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/StaticContextParamsTrait.html new file mode 100644 index 00000000000..5273463a8d9 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/StaticContextParamsTrait.html @@ -0,0 +1,425 @@ + + + + + +StaticContextParamsTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.traits
    +

    Class StaticContextParamsTrait

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/StaticContextParamsTraitValidator.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/StaticContextParamsTraitValidator.html new file mode 100644 index 00000000000..4b882b93f18 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/StaticContextParamsTraitValidator.html @@ -0,0 +1,348 @@ + + + + + +StaticContextParamsTraitValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.traits
    +

    Class StaticContextParamsTraitValidator

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          StaticContextParamsTraitValidator

          +
          public StaticContextParamsTraitValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/package-summary.html new file mode 100644 index 00000000000..e2beb23c04b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/package-summary.html @@ -0,0 +1,313 @@ + + + + + +software.amazon.smithy.rulesengine.traits (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.rulesengine.traits

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/package-tree.html new file mode 100644 index 00000000000..1c1e436f07d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/traits/package-tree.html @@ -0,0 +1,207 @@ + + + + + +software.amazon.smithy.rulesengine.traits Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.rulesengine.traits

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/validators/AuthSchemeValidator.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/validators/AuthSchemeValidator.html new file mode 100644 index 00000000000..807e5977d9a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/validators/AuthSchemeValidator.html @@ -0,0 +1,278 @@ + + + + + +AuthSchemeValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.validators
    +

    Interface AuthSchemeValidator

    +
    +
    +
    +
      +
    • +
      +
      All Superinterfaces:
      +
      java.util.function.Predicate<java.lang.String>
      +
      +
      +
      public interface AuthSchemeValidator
+extends java.util.function.Predicate<java.lang.String>
      +
      Validates an authentication scheme after passing a predicate check.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validateScheme

          +
          java.util.List<ValidationEvent> validateScheme​(java.util.Map<Identifier,​Literal> authScheme,
+                                               FromSourceLocation sourceLocation,
+                                               java.util.function.BiFunction<FromSourceLocation,​java.lang.String,​ValidationEvent> emitter)
          +
          Validates that the provided authScheme matches required modeling behavior, + emitting events for any failures.
          +
          +
          Parameters:
          +
          authScheme - an authorization scheme parameter set.
          +
          sourceLocation - the location of the authorization scheme to generate events from.
          +
          emitter - a function to emit ValidationEvents for validation failures.
          +
          Returns:
          +
          a list of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/validators/RuleSetAuthSchemesValidator.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/validators/RuleSetAuthSchemesValidator.html new file mode 100644 index 00000000000..f3c9d28a011 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/validators/RuleSetAuthSchemesValidator.html @@ -0,0 +1,380 @@ + + + + + +RuleSetAuthSchemesValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.validators
    +

    Class RuleSetAuthSchemesValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class RuleSetAuthSchemesValidator
+extends AbstractValidator
      +
      Validator which verifies an endpoint with an authSchemes property conforms to a strict schema.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          RuleSetAuthSchemesValidator

          +
          public RuleSetAuthSchemesValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/validators/RuleSetBuiltInValidator.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/validators/RuleSetBuiltInValidator.html new file mode 100644 index 00000000000..1651841d927 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/validators/RuleSetBuiltInValidator.html @@ -0,0 +1,348 @@ + + + + + +RuleSetBuiltInValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.validators
    +

    Class RuleSetBuiltInValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class RuleSetBuiltInValidator
+extends AbstractValidator
      +
      Validates that the built-in's specified on parameters are supported.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          RuleSetBuiltInValidator

          +
          public RuleSetBuiltInValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/validators/RuleSetParamMissingDocsValidator.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/validators/RuleSetParamMissingDocsValidator.html new file mode 100644 index 00000000000..3c8fe06b1bb --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/validators/RuleSetParamMissingDocsValidator.html @@ -0,0 +1,364 @@ + + + + + +RuleSetParamMissingDocsValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.validators
    +

    Class RuleSetParamMissingDocsValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class RuleSetParamMissingDocsValidator
+extends AbstractValidator
      +
      Validator to ensure that all parameters have documentation.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          RuleSetParamMissingDocsValidator

          +
          public RuleSetParamMissingDocsValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/validators/RuleSetParameterValidator.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/validators/RuleSetParameterValidator.html new file mode 100644 index 00000000000..3a231db9642 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/validators/RuleSetParameterValidator.html @@ -0,0 +1,348 @@ + + + + + +RuleSetParameterValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.validators
    +

    Class RuleSetParameterValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class RuleSetParameterValidator
+extends AbstractValidator
      +
      Validator for rule-set parameters.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          RuleSetParameterValidator

          +
          public RuleSetParameterValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/validators/RuleSetTestCaseValidator.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/validators/RuleSetTestCaseValidator.html new file mode 100644 index 00000000000..44e8e8f8a6e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/validators/RuleSetTestCaseValidator.html @@ -0,0 +1,348 @@ + + + + + +RuleSetTestCaseValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.validators
    +

    Class RuleSetTestCaseValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public class RuleSetTestCaseValidator
+extends AbstractValidator
      +
      Validator to ensure that test cases for rule-sets pass type checking evaluation.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          RuleSetTestCaseValidator

          +
          public RuleSetTestCaseValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/validators/RuleSetUriValidator.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/validators/RuleSetUriValidator.html new file mode 100644 index 00000000000..d93ed040fe3 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/validators/RuleSetUriValidator.html @@ -0,0 +1,348 @@ + + + + + +RuleSetUriValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.rulesengine.validators
    +

    Class RuleSetUriValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class RuleSetUriValidator
+extends AbstractValidator
      +
      Validate that URIs start with a scheme.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          RuleSetUriValidator

          +
          public RuleSetUriValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/validators/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/validators/package-summary.html new file mode 100644 index 00000000000..42b6b38a685 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/validators/package-summary.html @@ -0,0 +1,213 @@ + + + + + +software.amazon.smithy.rulesengine.validators (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.rulesengine.validators

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/rulesengine/validators/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/rulesengine/validators/package-tree.html new file mode 100644 index 00000000000..90a510219c3 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/rulesengine/validators/package-tree.html @@ -0,0 +1,180 @@ + + + + + +software.amazon.smithy.rulesengine.validators Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.rulesengine.validators

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    +
      +
    • java.util.function.Predicate<T> + +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/smoketests/traits/Expectation.html b/javadoc/1.47.0/software/amazon/smithy/smoketests/traits/Expectation.html new file mode 100644 index 00000000000..adba57bac26 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/smoketests/traits/Expectation.html @@ -0,0 +1,436 @@ + + + + + +Expectation (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.smoketests.traits
    +

    Class Expectation

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.smoketests.traits.Expectation
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ToNode
      +
      +
      +
      public final class Expectation
+extends java.lang.Object
+implements ToNode
      +
      Defines the expected result of the service call for a smoke test case. + +

      This can either be a successful response, any error response, or a + specific error response.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          success

          +
          public static Expectation success()
          +
          +
          Returns:
          +
          Creates an expectation that the service call for a smoke + test case is successful.
          +
          +
          • +
        + + + +
          +
        • +

          failure

          +
          public static Expectation failure​(FailureExpectation failure)
          +
          +
          Parameters:
          +
          failure - The failure to expect.
          +
          Returns:
          +
          Creates an expectation that the service call for a smoke test + case will result in the given failure.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          isSuccess

          +
          public boolean isSuccess()
          +
          +
          Returns:
          +
          Whether the service call is expected to succeed.
          +
          +
          • +
        + + + +
          +
        • +

          isFailure

          +
          public boolean isFailure()
          +
          +
          Returns:
          +
          Whether the service call is expected to fail.
          +
          +
          • +
        + + + +
          +
        • +

          getFailure

          +
          public java.util.Optional<FailureExpectation> getFailure()
          +
          +
          Returns:
          +
          The expected failure, if this expectation is a failure expectation.
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/smoketests/traits/FailureExpectation.html b/javadoc/1.47.0/software/amazon/smithy/smoketests/traits/FailureExpectation.html new file mode 100644 index 00000000000..3c144c21a61 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/smoketests/traits/FailureExpectation.html @@ -0,0 +1,396 @@ + + + + + +FailureExpectation (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.smoketests.traits
    +

    Class FailureExpectation

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.smoketests.traits.FailureExpectation
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ToNode
      +
      +
      +
      public final class FailureExpectation
+extends java.lang.Object
+implements ToNode
      +
      Defines the expected failure of a service call for a smoke test case. + +

      This can be any error response, or a specific error response.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          anyError

          +
          public static FailureExpectation anyError()
          +
          +
          Returns:
          +
          Creates a failure expectation that the service call will result + in any error response.
          +
          +
          • +
        + + + +
          +
        • +

          errorWithId

          +
          public static FailureExpectation errorWithId​(ShapeId errorId)
          +
          +
          Parameters:
          +
          errorId - Shape ID of the expected error.
          +
          Returns:
          +
          Creates a failure expectation that the service call will result + in an error matching the given shape ID.
          +
          +
          • +
        + + + +
          +
        • +

          getErrorId

          +
          public java.util.Optional<ShapeId> getErrorId()
          +
          Gets the ID of the expected error shape. + +

          If present, it indicates the call should throw a matching error. + Otherwise, the call should throw any error.

          +
          +
          Returns:
          +
          The ID of the expected error shape.
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/smoketests/traits/SmokeTestCase.Builder.html b/javadoc/1.47.0/software/amazon/smithy/smoketests/traits/SmokeTestCase.Builder.html new file mode 100644 index 00000000000..84b457ebda2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/smoketests/traits/SmokeTestCase.Builder.html @@ -0,0 +1,438 @@ + + + + + +SmokeTestCase.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.smoketests.traits
    +

    Class SmokeTestCase.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.smoketests.traits.SmokeTestCase.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          id

          +
          public SmokeTestCase.Builder id​(java.lang.String id)
          +
          Sets the smoke test case ID. + +

          Must be unique across all smoke test cases on other operations + bound to the same service. + +

          Must match the following regex: ^[A-Za-z_][A-Za-z0-9_]+$

          +
          +
          Parameters:
          +
          id - Test case ID.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          params

          +
          public SmokeTestCase.Builder params​(ObjectNode params)
          +
          Sets the input parameters to the operation targeted by the smoke test case. + +

          These parameters must be compatible with the operation's input.

          +
          +
          Parameters:
          +
          params - Test case operation input parameters.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          vendorParams

          +
          public SmokeTestCase.Builder vendorParams​(ObjectNode vendorParams)
          +
          Sets vendor-specific parameters for the test case which can be used to + influence the request. + +

          If vendorParamsShape(ShapeId) is set, these parameters must + match that shape's definition.

          +
          +
          Parameters:
          +
          vendorParams - Vendor-specific parameters for the test case.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          vendorParamsShape

          +
          public SmokeTestCase.Builder vendorParamsShape​(ShapeId vendorParamsShape)
          +
          Sets the shape ID of vendor-specific parameters for the test case. + +

          If set, vendorParams(ObjectNode) must be compatible with + this shape's definition

          +
          +
          Parameters:
          +
          vendorParamsShape - Shape ID of vendor-specific parameters.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          expectation

          +
          public SmokeTestCase.Builder expectation​(Expectation expectation)
          +
          Sets the expected response of the service call for the test case.
          +
          +
          Parameters:
          +
          expectation - Expected response of the service call.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          tags

          +
          public SmokeTestCase.Builder tags​(java.util.List<java.lang.String> tags)
          +
          Sets the tags that can be used to categorize and group test cases.
          +
          +
          Parameters:
          +
          tags - Tags to attach to the test case.
          +
          Returns:
          +
          Returns the builder.
          +
          +
          • +
        + + + +
          +
        • +

          build

          +
          public SmokeTestCase build()
          +
          Description copied from interface: SmithyBuilder
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Specified by:
          +
          build in interface SmithyBuilder<SmokeTestCase>
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/smoketests/traits/SmokeTestCase.html b/javadoc/1.47.0/software/amazon/smithy/smoketests/traits/SmokeTestCase.html new file mode 100644 index 00000000000..367b9bd7ba3 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/smoketests/traits/SmokeTestCase.html @@ -0,0 +1,563 @@ + + + + + +SmokeTestCase (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.smoketests.traits
    +

    Class SmokeTestCase

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.smoketests.traits.SmokeTestCase
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + +
          +
        • +

          getId

          +
          public java.lang.String getId()
          +
          Get the ID of this test case. + +

          This ID is unique across all smoke test cases for all operations + bound to the same service, and can be used to generate test case names.

          +
          +
          Returns:
          +
          Returns the smoke test case ID.
          +
          +
          • +
        + + + +
          +
        • +

          getParams

          +
          public java.util.Optional<ObjectNode> getParams()
          +
          Get the input parameters of this test case. + +

          These parameters, if present, are passed to the operation the smoke test + targets. If not present, the operation does not have any input.

          +
          +
          Returns:
          +
          Returns the optionally present input parameters.
          +
          +
          • +
        + + + +
          +
        • +

          getVendorParams

          +
          public java.util.Optional<ObjectNode> getVendorParams()
          +
          Get the vendor-specific parameters of this test case. + +

          These are custom parameters that can be used to influence the + request for this test case. + +

          These parameters match the shape id returned by getVendorParamsShape(), + if present.

          +
          +
          Returns:
          +
          Returns the optionally present vendor-specific parameters.
          +
          See Also:
          +
          getVendorParamsShape()
          +
          +
          • +
        + + + +
          +
        • +

          getVendorParamsShape

          +
          public java.util.Optional<ShapeId> getVendorParamsShape()
          +
          Get the shape ID of vendor-specific parameters used by this test case. + +

          If present, getVendorParams() will match this shape's definition.

          +
          +
          Returns:
          +
          The optionally present shape ID of vendor-specific parameters.
          +
          See Also:
          +
          getVendorParams()
          +
          +
          • +
        + + + +
          +
        • +

          getExpectation

          +
          public Expectation getExpectation()
          +
          Get the expected response from the service call for this test case. + +

          This expectation can be either a successful response, any error + response, or a specific error response.

          +
          +
          Returns:
          +
          Returns expectation.
          +
          +
          • +
        + + + +
          +
        • +

          getTags

          +
          public java.util.List<java.lang.String> getTags()
          +
          Description copied from interface: Tagged
          +
          Gets the tags applied to an object.
          +
          +
          Specified by:
          +
          getTags in interface Tagged
          +
          Returns:
          +
          Returns the tag values.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/smoketests/traits/SmokeTestCaseValidator.html b/javadoc/1.47.0/software/amazon/smithy/smoketests/traits/SmokeTestCaseValidator.html new file mode 100644 index 00000000000..79d4218b1b0 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/smoketests/traits/SmokeTestCaseValidator.html @@ -0,0 +1,354 @@ + + + + + +SmokeTestCaseValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.smoketests.traits
    +

    Class SmokeTestCaseValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public class SmokeTestCaseValidator
+extends AbstractValidator
      +
      Validates the following: + +
        +
      • vendorParamsShape is a valid shape.
        • +
      • vendorParams is compatible with vendorParamsShape.
        • +
      • input is valid for the operation under test.
        • +
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          SmokeTestCaseValidator

          +
          public SmokeTestCaseValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/smoketests/traits/SmokeTestsTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/smoketests/traits/SmokeTestsTrait.Provider.html new file mode 100644 index 00000000000..1a999253963 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/smoketests/traits/SmokeTestsTrait.Provider.html @@ -0,0 +1,337 @@ + + + + + +SmokeTestsTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.smoketests.traits
    +

    Class SmokeTestsTrait.Provider

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/smoketests/traits/SmokeTestsTrait.html b/javadoc/1.47.0/software/amazon/smithy/smoketests/traits/SmokeTestsTrait.html new file mode 100644 index 00000000000..2dc8a77b3f7 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/smoketests/traits/SmokeTestsTrait.html @@ -0,0 +1,439 @@ + + + + + +SmokeTestsTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.smoketests.traits
    +

    Class SmokeTestsTrait

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      FromSourceLocation, ToNode, ToShapeId, Trait
      +
      +
      +
      public final class SmokeTestsTrait
+extends AbstractTrait
      +
      Defines a set of test cases to send to a live service to ensure that + a client can connect to the service and get the right kind of response.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          SmokeTestsTrait

          +
          public SmokeTestsTrait​(java.util.List<SmokeTestCase> testCases)
          +
          • +
        + + + + +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getTestCases

          +
          public java.util.List<SmokeTestCase> getTestCases()
          +
          +
          Returns:
          +
          The smoke test cases to perform on the operation.
          +
          +
          • +
        + + + +
          +
        • +

          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.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/smoketests/traits/UniqueSmokeTestCaseIdValidator.html b/javadoc/1.47.0/software/amazon/smithy/smoketests/traits/UniqueSmokeTestCaseIdValidator.html new file mode 100644 index 00000000000..67f0082512a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/smoketests/traits/UniqueSmokeTestCaseIdValidator.html @@ -0,0 +1,349 @@ + + + + + +UniqueSmokeTestCaseIdValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.smoketests.traits
    +

    Class UniqueSmokeTestCaseIdValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public class UniqueSmokeTestCaseIdValidator
+extends AbstractValidator
      +
      Validates that smoke test cases have unique IDs within a service closure, + or within the trait if it is not connected to a service.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          UniqueSmokeTestCaseIdValidator

          +
          public UniqueSmokeTestCaseIdValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/smoketests/traits/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/smoketests/traits/package-summary.html new file mode 100644 index 00000000000..07ebb5465cf --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/smoketests/traits/package-summary.html @@ -0,0 +1,212 @@ + + + + + +software.amazon.smithy.smoketests.traits (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.smoketests.traits

    +
    +
    +
      +
    • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      Expectation +
      Defines the expected result of the service call for a smoke test case.
      +
      FailureExpectation +
      Defines the expected failure of a service call for a smoke test case.
      +
      SmokeTestCase +
      Defines a single smoke test case.
      +
      SmokeTestCase.Builder 
      SmokeTestCaseValidator +
      Validates the following: + + + vendorParamsShape is a valid shape. + vendorParams is compatible with vendorParamsShape. + input is valid for the operation under test. +
      +
      SmokeTestsTrait +
      Defines a set of test cases to send to a live service to ensure that + a client can connect to the service and get the right kind of response.
      +
      SmokeTestsTrait.Provider 
      UniqueSmokeTestCaseIdValidator +
      Validates that smoke test cases have unique IDs within a service closure, + or within the trait if it is not connected to a service.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/smoketests/traits/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/smoketests/traits/package-tree.html new file mode 100644 index 00000000000..b83b4ad296e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/smoketests/traits/package-tree.html @@ -0,0 +1,180 @@ + + + + + +software.amazon.smithy.smoketests.traits Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.smoketests.traits

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/syntax/CapturedToken.Builder.html b/javadoc/1.47.0/software/amazon/smithy/syntax/CapturedToken.Builder.html new file mode 100644 index 00000000000..9d8b0257ec2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/syntax/CapturedToken.Builder.html @@ -0,0 +1,439 @@ + + + + + +CapturedToken.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.syntax
    +

    Class CapturedToken.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.syntax.CapturedToken.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/syntax/CapturedToken.html b/javadoc/1.47.0/software/amazon/smithy/syntax/CapturedToken.html new file mode 100644 index 00000000000..f4c24ad1207 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/syntax/CapturedToken.html @@ -0,0 +1,600 @@ + + + + + +CapturedToken (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.syntax
    +

    Class CapturedToken

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.syntax.CapturedToken
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      FromSourceLocation, ToSmithyBuilder<CapturedToken>
      +
      +
      +
      public final class CapturedToken
+extends java.lang.Object
+implements FromSourceLocation, ToSmithyBuilder<CapturedToken>
      +
      A persisted token captured from an IdlTokenizer. + +

      For performance, IdlTokenizer does not create new tokens types for each encountered token. Instead, it + updates the current state of the tokenizer and allows the caller to inspect the tokenizer for information about each + token. Because smithy-syntax needs to create a token-tree rather than go directly to an AST, it requires arbitrary + lookahead of tokens, requiring it to persist tokens in memory.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          from

          +
          public static CapturedToken from​(IdlTokenizer tokenizer)
          +
          Persist the current token of an IdlTokenizer.
          +
          +
          Parameters:
          +
          tokenizer - Tokenizer to capture.
          +
          Returns:
          +
          Returns the persisted token.
          +
          +
          • +
        + + + +
          +
        • +

          from

          +
          public static CapturedToken from​(IdlTokenizer tokenizer,
+                                 java.util.function.Function<java.lang.CharSequence,​java.lang.String> stringTable)
          +
          Persist the current token of an IdlTokenizer.
          +
          +
          Parameters:
          +
          tokenizer - Tokenizer to capture.
          +
          stringTable - String table that caches previously created strings.
          +
          Returns:
          +
          Returns the persisted token.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getIdlToken

          +
          public IdlToken getIdlToken()
          +
          Get the token IDL token of the captured token.
          +
          +
          Returns:
          +
          Returns the underlying token type.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getFilename

          +
          public java.lang.String getFilename()
          +
          • +
        + + + +
          +
        • +

          getPosition

          +
          public int getPosition()
          +
          • +
        + + + +
          +
        • +

          getStartLine

          +
          public int getStartLine()
          +
          • +
        + + + +
          +
        • +

          getStartColumn

          +
          public int getStartColumn()
          +
          • +
        + + + +
          +
        • +

          getEndLine

          +
          public int getEndLine()
          +
          • +
        + + + +
          +
        • +

          getEndColumn

          +
          public int getEndColumn()
          +
          • +
        + + + +
          +
        • +

          getSpan

          +
          public int getSpan()
          +
          • +
        + + + +
          +
        • +

          getLexeme

          +
          public java.lang.CharSequence getLexeme()
          +
          Get the raw lexeme of the current token.
          +
          +
          Returns:
          +
          Returns the underlying lexeme of the token.
          +
          +
          • +
        + + + +
          +
        • +

          getStringContents

          +
          public java.lang.String getStringContents()
          +
          Get the associated String contents of the token if it's a string, text block, or identifier.
          +
          +
          Returns:
          +
          Returns the string contents of the lexeme, or null if not a string|text block|identifier.
          +
          +
          • +
        + + + +
          +
        • +

          getErrorMessage

          +
          public java.lang.String getErrorMessage()
          +
          Gets the associated error message with the token if it's an error.
          +
          +
          Returns:
          +
          Returns the error message or null if not an error.
          +
          +
          • +
        + + + +
          +
        • +

          getNumberValue

          +
          public java.lang.Number getNumberValue()
          +
          Get the computed Number of the current token if it's a number.
          +
          +
          Returns:
          +
          Returns the computed Number or null if not a number.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/syntax/Formatter.html b/javadoc/1.47.0/software/amazon/smithy/syntax/Formatter.html new file mode 100644 index 00000000000..46eecc3a1d1 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/syntax/Formatter.html @@ -0,0 +1,307 @@ + + + + + +Formatter (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.syntax
    +

    Class Formatter

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.syntax.Formatter
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class Formatter
+extends java.lang.Object
      +
      Formats valid Smithy IDL models. + +

      This formatter will by default sort use statements, remove unused use statements, and fix documentation + comments that should be normal comments.

      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static java.lang.Stringformat​(TokenTree root) +
        Formats the given token tree, wrapping lines at 120 characters.
        +
        static java.lang.Stringformat​(TokenTree root, + int maxWidth) +
        Formats the given token tree.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + +
          +
        • +

          format

          +
          public static java.lang.String format​(TokenTree root)
          +
          Formats the given token tree, wrapping lines at 120 characters.
          +
          +
          Parameters:
          +
          root - Root TreeType.IDL tree node to format.
          +
          Returns:
          +
          Returns the formatted model as a string.
          +
          Throws:
          +
          ModelSyntaxException - if the model contains errors.
          +
          +
          • +
        + + + +
          +
        • +

          format

          +
          public static java.lang.String format​(TokenTree root,
+                                      int maxWidth)
          +
          Formats the given token tree.
          +
          +
          Parameters:
          +
          root - Root TreeType.IDL tree node to format.
          +
          maxWidth - Maximum line width.
          +
          Returns:
          +
          Returns the formatted model as a string.
          +
          Throws:
          +
          ModelSyntaxException - if the model contains errors.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/syntax/TokenTree.html b/javadoc/1.47.0/software/amazon/smithy/syntax/TokenTree.html new file mode 100644 index 00000000000..e9e016034ea --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/syntax/TokenTree.html @@ -0,0 +1,702 @@ + + + + + +TokenTree (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.syntax
    +

    Interface TokenTree

    +
    +
    +
    +
      +
    • +
      +
      All Superinterfaces:
      +
      FromSourceLocation
      +
      +
      +
      public interface TokenTree
+extends FromSourceLocation
      +
      Provides a labeled tree of tokens returned from IdlTokenizer. + +

      This abstraction is a kind of parse tree based on lexer tokens, with the key difference being it bottoms-out at + IdlToken values rather than the more granular grammar productions for identifiers, strings, etc. + +

      Each consumed IDL token is present in the tree, and grouped together into nodes with labels defined by its + TreeType.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          of

          +
          static TokenTree of​(IdlTokenizer tokenizer)
          +
          Create the root of a TokenTree from an IdlTokenizer.
          +
          +
          Parameters:
          +
          tokenizer - Tokenizer to traverse.
          +
          Returns:
          +
          Returns the root of the created tree.
          +
          +
          • +
        + + + +
          +
        • +

          of

          +
          static TokenTree of​(IdlTokenizer tokenizer,
+                    TreeType type)
          +
          Create a TokenTree of the given TreeType from an IdlTokenizer. + +

          The following example shows how to create a TokenTree for a trait.

          + + 
          
+ IdlTokenizer tokenizer = IdlTokenizer.create("@someTrait");
+ TokenTree traitTree = TokenTree.of(tokenizer, TreeType.TRAIT);
+
          +
          +
          Parameters:
          +
          tokenizer - Tokenizer to traverse.
          +
          type - Type of tree to create.
          +
          Returns:
          +
          Returns the created tree.
          +
          +
          • +
        + + + +
          +
        • +

          of

          +
          static TokenTree of​(CapturedToken token)
          +
          Create a leaf tree from a single token.
          +
          +
          Parameters:
          +
          token - Token to wrap into a tree.
          +
          Returns:
          +
          Returns the created tree.
          +
          +
          • +
        + + + +
          +
        • +

          of

          +
          static TokenTree of​(TreeType type)
          +
          Create an empty tree of a specific type.
          +
          +
          Parameters:
          +
          type - Tree type to create.
          +
          Returns:
          +
          Returns the created tree.
          +
          +
          • +
        + + + +
          +
        • +

          fromError

          +
          static TokenTree fromError​(java.lang.String error)
          +
          Create an error tree with the given error message.
          +
          +
          Parameters:
          +
          error - Error message.
          +
          Returns:
          +
          Returns the created tree.
          +
          +
          • +
        + + + +
          +
        • +

          getType

          +
          TreeType getType()
          +
          Get the token tree type.
          +
          +
          Returns:
          +
          Returns the type.
          +
          +
          • +
        + + + +
          +
        • +

          getChildren

          +
          java.util.List<TokenTree> getChildren()
          +
          Get direct children of the tree.
          +
          +
          Returns:
          +
          Returns direct children.
          +
          +
          • +
        + + + +
          +
        • +

          isEmpty

          +
          boolean isEmpty()
          +
          Detect if the tree is empty (that is, a non-leaf that has no children or tokens).
          +
          +
          Returns:
          +
          Return true if the tree has no children or tokens.
          +
          +
          • +
        + + + +
          +
        • +

          appendChild

          +
          void appendChild​(TokenTree tree)
          +
          Append a child to the tree.
          +
          +
          Parameters:
          +
          tree - Tree to append.
          +
          Throws:
          +
          java.lang.UnsupportedOperationException - if the tree is a leaf.
          +
          +
          • +
        + + + +
          +
        • +

          removeChild

          +
          boolean removeChild​(TokenTree tree)
          +
          Remove a child tree by referential equality.
          +
          +
          Parameters:
          +
          tree - Tree to remove.
          +
          Returns:
          +
          Return true only if this child was found and removed.
          +
          +
          • +
        + + + +
          +
        • +

          replaceChild

          +
          boolean replaceChild​(TokenTree find,
+                     TokenTree replacement)
          +
          Replace a matching child with the given replacement using referential equality.
          +
          +
          Parameters:
          +
          find - Child to find and replace, using referential equality.
          +
          replacement - Replacement to use instead.
          +
          Returns:
          +
          Returns true only if a child was replaced.
          +
          +
          • +
        + + + +
          +
        • +

          tokens

          +
          java.util.stream.Stream<CapturedToken> tokens()
          +
          Get a flattened stream of all captured tokens contained within the tree.
          +
          +
          Returns:
          +
          Returns the contained tokens.
          +
          +
          • +
        + + + +
          +
        • +

          concatTokens

          +
          java.lang.String concatTokens()
          +
          Get the tokens contained in the tree as a single concatenated string.
          +
          +
          Returns:
          +
          Returns a concatenated string of tokens.
          +
          +
          • +
        + + + +
          +
        • +

          getError

          +
          default java.lang.String getError()
          +
          Get the error associated with the tree, or null if not present.
          +
          +
          Returns:
          +
          Returns the nullable error message.
          +
          +
          • +
        + + + +
          +
        • +

          zipper

          +
          default TreeCursor zipper()
          +
          Create a zipper for the current tree node, treating it as the root of the tree.
          +
          +
          Returns:
          +
          Returns the zipper cursor for the current node.
          +
          +
          • +
        + + + +
          +
        • +

          getStartPosition

          +
          int getStartPosition()
          +
          Get the absolute start position of the tree, starting at 0.
          +
          +
          Returns:
          +
          Returns the start position of this tree.
          +
          +
          • +
        + + + +
          +
        • +

          getStartLine

          +
          int getStartLine()
          +
          Get the line the tree starts, starting at 1.
          +
          +
          Returns:
          +
          Returns the start line.
          +
          +
          • +
        + + + +
          +
        • +

          getStartColumn

          +
          int getStartColumn()
          +
          Get the column the tree starts, starting at 1.
          +
          +
          Returns:
          +
          Returns the start column.
          +
          +
          • +
        + + + +
          +
        • +

          getEndLine

          +
          int getEndLine()
          +
          Get the line the tree ends, starting at 1.
          +
          +
          Returns:
          +
          Returns the end line.
          +
          +
          • +
        + + + +
          +
        • +

          getEndColumn

          +
          int getEndColumn()
          +
          Get the column the tree ends, starting at 1.
          +
          +
          Returns:
          +
          Returns the end column.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/syntax/TreeCursor.html b/javadoc/1.47.0/software/amazon/smithy/syntax/TreeCursor.html new file mode 100644 index 00000000000..f18fb214ab8 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/syntax/TreeCursor.html @@ -0,0 +1,652 @@ + + + + + +TreeCursor (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.syntax
    +

    Class TreeCursor

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.syntax.TreeCursor
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          of

          +
          public static TreeCursor of​(TokenTree tree)
          +
          Create a TreeCursor from the given TokenTree, treating it as the root of the tree.
          +
          +
          Parameters:
          +
          tree - Tree to create a cursor from.
          +
          Returns:
          +
          Returns the created cursor.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          getTree

          +
          public TokenTree getTree()
          +
          Get the wrapped TokenTree.
          +
          +
          Returns:
          +
          Return the token tree.
          +
          +
          • +
        + + + +
          +
        • +

          getParent

          +
          public TreeCursor getParent()
          +
          Get the parent cursor, or null if not present.
          +
          +
          Returns:
          +
          Nullable parent cursor.
          +
          +
          • +
        + + + +
          +
        • +

          getRoot

          +
          public TreeCursor getRoot()
          +
          Get the root of the tree, returning itself if the tree has no parent.
          +
          +
          Returns:
          +
          Non-nullable root tree.
          +
          +
          • +
        + + + +
          +
        • +

          getPathToCursor

          +
          public java.util.List<TreeCursor> getPathToCursor()
          +
          Get a list of tree cursors that lead up to the current tree, starting from the root as the first element, and + including the current tree as the last element.
          +
          +
          Returns:
          +
          Returns the path to the current tree from the root.
          +
          +
          • +
        + + + +
          +
        • +

          getPreviousSibling

          +
          public TreeCursor getPreviousSibling()
          +
          Get the previous sibling of this tree, if present.
          +
          +
          Returns:
          +
          Return the nullable previous sibling.
          +
          +
          • +
        + + + +
          +
        • +

          getNextSibling

          +
          public TreeCursor getNextSibling()
          +
          Get the next sibling of this tree, if present.
          +
          +
          Returns:
          +
          Return the nullable next sibling.
          +
          +
          • +
        + + + +
          +
        • +

          getChildren

          +
          public java.util.List<TreeCursor> getChildren()
          +
          Get all children of the tree as a list of cursors.
          +
          +
          Returns:
          +
          Return the cursors to each child.
          +
          +
          • +
        + + + +
          +
        • +

          getChildrenByType

          +
          public java.util.List<TreeCursor> getChildrenByType​(TreeType... types)
          +
          Get direct children from the current tree of a specific type.
          +
          +
          Parameters:
          +
          types - Types of children to get.
          +
          Returns:
          +
          Returns the collected children, or an empty list.
          +
          +
          • +
        + + + +
          +
        • +

          getFirstChild

          +
          public TreeCursor getFirstChild()
          +
          Get the first child of the wrapped tree.
          +
          +
          Returns:
          +
          Return the first child, or null if the tree has no children.
          +
          +
          • +
        + + + +
          +
        • +

          getFirstChild

          +
          public TreeCursor getFirstChild​(TreeType type)
          +
          Get the first child of the wrapped tree with the given type.
          +
          +
          Parameters:
          +
          type - Child type to get.
          +
          Returns:
          +
          Return the first child, or null if a matching child is not found.
          +
          +
          • +
        + + + +
          +
        • +

          getLastChild

          +
          public TreeCursor getLastChild()
          +
          Get the last child of the wrapped tree.
          +
          +
          Returns:
          +
          Return the last child, or null if the tree has no children.
          +
          +
          • +
        + + + +
          +
        • +

          getLastChild

          +
          public TreeCursor getLastChild​(TreeType type)
          +
          Get the last child of the wrapped tree with the given type.
          +
          +
          Parameters:
          +
          type - Child type to get.
          +
          Returns:
          +
          Return the last child, or null if a matching child is not found.
          +
          +
          • +
        + + + +
          +
        • +

          findChildrenByType

          +
          public java.util.List<TreeCursor> findChildrenByType​(TreeType... types)
          +
          Recursively find every node in the tree that has the given TreeType.
          +
          +
          Parameters:
          +
          types - Types of children to return.
          +
          Returns:
          +
          Returns the matching tree cursors.
          +
          +
          • +
        + + + +
          +
        • +

          findAt

          +
          public TreeCursor findAt​(int line,
+                         int column)
          +
          Find the innermost tree that contains the given coordinates.
          +
          +
          Parameters:
          +
          line - Line to find.
          +
          column - Column to find.
          +
          Returns:
          +
          Returns the innermost tree that contains the coordinates.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/syntax/TreeType.html b/javadoc/1.47.0/software/amazon/smithy/syntax/TreeType.html new file mode 100644 index 00000000000..e608edbe834 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/syntax/TreeType.html @@ -0,0 +1,1385 @@ + + + + + +TreeType (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.syntax
    +

    Enum TreeType

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Enum<TreeType>
        • +
      • +
          +
        • software.amazon.smithy.syntax.TreeType
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable, java.lang.Comparable<TreeType>
      +
      +
      +
      public enum TreeType
+extends java.lang.Enum<TreeType>
      +
      Defines the tree type. + +

      These types typically map 1:1 to a production in the Smithy IDL grammar, except that tree types bottom-out at + IdlToken. + +

      For example: + +

        +
      • The Identifier production is combined into a single IDENTIFIER node. + IdentifierStart and IdentifierChars are not exposed in the token tree.
        • +
      • The Number production is combined into a single NUMBER node. Productions like + DecimalPoint, Exp, etc are not exposed in the token tree.
        • +
      • The QuotedText production is combined into a single QUOTED_TEXT node. +
      • The TextBlock production is combined into a single TEXT_BLOCK node. +
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + +
          +
        • +

          IDL

          +
          public static final TreeType IDL
          +
          • +
        + + + +
          +
        • +

          CONTROL_SECTION

          +
          public static final TreeType CONTROL_SECTION
          +
          • +
        + + + +
          +
        • +

          CONTROL_STATEMENT

          +
          public static final TreeType CONTROL_STATEMENT
          +
          • +
        + + + +
          +
        • +

          METADATA_SECTION

          +
          public static final TreeType METADATA_SECTION
          +
          • +
        + + + +
          +
        • +

          METADATA_STATEMENT

          +
          public static final TreeType METADATA_STATEMENT
          +
          • +
        + + + +
          +
        • +

          SHAPE_SECTION

          +
          public static final TreeType SHAPE_SECTION
          +
          • +
        + + + +
          +
        • +

          NAMESPACE_STATEMENT

          +
          public static final TreeType NAMESPACE_STATEMENT
          +
          • +
        + + + +
          +
        • +

          USE_SECTION

          +
          public static final TreeType USE_SECTION
          +
          • +
        + + + +
          +
        • +

          USE_STATEMENT

          +
          public static final TreeType USE_STATEMENT
          +
          • +
        + + + +
          +
        • +

          SHAPE_STATEMENTS

          +
          public static final TreeType SHAPE_STATEMENTS
          +
          • +
        + + + +
          +
        • +

          SHAPE_OR_APPLY_STATEMENT

          +
          public static final TreeType SHAPE_OR_APPLY_STATEMENT
          +
          • +
        + + + +
          +
        • +

          SHAPE_STATEMENT

          +
          public static final TreeType SHAPE_STATEMENT
          +
          • +
        + + + +
          +
        • +

          SHAPE

          +
          public static final TreeType SHAPE
          +
          • +
        + + + +
          +
        • +

          SIMPLE_SHAPE

          +
          public static final TreeType SIMPLE_SHAPE
          +
          • +
        + + + +
          +
        • +

          SIMPLE_TYPE_NAME

          +
          public static final TreeType SIMPLE_TYPE_NAME
          +
          • +
        + + + +
          +
        • +

          ENUM_SHAPE

          +
          public static final TreeType ENUM_SHAPE
          +
          • +
        + + + +
          +
        • +

          ENUM_TYPE_NAME

          +
          public static final TreeType ENUM_TYPE_NAME
          +
          • +
        + + + +
          +
        • +

          ENUM_SHAPE_MEMBERS

          +
          public static final TreeType ENUM_SHAPE_MEMBERS
          +
          • +
        + + + +
          +
        • +

          ENUM_SHAPE_MEMBER

          +
          public static final TreeType ENUM_SHAPE_MEMBER
          +
          • +
        + + + +
          +
        • +

          AGGREGATE_SHAPE

          +
          public static final TreeType AGGREGATE_SHAPE
          +
          • +
        + + + +
          +
        • +

          AGGREGATE_TYPE_NAME

          +
          public static final TreeType AGGREGATE_TYPE_NAME
          +
          • +
        + + + +
          +
        • +

          FOR_RESOURCE

          +
          public static final TreeType FOR_RESOURCE
          +
          • +
        + + + +
          +
        • +

          SHAPE_MEMBERS

          +
          public static final TreeType SHAPE_MEMBERS
          +
          • +
        + + + +
          +
        • +

          SHAPE_MEMBER

          +
          public static final TreeType SHAPE_MEMBER
          +
          • +
        + + + +
          +
        • +

          EXPLICIT_SHAPE_MEMBER

          +
          public static final TreeType EXPLICIT_SHAPE_MEMBER
          +
          • +
        + + + +
          +
        • +

          ELIDED_SHAPE_MEMBER

          +
          public static final TreeType ELIDED_SHAPE_MEMBER
          +
          • +
        + + + +
          +
        • +

          ENTITY_SHAPE

          +
          public static final TreeType ENTITY_SHAPE
          +
          • +
        + + + +
          +
        • +

          ENTITY_TYPE_NAME

          +
          public static final TreeType ENTITY_TYPE_NAME
          +
          • +
        + + + +
          +
        • +

          OPERATION_SHAPE

          +
          public static final TreeType OPERATION_SHAPE
          +
          • +
        + + + +
          +
        • +

          OPERATION_BODY

          +
          public static final TreeType OPERATION_BODY
          +
          • +
        + + + +
          +
        • +

          OPERATION_PROPERTY

          +
          public static final TreeType OPERATION_PROPERTY
          +
          • +
        + + + +
          +
        • +

          OPERATION_INPUT

          +
          public static final TreeType OPERATION_INPUT
          +
          • +
        + + + +
          +
        • +

          OPERATION_OUTPUT

          +
          public static final TreeType OPERATION_OUTPUT
          +
          • +
        + + + +
          +
        • +

          INLINE_AGGREGATE_SHAPE

          +
          public static final TreeType INLINE_AGGREGATE_SHAPE
          +
          • +
        + + + +
          +
        • +

          OPERATION_ERRORS

          +
          public static final TreeType OPERATION_ERRORS
          +
          • +
        + + + +
          +
        • +

          MIXINS

          +
          public static final TreeType MIXINS
          +
          • +
        + + + +
          +
        • +

          VALUE_ASSIGNMENT

          +
          public static final TreeType VALUE_ASSIGNMENT
          +
          • +
        + + + +
          +
        • +

          TRAIT_STATEMENTS

          +
          public static final TreeType TRAIT_STATEMENTS
          +
          • +
        + + + +
          +
        • +

          TRAIT

          +
          public static final TreeType TRAIT
          +
          • +
        + + + +
          +
        • +

          TRAIT_BODY

          +
          public static final TreeType TRAIT_BODY
          +
          • +
        + + + +
          +
        • +

          TRAIT_STRUCTURE

          +
          public static final TreeType TRAIT_STRUCTURE
          +
          • +
        + + + +
          +
        • +

          TRAIT_NODE

          +
          public static final TreeType TRAIT_NODE
          +
          • +
        + + + +
          +
        • +

          APPLY_STATEMENT

          +
          public static final TreeType APPLY_STATEMENT
          +
          • +
        + + + +
          +
        • +

          APPLY_STATEMENT_SINGULAR

          +
          public static final TreeType APPLY_STATEMENT_SINGULAR
          +
          • +
        + + + +
          +
        • +

          APPLY_STATEMENT_BLOCK

          +
          public static final TreeType APPLY_STATEMENT_BLOCK
          +
          • +
        + + + +
          +
        • +

          NODE_VALUE

          +
          public static final TreeType NODE_VALUE
          +
          • +
        + + + +
          +
        • +

          NODE_ARRAY

          +
          public static final TreeType NODE_ARRAY
          +
          • +
        + + + +
          +
        • +

          NODE_OBJECT

          +
          public static final TreeType NODE_OBJECT
          +
          • +
        + + + +
          +
        • +

          NODE_OBJECT_KVP

          +
          public static final TreeType NODE_OBJECT_KVP
          +
          • +
        + + + +
          +
        • +

          NODE_OBJECT_KEY

          +
          public static final TreeType NODE_OBJECT_KEY
          +
          • +
        + + + +
          +
        • +

          NODE_KEYWORD

          +
          public static final TreeType NODE_KEYWORD
          +
          • +
        + + + +
          +
        • +

          NODE_STRING_VALUE

          +
          public static final TreeType NODE_STRING_VALUE
          +
          • +
        + + + +
          +
        • +

          QUOTED_TEXT

          +
          public static final TreeType QUOTED_TEXT
          +
          • +
        + + + +
          +
        • +

          TEXT_BLOCK

          +
          public static final TreeType TEXT_BLOCK
          +
          • +
        + + + +
          +
        • +

          NUMBER

          +
          public static final TreeType NUMBER
          +
          • +
        + + + +
          +
        • +

          SHAPE_ID

          +
          public static final TreeType SHAPE_ID
          +
          • +
        + + + +
          +
        • +

          ROOT_SHAPE_ID

          +
          public static final TreeType ROOT_SHAPE_ID
          +
          • +
        + + + +
          +
        • +

          ABSOLUTE_ROOT_SHAPE_ID

          +
          public static final TreeType ABSOLUTE_ROOT_SHAPE_ID
          +
          • +
        + + + +
          +
        • +

          SHAPE_ID_MEMBER

          +
          public static final TreeType SHAPE_ID_MEMBER
          +
          • +
        + + + +
          +
        • +

          NAMESPACE

          +
          public static final TreeType NAMESPACE
          +
          • +
        + + + +
          +
        • +

          IDENTIFIER

          +
          public static final TreeType IDENTIFIER
          +
          • +
        + + + +
          +
        • +

          SP

          +
          public static final TreeType SP
          +
          • +
        + + + +
          +
        • +

          WS

          +
          public static final TreeType WS
          +
          • +
        + + + +
          +
        • +

          COMMENT

          +
          public static final TreeType COMMENT
          +
          • +
        + + + +
          +
        • +

          BR

          +
          public static final TreeType BR
          +
          • +
        + + + +
          +
        • +

          COMMA

          +
          public static final TreeType COMMA
          +
          • +
        + + + +
          +
        • +

          ERROR

          +
          public static final TreeType ERROR
          +
          An ERROR tree is created when a parser error is encountered; that is, any parse tree that contains this node + is an invalid model.
          +
          • +
        + + + +
          +
        • +

          TOKEN

          +
          public static final TreeType TOKEN
          +
          The innermost node of the token tree that contains an actual token returned from IdlTokenizer.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static TreeType[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (TreeType c : TreeType.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static TreeType valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          optionalWs

          +
          protected static void optionalWs​(software.amazon.smithy.syntax.CapturingTokenizer tokenizer)
          +
          • +
        + + + +
          +
        • +

          optionalSpaces

          +
          protected static void optionalSpaces​(software.amazon.smithy.syntax.CapturingTokenizer tokenizer)
          +
          • +
        + + + +
          +
        • +

          parseShapeTypeAndName

          +
          protected static void parseShapeTypeAndName​(software.amazon.smithy.syntax.CapturingTokenizer tokenizer)
          +
          • +
        + + + +
          +
        • +

          parseShapeTypeAndName

          +
          protected static void parseShapeTypeAndName​(software.amazon.smithy.syntax.CapturingTokenizer tokenizer,
+                                            TreeType typeName)
          +
          • +
        + + + +
          +
        • +

          parseSharedStructureBodyWithinInline

          +
          protected static void parseSharedStructureBodyWithinInline​(software.amazon.smithy.syntax.CapturingTokenizer tokenizer)
          +
          • +
        + + + +
          +
        • +

          parseOptionalForResource

          +
          protected static void parseOptionalForResource​(software.amazon.smithy.syntax.CapturingTokenizer tokenizer)
          +
          • +
        + + + +
          +
        • +

          parseOptionalMixins

          +
          protected static void parseOptionalMixins​(software.amazon.smithy.syntax.CapturingTokenizer tokenizer)
          +
          • +
        + + + +
          +
        • +

          parseOptionalValueAssignment

          +
          protected static void parseOptionalValueAssignment​(software.amazon.smithy.syntax.CapturingTokenizer tokenizer)
          +
          • +
        + + + +
          +
        • +

          operationInputOutputDefinition

          +
          protected static void operationInputOutputDefinition​(software.amazon.smithy.syntax.CapturingTokenizer tokenizer)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/syntax/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/syntax/package-summary.html new file mode 100644 index 00000000000..ec43a766f7b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/syntax/package-summary.html @@ -0,0 +1,222 @@ + + + + + +software.amazon.smithy.syntax (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.syntax

    +
    +
    +
    + + +
    This package is currently marked as unstable. It will be marked as stable when it is integrated with the + Smithy LSP.
    +
    +
      +
    • + + + + + + + + + + + + +
      Interface Summary 
      InterfaceDescription
      TokenTree +
      Provides a labeled tree of tokens returned from IdlTokenizer.
      +
      +
      • +
    • + + + + + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      CapturedToken +
      A persisted token captured from an IdlTokenizer.
      +
      CapturedToken.Builder 
      Formatter +
      Formats valid Smithy IDL models.
      +
      TreeCursor +
      Externally traverses a TokenTree to provide access to parents and siblings.
      +
      +
      • +
    • + + + + + + + + + + + + +
      Enum Summary 
      EnumDescription
      TreeType +
      Defines the tree type.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/syntax/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/syntax/package-tree.html new file mode 100644 index 00000000000..04d441bb9f4 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/syntax/package-tree.html @@ -0,0 +1,188 @@ + + + + + +software.amazon.smithy.syntax Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.syntax

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +

    Enum Hierarchy

    +
      +
    • java.lang.Object +
        +
      • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) +
          +
        • software.amazon.smithy.syntax.TreeType
          • +
        +
        • +
      +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/traitcodegen/GenerateTraitDirective.html b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/GenerateTraitDirective.html new file mode 100644 index 00000000000..03c14603c0d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/GenerateTraitDirective.html @@ -0,0 +1,322 @@ + + + + + +GenerateTraitDirective (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.traitcodegen
    +

    Class GenerateTraitDirective

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.traitcodegen.GenerateTraitDirective
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class GenerateTraitDirective
+extends java.lang.Object
      +
      Custom directive that contains contextual information needed + to generate a trait class.
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/traitcodegen/SymbolProperties.html b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/SymbolProperties.html new file mode 100644 index 00000000000..509348e65d7 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/SymbolProperties.html @@ -0,0 +1,350 @@ + + + + + +SymbolProperties (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.traitcodegen
    +

    Class SymbolProperties

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.traitcodegen.SymbolProperties
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class SymbolProperties
+extends java.lang.Object
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        static java.lang.StringBASE_SYMBOL +
        The "base" symbol for a trait.
        +
        static java.lang.StringBUILDER_REF_INITIALIZER +
        Provides an initializer for the builder ref.
        +
        static java.lang.StringIS_PRIMITIVE +
        Indicates that the given symbol is a primitive type.
        +
        static java.lang.StringUNBOXED_SYMBOL +
        The unboxed or primitive version of a Symbol.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Field Detail

        + + + +
          +
        • +

          BUILDER_REF_INITIALIZER

          +
          public static final java.lang.String BUILDER_REF_INITIALIZER
          +
          Provides an initializer for the builder ref. + +

          This should always be included on collection shapes such as Maps and Lists.

          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        + + + +
          +
        • +

          BASE_SYMBOL

          +
          public static final java.lang.String BASE_SYMBOL
          +
          The "base" symbol for a trait. + +

          This is the symbol that the shape would resolve + to if it were not marked with `@trait`. This property is expected on all + trait symbols.

          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        + + + +
          +
        • +

          UNBOXED_SYMBOL

          +
          public static final java.lang.String UNBOXED_SYMBOL
          +
          The unboxed or primitive version of a Symbol. + +

          This property should be included on symbols such as `Integer` that + have the boxed version Integer and an unboxed (primitive) version + integer.

          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        + + + +
          +
        • +

          IS_PRIMITIVE

          +
          public static final java.lang.String IS_PRIMITIVE
          +
          Indicates that the given symbol is a primitive type. + +

          This property is checked for existence only and should have no meaningful value.

          +
          +
          See Also:
          +
          Constant Field Values
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/traitcodegen/TraitCodegenContext.html b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/TraitCodegenContext.html new file mode 100644 index 00000000000..10aecfe2d21 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/TraitCodegenContext.html @@ -0,0 +1,385 @@ + + + + + +TraitCodegenContext (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.traitcodegen
    +

    Class TraitCodegenContext

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.traitcodegen.TraitCodegenContext
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/traitcodegen/TraitCodegenPlugin.html b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/TraitCodegenPlugin.html new file mode 100644 index 00000000000..fcdc68e6119 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/TraitCodegenPlugin.html @@ -0,0 +1,351 @@ + + + + + +TraitCodegenPlugin (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.traitcodegen
    +

    Class TraitCodegenPlugin

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.traitcodegen.TraitCodegenPlugin
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      SmithyBuildPlugin
      +
      +
      +
      public final class TraitCodegenPlugin
+extends java.lang.Object
+implements SmithyBuildPlugin
      +
      Generates Java code implementations of traits from a Smithy model.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        TraitCodegenPlugin() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidexecute​(PluginContext context) +
        Executes the plugin, creating any number of artifacts.
        +
        java.lang.StringgetName() +
        Gets the name of the plugin.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          TraitCodegenPlugin

          +
          public TraitCodegenPlugin()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getName

          +
          public java.lang.String getName()
          +
          Description copied from interface: SmithyBuildPlugin
          +
          Gets the name of the plugin.
          +
          +
          Specified by:
          +
          getName in interface SmithyBuildPlugin
          +
          Returns:
          +
          Returns the name (e.g., "MyPlugin").
          +
          +
          • +
        + + + +
          +
        • +

          execute

          +
          public void execute​(PluginContext context)
          +
          Description copied from interface: SmithyBuildPlugin
          +
          Executes the plugin, creating any number of artifacts.
          +
          +
          Specified by:
          +
          execute in interface SmithyBuildPlugin
          +
          Parameters:
          +
          context - Plugin context for build execution.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/traitcodegen/TraitCodegenSettings.html b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/TraitCodegenSettings.html new file mode 100644 index 00000000000..d4f304df2e2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/TraitCodegenSettings.html @@ -0,0 +1,372 @@ + + + + + +TraitCodegenSettings (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.traitcodegen
    +

    Class TraitCodegenSettings

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.traitcodegen.TraitCodegenSettings
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class TraitCodegenSettings
+extends java.lang.Object
      +
      Settings for trait code generation. These can be set in the + smithy-build.json configuration for this plugin. + +

      The following options are provided: +

      +
      "packageName" (String)
      +
      Sets the package namespace to use for generated Java classes.
      +
      "headerLines" (List<String>)
      +
      Defines the header comment to include in all output files. Use + this setting to add license and/or author information to all generated files. Each entry in the list + is generated as a new line in the generated comment.
      +
      "excludeTags" (List<String>)
      +
      List of Smithy tags to use for filtering out trait shapes + from the trait code generation process.
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.util.List<java.lang.String>excludeTags() +
        List of tags to exclude from shape code generation.
        +
        static TraitCodegenSettingsfromNode​(ObjectNode node) +
        Loads settings from an ObjectNode.
        +
        java.util.List<java.lang.String>headerLines() +
        List of lines added to the top of every generated file as a header.
        +
        java.lang.StringpackageName() +
        Java package name to generate traits into.
        +
        java.lang.StringsmithyNamespace() +
        Smithy namespace to search for traits.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + +
          +
        • +

          fromNode

          +
          public static TraitCodegenSettings fromNode​(ObjectNode node)
          +
          Loads settings from an ObjectNode.
          +
          +
          Parameters:
          +
          node - object node to load settings from
          +
          Returns:
          +
          settings loaded from given node
          +
          +
          • +
        + + + +
          +
        • +

          packageName

          +
          public java.lang.String packageName()
          +
          Java package name to generate traits into.
          +
          +
          Returns:
          +
          package name
          +
          +
          • +
        + + + +
          +
        • +

          smithyNamespace

          +
          public java.lang.String smithyNamespace()
          +
          Smithy namespace to search for traits.
          +
          +
          Returns:
          +
          namespace
          +
          +
          • +
        + + + +
          +
        • +

          headerLines

          +
          public java.util.List<java.lang.String> headerLines()
          +
          List of lines added to the top of every generated file as a header.
          +
          +
          Returns:
          +
          header lines as a list
          +
          +
          • +
        + + + +
          +
        • +

          excludeTags

          +
          public java.util.List<java.lang.String> excludeTags()
          +
          List of tags to exclude from shape code generation.
          +
          +
          Returns:
          +
          tag list
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/traitcodegen/TraitCodegenUtils.html b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/TraitCodegenUtils.html new file mode 100644 index 00000000000..a582658e612 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/TraitCodegenUtils.html @@ -0,0 +1,482 @@ + + + + + +TraitCodegenUtils (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.traitcodegen
    +

    Class TraitCodegenUtils

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.traitcodegen.TraitCodegenUtils
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class TraitCodegenUtils
+extends java.lang.Object
      +
      Provides utility methods for trait code generation.
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static SymbolfromClass​(java.lang.Class<?> clazz) +
        Gets a Smithy codegen Symbol for a Java class.
        +
        static java.lang.StringgetDefaultName​(Shape shape) +
        Gets the default class name to use for a given Smithy Shape.
        +
        static java.lang.StringgetDefaultTraitName​(Shape shape) +
        Gets the default class name to use for a given Smithy Shape that + defines a trait.
        +
        static booleanisJavaString​(Symbol symbol) +
        Checks if a symbol maps to a Java String.
        +
        static booleanisJavaStringList​(Shape shape, + SymbolProvider symbolProvider) +
        Checks if a symbol maps to a Java List<String>.
        +
        static java.lang.StringmapNamespace​(java.lang.String rootSmithyNamespace, + java.lang.String shapeNamespace, + java.lang.String packageNamespace) +
        Maps a smithy namespace to a java package namespace.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Field Detail

        + + + +
          +
        • +

          JAVA_STRING_SYMBOL

          +
          public static final Symbol JAVA_STRING_SYMBOL
          +
          • +
        + + + +
          +
        • +

          RESERVED_WORDS_FILE

          +
          public static final java.net.URL RESERVED_WORDS_FILE
          +
          • +
        + + + +
          +
        • +

          SHAPE_ESCAPER

          +
          public static final ReservedWords SHAPE_ESCAPER
          +
          • +
        + + + +
          +
        • +

          MEMBER_ESCAPER

          +
          public static final ReservedWords MEMBER_ESCAPER
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          fromClass

          +
          public static Symbol fromClass​(java.lang.Class<?> clazz)
          +
          Gets a Smithy codegen Symbol for a Java class.
          +
          +
          Parameters:
          +
          clazz - class to get symbol for.
          +
          Returns:
          +
          Symbol representing the provided class.
          +
          +
          • +
        + + + +
          +
        • +

          getDefaultName

          +
          public static java.lang.String getDefaultName​(Shape shape)
          +
          Gets the default class name to use for a given Smithy Shape.
          +
          +
          Parameters:
          +
          shape - Shape to get name for.
          +
          Returns:
          +
          Default name.
          +
          +
          • +
        + + + +
          +
        • +

          getDefaultTraitName

          +
          public static java.lang.String getDefaultTraitName​(Shape shape)
          +
          Gets the default class name to use for a given Smithy Shape that + defines a trait.
          +
          +
          Parameters:
          +
          shape - Shape to get name for.
          +
          Returns:
          +
          Default name.
          +
          +
          • +
        + + + +
          +
        • +

          isJavaString

          +
          public static boolean isJavaString​(Symbol symbol)
          +
          Checks if a symbol maps to a Java String.
          +
          +
          Parameters:
          +
          symbol - Symbol to check.
          +
          Returns:
          +
          Returns true if the symbol maps to a Java String.
          +
          +
          • +
        + + + +
          +
        • +

          isJavaStringList

          +
          public static boolean isJavaStringList​(Shape shape,
+                                       SymbolProvider symbolProvider)
          +
          Checks if a symbol maps to a Java List<String>.
          +
          +
          Parameters:
          +
          shape - shape to check if it resolves to a list of java strings
          +
          symbolProvider - symbol provider to use for checking member type
          +
          Returns:
          +
          Returns true if the symbol maps to a Java String List.
          +
          +
          • +
        + + + +
          +
        • +

          mapNamespace

          +
          public static java.lang.String mapNamespace​(java.lang.String rootSmithyNamespace,
+                                            java.lang.String shapeNamespace,
+                                            java.lang.String packageNamespace)
          +
          Maps a smithy namespace to a java package namespace.
          +
          +
          Parameters:
          +
          rootSmithyNamespace - base smithy namespace in use for trait codegen trait discovery
          +
          shapeNamespace - namespace of shape to map into package namespace.
          +
          packageNamespace - Java package namespace for trait codegen.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/traitcodegen/generators/ShapeGenerator.html b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/generators/ShapeGenerator.html new file mode 100644 index 00000000000..8a4dcd5869c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/generators/ShapeGenerator.html @@ -0,0 +1,324 @@ + + + + + +ShapeGenerator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.traitcodegen.generators
    +

    Class ShapeGenerator

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.traitcodegen.generators.ShapeGenerator
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.util.function.Consumer<GenerateTraitDirective>
      +
      +
      +
      public final class ShapeGenerator
+extends java.lang.Object
+implements java.util.function.Consumer<GenerateTraitDirective>
      +
      Base class used for the generation of traits and nested shapes from a GenerateTraitDirective. + +

      This class will determine if a shape is a trait (i.e. has the TraitDefinition trait) or if the + shape provided should be treated as a nested shape (i.e. defines a simple pojo).

      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        ShapeGenerator() 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        voidaccept​(GenerateTraitDirective directive) 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

          Methods inherited from interface java.util.function.Consumer

          +andThen
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ShapeGenerator

          +
          public ShapeGenerator()
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/traitcodegen/generators/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/generators/package-summary.html new file mode 100644 index 00000000000..5f1f045e1ab --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/generators/package-summary.html @@ -0,0 +1,166 @@ + + + + + +software.amazon.smithy.traitcodegen.generators (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.traitcodegen.generators

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/traitcodegen/generators/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/generators/package-tree.html new file mode 100644 index 00000000000..11e6d402c9e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/generators/package-tree.html @@ -0,0 +1,161 @@ + + + + + +software.amazon.smithy.traitcodegen.generators Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.traitcodegen.generators

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    +
      +
    • java.lang.Object +
        +
      • software.amazon.smithy.traitcodegen.generators.ShapeGenerator (implements java.util.function.Consumer<T>)
        • +
      +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/TraitCodegenIntegration.html b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/TraitCodegenIntegration.html new file mode 100644 index 00000000000..85b8d103aa8 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/TraitCodegenIntegration.html @@ -0,0 +1,227 @@ + + + + + +TraitCodegenIntegration (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.traitcodegen.integrations
    +

    Interface TraitCodegenIntegration

    +
    +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/core/CoreIntegration.html b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/core/CoreIntegration.html new file mode 100644 index 00000000000..9134ecc9f83 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/core/CoreIntegration.html @@ -0,0 +1,409 @@ + + + + + +CoreIntegration (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.traitcodegen.integrations.core
    +

    Class CoreIntegration

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.traitcodegen.integrations.core.CoreIntegration
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      SmithyIntegration<TraitCodegenSettings,​TraitCodegenWriter,​TraitCodegenContext>, TraitCodegenIntegration
      +
      +
      +
      public final class CoreIntegration
+extends java.lang.Object
+implements TraitCodegenIntegration
      +
      Core integration for Trait code generation. + +

      This integration applies no built-in's, but decorates the Symbol provider to replace a + shape symbol with a trait symbol definition if the trait has the + TraitDefinition trait applied. + Trait symbols are named <ShapeName>Trait and always have a definition file. + This integration runs after all other integrations have finished to ensure that + any other type decorators and integrations have already been applied before creating any Trait + definitions from the resulting type.

      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/core/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/core/package-summary.html new file mode 100644 index 00000000000..f43dda1bd88 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/core/package-summary.html @@ -0,0 +1,166 @@ + + + + + +software.amazon.smithy.traitcodegen.integrations.core (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.traitcodegen.integrations.core

    +
    +
    +
      +
    • + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      CoreIntegration +
      Core integration for Trait code generation.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/core/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/core/package-tree.html new file mode 100644 index 00000000000..7c13b1b1436 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/core/package-tree.html @@ -0,0 +1,161 @@ + + + + + +software.amazon.smithy.traitcodegen.integrations.core Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.traitcodegen.integrations.core

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/idref/IdRefDecoratorIntegration.html b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/idref/IdRefDecoratorIntegration.html new file mode 100644 index 00000000000..517dc93194d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/idref/IdRefDecoratorIntegration.html @@ -0,0 +1,405 @@ + + + + + +IdRefDecoratorIntegration (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.traitcodegen.integrations.idref
    +

    Class IdRefDecoratorIntegration

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.traitcodegen.integrations.idref.IdRefDecoratorIntegration
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/idref/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/idref/package-summary.html new file mode 100644 index 00000000000..7423657126d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/idref/package-summary.html @@ -0,0 +1,167 @@ + + + + + +software.amazon.smithy.traitcodegen.integrations.idref (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.traitcodegen.integrations.idref

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/idref/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/idref/package-tree.html new file mode 100644 index 00000000000..6a1a4973fb0 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/idref/package-tree.html @@ -0,0 +1,161 @@ + + + + + +software.amazon.smithy.traitcodegen.integrations.idref Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.traitcodegen.integrations.idref

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/javadoc/JavaDocIntegration.html b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/javadoc/JavaDocIntegration.html new file mode 100644 index 00000000000..34e9557011f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/javadoc/JavaDocIntegration.html @@ -0,0 +1,365 @@ + + + + + +JavaDocIntegration (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.traitcodegen.integrations.javadoc
    +

    Class JavaDocIntegration

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.traitcodegen.integrations.javadoc.JavaDocIntegration
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/javadoc/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/javadoc/package-summary.html new file mode 100644 index 00000000000..e4bd93c6520 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/javadoc/package-summary.html @@ -0,0 +1,166 @@ + + + + + +software.amazon.smithy.traitcodegen.integrations.javadoc (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.traitcodegen.integrations.javadoc

    +
    +
    +
      +
    • + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      JavaDocIntegration +
      Adds all built-in Javadoc-generating interceptors.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/javadoc/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/javadoc/package-tree.html new file mode 100644 index 00000000000..6291cbf92c9 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/javadoc/package-tree.html @@ -0,0 +1,161 @@ + + + + + +software.amazon.smithy.traitcodegen.integrations.javadoc Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.traitcodegen.integrations.javadoc

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/package-summary.html new file mode 100644 index 00000000000..b1bb98743e3 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/package-summary.html @@ -0,0 +1,166 @@ + + + + + +software.amazon.smithy.traitcodegen.integrations (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.traitcodegen.integrations

    +
    +
    +
      +
    • + + + + + + + + + + + + +
      Interface Summary 
      InterfaceDescription
      TraitCodegenIntegration +
      Allows additional functionality to be added into the trait codegen generator.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/package-tree.html new file mode 100644 index 00000000000..788b1ab45b5 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/package-tree.html @@ -0,0 +1,161 @@ + + + + + +software.amazon.smithy.traitcodegen.integrations Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.traitcodegen.integrations

    +Package Hierarchies: + +
    +
    +
    +

    Interface Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/uniqueitems/UniqueItemDecoratorIntegration.html b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/uniqueitems/UniqueItemDecoratorIntegration.html new file mode 100644 index 00000000000..6744816f599 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/uniqueitems/UniqueItemDecoratorIntegration.html @@ -0,0 +1,431 @@ + + + + + +UniqueItemDecoratorIntegration (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.traitcodegen.integrations.uniqueitems
    +

    Class UniqueItemDecoratorIntegration

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.traitcodegen.integrations.uniqueitems.UniqueItemDecoratorIntegration
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/uniqueitems/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/uniqueitems/package-summary.html new file mode 100644 index 00000000000..5ad4d836f20 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/uniqueitems/package-summary.html @@ -0,0 +1,166 @@ + + + + + +software.amazon.smithy.traitcodegen.integrations.uniqueitems (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.traitcodegen.integrations.uniqueitems

    +
    +
    +
      +
    • + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      UniqueItemDecoratorIntegration +
      Handles type conversions associated with the use of the UniqueItems trait.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/uniqueitems/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/uniqueitems/package-tree.html new file mode 100644 index 00000000000..abdc77451d6 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/integrations/uniqueitems/package-tree.html @@ -0,0 +1,161 @@ + + + + + +software.amazon.smithy.traitcodegen.integrations.uniqueitems Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.traitcodegen.integrations.uniqueitems

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/traitcodegen/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/package-summary.html new file mode 100644 index 00000000000..840c50dc0e2 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/package-summary.html @@ -0,0 +1,195 @@ + + + + + +software.amazon.smithy.traitcodegen (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.traitcodegen

    +
    +
    +
      +
    • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      GenerateTraitDirective +
      Custom directive that contains contextual information needed + to generate a trait class.
      +
      SymbolProperties 
      TraitCodegenContext +
      Contextual information that is made available during most parts of trait code generation.
      +
      TraitCodegenPlugin +
      Generates Java code implementations of traits from a Smithy model.
      +
      TraitCodegenSettings +
      Settings for trait code generation.
      +
      TraitCodegenUtils +
      Provides utility methods for trait code generation.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/traitcodegen/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/package-tree.html new file mode 100644 index 00000000000..806c648f1f0 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/package-tree.html @@ -0,0 +1,166 @@ + + + + + +software.amazon.smithy.traitcodegen Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.traitcodegen

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/traitcodegen/sections/BuilderClassSection.html b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/sections/BuilderClassSection.html new file mode 100644 index 00000000000..86f85cab29f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/sections/BuilderClassSection.html @@ -0,0 +1,320 @@ + + + + + +BuilderClassSection (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.traitcodegen.sections
    +

    Class BuilderClassSection

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.traitcodegen.sections.BuilderClassSection
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      CodeSection
      +
      +
      +
      public final class BuilderClassSection
+extends java.lang.Object
+implements CodeSection
      +
      Contains the static builder class for a shape.
      +
      • +
    +
    +
    +
      +
    • + +
      + +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        Symbolsymbol() +
        Symbol representing the enclosing class for this builder.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          BuilderClassSection

          +
          public BuilderClassSection​(Symbol symbol)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          symbol

          +
          public Symbol symbol()
          +
          Symbol representing the enclosing class for this builder.
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/traitcodegen/sections/ClassSection.html b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/sections/ClassSection.html new file mode 100644 index 00000000000..3b4a6483e96 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/sections/ClassSection.html @@ -0,0 +1,320 @@ + + + + + +ClassSection (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.traitcodegen.sections
    +

    Class ClassSection

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.traitcodegen.sections.ClassSection
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      CodeSection
      +
      +
      +
      public final class ClassSection
+extends java.lang.Object
+implements CodeSection
      +
      Contains a Java class defining a trait or nested shape.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        ClassSection​(Shape shape) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        Shapeshape() +
        Shape that this Java class represents.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          ClassSection

          +
          public ClassSection​(Shape shape)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          shape

          +
          public Shape shape()
          +
          Shape that this Java class represents.
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/traitcodegen/sections/EnumVariantSection.html b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/sections/EnumVariantSection.html new file mode 100644 index 00000000000..9257c4b9daf --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/sections/EnumVariantSection.html @@ -0,0 +1,320 @@ + + + + + +EnumVariantSection (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.traitcodegen.sections
    +

    Class EnumVariantSection

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.traitcodegen.sections.EnumVariantSection
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      CodeSection
      +
      +
      +
      public final class EnumVariantSection
+extends java.lang.Object
+implements CodeSection
      +
      Contains an enum variant.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          EnumVariantSection

          +
          public EnumVariantSection​(MemberShape memberShape)
          +
          • +
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/traitcodegen/sections/GetterSection.html b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/sections/GetterSection.html new file mode 100644 index 00000000000..3631fdb27d4 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/sections/GetterSection.html @@ -0,0 +1,320 @@ + + + + + +GetterSection (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.traitcodegen.sections
    +

    Class GetterSection

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.traitcodegen.sections.GetterSection
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      CodeSection
      +
      +
      +
      public final class GetterSection
+extends java.lang.Object
+implements CodeSection
      +
      Contains a getter method.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        GetterSection​(Shape shape) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        Shapeshape() +
        Shape that this getter returns a Java object for.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          GetterSection

          +
          public GetterSection​(Shape shape)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          shape

          +
          public Shape shape()
          +
          Shape that this getter returns a Java object for.
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/traitcodegen/sections/JavaDocSection.html b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/sections/JavaDocSection.html new file mode 100644 index 00000000000..4cb9135a942 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/sections/JavaDocSection.html @@ -0,0 +1,320 @@ + + + + + +JavaDocSection (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.traitcodegen.sections
    +

    Class JavaDocSection

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.traitcodegen.sections.JavaDocSection
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      CodeSection
      +
      +
      +
      public final class JavaDocSection
+extends java.lang.Object
+implements CodeSection
      +
      Contains a Java doc section attached to a class or method.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        JavaDocSection​(Shape shape) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        Shapeshape() +
        Shape that the class the Javadoc is added to represents.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          JavaDocSection

          +
          public JavaDocSection​(Shape shape)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          shape

          +
          public Shape shape()
          +
          Shape that the class the Javadoc is added to represents.
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/traitcodegen/sections/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/sections/package-summary.html new file mode 100644 index 00000000000..ce6b23bebaa --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/sections/package-summary.html @@ -0,0 +1,190 @@ + + + + + +software.amazon.smithy.traitcodegen.sections (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.traitcodegen.sections

    +
    +
    +
      +
    • + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      BuilderClassSection +
      Contains the static builder class for a shape.
      +
      ClassSection +
      Contains a Java class defining a trait or nested shape.
      +
      EnumVariantSection +
      Contains an enum variant.
      +
      GetterSection +
      Contains a getter method.
      +
      JavaDocSection +
      Contains a Java doc section attached to a class or method.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/traitcodegen/sections/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/sections/package-tree.html new file mode 100644 index 00000000000..f6733e6aae6 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/sections/package-tree.html @@ -0,0 +1,165 @@ + + + + + +software.amazon.smithy.traitcodegen.sections Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.traitcodegen.sections

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/traitcodegen/writer/TraitCodegenWriter.html b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/writer/TraitCodegenWriter.html new file mode 100644 index 00000000000..34ef874e859 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/writer/TraitCodegenWriter.html @@ -0,0 +1,496 @@ + + + + + +TraitCodegenWriter (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.traitcodegen.writer
    +

    Class TraitCodegenWriter

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      SymbolDependencyContainer
      +
      +
      +
      public class TraitCodegenWriter
+extends SymbolWriter<TraitCodegenWriter,​software.amazon.smithy.traitcodegen.writer.TraitCodegenImportContainer>
      +
      Writes Java code for trait definitions. + +

      This writer supports two custom formatters, a Java type formatter '$T' and + a Base type formatter '$B'. +

        +
      • TraitCodegenWriter.JavaTypeFormatter|'T': This formatter handles the formatting of + Java types and also ensures that parameterized types (such as List<String> are + written correctly. + +
      • TraitCodegenWriter.BaseTypeFormatter|'B': This formatter allows you to use the base type + for a trait. For example a String Trait may have a base type of ShapeId. To write + this base type, use the $B formatter and provide the trait symbol. Note that + if no base type is found (i.e. type is not a trait) then this formatter behaves exactly the + same as the TraitCodegenWriter.JavaTypeFormatter. +
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          TraitCodegenWriter

          +
          public TraitCodegenWriter​(java.lang.String fileName,
+                          java.lang.String namespace,
+                          TraitCodegenSettings settings)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          openDocstring

          +
          public void openDocstring()
          +
          • +
        + + + +
          +
        • +

          writeDocStringContents

          +
          public void writeDocStringContents​(java.lang.String contents)
          +
          • +
        + + + +
          +
        • +

          writeDocStringContents

          +
          public void writeDocStringContents​(java.lang.String contents,
+                                   java.lang.Object... args)
          +
          • +
        + + + +
          +
        • +

          closeDocstring

          +
          public void closeDocstring()
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          Description copied from class: AbstractCodeWriter
          +
          Gets the contents of the generated code. + +

          The result will have an appended newline if the AbstractCodeWriter is + configured to always append a newline. A newline is only appended + in these cases if the result does not already end with a newline.

          +
          +
          Overrides:
          +
          toString in class AbstractCodeWriter<TraitCodegenWriter>
          +
          Returns:
          +
          Returns the generated code.
          +
          +
          • +
        + + + +
          +
        • +

          getPackageHeader

          +
          public java.lang.String getPackageHeader()
          +
          • +
        + + + +
          +
        • +

          getHeader

          +
          public java.lang.String getHeader()
          +
          • +
        + + + +
          +
        • +

          newLine

          +
          public void newLine()
          +
          • +
        + + + +
          +
        • +

          override

          +
          public void override()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/traitcodegen/writer/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/writer/package-summary.html new file mode 100644 index 00000000000..9ecf0f5074e --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/writer/package-summary.html @@ -0,0 +1,166 @@ + + + + + +software.amazon.smithy.traitcodegen.writer (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.traitcodegen.writer

    +
    +
    +
      +
    • + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      TraitCodegenWriter +
      Writes Java code for trait definitions.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/traitcodegen/writer/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/writer/package-tree.html new file mode 100644 index 00000000000..b033865d317 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/traitcodegen/writer/package-tree.html @@ -0,0 +1,169 @@ + + + + + +software.amazon.smithy.traitcodegen.writer Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.traitcodegen.writer

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/utils/AbstractCodeWriter.html b/javadoc/1.47.0/software/amazon/smithy/utils/AbstractCodeWriter.html new file mode 100644 index 00000000000..43893bf09cf --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/utils/AbstractCodeWriter.html @@ -0,0 +1,2890 @@ + + + + + +AbstractCodeWriter (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.utils
    +

    Class AbstractCodeWriter<T extends AbstractCodeWriter<T>>

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.utils.AbstractCodeWriter<T>
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Direct Known Subclasses:
      +
      CodeWriter, SimpleCodeWriter, SymbolWriter, SymbolWriter
      +
      +
      +
      public abstract class AbstractCodeWriter<T extends AbstractCodeWriter<T>>
+extends java.lang.Object
      +
      Helper class for generating code. + +

      An AbstractCodeWriter can be used to write basically any kind of code, including + whitespace sensitive and brace-based. + +

      The following example generates some Python code: + + 

      
+ SimpleCodeWriter writer = new SimpleCodeWriter();
+ writer.write("def Foo(str):")
+       .indent()
+       .write("print str");
+ String code = writer.toString();
+
      + +

      Code interpolation

      + +

      The write(java.lang.Object, java.lang.Object...), openBlock(java.lang.String, java.lang.Object...), and closeBlock(java.lang.String, java.lang.Object...) methods + take a code expression and a variadic list of arguments that are + interpolated into the expression. Consider the following call to + write: + + 

      
+ SimpleCodeWriter = new SimpleCodeWriter();
+ writer.write("Hello, $L", "there!");
+ String code = writer.toString();
+
      + +

      In the above example, $L is interpolated and replaced with the + relative argument there!. + +

      An AbstractCodeWriter supports three kinds of interpolations: relative, + positional, and named. Each of these kinds of interpolations pass a value + to a formatter.

      + +

      Formatters

      + +

      Formatters are named functions that accept an object as input, accepts a + string that contains the current indentation (it can be ignored if not useful), + and returns a string as output. AbstractCodeWriter registers two built-in + formatters: + +

        +
      • L (literal): Outputs a literal value of an Object using + the following implementation: (1) A null value is formatted as "". + (2) An empty Optional value is formatted as "". (3) A non-empty + Optional value is recursively formatted using the value inside + of the Optional. (3) All other valeus are formatted using the + result of calling String.valueOf(java.lang.Object).
        • + +
      • C (call): Runs a Runnable or Consumer argument + that is expected to write to the same writer. Any text written to the AbstractCodeWriter + inside of the Runnable is used as the value of the argument. Note that a + single trailing newline is removed from the captured text. If a Runnable is + provided, it is required to have a reference to the AbstractCodeWriter. A Consumer + is provided a reference to the AbstractCodeWriter as a single argument. + + 
        
+     SimpleCodeWriter writer = new SimpleCodeWriter();
+     writer.write("Hello, $C.", (Runnable) () -> writer.write("there"));
+     assert(writer.toString().equals("Hello, there.\n"));
+
        • + +
      • S (string): Adds double quotes around the result of formatting a + value first using the default literal "L" implementation described + above and then wrapping the value in an escaped string safe for use in + Java according to https://docs.oracle.com/javase/specs/jls/se7/html/jls-3.html#jls-3.10.6. + This formatter can be overridden if needed to support other + programming languages.
        • +
      + +

      Custom formatters can be registered using putFormatter(char, java.util.function.BiFunction<java.lang.Object, java.lang.String, java.lang.String>). Custom + formatters can be used only within the state they were added. Because states + inherit the formatters of parent states, adding a formatter to the root state + of the AbstractCodeWriter allows the formatter to be used in any state. + +

      The identifier given to a formatter must match one of the following + characters: + + 

      +    "!" / "#" / "%" / "&" / "*" / "+" / "," / "-" / "." / "/" / ";"
+  / "=" / "?" / "@" / "A" / "B" / "C" / "D" / "E" / "F" / "G" / "H"
+  / "I" / "J" / "K" / "L" / "M" / "N" / "O" / "P" / "Q" / "R" / "S"
+  / "T" / "U" / "V" / "W" / "X" / "Y" / "Z" / "^" / "_" / "`" / "~"
+
      + +

      Relative parameters

      + +

      Placeholders in the form of "$" followed by a formatter name are treated + as relative parameters. The first instance of a relative parameter + interpolates the first positional argument, the second the second, etc. + + 

      
+ SimpleCodeWriter = new SimpleCodeWriter();
+ writer.write("$L $L $L", "a", "b", "c");
+ System.out.println(writer.toString());
+ // Outputs: "a b c"
+
      + +

      All relative arguments must be used as part of an expression and + relative interpolation cannot be mixed with positional variables. + +

      Positional parameters

      + +

      Placeholders in the form of "$" followed by a positive number, + followed by a formatter name are treated as positional parameters. The + number refers to the 1-based index of the argument to interpolate. + + 

      
+ SimpleCodeWriter = new SimpleCodeWriter();
+ writer.write("$1L $2L $3L, $3L $2L $1L", "a", "b", "c");
+ System.out.println(writer.toString());
+ // Outputs: "a b c c b a"
+
      + +

      All positional arguments must be used as part of an expression + and relative interpolation cannot be mixed with positional variables. + +

      Named parameters

      + +

      Named parameters are parameters that take a value from the context bag of + the current state or using getters of the CodeSection associated with + the current state. They take the following form $<variable>:<formatter>, + where <variable> is a string that starts with a lowercase letter, + followed by any number of [A-Za-z0-9_#$.] characters, and + <formatter> is the name of a formatter. + + 

      
+ SimpleCodeWriter = new SimpleCodeWriter();
+ writer.putContext("foo", "a");
+ writer.putContext("baz.bar", "b");
+ writer.write("$foo:L $baz.bar:L");
+ System.out.println(writer.toString());
+ // Outputs: "a b"
+
      + +

      The context bag is checked first, and then if the parameter is not found, + getters of the currently associated CodeSection are checked. If a getter is + found that matches the key exactly, then that getter is invoked and used as + the named parameter. If a getter is found that matches + "get" + uppercase_first_letter(key), then that getter is used as the named + parameter. + +

      Escaping interpolation

      + +

      You can escape the "$" character using two "$$". + + 

      
+ SimpleCodeWriter = new SimpleCodeWriter().write("$$L");
+ System.out.println(writer.toString());
+ // Outputs: "$L"
+
      + +

      Custom expression characters

      + +

      The character used to start a code block expression can be customized + to make it easier to write code that makes heavy use of $. The + default character used to start an expression is, $, but this can + be changed for the current state of the AbstractCodeWriter by calling + setExpressionStart(char). A custom start character can be escaped + using two start characters in a row. For example, given a custom start + character of #, # can be escaped using ##. + + 

      
+ SimpleCodeWriter = new SimpleCodeWriter();
+ writer.setExpressionStart('#');
+ writer.write("#L ##L $L", "hi");
+ System.out.println(writer.toString());
+ // Outputs: "hi #L $L"
+
      + + The start character cannot be set to ' ' or '\n'. + +

      Opening and closing blocks

      + +

      AbstractCodeWriter provides a short cut for opening code blocks that + have an opening an closing delimiter (for example, "{" and "}") and that + require indentation inside of the delimiters. Calling openBlock(java.lang.String, java.lang.Object...) + and providing the opening statement will write and format a line followed + by indenting one level. Calling closeBlock(java.lang.String, java.lang.Object...) will first dedent and + then print a formatted statement. + + 

      
+ SimpleCodeWriter = new SimpleCodeWriter()
+       .openBlock("if ($L) {", someValue)
+       .write("System.out.println($S);", "Hello!")
+       .closeBlock("}");
+
      + +

      The above example outputs (assuming someValue is equal to "foo"): + + 

      
+ if (foo) {
+     System.out.println("Hello!");
+ }
+
      + +

      Pushing and popping state

      + +

      AbstractCodeWriter can maintain a stack of transformation states, including + the text used to indent, a prefix to add before each line, newline character, + the number of times to indent, a map of context values, whether or not + whitespace is trimmed from the end of newlines, whether or not the automatic + insertion of newlines is disabled, the character used to start code + expressions (defaults to $), and formatters. State can be pushed onto + the stack using pushState() which copies the current state. Mutations + can then be made to the top-most state of the AbstractCodeWriter and do not affect + previous states. The previous transformation state of the AbstractCodeWriter can later + be restored using popState(). + +

      AbstractCodeWriter is stateful, and a prefix can be added before each line. + This is useful for doing things like create Javadoc strings: + + 

      
+ SimpleCodeWriter = new SimpleCodeWriter();
+ writer
+       .pushState()
+       .write("/**")
+       .setNewlinePrefix(" * ")
+       .write("This is some docs.")
+       .write("And more docs.\n\n\n")
+       .write("Foo.")
+       .popState()
+       .write(" *\/");
+
      + +

      The above example outputs: + + 

      
+ /**
+  * This is some docs.
+  * And more docs.
+  *
+  * Foo.
+  *\/
+
+   ^ Minus this escape character
+
      + +

      AbstractCodeWriter maintains some global state that is not affected by + pushState() and popState(): + +

        +
      • The number of successive blank lines to trim.
        • +
      • Whether or not a trailing newline is inserted or removed from + the result of converting the AbstractCodeWriter to a string.
        • +
      + +

      Limiting blank lines

      + +

      Many coding standards recommend limiting the number of successive blank + lines. This can be handled automatically by AbstractCodeWriter by calling + trimBlankLines. The removal of blank lines is handled when the + AbstractCodeWriter is converted to a string. Lines that consist solely + of spaces or tabs are considered blank. If the number of blank lines + exceeds the allowed threshold, they are omitted from the result. + +

      Trimming trailing spaces

      + +

      Trailing spaces can be automatically trimmed from each line by calling + trimTrailingSpaces(). + +

      In the following example: + + 

      
+ SimpleCodeWriter = new SimpleCodeWriter();
+ String result = writer.trimTrailingSpaces().write("hello  ").toString();
+
      + +

      The value of result contains "hello" + +

      Extending AbstractCodeWriter

      + +

      AbstractCodeWriter can be extended to add functionality for specific + programming languages. For example, Java specific code generator could + be implemented that makes it easier to write Javadocs. + + 

      
+ class JavaCodeWriter extends AbstractCodeWriter<JavaCodeWriter> {
+     public JavaCodeWriter javadoc(Runnable runnable) {
+         pushState()
+         write("/**")
+         setNewlinePrefix(" * ")
+         runnable.run();
+         popState()
+         write(" *\/");
+         return this;
+     }
+ }
+
+ JavaCodeWriter writer = new JavaCodeWriter();
+ writer.javadoc(() -> {
+     writer.write("This is an example.");
+ });
+
      + +

      Code sections

      + +

      Named sections can be marked in the code writer that can be intercepted + and modified by section interceptors. This gives the + AbstractCodeWriter a lightweight extension system for augmenting generated + code. + +

      A section of code can be captured using a block state or an inline + section. Section names must match the following regular expression: + ^[a-z]+[a-zA-Z0-9_.#$]*$. + +

      Block states

      + +

      A block section is created by passing a string to pushState(). + This string gives the state a name and captures all of the output written + inside of this state to an internal buffer. This buffer is then passed to + each registered interceptor for that name. These interceptors can choose + to use the default contents of the section or emit entirely different + content. Interceptors are expected to make calls to the AbstractCodeWriter + in order to emit content. Interceptors need to have a reference to the + AbstractCodeWriter as one is not provided to them when they are invoked. + Interceptors are invoked in the order in which they are added to the + CodeBuilder. + + 

      
+ SimpleCodeWriter = new SimpleCodeWriter();
+ writer.onSection("example", text -> writer.write("Intercepted: " + text));
+ writer.pushState("example");
+ writer.write("Original contents");
+ writer.popState();
+ System.out.println(writer.toString());
+ // Outputs: "Intercepted: Original contents\n"
+
      + +

      Inline sections

      + + An inline section is created using a special CodeWriter interpolation + format that appends "@" followed by the section name. Inline sections are + function just like block sections, but they can appear inline inside of + other content passed in calls to write(java.lang.Object, java.lang.Object...). An inline section + that makes no calls to write(java.lang.Object, java.lang.Object...) expands to an empty string. + +

      Inline sections are created in a format string inside of braced arguments + after the formatter. For example, ${L@foo} is an inline section + that uses the literal "L" value of a relative argument as the default value + of the section and allows AbstractCodeWriter registered for the "foo" section to + make calls to the CodeWriter to modify the section. + + 

      
+ SimpleCodeWriter = new SimpleCodeWriter();
+ writer.onSection("example", text -> writer.write("Intercepted: " + text));
+ writer.write("Leading text...${L@example}...Trailing text...", "foo");
+ System.out.println(writer.toString());
+ // Outputs: "Leading text...Intercepted: foo...Trailing text...\n"
+
      + + Inline sections are useful for composing sets or lists from any code with access to AbstractCodeWriter: + + 
      
+ SimpleCodeWriter = new SimpleCodeWriter();
+ writer.onSection("example", text -> writer.write(text + "1, "));
+ writer.onSection("example", text -> writer.write(text + "2, "));
+ writer.onSection("example", text -> writer.write(text + "3"));
+ writer.write("[${L@example}]", "");
+ System.out.println(writer.toString());
+ // Outputs: "[1, 2, 3]\n"
+
      + +

      Inline block alignment

      + +

      The long-form interpolation syntax allows for + inline block alignment, which means that any newline emitted by + the interpolation is automatically aligned with the column of where the + interpolation occurs. Inline block indentation is defined by preceding + the closing '}' character with '|' (e.g., ${L|}): + + 

      
+ SimpleCodeWriter = new SimpleCodeWriter();
+ writer.write("$L: ${L|}", "Names", "Bob\nKaren\nLuis");
+ System.out.println(writer.toString());
+ // Outputs: "Names: Bob\n       Karen\n       Luis\n"
+
      + +

      Alignment occurs either statically or dynamically based on the characters + that come before interpolation. If all of the characters in the literal + template that come before interpolation are spaces and tabs, then those + characters are used when indenting newlines. Otherwise, the number of + characters written as the template result that come before interpolation + are used when indenting (this takes into account any interpolation that + may precede block interpolation). + +

      Block interpolation is particularly used when using text blocks in Java + because it allows templates to more closely match their end result. + + 

      
+ // Assume handleNull, handleA, and handleB are Runnable.
+ writer.write("""
+     if (foo == null) {
+         ${C|}
+     } else if (foo == "a") {
+         ${C|}
+     } else if (foo == "b") {
+         ${C|}
+     }
+     """,
+     handleNull,
+     handleA,
+     handleB);
+
      + +

      Template conditionals and loops

      + +

      AbstractCodeWriter is a lightweight template engine that supports conditional + blocks and loops. + +

      Conditional blocks

      + +

      Conditional blocks are defined using the following syntax: + + 

      
+ ${?foo}
+ Foo is set: ${foo:L}
+ ${/foo}
+
      + +

      Assuming foo is truthy and set to "hi", then the above template + outputs: "Foo is set: hi" + +

      In the above example, "?" indicates that the expression is a conditional block + to check if the named parameter "foo" is truthy. If it is, then the contents of the + block up to the matching closing block, ${/foo}, are evaluated. If the + condition is not satisfied, then contents of the block are skipped. + +

      You can check if a named property is falsey using "^": + + 

      
+ ${^foo}
+ Foo is not set
+ ${/foo}
+
      + +

      Assuming foo is set to "hi", then the above template outputs nothing. + If foo is falsey, then the above template output "Foo is not set". + +

      Truthy and falsey

      + +

      The following values are considered falsey: + +

        +
      • values that are not found
        • +
      • null values
        • +
      • false
        • +
      • empty String
        • +
      • empty Iterable
        • +
      • empty Map
        • +
      • empty Optional
        • +
      + +

      Values that are not falsey are considered truthy. + +

      Loops

      + +

      Loops can be created to repeat a section of a template for each value stored in + a list or each each key value pair stored in a map. Loops are created using "#". + +

      The following template with a "foo" value of {"key1": "a", "key2": "b", "key3": "c"}: + + 

      
+ ${#foo}
+ - ${key:L}: ${value:L} (first: ${key.first:L}, last: ${key.last:L})
+ ${/foo}
+
      + +

      Evaluates to:

      + + 
      
+ - key1: a (first: true, last: false)
+ - key2: b (first: false, last: false)
+ - key3: c (first: false, last: true)
+
      + +

      Each iteration of the loop pushes a new state in the writer that sets the following + context properties: + +

        +
      • key: contains the current 0-based index of an iterator or the current key of a map entry
        • +
      • value: contains the current value of an iterator or current value of a map entry
        • +
      • key.first: set to true if the loop is on the first iteration
        • +
      • key.false: set to true if the loop is on the last iteration
        • +
      + +

      A custom variable name can be used in loops. For example: + + 

      
+ ${#foo as key1, value1}
+     - ${key1:L}: ${value1:L} (first: ${key1.first:L}, last: ${key1.last:L})
+ ${/foo}
+
      + +

      Whitespace control

      + +

      Conditional blocks that occur on lines that only contain whitespace are not written + to the template output. For example, if the condition in the following template evaluates + to falsey, then the template expands to an empty string: + + 

      
+ ${?foo}
+ Foo is set: ${foo:L}
+ ${/foo}
+
      + +

      Whitespace that comes before an expression can be removed by putting "~" at the beginning of an expression. + +

      Assuming that the first positional argument is "hi": + + 

      
+ Greeting:
+     ${~L}
+
      + +

      Expands to: + + 

      
+ Greeting:hi
+
      + +

      Whitespace that comes after an expression can be removed by adding "~" to the end of the expression: + + 

      
+ ${L~}
+
+ .
+
      + +

      Expands to: + + 

      
+ hi.
+
      + +

      Leading whitespace cannot be removed when using inline block alignment ('|'). The following is invalid: + + 

      
+ ${~C|}
+
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        AbstractCodeWriter() +
        Creates a new SimpleCodeWriter that uses "\n" for a newline, four spaces + for indentation, does not strip trailing whitespace, does not flatten + multiple successive blank lines into a single blank line, and adds no + trailing new line.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        Tcall​(java.lang.Runnable task) +
        Allows calling out to arbitrary code for things like looping or + conditional writes without breaking method chaining.
        +
        TcloseBlock​(java.lang.String textAfterNewline, + java.lang.Object... args) +
        Closes a block of syntax by writing a newline, dedenting, then writing text.
        +
        java.util.function.Consumer<T>consumer​(java.util.function.Consumer<T> consumer) +
        A simple helper method that makes it easier to invoke the built-in C + (call) formatter using a Consumer where T is the specific type + of AbstractCodeWriter.
        +
        voidcopySettingsFrom​(AbstractCodeWriter<T> other) +
        Copies settings from the given AbstractCodeWriter into this AbstractCodeWriter.
        +
        Tdedent() +
        Removes one level of indentation from all lines.
        +
        Tdedent​(int levels) +
        Removes a specific number of indentations from all lines.
        +
        TdisableNewlines() +
        Disables the automatic appending of newlines in the current state.
        +
        TenableNewlines() +
        Enables the automatic appending of newlines in the current state.
        +
        TenableStackTraceComments​(boolean enableStackTraceComments) +
        Enable or disable writing stack trace comments before each call to + write(java.lang.Object, java.lang.Object...), writeWithNoFormatting(java.lang.Object), writeInline(java.lang.Object, java.lang.Object...), + and writeInlineWithNoFormatting(java.lang.Object).
        +
        TensureNewline() +
        Ensures that the last text written to the writer was a newline as defined in + the current state and inserts one if necessary.
        +
        java.lang.Stringformat​(java.lang.Object content, + java.lang.Object... args) +
        Creates a formatted string using formatter expressions and variadic + arguments.
        +
        static java.lang.StringformatLiteral​(java.lang.Object value) +
        Provides the default functionality for formatting literal values.
        +
        protected java.lang.StringformatWithStackTraceElement​(java.lang.String content, + java.lang.StackTraceElement element, + boolean inline) +
        Formats content for the given stack frame.
        +
        java.lang.ObjectgetContext​(java.lang.String key) +
        Gets a named contextual key-value pair from the current state or any parent states.
        +
        <C> CgetContext​(java.lang.String key, + java.lang.Class<C> type) +
        Gets a named context key-value pair from the current state and + casts the value to the given type.
        +
        CodeWriterDebugInfogetDebugInfo() +
        Gets debug information about the current state of the AbstractCodeWriter, including + the path to the current state as returned by getStateDebugPath(), + and up to the last two lines of text written to the AbstractCodeWriter.
        +
        CodeWriterDebugInfogetDebugInfo​(int numberOfContextLines) +
        Gets debug information about the current state of the AbstractCodeWriter.
        +
        chargetExpressionStart() +
        Get the expression start character of the current state.
        +
        intgetIndentLevel() +
        Gets the indentation level of the current state.
        +
        java.lang.StringgetIndentText() +
        Gets the text used for indentation (defaults to four spaces).
        +
        booleangetInsertTrailingNewline() +
        Checks if the AbstractCodeWriter inserts a trailing newline (if necessary) when + converted to a string.
        +
        java.lang.StringgetNewline() +
        Gets the character used to represent newlines in the current state.
        +
        java.lang.StringgetNewlinePrefix() +
        Gets the prefix to prepend to every line after a new line is added + (except for an inserted trailing newline).
        +
        intgetTrimBlankLines() +
        Returns the number of allowed consecutive newlines that are not + trimmed by the AbstractCodeWriter when written to a string.
        +
        booleangetTrimTrailingSpaces() +
        Returns true if the trailing spaces in the current state are trimmed.
        +
        Tindent() +
        Indents all text one level.
        +
        Tindent​(int levels) +
        Indents all text a specific number of levels.
        +
        TinjectSection​(CodeSection section) +
        Creates a section that contains no content used to allow CodeInterceptors + to inject content at specific locations.
        +
        TinsertTrailingNewline() +
        Configures the AbstractCodeWriter to always append a newline at the end of + the text if one is not already present.
        +
        TinsertTrailingNewline​(boolean trailingNewline) +
        Configures the AbstractCodeWriter to always append a newline at the end of + the text if one is not already present.
        +
        protected booleanisStackTraceRelevant​(java.lang.StackTraceElement e) +
        Tests if the given StackTraceElement is relevant for a comment + used when writing debug information before calls to write.
        +
        TonSection​(java.lang.String sectionName, + java.util.function.Consumer<java.lang.Object> interceptor) +
        Registers a function that intercepts the contents of a section and + writes to the AbstractCodeWriter with the updated contents.
        +
        <S extends CodeSection>
        T        		onSection​(CodeInterceptor<S,​T> interceptor) +
        Intercepts a section of code emitted for a strongly typed CodeSection.
        +
        TopenBlock​(java.lang.String textBeforeNewline, + java.lang.Object... args) +
        Opens a block of syntax by writing text, a newline, then indenting.
        +
        TopenBlock​(java.lang.String textBeforeNewline, + java.lang.String textAfterNewline, + java.lang.Object[] args, + java.lang.Runnable f) +
        Opens a block of syntax by writing textBeforeNewline, a newline, then + indenting, then executes the given Runnable, then closes the block of + syntax by writing a newline, dedenting, then writing textAfterNewline.
        +
        TopenBlock​(java.lang.String textBeforeNewline, + java.lang.String textAfterNewline, + java.lang.Object arg1, + java.lang.Object arg2, + java.lang.Object arg3, + java.lang.Object arg4, + java.lang.Object arg5, + java.lang.Runnable f) +
        Opens a block of syntax by writing textBeforeNewline, a newline, then + indenting, then executes the given Runnable, then closes the block of + syntax by writing a newline, dedenting, then writing textAfterNewline.
        +
        TopenBlock​(java.lang.String textBeforeNewline, + java.lang.String textAfterNewline, + java.lang.Object arg1, + java.lang.Object arg2, + java.lang.Object arg3, + java.lang.Object arg4, + java.lang.Runnable f) +
        Opens a block of syntax by writing textBeforeNewline, a newline, then + indenting, then executes the given Runnable, then closes the block of + syntax by writing a newline, dedenting, then writing textAfterNewline.
        +
        TopenBlock​(java.lang.String textBeforeNewline, + java.lang.String textAfterNewline, + java.lang.Object arg1, + java.lang.Object arg2, + java.lang.Object arg3, + java.lang.Runnable f) +
        Opens a block of syntax by writing textBeforeNewline, a newline, then + indenting, then executes the given Runnable, then closes the block of + syntax by writing a newline, dedenting, then writing textAfterNewline.
        +
        TopenBlock​(java.lang.String textBeforeNewline, + java.lang.String textAfterNewline, + java.lang.Object arg1, + java.lang.Object arg2, + java.lang.Runnable f) +
        Opens a block of syntax by writing textBeforeNewline, a newline, then + indenting, then executes the given Runnable, then closes the block of + syntax by writing a newline, dedenting, then writing textAfterNewline.
        +
        TopenBlock​(java.lang.String textBeforeNewline, + java.lang.String textAfterNewline, + java.lang.Object arg1, + java.lang.Runnable f) +
        Opens a block of syntax by writing textBeforeNewline, a newline, then + indenting, then executes the given Runnable, then closes the block of + syntax by writing a newline, dedenting, then writing textAfterNewline.
        +
        TopenBlock​(java.lang.String textBeforeNewline, + java.lang.String textAfterNewline, + java.lang.Runnable f) +
        Opens a block of syntax by writing textBeforeNewline, a newline, then + indenting, then executes the given Runnable, then closes the block of + syntax by writing a newline, dedenting, then writing textAfterNewline.
        +
        TpopState() +
        Pops the current AbstractCodeWriter state from the state stack.
        +
        TpushFilteredState​(java.util.function.Function<java.lang.String,​java.lang.String> filter) +
        Pushes an anonymous named state that is always passed through the given + filter function before being written to the writer.
        +
        TpushState() +
        Copies and pushes the current state to the state stack.
        +
        TpushState​(java.lang.String sectionName) +
        Copies and pushes the current state to the state stack using a named + state that can be intercepted by functions registered with + onSection(CodeInterceptor).
        +
        TpushState​(CodeSection section) +
        Pushes a strongly typed section extension point.
        +
        TputContext​(java.lang.String key, + java.lang.Object value) +
        Adds a named key-value pair to the context of the current state.
        +
        TputContext​(java.util.Map<java.lang.String,​java.lang.Object> mappings) +
        Adds a map of named key-value pair to the context of the current state.
        +
        TputFormatter​(char identifier, + java.util.function.BiFunction<java.lang.Object,​java.lang.String,​java.lang.String> formatFunction) +
        Adds a custom formatter expression to the current state of the + AbstractCodeWriter.
        +
        TremoveContext​(java.lang.String key) +
        Removes a named key-value pair from the context of the current state.
        +
        TsetExpressionStart​(char expressionStart) +
        Sets the character used to start expressions in the current state when calling + write(java.lang.Object, java.lang.Object...), writeInline(java.lang.Object, java.lang.Object...), openBlock(java.lang.String, java.lang.Object...), etc.
        +
        TsetIndentText​(java.lang.String indentText) +
        Sets the text used for indentation (defaults to four spaces).
        +
        TsetNewline​(char newline) +
        Sets the character used to represent newlines in the current state + ("\n" is the default).
        +
        TsetNewline​(java.lang.String newline) +
        Sets the character used to represent newlines in the current state + ("\n" is the default).
        +
        TsetNewlinePrefix​(java.lang.String newlinePrefix) +
        Sets a prefix to prepend to every line after a new line is added + (except for an inserted trailing newline).
        +
        java.lang.StringtoString() +
        Gets the contents of the generated code.
        +
        TtrimBlankLines() +
        Ensures that no more than one blank line occurs in succession.
        +
        TtrimBlankLines​(int trimBlankLines) +
        Ensures that no more than the given number of newlines can occur + in succession, removing consecutive newlines that exceed the given + threshold.
        +
        TtrimTrailingSpaces() +
        Enables the trimming of trailing spaces on a line.
        +
        TtrimTrailingSpaces​(boolean trimTrailingSpaces) +
        Configures if trailing spaces on a line are removed.
        +
        Tunwrite​(java.lang.Object content, + java.lang.Object... args) +
        Remove the most recent text written to the AbstractCodeWriter if and only + if the last written text is exactly equal to the given expanded + content string.
        +
        Twrite​(java.lang.Object content, + java.lang.Object... args) +
        Writes text to the AbstractCodeWriter and appends a newline.
        +
        TwriteInline​(java.lang.Object content, + java.lang.Object... args) +
        Writes text to the AbstractCodeWriter without appending a newline.
        +
        TwriteInlineWithNoFormatting​(java.lang.Object content) +
        Writes inline text to the AbstractCodeWriter with no formatting.
        +
        TwriteOptional​(java.lang.Object content) +
        Optionally writes text to the AbstractCodeWriter and appends a newline + if a value is present.
        +
        TwriteWithNoFormatting​(java.lang.Object content) +
        Writes text to the AbstractCodeWriter and appends a newline.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          AbstractCodeWriter

          +
          public AbstractCodeWriter()
          +
          Creates a new SimpleCodeWriter that uses "\n" for a newline, four spaces + for indentation, does not strip trailing whitespace, does not flatten + multiple successive blank lines into a single blank line, and adds no + trailing new line.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          copySettingsFrom

          +
          public void copySettingsFrom​(AbstractCodeWriter<T> other)
          +
          Copies settings from the given AbstractCodeWriter into this AbstractCodeWriter. + +

          The settings of the other AbstractCodeWriter will overwrite both global and state-based settings + of this AbstractCodeWriter. + +

          Stateful settings of the other AbstractCodeWriter like formatters, interceptors, and context are + flattened and then copied into the current state of this AbstractCodeWriter. Any conflicts between + formatters, interceptors, or context of the current writer are overwritten by the other writer. The stack of + states and the contents written to other are not copied. + + 

          
+ SimpleCodeWriter a = new SimpleCodeWriter();
+ a.setExpressionStart('#');
+
+ SimpleCodeWriter b = new SimpleCodeWriter();
+ b.copySettingsFrom(a);
+
+ assert(b.getExpressionStart() == '#');
+
          +
          +
          Parameters:
          +
          other - CodeWriter to copy settings from.
          +
          +
          • +
        + + + +
          +
        • +

          formatLiteral

          +
          public static java.lang.String formatLiteral​(java.lang.Object value)
          +
          Provides the default functionality for formatting literal values. + +

          This formatter is registered by default as the literal "L" formatter, + and is called in the default string "S" formatter before escaping any + characters in the string. + +

            +
          • null: Formatted as an empty string.
            • +
          • Empty Optional: Formatted as an empty string.
            • +
          • Optional with value: Formatted as the formatted value in the optional.
            • +
          • Everything else: Formatted as the result of String.valueOf(java.lang.Object).
            • +
          +
          +
          Parameters:
          +
          value - Value to format.
          +
          Returns:
          +
          Returns the formatted value.
          +
          +
          • +
        + + + +
          +
        • +

          putFormatter

          +
          public T putFormatter​(char identifier,
+                      java.util.function.BiFunction<java.lang.Object,​java.lang.String,​java.lang.String> formatFunction)
          +
          Adds a custom formatter expression to the current state of the + AbstractCodeWriter. + +

          The provided identifier string must match the following ABNF: + + 

          + %x21-23    ; ( '!' - '#' )
+ / %x25-2F  ; ( '%' - '/' )
+ / %x3A-60  ; ( ':' - '`' )
+ / %x7B-7E  ; ( '{' - '~' )
+
          +
          +
          Parameters:
          +
          identifier - Formatter identifier to associate with this formatter.
          +
          formatFunction - Formatter function that formats the given object as a String. + The formatter is give the value to format as an object + (use .toString to access the string contents) and the + current indentation string of the AbstractCodeWriter.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          setExpressionStart

          +
          public T setExpressionStart​(char expressionStart)
          +
          Sets the character used to start expressions in the current state when calling + write(java.lang.Object, java.lang.Object...), writeInline(java.lang.Object, java.lang.Object...), openBlock(java.lang.String, java.lang.Object...), etc. + +

          By default, $ is used to start expressions (for example + $L. However, some programming languages frequently give + syntactic meaning to $, making this an inconvenient syntactic + character for the AbstractCodeWriter. In these cases, the character used to + start a AbstractCodeWriter expression can be changed. Just like $, the + custom start character can be escaped using two subsequent start + characters (e.g., $$).

          +
          +
          Parameters:
          +
          expressionStart - Character to use to start expressions.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          getExpressionStart

          +
          public char getExpressionStart()
          +
          Get the expression start character of the current state. + +

          This value should not be cached and reused across pushed and popped + states. This value is "$" by default, but it can be changed using + setExpressionStart(char).

          +
          +
          Returns:
          +
          Returns the expression start char of the current state.
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          Gets the contents of the generated code. + +

          The result will have an appended newline if the AbstractCodeWriter is + configured to always append a newline. A newline is only appended + in these cases if the result does not already end with a newline.

          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          Returns:
          +
          Returns the generated code.
          +
          +
          • +
        + + + +
          +
        • +

          pushState

          +
          public T pushState()
          +
          Copies and pushes the current state to the state stack. + +

          This method is used to prepare for a corresponding popState() + operation later. It stores the current state of the AbstractCodeWriter into a + stack and keeps it active. After pushing, mutations can be made to the + state of the AbstractCodeWriter without affecting the previous state on the + stack. Changes to the state of the AbstractCodeWriter can be undone by using + popState(), which Returns self state to the state + it was in before calling pushState.

          +
          +
          Returns:
          +
          Returns the code writer.
          +
          +
          • +
        + + + +
          +
        • +

          pushState

          +
          public T pushState​(java.lang.String sectionName)
          +
          Copies and pushes the current state to the state stack using a named + state that can be intercepted by functions registered with + onSection(CodeInterceptor). + +

          The text written while in this state is buffered and passed to each + state interceptor. If no text is written by the section or an + interceptor, nothing is changed on the AbstractCodeWriter. This + behavior allows for placeholder sections to be added into + AbstractCodeWriter generators in order to provide extension points + that can be otherwise empty.

          +
          +
          Parameters:
          +
          sectionName - Name of the section to set on the state.
          +
          Returns:
          +
          Returns the code writer.
          +
          +
          • +
        + + + +
          +
        • +

          pushState

          +
          public T pushState​(CodeSection section)
          +
          Pushes a strongly typed section extension point. + +

          Interceptors can be registered to intercept this specific type + of CodeSection using a CodeInterceptor and providing a + class for which section is an instance.

          +
          +
          Parameters:
          +
          section - The section value to push.
          +
          Returns:
          +
          Returns self.
          +
          See Also:
          +
          onSection(CodeInterceptor)
          +
          +
          • +
        + + + +
          +
        • +

          injectSection

          +
          public T injectSection​(CodeSection section)
          +
          Creates a section that contains no content used to allow CodeInterceptors + to inject content at specific locations.
          +
          +
          Parameters:
          +
          section - The code section to register that can be intercepted by type.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          getDebugInfo

          +
          public final CodeWriterDebugInfo getDebugInfo()
          +
          Gets debug information about the current state of the AbstractCodeWriter, including + the path to the current state as returned by getStateDebugPath(), + and up to the last two lines of text written to the AbstractCodeWriter. + +

          This debug information is used in most exceptions thrown by AbstractCodeWriter to + provide additional context when something goes wrong. It can also be used + by subclasses and collaborators to aid in debugging codegen issues.

          +
          +
          Returns:
          +
          Returns debug info as a string.
          +
          See Also:
          +
          getDebugInfo(int)
          +
          +
          • +
        + + + +
          +
        • +

          getDebugInfo

          +
          public CodeWriterDebugInfo getDebugInfo​(int numberOfContextLines)
          +
          Gets debug information about the current state of the AbstractCodeWriter. + +

          This method can be overridden in order to add more metadata to the created + debug info object.

          +
          +
          Parameters:
          +
          numberOfContextLines - Include the last N lines in the output. Set to 0 to omit lines.
          +
          Returns:
          +
          Returns debug info as a string.
          +
          See Also:
          +
          getDebugInfo()
          +
          +
          • +
        + + + +
          +
        • +

          pushFilteredState

          +
          public T pushFilteredState​(java.util.function.Function<java.lang.String,​java.lang.String> filter)
          +
          Pushes an anonymous named state that is always passed through the given + filter function before being written to the writer.
          +
          +
          Parameters:
          +
          filter - Function that maps over the entire section when popped.
          +
          Returns:
          +
          Returns the code writer.
          +
          +
          • +
        + + + +
          +
        • +

          popState

          +
          public T popState()
          +
          Pops the current AbstractCodeWriter state from the state stack. + +

          This method is used to reverse a previous pushState() + operation. It configures the current AbstractCodeWriter state to what it was + before the last preceding pushState call.

          +
          +
          Returns:
          +
          Returns self.
          +
          Throws:
          +
          java.lang.IllegalStateException - if there a no states to pop.
          +
          +
          • +
        + + + +
          +
        • +

          onSection

          +
          public T onSection​(java.lang.String sectionName,
+                   java.util.function.Consumer<java.lang.Object> interceptor)
          +
          Registers a function that intercepts the contents of a section and + writes to the AbstractCodeWriter with the updated contents. + +

          The interceptor function is expected to have a reference to + the AbstractCodeWriter and to mutate it when they are invoked. Each + interceptor is invoked in their own isolated pushed/popped states. + +

          The text provided to interceptor does not contain a trailing + new line. A trailing new line is expected to be injected automatically + when the results of intercepting the contents are written to the + AbstractCodeWriter. A result is only written if the interceptors write + a non-null, non-empty string, allowing for empty placeholders to be + added that don't affect the resulting layout of the code. + + 

          
+ SimpleCodeWriter = new SimpleCodeWriter();
+
+ // Prepend text to a section named "foo".
+ writer.onSectionPrepend("foo", () -> writer.write("A"));
+
+ // Write text to a section, and ensure that the original
+ // text is written too.
+ writer.onSection("foo", text -> {
+     // Write before the original text.
+     writer.write("A");
+     // Write the original text of the section.
+     writer.writeWithNoFormatting(text);
+     // Write more text to the section.
+     writer.write("C");
+ });
+
+ // Create the section, write to it, then close the section.
+ writer.pushState("foo").write("B").popState();
+
+ assert(writer.toString().equals("A\nB\nC\n"));
+
          + +

          Newline handling

          + +

          This method is a wrapper around onSection(CodeInterceptor) + that has several limitations: + +

            +
          • The provided interceptor is expected to have a reference + to an AbstractCodeWriter so that write calls can be made.
            • +
          • The handling of newlines is much less precise. If you want to + give interceptors full control over how newlines are injected, then + onSection(CodeInterceptor) must be used directly and + careful use of writeInlineWithNoFormatting(Object) is + required when writing the previous contents to the interceptor.
            • +
          • Interceptors do not have access to strongly typed event data + like CodeInterceptors do. +
          + +

          The newline handling functionality provided by this method can be + reproduced using a CodeInterceptor by removing trailing newlines + using removeTrailingNewline(String). + + 

          
+ SimpleCodeWriter = new SimpleCodeWriter();
+
+ CodeInterceptor<CodeSection, SimpleCodeWriter> interceptor = CodeInterceptor.forName(sectionName, (w, p) -> {
+     String trimmedContent = removeTrailingNewline(p);
+     interceptor.accept(trimmedContent);
+ })
+
+ writer.onSection(interceptor);
+
          +
          +
          Parameters:
          +
          sectionName - The name of the section to intercept.
          +
          interceptor - The function to intercept with.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          onSection

          +
          public <S extends CodeSection> T onSection​(CodeInterceptor<S,​T> interceptor)
          +
          Intercepts a section of code emitted for a strongly typed CodeSection. + +

          These section interceptors provide a kind of event-based hook system for + AbstractCodeWriters that add extension points when generating code. The function has + the ability to completely ignore the original contents of the section, to + prepend text to it, and append text to it. Intercepting functions are + expected to have a reference to the AbstractCodeWriter and to mutate it + when they are invoked. Each interceptor is invoked in their own + isolated pushed/popped states. + +

          Interceptors are registered on the current state of the + AbstractCodeWriter. When the state to which an interceptor is registered + is popped, the interceptor is no longer in scope.

          +
          +
          Type Parameters:
          +
          S - The type of section being intercepted.
          +
          Parameters:
          +
          interceptor - A consumer that takes the writer and strongly typed section.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          enableNewlines

          +
          public T enableNewlines()
          +
          Enables the automatic appending of newlines in the current state.
          +
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          setNewline

          +
          public T setNewline​(java.lang.String newline)
          +
          Sets the character used to represent newlines in the current state + ("\n" is the default). + +

          When the provided string is empty (""), then newlines are disabled + in the current state. This is exactly equivalent to calling + disableNewlines(), and does not actually change the newline + character of the current state. + +

          Setting the newline character to a non-empty string implicitly + enables newlines in the current state.

          +
          +
          Parameters:
          +
          newline - Newline character to use.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          setNewline

          +
          public T setNewline​(char newline)
          +
          Sets the character used to represent newlines in the current state + ("\n" is the default). + +

          This call also enables newlines in the current state by calling + enableNewlines().

          +
          +
          Parameters:
          +
          newline - Newline character to use.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          getNewline

          +
          public java.lang.String getNewline()
          +
          Gets the character used to represent newlines in the current state.
          +
          +
          Returns:
          +
          Returns the newline string.
          +
          +
          • +
        + + + +
          +
        • +

          setIndentText

          +
          public T setIndentText​(java.lang.String indentText)
          +
          Sets the text used for indentation (defaults to four spaces).
          +
          +
          Parameters:
          +
          indentText - Indentation text.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          getIndentText

          +
          public final java.lang.String getIndentText()
          +
          Gets the text used for indentation (defaults to four spaces).
          +
          +
          Returns:
          +
          Returns the indentation string.
          +
          +
          • +
        + + + +
          +
        • +

          trimTrailingSpaces

          +
          public T trimTrailingSpaces()
          +
          Enables the trimming of trailing spaces on a line.
          +
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          trimTrailingSpaces

          +
          public T trimTrailingSpaces​(boolean trimTrailingSpaces)
          +
          Configures if trailing spaces on a line are removed.
          +
          +
          Parameters:
          +
          trimTrailingSpaces - Set to true to trim trailing spaces.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          getTrimTrailingSpaces

          +
          public boolean getTrimTrailingSpaces()
          +
          Returns true if the trailing spaces in the current state are trimmed.
          +
          +
          Returns:
          +
          Returns the trailing spaces setting of the current state.
          +
          +
          • +
        + + + +
          +
        • +

          trimBlankLines

          +
          public T trimBlankLines()
          +
          Ensures that no more than one blank line occurs in succession.
          +
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          trimBlankLines

          +
          public T trimBlankLines​(int trimBlankLines)
          +
          Ensures that no more than the given number of newlines can occur + in succession, removing consecutive newlines that exceed the given + threshold.
          +
          +
          Parameters:
          +
          trimBlankLines - Number of allowed consecutive newlines. Set to + -1 to perform no trimming. Set to 0 to allow no blank lines. Set to + 1 or more to allow for no more than N consecutive blank lines.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          getTrimBlankLines

          +
          public int getTrimBlankLines()
          +
          Returns the number of allowed consecutive newlines that are not + trimmed by the AbstractCodeWriter when written to a string.
          +
          +
          Returns:
          +
          Returns the number of allowed consecutive newlines. -1 means + that no newlines are trimmed. 0 allows no blank lines. 1 or more + allows for no more than N consecutive blank lines.
          +
          +
          • +
        + + + +
          +
        • +

          insertTrailingNewline

          +
          public T insertTrailingNewline()
          +
          Configures the AbstractCodeWriter to always append a newline at the end of + the text if one is not already present. + +

          This setting is not captured as part of push/popState.

          +
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          insertTrailingNewline

          +
          public T insertTrailingNewline​(boolean trailingNewline)
          +
          Configures the AbstractCodeWriter to always append a newline at the end of + the text if one is not already present. + +

          This setting is not captured as part of push/popState.

          +
          +
          Parameters:
          +
          trailingNewline - True if a newline is added.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          getInsertTrailingNewline

          +
          public boolean getInsertTrailingNewline()
          +
          Checks if the AbstractCodeWriter inserts a trailing newline (if necessary) when + converted to a string.
          +
          +
          Returns:
          +
          The newline behavior (true to insert a trailing newline).
          +
          +
          • +
        + + + +
          +
        • +

          setNewlinePrefix

          +
          public T setNewlinePrefix​(java.lang.String newlinePrefix)
          +
          Sets a prefix to prepend to every line after a new line is added + (except for an inserted trailing newline).
          +
          +
          Parameters:
          +
          newlinePrefix - Newline prefix to use.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          getNewlinePrefix

          +
          public java.lang.String getNewlinePrefix()
          +
          Gets the prefix to prepend to every line after a new line is added + (except for an inserted trailing newline).
          +
          +
          Returns:
          +
          Returns the newline prefix string.
          +
          +
          • +
        + + + +
          +
        • +

          indent

          +
          public T indent()
          +
          Indents all text one level.
          +
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          indent

          +
          public T indent​(int levels)
          +
          Indents all text a specific number of levels.
          +
          +
          Parameters:
          +
          levels - Number of levels to indent.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          getIndentLevel

          +
          public int getIndentLevel()
          +
          Gets the indentation level of the current state.
          +
          +
          Returns:
          +
          Returns the indentation level of the current state.
          +
          +
          • +
        + + + +
          +
        • +

          dedent

          +
          public T dedent()
          +
          Removes one level of indentation from all lines.
          +
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          dedent

          +
          public T dedent​(int levels)
          +
          Removes a specific number of indentations from all lines. + +

          Set to -1 to dedent back to 0 (root).

          +
          +
          Parameters:
          +
          levels - Number of levels to remove.
          +
          Returns:
          +
          Returns self.
          +
          Throws:
          +
          java.lang.IllegalStateException - when trying to dedent too far.
          +
          +
          • +
        + + + +
          +
        • +

          openBlock

          +
          public T openBlock​(java.lang.String textBeforeNewline,
+                   java.lang.Object... args)
          +
          Opens a block of syntax by writing text, a newline, then indenting. + + 
          + 
+ String result = new SimpleCodeWriter()
+         .openBlock("public final class $L {", "Foo")
+             .openBlock("public void main(String[] args) {")
+                 .write("System.out.println(args[0]);")
+             .closeBlock("}")
+         .closeBlock("}")
+         .toString();
+ 
+
          +
          +
          Parameters:
          +
          textBeforeNewline - Text to write before writing a newline and indenting.
          +
          args - String arguments to use for formatting.
          +
          Returns:
          +
          Returns this.
          +
          +
          • +
        + + + +
          +
        • +

          openBlock

          +
          public T openBlock​(java.lang.String textBeforeNewline,
+                   java.lang.String textAfterNewline,
+                   java.lang.Runnable f)
          +
          Opens a block of syntax by writing textBeforeNewline, a newline, then + indenting, then executes the given Runnable, then closes the block of + syntax by writing a newline, dedenting, then writing textAfterNewline. + + 
          
+ SimpleCodeWriter = new SimpleCodeWriter();
+ writer.openBlock("public final class $L {", "}", "Foo", () -> {
+     writer.openBlock("public void main(String[] args) {", "}", () -> {
+         writer.write("System.out.println(args[0]);");
+     })
+ });
+
          +
          +
          Parameters:
          +
          textBeforeNewline - Text to write before writing a newline and indenting.
          +
          textAfterNewline - Text to write after writing a newline and indenting.
          +
          f - Runnable function to execute inside of the block.
          +
          Returns:
          +
          Returns this.
          +
          +
          • +
        + + + +
          +
        • +

          openBlock

          +
          public T openBlock​(java.lang.String textBeforeNewline,
+                   java.lang.String textAfterNewline,
+                   java.lang.Object arg1,
+                   java.lang.Runnable f)
          +
          Opens a block of syntax by writing textBeforeNewline, a newline, then + indenting, then executes the given Runnable, then closes the block of + syntax by writing a newline, dedenting, then writing textAfterNewline.
          +
          +
          Parameters:
          +
          textBeforeNewline - Text to write before writing a newline and indenting.
          +
          textAfterNewline - Text to write after writing a newline and indenting.
          +
          arg1 - First positional argument to substitute into textBeforeNewline.
          +
          f - Runnable function to execute inside of the block.
          +
          Returns:
          +
          Returns this.
          +
          +
          • +
        + + + +
          +
        • +

          openBlock

          +
          public T openBlock​(java.lang.String textBeforeNewline,
+                   java.lang.String textAfterNewline,
+                   java.lang.Object arg1,
+                   java.lang.Object arg2,
+                   java.lang.Runnable f)
          +
          Opens a block of syntax by writing textBeforeNewline, a newline, then + indenting, then executes the given Runnable, then closes the block of + syntax by writing a newline, dedenting, then writing textAfterNewline.
          +
          +
          Parameters:
          +
          textBeforeNewline - Text to write before writing a newline and indenting.
          +
          textAfterNewline - Text to write after writing a newline and indenting.
          +
          arg1 - First positional argument to substitute into textBeforeNewline.
          +
          arg2 - Second positional argument to substitute into textBeforeNewline.
          +
          f - Runnable function to execute inside of the block.
          +
          Returns:
          +
          Returns this.
          +
          +
          • +
        + + + +
          +
        • +

          openBlock

          +
          public T openBlock​(java.lang.String textBeforeNewline,
+                   java.lang.String textAfterNewline,
+                   java.lang.Object arg1,
+                   java.lang.Object arg2,
+                   java.lang.Object arg3,
+                   java.lang.Runnable f)
          +
          Opens a block of syntax by writing textBeforeNewline, a newline, then + indenting, then executes the given Runnable, then closes the block of + syntax by writing a newline, dedenting, then writing textAfterNewline.
          +
          +
          Parameters:
          +
          textBeforeNewline - Text to write before writing a newline and indenting.
          +
          textAfterNewline - Text to write after writing a newline and indenting.
          +
          arg1 - First positional argument to substitute into textBeforeNewline.
          +
          arg2 - Second positional argument to substitute into textBeforeNewline.
          +
          arg3 - Third positional argument to substitute into textBeforeNewline.
          +
          f - Runnable function to execute inside of the block.
          +
          Returns:
          +
          Returns this.
          +
          +
          • +
        + + + +
          +
        • +

          openBlock

          +
          public T openBlock​(java.lang.String textBeforeNewline,
+                   java.lang.String textAfterNewline,
+                   java.lang.Object arg1,
+                   java.lang.Object arg2,
+                   java.lang.Object arg3,
+                   java.lang.Object arg4,
+                   java.lang.Runnable f)
          +
          Opens a block of syntax by writing textBeforeNewline, a newline, then + indenting, then executes the given Runnable, then closes the block of + syntax by writing a newline, dedenting, then writing textAfterNewline.
          +
          +
          Parameters:
          +
          textBeforeNewline - Text to write before writing a newline and indenting.
          +
          textAfterNewline - Text to write after writing a newline and indenting.
          +
          arg1 - First positional argument to substitute into textBeforeNewline.
          +
          arg2 - Second positional argument to substitute into textBeforeNewline.
          +
          arg3 - Third positional argument to substitute into textBeforeNewline.
          +
          arg4 - Fourth positional argument to substitute into textBeforeNewline.
          +
          f - Runnable function to execute inside of the block.
          +
          Returns:
          +
          Returns this.
          +
          +
          • +
        + + + +
          +
        • +

          openBlock

          +
          public T openBlock​(java.lang.String textBeforeNewline,
+                   java.lang.String textAfterNewline,
+                   java.lang.Object arg1,
+                   java.lang.Object arg2,
+                   java.lang.Object arg3,
+                   java.lang.Object arg4,
+                   java.lang.Object arg5,
+                   java.lang.Runnable f)
          +
          Opens a block of syntax by writing textBeforeNewline, a newline, then + indenting, then executes the given Runnable, then closes the block of + syntax by writing a newline, dedenting, then writing textAfterNewline.
          +
          +
          Parameters:
          +
          textBeforeNewline - Text to write before writing a newline and indenting.
          +
          textAfterNewline - Text to write after writing a newline and indenting.
          +
          arg1 - First positional argument to substitute into textBeforeNewline.
          +
          arg2 - Second positional argument to substitute into textBeforeNewline.
          +
          arg3 - Third positional argument to substitute into textBeforeNewline.
          +
          arg4 - Fourth positional argument to substitute into textBeforeNewline.
          +
          arg5 - Fifth positional argument to substitute into textBeforeNewline.
          +
          f - Runnable function to execute inside of the block.
          +
          Returns:
          +
          Returns this.
          +
          +
          • +
        + + + +
          +
        • +

          openBlock

          +
          public T openBlock​(java.lang.String textBeforeNewline,
+                   java.lang.String textAfterNewline,
+                   java.lang.Object[] args,
+                   java.lang.Runnable f)
          +
          Opens a block of syntax by writing textBeforeNewline, a newline, then + indenting, then executes the given Runnable, then closes the block of + syntax by writing a newline, dedenting, then writing textAfterNewline.
          +
          +
          Parameters:
          +
          textBeforeNewline - Text to write before writing a newline and indenting.
          +
          textAfterNewline - Text to write after writing a newline and indenting.
          +
          args - Arguments to substitute into textBeforeNewline.
          +
          f - Runnable function to execute inside of the block.
          +
          Returns:
          +
          Returns this.
          +
          +
          • +
        + + + +
          +
        • +

          closeBlock

          +
          public T closeBlock​(java.lang.String textAfterNewline,
+                    java.lang.Object... args)
          +
          Closes a block of syntax by writing a newline, dedenting, then writing text.
          +
          +
          Parameters:
          +
          textAfterNewline - Text to write after writing a newline and dedenting.
          +
          args - String arguments to use for formatting.
          +
          Returns:
          +
          Returns this.
          +
          +
          • +
        + + + +
          +
        • +

          writeWithNoFormatting

          +
          public T writeWithNoFormatting​(java.lang.Object content)
          +
          Writes text to the AbstractCodeWriter and appends a newline. + +

          The provided text does not use any kind of expression formatting. + +

          Indentation and the newline prefix is only prepended if the writer's + cursor is at the beginning of a newline. + +

          Stack trace comments are written along with the given content if + enableStackTraceComments(boolean) was called with true.

          +
          +
          Parameters:
          +
          content - Content to write.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          isStackTraceRelevant

          +
          protected boolean isStackTraceRelevant​(java.lang.StackTraceElement e)
          +
          Tests if the given StackTraceElement is relevant for a comment + used when writing debug information before calls to write. + +

          The default implementation filters out all methods in "java.*", + AbstractCodeWriter, software.amazon.smithy.utils.SymbolWriter, + SimpleCodeWriter, and methods of the implementing subclass of + AbstractCodeWriter. This method can be overridden to further filter + stack frames as needed.

          +
          +
          Parameters:
          +
          e - StackTraceElement to test.
          +
          Returns:
          +
          Returns true if this element should be in a comment.
          +
          +
          • +
        + + + +
          +
        • +

          formatWithStackTraceElement

          +
          protected java.lang.String formatWithStackTraceElement​(java.lang.String content,
+                                                       java.lang.StackTraceElement element,
+                                                       boolean inline)
          +
          Formats content for the given stack frame. + +

          Subclasses are expected to override this method as needed to handle + language-specific comment requirements. By default, this class will use + C/Java style "traditional" comments that come on the same line before + both calls to writeInline and calls to write with a newline + {@see https://docs.oracle.com/javase/specs/jls/se18/html/jls-3.html#jls-3.7}. + +

          Programming languages that do not support inline comments should return + the given content string as-is when writingInline is set + to true.

          +
          +
          Parameters:
          +
          content - The content about to be written.
          +
          element - The StackFrameElement to format.
          +
          inline - Set to true when this is a comment intended to appear before inline content.
          +
          Returns:
          +
          Returns the formatted content that includes a leading comment.
          +
          +
          • +
        + + + +
          +
        • +

          writeInlineWithNoFormatting

          +
          public final T writeInlineWithNoFormatting​(java.lang.Object content)
          +
          Writes inline text to the AbstractCodeWriter with no formatting. + +

          The provided text does not use any kind of expression formatting. + Indentation and the newline prefix is only prepended if the writer's + cursor is at the beginning of a newline. + +

          Stack trace comments are written along with the given content if + enableStackTraceComments(boolean) was called with true.

          +
          +
          Parameters:
          +
          content - Inline content to write.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          format

          +
          public final java.lang.String format​(java.lang.Object content,
+                                     java.lang.Object... args)
          +
          Creates a formatted string using formatter expressions and variadic + arguments. + +

          Important: if the formatters that are executed while formatting the + given content string mutate the AbstractCodeWriter, it could leave the + SimpleCodeWriter in an inconsistent state. For example, some AbstractCodeWriter + implementations manage imports and dependencies automatically based on + code that is referenced by formatters. If such an expression is used + with this format method but the returned String is never written to the + AbstractCodeWriter, then the AbstractCodeWriter might be mutated to track dependencies + that aren't actually necessary. + + 

          
+ SimpleCodeWriter = new SimpleCodeWriter();
+ String name = "Person";
+ String formatted = writer.format("Hello, $L", name);
+ assert(formatted.equals("Hello, Person"));
+
          +
          +
          Parameters:
          +
          content - Content to format.
          +
          args - String arguments to use for formatting.
          +
          Returns:
          +
          Returns the formatted string.
          +
          See Also:
          +
          write(java.lang.Object, java.lang.Object...), +putFormatter(char, java.util.function.BiFunction<java.lang.Object, java.lang.String, java.lang.String>)
          +
          +
          • +
        + + + +
          +
        • +

          consumer

          +
          public java.util.function.Consumer<T> consumer​(java.util.function.Consumer<T> consumer)
          +
          A simple helper method that makes it easier to invoke the built-in C + (call) formatter using a Consumer where T is the specific type + of AbstractCodeWriter. + +

          Instead of having to type this: + + 

          
+ writer.write("$C", (Consumer<MyWriter>) (w) -> w.write("Hi"));
+
          + +

          You can write: + + 

          
+ writer.write("$C", writer.consumer(w -> w.write("Hi"));
+
          +
          +
          Parameters:
          +
          consumer - The consumer to call.
          +
          Returns:
          +
          Returns the consumer as-is, but cast as the appropriate Java type.
          +
          +
          • +
        + + + +
          +
        • +

          call

          +
          public T call​(java.lang.Runnable task)
          +
          Allows calling out to arbitrary code for things like looping or + conditional writes without breaking method chaining.
          +
          +
          Parameters:
          +
          task - Method to invoke.
          +
          Returns:
          +
          Returns this.
          +
          +
          • +
        + + + +
          +
        • +

          write

          +
          public T write​(java.lang.Object content,
+               java.lang.Object... args)
          +
          Writes text to the AbstractCodeWriter and appends a newline. + +

          The provided text is automatically formatted using variadic + arguments. + +

          Indentation and the newline prefix is only prepended if the writer's + cursor is at the beginning of a newline. + +

          If a subclass overrides this method, it should first + perform formatting and then delegate to writeWithNoFormatting(java.lang.Object) + to perform the actual write.

          +
          +
          Parameters:
          +
          content - Content to write.
          +
          args - String arguments to use for formatting.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          writeInline

          +
          public T writeInline​(java.lang.Object content,
+                     java.lang.Object... args)
          +
          Writes text to the AbstractCodeWriter without appending a newline. + +

          The provided text is automatically formatted using variadic + arguments. + +

          Indentation and the newline prefix is only prepended if the writer's + cursor is at the beginning of a newline. + +

          If newlines are present in the given string, each of those lines will receive proper indentation. + +

          If a subclass overrides this method, it should first + perform formatting and then delegate to writeInlineWithNoFormatting(java.lang.Object) + to perform the actual write.

          +
          +
          Parameters:
          +
          content - Content to write.
          +
          args - String arguments to use for formatting.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          ensureNewline

          +
          public T ensureNewline()
          +
          Ensures that the last text written to the writer was a newline as defined in + the current state and inserts one if necessary.
          +
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          writeOptional

          +
          public T writeOptional​(java.lang.Object content)
          +
          Optionally writes text to the AbstractCodeWriter and appends a newline + if a value is present. + +

          If the provided content value is null, nothing is + written. If the provided content value is an empty + Optional, nothing is written. If the result of calling + toString on content results in an empty string, + nothing is written. Finally, if the value is a non-empty string, + the content is written to the AbstractCodeWriter at the current + level of indentation, and a newline is appended.

          +
          +
          Parameters:
          +
          content - Content to write if present.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          unwrite

          +
          public T unwrite​(java.lang.Object content,
+                 java.lang.Object... args)
          +
          Remove the most recent text written to the AbstractCodeWriter if and only + if the last written text is exactly equal to the given expanded + content string. + +

          This can be useful, for example, for use cases like removing + trailing commas from lists of values. + +

          For example, the following will remove ", there." from the + end of the AbstractCodeWriter: + + 

          
+ SimpleCodeWriter = new SimpleCodeWriter();
+ writer.writeInline("Hello, there.");
+ writer.unwrite(", there.");
+ assert(writer.toString().equals("Hello\n"));
+
          + +

          However, the following call to unwrite will do nothing because + the last text written to the AbstractCodeWriter does not match: + + 

          
+ SimpleCodeWriter = new SimpleCodeWriter();
+ writer.writeInline("Hello.");
+ writer.unwrite("there.");
+ assert(writer.toString().equals("Hello.\n"));
+
          +
          +
          Parameters:
          +
          content - Content to write.
          +
          args - String arguments to use for formatting.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          putContext

          +
          public T putContext​(java.lang.String key,
+                    java.lang.Object value)
          +
          Adds a named key-value pair to the context of the current state. + +

          These context values can be referenced by named interpolated + parameters.

          +
          +
          Parameters:
          +
          key - Key to add to the context.
          +
          value - Value to associate with the key.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          putContext

          +
          public T putContext​(java.util.Map<java.lang.String,​java.lang.Object> mappings)
          +
          Adds a map of named key-value pair to the context of the current state. + +

          These context values can be referenced by named interpolated + parameters.

          +
          +
          Parameters:
          +
          mappings - Key value pairs to add.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          removeContext

          +
          public T removeContext​(java.lang.String key)
          +
          Removes a named key-value pair from the context of the current state. + +

          This method has no effect if the parent state defines the context key value pair.

          +
          +
          Parameters:
          +
          key - Key to add to remove from the current context.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          getContext

          +
          public java.lang.Object getContext​(java.lang.String key)
          +
          Gets a named contextual key-value pair from the current state or any parent states.
          +
          +
          Parameters:
          +
          key - Key to retrieve.
          +
          Returns:
          +
          Returns the associated value or null if not present.
          +
          +
          • +
        + + + +
          +
        • +

          getContext

          +
          public <C> C getContext​(java.lang.String key,
+                        java.lang.Class<C> type)
          +
          Gets a named context key-value pair from the current state and + casts the value to the given type.
          +
          +
          Parameters:
          +
          key - Key to retrieve.
          +
          type - The type of value expected.
          +
          Returns:
          +
          Returns the associated value or null if not present.
          +
          Throws:
          +
          java.lang.ClassCastException - if the stored value is not null and does not match type.
          +
          +
          • +
        + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/utils/BuilderRef.html b/javadoc/1.47.0/software/amazon/smithy/utils/BuilderRef.html new file mode 100644 index 00000000000..621c2e01563 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/utils/BuilderRef.html @@ -0,0 +1,500 @@ + + + + + +BuilderRef (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.utils
    +

    Interface BuilderRef<T>

    +
    +
    +
    +
      +
    • +
      +
      Type Parameters:
      +
      T - Type of value being created.
      +
      +
      +
      public interface BuilderRef<T>
      +
      Manages the creation, copying, and reuse of values created by builders. + +

      BuilderRef manages the state of a mutable value contained in a builder. + It ensures that things like arrays built up in a builder can be used + directly in objects being built without copies, and it allows the builder + to be reused without mutating previously built objects. + +

      Smithy uses lots of builders to build up immutable objects. To make an + immutable object in Java, you need to make defensive copies of things like + lists, sets, and maps, but doing that for every single one of these types + in builders results in lots of copies. One option is to just use the lists + et al contained in builders directly in the built objects, but that runs the + risk of the builder being further mutated and thus mutating the object. + Another option is to clear out the state of the builder and give "ownership" + of lists et al to built objects, but that means builders can't easily be + used to build up multiple objects (and while that rare, it's a use case that + probably *should* work, and always has worked in Smithy). + +

      BuilderRef creates the value if needed when the builder needs to mutate + the wrapped value (see get(). It creates an immutable copy of the value + when copy() is called, and an immutable "borrowed" reference to the + copied value is maintained in the reference. This borrowed copy can be queried + using peek(), but it can't be mutated. If the reference only has a + borrowed value but attempts to call get(), then a copy of the borrowed + value is created and returned from get().

      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Abstract Methods 
        Modifier and TypeMethodDescription
        voidclear() +
        Removes any borrowed or owned values from the reference.
        +
        Tcopy() +
        Creates an immutable copy of T.
        +
        static <T> BuilderRef<java.util.List<T>>forList() +
        Creates a builder reference to a list.
        +
        static <K,​V>
        BuilderRef<java.util.Map<K,​V>>        		forOrderedMap() +
        Creates a builder reference to a ordered map.
        +
        static <T> BuilderRef<java.util.Set<T>>forOrderedSet() +
        Creates a builder reference to an ordered set.
        +
        static <K,​V>
        BuilderRef<java.util.Map<K,​V>>        		forUnorderedMap() +
        Creates a builder reference to an unordered map.
        +
        static <T> BuilderRef<java.util.Set<T>>forUnorderedSet() +
        Creates a builder reference to an unordered set.
        +
        Tget() +
        Gets a mutable T from the reference, creating one if needed.
        +
        booleanhasValue() +
        Checks if the reference currently has a borrowed or owned value.
        +
        Tpeek() +
        Gets an immutable T from the reference, reusing borrowed + values if possible, and creating owned values if needed.
        +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          copy

          +
          T copy()
          +
          Creates an immutable copy of T. + +

          Subsequent calls to hasValue() may or may not return true + after this method is called.

          +
          +
          Returns:
          +
          Returns the copied immutable value.
          +
          +
          • +
        + + + +
          +
        • +

          hasValue

          +
          boolean hasValue()
          +
          Checks if the reference currently has a borrowed or owned value. + +

          This method does not check if the contained value is considered + empty. This method only returns true if the reference contains any + kind of previously built value. This might be useful for builder + methods that attempt to remove values from the contained object. + If there is no contained object, then there's no need to create + one just to remove a value from an empty container.

          +
          +
          Returns:
          +
          Returns true if the reference contains a value of any kind.
          +
          +
          • +
        + + + +
          +
        • +

          clear

          +
          void clear()
          +
          Removes any borrowed or owned values from the reference. + +

          Subsequent calls to hasValue() will return false after + this method is called.

          +
          • +
        + + + +
          +
        • +

          forUnorderedMap

          +
          static <K,​V> BuilderRef<java.util.Map<K,​V>> forUnorderedMap()
          +
          Creates a builder reference to an unordered map.
          +
          +
          Type Parameters:
          +
          K - Type of key of the map.
          +
          V - Type of value of the map.
          +
          Returns:
          +
          Returns the created map.
          +
          +
          • +
        + + + +
          +
        • +

          forOrderedMap

          +
          static <K,​V> BuilderRef<java.util.Map<K,​V>> forOrderedMap()
          +
          Creates a builder reference to a ordered map.
          +
          +
          Type Parameters:
          +
          K - Type of key of the map.
          +
          V - Type of value of the map.
          +
          Returns:
          +
          Returns the created map.
          +
          +
          • +
        + + + +
          +
        • +

          forList

          +
          static <T> BuilderRef<java.util.List<T>> forList()
          +
          Creates a builder reference to a list.
          +
          +
          Type Parameters:
          +
          T - Type of value in the list.
          +
          Returns:
          +
          Returns the created list.
          +
          +
          • +
        + + + +
          +
        • +

          forUnorderedSet

          +
          static <T> BuilderRef<java.util.Set<T>> forUnorderedSet()
          +
          Creates a builder reference to an unordered set.
          +
          +
          Type Parameters:
          +
          T - Type of value in the set.
          +
          Returns:
          +
          Returns the created set.
          +
          +
          • +
        + + + +
          +
        • +

          forOrderedSet

          +
          static <T> BuilderRef<java.util.Set<T>> forOrderedSet()
          +
          Creates a builder reference to an ordered set.
          +
          +
          Type Parameters:
          +
          T - Type of value in the set.
          +
          Returns:
          +
          Returns the created set.
          +
          +
          • +
        + + + +
          +
        • +

          get

          +
          T get()
          +
          Gets a mutable T from the reference, creating one if needed.
          +
          +
          Returns:
          +
          Returns a mutable T value.
          +
          +
          • +
        + + + +
          +
        • +

          peek

          +
          T peek()
          +
          Gets an immutable T from the reference, reusing borrowed + values if possible, and creating owned values if needed. + +

          Attempting to mutate the provided value should fail + at runtime, but even if it doesn't, doing so could inadvertently + mutate previously built objects.

          +
          +
          Returns:
          +
          Returns an immutable peeked T value.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/utils/CaseUtils.html b/javadoc/1.47.0/software/amazon/smithy/utils/CaseUtils.html new file mode 100644 index 00000000000..3ceb3f717ca --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/utils/CaseUtils.html @@ -0,0 +1,447 @@ + + + + + +CaseUtils (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.utils
    +

    Class CaseUtils

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.utils.CaseUtils
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class CaseUtils
+extends java.lang.Object
      +
      Provides support for camelCase, snake_case, and other kinds + of case conversions.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static java.lang.StringsnakeToCamelCase​(java.lang.String str) +
        Converts all the delimiter separated words in a String into camelCase, + that is each word is made up of a titlecase character and then a series of + lowercase characters.
        +
        static java.lang.StringsnakeToPascalCase​(java.lang.String str) +
        Converts all words separated by "_" into PascalCase, that is each + word is made up of a titlecase character and then a series of + lowercase characters.
        +
        static java.lang.StringtoCamelCase​(java.lang.String str) +
        Converts all words separated by " ", "-", and "_" to CamelCase.
        +
        static java.lang.StringtoCamelCase​(java.lang.String str, + boolean capitalizeFirstLetter, + char... delimiters) +
        Converts all the delimiter separated words in a String into camelCase, + that is each word is made up of a titlecase character and then a series of + lowercase characters.
        +
        static java.lang.StringtoPascalCase​(java.lang.String str) +
        Converts all words separated by " ", "-", and "_" to CamelCase.
        +
        static java.lang.StringtoSnakeCase​(java.lang.String word) +
        Convert a given word to snake_case with all lowercase letters.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + +
          +
        • +

          snakeToPascalCase

          +
          public static java.lang.String snakeToPascalCase​(java.lang.String str)
          +

          Converts all words separated by "_" into PascalCase, that is each + word is made up of a titlecase character and then a series of + lowercase characters.

          + +

          PacalCase is just like CamelCase, except the first character is an + uppercase letter.

          +
          +
          Parameters:
          +
          str - the String to be converted to PascalCase, may be null
          +
          Returns:
          +
          camelCase of String, null if null String input
          +
          +
          • +
        + + + +
          +
        • +

          snakeToCamelCase

          +
          public static java.lang.String snakeToCamelCase​(java.lang.String str)
          +

          Converts all the delimiter separated words in a String into camelCase, + that is each word is made up of a titlecase character and then a series of + lowercase characters. + +

          The first character is always converted to lowercase.

          +
          +
          Parameters:
          +
          str - the String to be converted to camelCase, may be null
          +
          Returns:
          +
          camelCase of String, null if null String input
          +
          +
          • +
        + + + +
          +
        • +

          toCamelCase

          +
          public static java.lang.String toCamelCase​(java.lang.String str)
          +

          Converts all words separated by " ", "-", and "_" to CamelCase. + +

          The first character is always converted to lowercase.

          +
          +
          Parameters:
          +
          str - the String to be converted to camelCase, may be null
          +
          Returns:
          +
          camelCase of String, null if null String input
          +
          +
          • +
        + + + +
          +
        • +

          toPascalCase

          +
          public static java.lang.String toPascalCase​(java.lang.String str)
          +

          Converts all words separated by " ", "-", and "_" to CamelCase.

          + +

          PacalCase is just like CamelCase, except the first character is an + uppercase letter.

          +
          +
          Parameters:
          +
          str - the String to be converted to PascalCase, may be null
          +
          Returns:
          +
          camelCase of String, null if null String input
          +
          +
          • +
        + + + +
          +
        • +

          toCamelCase

          +
          public static java.lang.String toCamelCase​(java.lang.String str,
+                                           boolean capitalizeFirstLetter,
+                                           char... delimiters)
          +

          Converts all the delimiter separated words in a String into camelCase, + that is each word is made up of a titlecase character and then a series of + lowercase characters.

          + +

          The delimiters represent a set of characters understood to separate words. + The first non-delimiter character after a delimiter will be capitalized. The first String + character may or may not be capitalized and it's determined by the user input for capitalizeFirstLetter + variable.

          + +

          A null input String returns null. + Capitalization uses the Unicode title case, normally equivalent to + upper case and cannot perform locale-sensitive mappings.

          + + 
          + CaseUtils.toCamelCase(null, false)                                 = null
+ CaseUtils.toCamelCase("", false, *)                                = ""
+ CaseUtils.toCamelCase(*, false, null)                              = *
+ CaseUtils.toCamelCase(*, true, new char[0])                        = *
+ CaseUtils.toCamelCase("To.Camel.Case", false, new char[]{'.'})     = "toCamelCase"
+ CaseUtils.toCamelCase(" to @ Camel case", true, new char[]{'@'})   = "ToCamelCase"
+ CaseUtils.toCamelCase(" @to @ Camel case", false, new char[]{'@'}) = "toCamelCase"
+
          +
          +
          Parameters:
          +
          str - the String to be converted to camelCase, may be null
          +
          capitalizeFirstLetter - boolean that determines if the first character of first word should be title case.
          +
          delimiters - set of characters to determine capitalization, null and/or empty array means whitespace
          +
          Returns:
          +
          camelCase of String, null if null String input
          +
          See Also:
          +
          Source
          +
          +
          • +
        + + + +
          +
        • +

          toSnakeCase

          +
          public static java.lang.String toSnakeCase​(java.lang.String word)
          +
          Convert a given word to snake_case with all lowercase letters. + +

          This method was based on Elephant Bird's underscore method. + "-", " ", "\n", "\t", "\r" are replaced with "_". + +

          Note: this method does not sanitize the string for use as a snake_case + variable in any specific programming language.

          +
          +
          Parameters:
          +
          word - The word to convert.
          +
          Returns:
          +
          The underscored version of the word
          +
          See Also:
          +
          Elephant bird
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/utils/CodeInterceptor.Appender.html b/javadoc/1.47.0/software/amazon/smithy/utils/CodeInterceptor.Appender.html new file mode 100644 index 00000000000..8ec35679f71 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/utils/CodeInterceptor.Appender.html @@ -0,0 +1,337 @@ + + + + + +CodeInterceptor.Appender (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.utils
    +

    Interface CodeInterceptor.Appender<S extends CodeSection,​W extends AbstractCodeWriter<W>>

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + +
          +
        • +

          write

          +
          default void write​(W writer,
+                   java.lang.String previousText,
+                   S section)
          +
          Description copied from interface: CodeInterceptor
          +
          Intercepts an AbstractCodeWriter section.
          +
          +
          Specified by:
          +
          write in interface CodeInterceptor<S extends CodeSection,​W extends AbstractCodeWriter<W>>
          +
          Parameters:
          +
          writer - Writer used to write content. If no write calls are + made, any intercepted text is lost.
          +
          previousText - The previous text that was written. This text + needs to be written again in order for it to + be kept in the section.
          +
          section - The strongly typed section value.
          +
          +
          • +
        + + + + + +
          +
        • +

          append

          +
          void append​(W writer,
+            S section)
          +
          Writes text after previous content in the section.
          +
          +
          Parameters:
          +
          writer - The code writer to write to.
          +
          section - The section being intercepted.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/utils/CodeInterceptor.Prepender.html b/javadoc/1.47.0/software/amazon/smithy/utils/CodeInterceptor.Prepender.html new file mode 100644 index 00000000000..b6d834d3f4c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/utils/CodeInterceptor.Prepender.html @@ -0,0 +1,336 @@ + + + + + +CodeInterceptor.Prepender (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.utils
    +

    Interface CodeInterceptor.Prepender<S extends CodeSection,​W extends AbstractCodeWriter<W>>

    +
    +
    +
    +
      +
    • +
      +
      Type Parameters:
      +
      S - The type of section to intercept.
      +
      W - The type of code writer.
      +
      +
      +
      All Superinterfaces:
      +
      CodeInterceptor<S,​W>
      +
      +
      +
      Enclosing interface:
      +
      CodeInterceptor<S extends CodeSection,​W extends AbstractCodeWriter<W>>
      +
      +
      +
      public static interface CodeInterceptor.Prepender<S extends CodeSection,​W extends AbstractCodeWriter<W>>
+extends CodeInterceptor<S,​W>
      +
      A code section interceptor that adds text before the intercepted section. + +

      The previously written text is only included if it's a non-empty string.

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + +
          +
        • +

          write

          +
          default void write​(W writer,
+                   java.lang.String previousText,
+                   S section)
          +
          Description copied from interface: CodeInterceptor
          +
          Intercepts an AbstractCodeWriter section.
          +
          +
          Specified by:
          +
          write in interface CodeInterceptor<S extends CodeSection,​W extends AbstractCodeWriter<W>>
          +
          Parameters:
          +
          writer - Writer used to write content. If no write calls are + made, any intercepted text is lost.
          +
          previousText - The previous text that was written. This text + needs to be written again in order for it to + be kept in the section.
          +
          section - The strongly typed section value.
          +
          +
          • +
        + + + + + +
          +
        • +

          prepend

          +
          void prepend​(W writer,
+             S section)
          +
          Writes text before previously written content in the section.
          +
          +
          Parameters:
          +
          writer - The code writer to write to.
          +
          section - The section being intercepted.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/utils/CodeInterceptor.html b/javadoc/1.47.0/software/amazon/smithy/utils/CodeInterceptor.html new file mode 100644 index 00000000000..e3a4b9e0658 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/utils/CodeInterceptor.html @@ -0,0 +1,438 @@ + + + + + +CodeInterceptor (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.utils
    +

    Interface CodeInterceptor<S extends CodeSection,​W extends AbstractCodeWriter<W>>

    +
    +
    +
    +
      +
    • +
      +
      Type Parameters:
      +
      S - Type of CodeSection to intercept.
      +
      W - Type of CodeWriter to expect.
      +
      +
      +
      All Known Subinterfaces:
      +
      CodeInterceptor.Appender<S,​W>, CodeInterceptor.Prepender<S,​W>
      +
      +
      +
      public interface CodeInterceptor<S extends CodeSection,​W extends AbstractCodeWriter<W>>
      +
      A CodeSection interceptor for a specific type of CodeSection. + +

      These interceptors are executed after a state is popped by + AbstractCodeWriter. Interceptors have an opportunity to + change the contents of the popped state and are expected to write to + the AbstractCodeWriter they are given when called. + +

      Unless you need to intercept previously written content and change it, + it's best to implement the CodeInterceptor.Appender or CodeInterceptor.Prepender interfaces + since they take care of properly writing previously written content to + the section (for example, only writing if it's non-empty, and using + writeInlineWithNoFormatting to avoid unintentional interpolation).

      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          sectionType

          +
          java.lang.Class<S> sectionType()
          +
          Get the strongly typed CodeSection this interceptor is used + to intercept.
          +
          +
          Returns:
          +
          The code section to intercept.
          +
          +
          • +
        + + + + + +
          +
        • +

          isIntercepted

          +
          default boolean isIntercepted​(S section)
          +
          Checks if the given section is filtered by this interceptor or not. + +

          In some cases sectionType() might allow filtering a wider + array of types than what is actually filtered by an interceptor. The + most common example of this is intercepting any type of CodeSection + and only filtering based on the result of CodeSection.sectionName(). + +

          This method will return true by default, meaning that any + type of CodeSection that is an instance of the class returned + from sectionType() will be intercepted.

          +
          +
          Parameters:
          +
          section - Section to test if this interceptor is relevant.
          +
          Returns:
          +
          Returns true if the section is intercepted or not.
          +
          +
          • +
        + + + + + +
          +
        • +

          write

          +
          void write​(W writer,
+           java.lang.String previousText,
+           S section)
          +
          Intercepts an AbstractCodeWriter section.
          +
          +
          Parameters:
          +
          writer - Writer used to write content. If no write calls are + made, any intercepted text is lost.
          +
          previousText - The previous text that was written. This text + needs to be written again in order for it to + be kept in the section.
          +
          section - The strongly typed section value.
          +
          +
          • +
        + + + +
          +
        • +

          appender

          +
          static <S extends CodeSection,​W extends AbstractCodeWriter<W>> CodeInterceptor<S,​W> appender​(java.lang.Class<S> type,
+                                                                                                         java.util.function.BiConsumer<W,​S> appender)
          +
          Provides a more concise way of creating anonymous CodeInterceptor.Appenders. + +

          This method does not support custom filters on matched CodeSections. That + functionality must be implemented by directly creating an Appender class.

          +
          +
          Type Parameters:
          +
          S - The type of section being intercepted.
          +
          W - The type of writer to use.
          +
          Parameters:
          +
          type - The type of section to intercept.
          +
          appender - A BiConsumer that takes the writer and section and is expected to make write calls.
          +
          Returns:
          +
          Returns the created Appender.
          +
          +
          • +
        + + + +
          +
        • +

          forName

          +
          static <W extends AbstractCodeWriter<W>> CodeInterceptor<CodeSection,​W> forName​(java.lang.String sectionName,
+                                                                                      java.util.function.BiConsumer<W,​java.lang.String> consumer)
          +
          Creates an interceptor that works with any type of CodeSection and is filtered + only by the name of the section.
          +
          +
          Type Parameters:
          +
          W - The type of code writer being used.
          +
          Parameters:
          +
          sectionName - The name of the section to intercept.
          +
          consumer - A consumer to invoke for intercepted sections that accepts the writer and previous text.
          +
          Returns:
          +
          Returns the created interceptor.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/utils/CodeSection.html b/javadoc/1.47.0/software/amazon/smithy/utils/CodeSection.html new file mode 100644 index 00000000000..02fe4827b0a --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/utils/CodeSection.html @@ -0,0 +1,286 @@ + + + + + +CodeSection (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.utils
    +

    Interface CodeSection

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          sectionName

          +
          default java.lang.String sectionName()
          +
          Gets the name of the section. + +

          This class will return the canonical class of the implementing + class by default.

          +
          +
          Returns:
          +
          Returns the section name.
          +
          +
          • +
        + + + +
          +
        • +

          forName

          +
          static CodeSection forName​(java.lang.String sectionName)
          +
          Creates a CodeSection that returns the given sectionName.
          +
          +
          Parameters:
          +
          sectionName - Section name to provide when sectionName is called on the created CodeSection.
          +
          Returns:
          +
          Returns CodeSection that uses the provided name.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/utils/CodeWriter.html b/javadoc/1.47.0/software/amazon/smithy/utils/CodeWriter.html new file mode 100644 index 00000000000..097e494443f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/utils/CodeWriter.html @@ -0,0 +1,1988 @@ + + + + + +CodeWriter (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.utils
    +

    Class CodeWriter

    +
    +
    + +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        CodeWriter() +
        Deprecated.
        + 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
        Modifier and TypeMethodDescription
        CodeWritercall​(java.lang.Runnable task) +
        Deprecated.
        +
        Allows calling out to arbitrary code for things like looping or + conditional writes without breaking method chaining.
        +
        CodeWritercloseBlock​(java.lang.String textAfterNewline, + java.lang.Object... args) +
        Deprecated.
        +
        Closes a block of syntax by writing a newline, dedenting, then writing text.
        +
        voidcopySettingsFrom​(CodeWriter other) +
        Deprecated.
        + 
        static CodeWritercreateDefault() +
        Deprecated.
        +
        Creates a default instance of a CodeWriter that uses "\n" for newlines, + flattens multiple successive blank lines into a single blank line, + and adds a trailing new line if needed when converting the CodeWriter + to a string.
        +
        CodeWriterdedent() +
        Deprecated.
        +
        Removes one level of indentation from all lines.
        +
        CodeWriterdedent​(int levels) +
        Deprecated.
        +
        Removes a specific number of indentations from all lines.
        +
        CodeWriterdisableNewlines() +
        Deprecated.
        +
        Disables the automatic appending of newlines in the current state.
        +
        CodeWriterenableNewlines() +
        Deprecated.
        +
        Enables the automatic appending of newlines in the current state.
        +
        CodeWriterensureNewline() +
        Deprecated.
        +
        Ensures that the last text written to the writer was a newline as defined in + the current state and inserts one if necessary.
        +
        CodeWriterindent() +
        Deprecated.
        +
        Indents all text one level.
        +
        CodeWriterindent​(int levels) +
        Deprecated.
        +
        Indents all text a specific number of levels.
        +
        CodeWriterinsertTrailingNewline() +
        Deprecated.
        +
        Configures the AbstractCodeWriter to always append a newline at the end of + the text if one is not already present.
        +
        CodeWriterinsertTrailingNewline​(boolean trailingNewline) +
        Deprecated.
        +
        Configures the AbstractCodeWriter to always append a newline at the end of + the text if one is not already present.
        +
        CodeWriteronSection​(java.lang.String sectionName, + java.util.function.Consumer<java.lang.Object> interceptor) +
        Deprecated.
        +
        Registers a function that intercepts the contents of a section and + writes to the AbstractCodeWriter with the updated contents.
        +
        CodeWriteronSectionAppend​(java.lang.String sectionName, + java.lang.Runnable writeAfter) +
        Deprecated.
        +
        CodeWriteronSectionPrepend​(java.lang.String sectionName, + java.lang.Runnable writeBefore) +
        Deprecated.
        +
        CodeWriteropenBlock​(java.lang.String textBeforeNewline, + java.lang.Object... args) +
        Deprecated.
        +
        Opens a block of syntax by writing text, a newline, then indenting.
        +
        CodeWriteropenBlock​(java.lang.String textBeforeNewline, + java.lang.String textAfterNewline, + java.lang.Object[] args, + java.lang.Runnable f) +
        Deprecated.
        +
        Opens a block of syntax by writing textBeforeNewline, a newline, then + indenting, then executes the given Runnable, then closes the block of + syntax by writing a newline, dedenting, then writing textAfterNewline.
        +
        CodeWriteropenBlock​(java.lang.String textBeforeNewline, + java.lang.String textAfterNewline, + java.lang.Object arg1, + java.lang.Object arg2, + java.lang.Object arg3, + java.lang.Object arg4, + java.lang.Object arg5, + java.lang.Runnable f) +
        Deprecated.
        +
        Opens a block of syntax by writing textBeforeNewline, a newline, then + indenting, then executes the given Runnable, then closes the block of + syntax by writing a newline, dedenting, then writing textAfterNewline.
        +
        CodeWriteropenBlock​(java.lang.String textBeforeNewline, + java.lang.String textAfterNewline, + java.lang.Object arg1, + java.lang.Object arg2, + java.lang.Object arg3, + java.lang.Object arg4, + java.lang.Runnable f) +
        Deprecated.
        +
        Opens a block of syntax by writing textBeforeNewline, a newline, then + indenting, then executes the given Runnable, then closes the block of + syntax by writing a newline, dedenting, then writing textAfterNewline.
        +
        CodeWriteropenBlock​(java.lang.String textBeforeNewline, + java.lang.String textAfterNewline, + java.lang.Object arg1, + java.lang.Object arg2, + java.lang.Object arg3, + java.lang.Runnable f) +
        Deprecated.
        +
        Opens a block of syntax by writing textBeforeNewline, a newline, then + indenting, then executes the given Runnable, then closes the block of + syntax by writing a newline, dedenting, then writing textAfterNewline.
        +
        CodeWriteropenBlock​(java.lang.String textBeforeNewline, + java.lang.String textAfterNewline, + java.lang.Object arg1, + java.lang.Object arg2, + java.lang.Runnable f) +
        Deprecated.
        +
        Opens a block of syntax by writing textBeforeNewline, a newline, then + indenting, then executes the given Runnable, then closes the block of + syntax by writing a newline, dedenting, then writing textAfterNewline.
        +
        CodeWriteropenBlock​(java.lang.String textBeforeNewline, + java.lang.String textAfterNewline, + java.lang.Object arg1, + java.lang.Runnable f) +
        Deprecated.
        +
        Opens a block of syntax by writing textBeforeNewline, a newline, then + indenting, then executes the given Runnable, then closes the block of + syntax by writing a newline, dedenting, then writing textAfterNewline.
        +
        CodeWriteropenBlock​(java.lang.String textBeforeNewline, + java.lang.String textAfterNewline, + java.lang.Runnable f) +
        Deprecated.
        +
        Opens a block of syntax by writing textBeforeNewline, a newline, then + indenting, then executes the given Runnable, then closes the block of + syntax by writing a newline, dedenting, then writing textAfterNewline.
        +
        CodeWriterpopState() +
        Deprecated.
        +
        Pops the current AbstractCodeWriter state from the state stack.
        +
        CodeWriterpushFilteredState​(java.util.function.Function<java.lang.String,​java.lang.String> filter) +
        Deprecated.
        +
        Pushes an anonymous named state that is always passed through the given + filter function before being written to the writer.
        +
        CodeWriterpushState() +
        Deprecated.
        +
        Copies and pushes the current state to the state stack.
        +
        CodeWriterpushState​(java.lang.String sectionName) +
        Deprecated.
        +
        Copies and pushes the current state to the state stack using a named + state that can be intercepted by functions registered with + AbstractCodeWriter.onSection(CodeInterceptor).
        +
        CodeWriterputContext​(java.lang.String key, + java.lang.Object value) +
        Deprecated.
        +
        Adds a named key-value pair to the context of the current state.
        +
        CodeWriterputContext​(java.util.Map<java.lang.String,​java.lang.Object> mappings) +
        Deprecated.
        +
        Adds a map of named key-value pair to the context of the current state.
        +
        CodeWriterputFormatter​(char identifier, + java.util.function.BiFunction<java.lang.Object,​java.lang.String,​java.lang.String> formatFunction) +
        Deprecated.
        +
        Adds a custom formatter expression to the current state of the + AbstractCodeWriter.
        +
        CodeWriterremoveContext​(java.lang.String key) +
        Deprecated.
        +
        Removes a named key-value pair from the context of the current state.
        +
        CodeWritersetExpressionStart​(char expressionStart) +
        Deprecated.
        +
        Sets the character used to start expressions in the current state when calling + AbstractCodeWriter.write(java.lang.Object, java.lang.Object...), AbstractCodeWriter.writeInline(java.lang.Object, java.lang.Object...), AbstractCodeWriter.openBlock(java.lang.String, java.lang.Object...), etc.
        +
        CodeWritersetIndentText​(java.lang.String indentText) +
        Deprecated.
        +
        Sets the text used for indentation (defaults to four spaces).
        +
        CodeWritersetNewline​(char newline) +
        Deprecated.
        +
        Sets the character used to represent newlines in the current state + ("\n" is the default).
        +
        CodeWritersetNewline​(java.lang.String newline) +
        Deprecated.
        +
        Sets the character used to represent newlines in the current state + ("\n" is the default).
        +
        CodeWritersetNewlinePrefix​(java.lang.String newlinePrefix) +
        Deprecated.
        +
        Sets a prefix to prepend to every line after a new line is added + (except for an inserted trailing newline).
        +
        CodeWritertrimBlankLines() +
        Deprecated.
        +
        Ensures that no more than one blank line occurs in succession.
        +
        CodeWritertrimBlankLines​(int trimBlankLines) +
        Deprecated.
        +
        Ensures that no more than the given number of newlines can occur + in succession, removing consecutive newlines that exceed the given + threshold.
        +
        CodeWritertrimTrailingSpaces() +
        Deprecated.
        +
        Enables the trimming of trailing spaces on a line.
        +
        CodeWritertrimTrailingSpaces​(boolean trimTrailingSpaces) +
        Deprecated.
        +
        Configures if trailing spaces on a line are removed.
        +
        CodeWriterunwrite​(java.lang.Object content, + java.lang.Object... args) +
        Deprecated.
        +
        Remove the most recent text written to the AbstractCodeWriter if and only + if the last written text is exactly equal to the given expanded + content string.
        +
        CodeWriterwrite​(java.lang.Object content, + java.lang.Object... args) +
        Deprecated.
        +
        Writes text to the AbstractCodeWriter and appends a newline.
        +
        CodeWriterwriteInline​(java.lang.Object content, + java.lang.Object... args) +
        Deprecated.
        +
        Writes text to the AbstractCodeWriter without appending a newline.
        +
        CodeWriterwriteOptional​(java.lang.Object content) +
        Deprecated.
        +
        Optionally writes text to the AbstractCodeWriter and appends a newline + if a value is present.
        +
        CodeWriterwriteWithNoFormatting​(java.lang.Object content) +
        Deprecated.
        +
        Writes text to the AbstractCodeWriter and appends a newline.
        +
        + +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          CodeWriter

          +
          public CodeWriter()
          +
          Deprecated.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          createDefault

          +
          public static CodeWriter createDefault()
          +
          Deprecated.
          +
          Creates a default instance of a CodeWriter that uses "\n" for newlines, + flattens multiple successive blank lines into a single blank line, + and adds a trailing new line if needed when converting the CodeWriter + to a string.
          +
          +
          Returns:
          +
          Returns the created and configured CodeWriter.
          +
          +
          • +
        + + + +
          +
        • +

          onSectionPrepend

          +
          @Deprecated
+public CodeWriter onSectionPrepend​(java.lang.String sectionName,
+                                   java.lang.Runnable writeBefore)
          +
          Deprecated.
          +
          Prepends to the contents of a named section. + + 
          
+ writer.onSectionPrepend("foo", () -> {
+     writer.write("This text is added before the rest of the section.");
+ });
+
          +
          +
          Parameters:
          +
          sectionName - The name of the section to intercept.
          +
          writeBefore - A runnable that prepends to a section by mutating the writer.
          +
          Returns:
          +
          Returns the CodeWriter.
          +
          See Also:
          +
          as an alternative + that allows more explicit whitespace handling.
          +
          +
          • +
        + + + +
          +
        • +

          onSectionAppend

          +
          @Deprecated
+public CodeWriter onSectionAppend​(java.lang.String sectionName,
+                                  java.lang.Runnable writeAfter)
          +
          Deprecated.
          +
          Appends to the contents of a named section. + + 
          
+ writer.onSectionAppend("foo", () -> {
+     writer.write("This text is added after the rest of the section.");
+ });
+
          +
          +
          Parameters:
          +
          sectionName - The name of the section to intercept.
          +
          writeAfter - A runnable that appends to a section by mutating the writer.
          +
          Returns:
          +
          Returns the CodeWriter.
          +
          See Also:
          +
          as an alternative + that allows more explicit whitespace handling.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          putFormatter

          +
          public CodeWriter putFormatter​(char identifier,
+                               java.util.function.BiFunction<java.lang.Object,​java.lang.String,​java.lang.String> formatFunction)
          +
          Deprecated.
          +
          Description copied from class: AbstractCodeWriter
          +
          Adds a custom formatter expression to the current state of the + AbstractCodeWriter. + +

          The provided identifier string must match the following ABNF: + + 

          + %x21-23    ; ( '!' - '#' )
+ / %x25-2F  ; ( '%' - '/' )
+ / %x3A-60  ; ( ':' - '`' )
+ / %x7B-7E  ; ( '{' - '~' )
+
          +
          +
          Overrides:
          +
          putFormatter in class AbstractCodeWriter<CodeWriter>
          +
          Parameters:
          +
          identifier - Formatter identifier to associate with this formatter.
          +
          formatFunction - Formatter function that formats the given object as a String. + The formatter is give the value to format as an object + (use .toString to access the string contents) and the + current indentation string of the AbstractCodeWriter.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          pushState

          +
          public CodeWriter pushState()
          +
          Deprecated.
          +
          Description copied from class: AbstractCodeWriter
          +
          Copies and pushes the current state to the state stack. + +

          This method is used to prepare for a corresponding AbstractCodeWriter.popState() + operation later. It stores the current state of the AbstractCodeWriter into a + stack and keeps it active. After pushing, mutations can be made to the + state of the AbstractCodeWriter without affecting the previous state on the + stack. Changes to the state of the AbstractCodeWriter can be undone by using + AbstractCodeWriter.popState(), which Returns self state to the state + it was in before calling pushState.

          +
          +
          Overrides:
          +
          pushState in class AbstractCodeWriter<CodeWriter>
          +
          Returns:
          +
          Returns the code writer.
          +
          +
          • +
        + + + +
          +
        • +

          pushState

          +
          public CodeWriter pushState​(java.lang.String sectionName)
          +
          Deprecated.
          +
          Description copied from class: AbstractCodeWriter
          +
          Copies and pushes the current state to the state stack using a named + state that can be intercepted by functions registered with + AbstractCodeWriter.onSection(CodeInterceptor). + +

          The text written while in this state is buffered and passed to each + state interceptor. If no text is written by the section or an + interceptor, nothing is changed on the AbstractCodeWriter. This + behavior allows for placeholder sections to be added into + AbstractCodeWriter generators in order to provide extension points + that can be otherwise empty.

          +
          +
          Overrides:
          +
          pushState in class AbstractCodeWriter<CodeWriter>
          +
          Parameters:
          +
          sectionName - Name of the section to set on the state.
          +
          Returns:
          +
          Returns the code writer.
          +
          +
          • +
        + + + +
          +
        • +

          pushFilteredState

          +
          public CodeWriter pushFilteredState​(java.util.function.Function<java.lang.String,​java.lang.String> filter)
          +
          Deprecated.
          +
          Description copied from class: AbstractCodeWriter
          +
          Pushes an anonymous named state that is always passed through the given + filter function before being written to the writer.
          +
          +
          Overrides:
          +
          pushFilteredState in class AbstractCodeWriter<CodeWriter>
          +
          Parameters:
          +
          filter - Function that maps over the entire section when popped.
          +
          Returns:
          +
          Returns the code writer.
          +
          +
          • +
        + + + +
          +
        • +

          popState

          +
          public CodeWriter popState()
          +
          Deprecated.
          +
          Description copied from class: AbstractCodeWriter
          +
          Pops the current AbstractCodeWriter state from the state stack. + +

          This method is used to reverse a previous AbstractCodeWriter.pushState() + operation. It configures the current AbstractCodeWriter state to what it was + before the last preceding pushState call.

          +
          +
          Overrides:
          +
          popState in class AbstractCodeWriter<CodeWriter>
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          onSection

          +
          public CodeWriter onSection​(java.lang.String sectionName,
+                            java.util.function.Consumer<java.lang.Object> interceptor)
          +
          Deprecated.
          +
          Description copied from class: AbstractCodeWriter
          +
          Registers a function that intercepts the contents of a section and + writes to the AbstractCodeWriter with the updated contents. + +

          The interceptor function is expected to have a reference to + the AbstractCodeWriter and to mutate it when they are invoked. Each + interceptor is invoked in their own isolated pushed/popped states. + +

          The text provided to interceptor does not contain a trailing + new line. A trailing new line is expected to be injected automatically + when the results of intercepting the contents are written to the + AbstractCodeWriter. A result is only written if the interceptors write + a non-null, non-empty string, allowing for empty placeholders to be + added that don't affect the resulting layout of the code. + + 

          
+ SimpleCodeWriter = new SimpleCodeWriter();
+
+ // Prepend text to a section named "foo".
+ writer.onSectionPrepend("foo", () -> writer.write("A"));
+
+ // Write text to a section, and ensure that the original
+ // text is written too.
+ writer.onSection("foo", text -> {
+     // Write before the original text.
+     writer.write("A");
+     // Write the original text of the section.
+     writer.writeWithNoFormatting(text);
+     // Write more text to the section.
+     writer.write("C");
+ });
+
+ // Create the section, write to it, then close the section.
+ writer.pushState("foo").write("B").popState();
+
+ assert(writer.toString().equals("A\nB\nC\n"));
+
          + +

          Newline handling

          + +

          This method is a wrapper around AbstractCodeWriter.onSection(CodeInterceptor) + that has several limitations: + +

          + +

          The newline handling functionality provided by this method can be + reproduced using a CodeInterceptor by removing trailing newlines + using AbstractCodeWriter.removeTrailingNewline(String). + + 

          
+ SimpleCodeWriter = new SimpleCodeWriter();
+
+ CodeInterceptor<CodeSection, SimpleCodeWriter> interceptor = CodeInterceptor.forName(sectionName, (w, p) -> {
+     String trimmedContent = removeTrailingNewline(p);
+     interceptor.accept(trimmedContent);
+ })
+
+ writer.onSection(interceptor);
+
          +
          +
          Overrides:
          +
          onSection in class AbstractCodeWriter<CodeWriter>
          +
          Parameters:
          +
          sectionName - The name of the section to intercept.
          +
          interceptor - The function to intercept with.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + + + + + + + + + +
          +
        • +

          setNewline

          +
          public CodeWriter setNewline​(java.lang.String newline)
          +
          Deprecated.
          +
          Description copied from class: AbstractCodeWriter
          +
          Sets the character used to represent newlines in the current state + ("\n" is the default). + +

          When the provided string is empty (""), then newlines are disabled + in the current state. This is exactly equivalent to calling + AbstractCodeWriter.disableNewlines(), and does not actually change the newline + character of the current state. + +

          Setting the newline character to a non-empty string implicitly + enables newlines in the current state.

          +
          +
          Overrides:
          +
          setNewline in class AbstractCodeWriter<CodeWriter>
          +
          Parameters:
          +
          newline - Newline character to use.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          setIndentText

          +
          public CodeWriter setIndentText​(java.lang.String indentText)
          +
          Deprecated.
          +
          Description copied from class: AbstractCodeWriter
          +
          Sets the text used for indentation (defaults to four spaces).
          +
          +
          Overrides:
          +
          setIndentText in class AbstractCodeWriter<CodeWriter>
          +
          Parameters:
          +
          indentText - Indentation text.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          trimTrailingSpaces

          +
          public CodeWriter trimTrailingSpaces​(boolean trimTrailingSpaces)
          +
          Deprecated.
          +
          Description copied from class: AbstractCodeWriter
          +
          Configures if trailing spaces on a line are removed.
          +
          +
          Overrides:
          +
          trimTrailingSpaces in class AbstractCodeWriter<CodeWriter>
          +
          Parameters:
          +
          trimTrailingSpaces - Set to true to trim trailing spaces.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          trimBlankLines

          +
          public CodeWriter trimBlankLines​(int trimBlankLines)
          +
          Deprecated.
          +
          Description copied from class: AbstractCodeWriter
          +
          Ensures that no more than the given number of newlines can occur + in succession, removing consecutive newlines that exceed the given + threshold.
          +
          +
          Overrides:
          +
          trimBlankLines in class AbstractCodeWriter<CodeWriter>
          +
          Parameters:
          +
          trimBlankLines - Number of allowed consecutive newlines. Set to + -1 to perform no trimming. Set to 0 to allow no blank lines. Set to + 1 or more to allow for no more than N consecutive blank lines.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          insertTrailingNewline

          +
          public CodeWriter insertTrailingNewline()
          +
          Deprecated.
          +
          Description copied from class: AbstractCodeWriter
          +
          Configures the AbstractCodeWriter to always append a newline at the end of + the text if one is not already present. + +

          This setting is not captured as part of push/popState.

          +
          +
          Overrides:
          +
          insertTrailingNewline in class AbstractCodeWriter<CodeWriter>
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          insertTrailingNewline

          +
          public CodeWriter insertTrailingNewline​(boolean trailingNewline)
          +
          Deprecated.
          +
          Description copied from class: AbstractCodeWriter
          +
          Configures the AbstractCodeWriter to always append a newline at the end of + the text if one is not already present. + +

          This setting is not captured as part of push/popState.

          +
          +
          Overrides:
          +
          insertTrailingNewline in class AbstractCodeWriter<CodeWriter>
          +
          Parameters:
          +
          trailingNewline - True if a newline is added.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          setNewlinePrefix

          +
          public CodeWriter setNewlinePrefix​(java.lang.String newlinePrefix)
          +
          Deprecated.
          +
          Description copied from class: AbstractCodeWriter
          +
          Sets a prefix to prepend to every line after a new line is added + (except for an inserted trailing newline).
          +
          +
          Overrides:
          +
          setNewlinePrefix in class AbstractCodeWriter<CodeWriter>
          +
          Parameters:
          +
          newlinePrefix - Newline prefix to use.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          indent

          +
          public CodeWriter indent​(int levels)
          +
          Deprecated.
          +
          Description copied from class: AbstractCodeWriter
          +
          Indents all text a specific number of levels.
          +
          +
          Overrides:
          +
          indent in class AbstractCodeWriter<CodeWriter>
          +
          Parameters:
          +
          levels - Number of levels to indent.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + + + + + +
          +
        • +

          dedent

          +
          public CodeWriter dedent​(int levels)
          +
          Deprecated.
          +
          Description copied from class: AbstractCodeWriter
          +
          Removes a specific number of indentations from all lines. + +

          Set to -1 to dedent back to 0 (root).

          +
          +
          Overrides:
          +
          dedent in class AbstractCodeWriter<CodeWriter>
          +
          Parameters:
          +
          levels - Number of levels to remove.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          openBlock

          +
          public CodeWriter openBlock​(java.lang.String textBeforeNewline,
+                            java.lang.Object... args)
          +
          Deprecated.
          +
          Description copied from class: AbstractCodeWriter
          +
          Opens a block of syntax by writing text, a newline, then indenting. + + 
          + 
+ String result = new SimpleCodeWriter()
+         .openBlock("public final class $L {", "Foo")
+             .openBlock("public void main(String[] args) {")
+                 .write("System.out.println(args[0]);")
+             .closeBlock("}")
+         .closeBlock("}")
+         .toString();
+ 
+
          +
          +
          Overrides:
          +
          openBlock in class AbstractCodeWriter<CodeWriter>
          +
          Parameters:
          +
          textBeforeNewline - Text to write before writing a newline and indenting.
          +
          args - String arguments to use for formatting.
          +
          Returns:
          +
          Returns this.
          +
          +
          • +
        + + + +
          +
        • +

          openBlock

          +
          public CodeWriter openBlock​(java.lang.String textBeforeNewline,
+                            java.lang.String textAfterNewline,
+                            java.lang.Runnable f)
          +
          Deprecated.
          +
          Description copied from class: AbstractCodeWriter
          +
          Opens a block of syntax by writing textBeforeNewline, a newline, then + indenting, then executes the given Runnable, then closes the block of + syntax by writing a newline, dedenting, then writing textAfterNewline. + + 
          
+ SimpleCodeWriter = new SimpleCodeWriter();
+ writer.openBlock("public final class $L {", "}", "Foo", () -> {
+     writer.openBlock("public void main(String[] args) {", "}", () -> {
+         writer.write("System.out.println(args[0]);");
+     })
+ });
+
          +
          +
          Overrides:
          +
          openBlock in class AbstractCodeWriter<CodeWriter>
          +
          Parameters:
          +
          textBeforeNewline - Text to write before writing a newline and indenting.
          +
          textAfterNewline - Text to write after writing a newline and indenting.
          +
          f - Runnable function to execute inside of the block.
          +
          Returns:
          +
          Returns this.
          +
          +
          • +
        + + + +
          +
        • +

          openBlock

          +
          public CodeWriter openBlock​(java.lang.String textBeforeNewline,
+                            java.lang.String textAfterNewline,
+                            java.lang.Object arg1,
+                            java.lang.Runnable f)
          +
          Deprecated.
          +
          Description copied from class: AbstractCodeWriter
          +
          Opens a block of syntax by writing textBeforeNewline, a newline, then + indenting, then executes the given Runnable, then closes the block of + syntax by writing a newline, dedenting, then writing textAfterNewline.
          +
          +
          Overrides:
          +
          openBlock in class AbstractCodeWriter<CodeWriter>
          +
          Parameters:
          +
          textBeforeNewline - Text to write before writing a newline and indenting.
          +
          textAfterNewline - Text to write after writing a newline and indenting.
          +
          arg1 - First positional argument to substitute into textBeforeNewline.
          +
          f - Runnable function to execute inside of the block.
          +
          Returns:
          +
          Returns this.
          +
          +
          • +
        + + + +
          +
        • +

          openBlock

          +
          public CodeWriter openBlock​(java.lang.String textBeforeNewline,
+                            java.lang.String textAfterNewline,
+                            java.lang.Object arg1,
+                            java.lang.Object arg2,
+                            java.lang.Runnable f)
          +
          Deprecated.
          +
          Description copied from class: AbstractCodeWriter
          +
          Opens a block of syntax by writing textBeforeNewline, a newline, then + indenting, then executes the given Runnable, then closes the block of + syntax by writing a newline, dedenting, then writing textAfterNewline.
          +
          +
          Overrides:
          +
          openBlock in class AbstractCodeWriter<CodeWriter>
          +
          Parameters:
          +
          textBeforeNewline - Text to write before writing a newline and indenting.
          +
          textAfterNewline - Text to write after writing a newline and indenting.
          +
          arg1 - First positional argument to substitute into textBeforeNewline.
          +
          arg2 - Second positional argument to substitute into textBeforeNewline.
          +
          f - Runnable function to execute inside of the block.
          +
          Returns:
          +
          Returns this.
          +
          +
          • +
        + + + +
          +
        • +

          openBlock

          +
          public CodeWriter openBlock​(java.lang.String textBeforeNewline,
+                            java.lang.String textAfterNewline,
+                            java.lang.Object arg1,
+                            java.lang.Object arg2,
+                            java.lang.Object arg3,
+                            java.lang.Runnable f)
          +
          Deprecated.
          +
          Description copied from class: AbstractCodeWriter
          +
          Opens a block of syntax by writing textBeforeNewline, a newline, then + indenting, then executes the given Runnable, then closes the block of + syntax by writing a newline, dedenting, then writing textAfterNewline.
          +
          +
          Overrides:
          +
          openBlock in class AbstractCodeWriter<CodeWriter>
          +
          Parameters:
          +
          textBeforeNewline - Text to write before writing a newline and indenting.
          +
          textAfterNewline - Text to write after writing a newline and indenting.
          +
          arg1 - First positional argument to substitute into textBeforeNewline.
          +
          arg2 - Second positional argument to substitute into textBeforeNewline.
          +
          arg3 - Third positional argument to substitute into textBeforeNewline.
          +
          f - Runnable function to execute inside of the block.
          +
          Returns:
          +
          Returns this.
          +
          +
          • +
        + + + +
          +
        • +

          openBlock

          +
          public CodeWriter openBlock​(java.lang.String textBeforeNewline,
+                            java.lang.String textAfterNewline,
+                            java.lang.Object arg1,
+                            java.lang.Object arg2,
+                            java.lang.Object arg3,
+                            java.lang.Object arg4,
+                            java.lang.Runnable f)
          +
          Deprecated.
          +
          Description copied from class: AbstractCodeWriter
          +
          Opens a block of syntax by writing textBeforeNewline, a newline, then + indenting, then executes the given Runnable, then closes the block of + syntax by writing a newline, dedenting, then writing textAfterNewline.
          +
          +
          Overrides:
          +
          openBlock in class AbstractCodeWriter<CodeWriter>
          +
          Parameters:
          +
          textBeforeNewline - Text to write before writing a newline and indenting.
          +
          textAfterNewline - Text to write after writing a newline and indenting.
          +
          arg1 - First positional argument to substitute into textBeforeNewline.
          +
          arg2 - Second positional argument to substitute into textBeforeNewline.
          +
          arg3 - Third positional argument to substitute into textBeforeNewline.
          +
          arg4 - Fourth positional argument to substitute into textBeforeNewline.
          +
          f - Runnable function to execute inside of the block.
          +
          Returns:
          +
          Returns this.
          +
          +
          • +
        + + + +
          +
        • +

          openBlock

          +
          public CodeWriter openBlock​(java.lang.String textBeforeNewline,
+                            java.lang.String textAfterNewline,
+                            java.lang.Object arg1,
+                            java.lang.Object arg2,
+                            java.lang.Object arg3,
+                            java.lang.Object arg4,
+                            java.lang.Object arg5,
+                            java.lang.Runnable f)
          +
          Deprecated.
          +
          Description copied from class: AbstractCodeWriter
          +
          Opens a block of syntax by writing textBeforeNewline, a newline, then + indenting, then executes the given Runnable, then closes the block of + syntax by writing a newline, dedenting, then writing textAfterNewline.
          +
          +
          Overrides:
          +
          openBlock in class AbstractCodeWriter<CodeWriter>
          +
          Parameters:
          +
          textBeforeNewline - Text to write before writing a newline and indenting.
          +
          textAfterNewline - Text to write after writing a newline and indenting.
          +
          arg1 - First positional argument to substitute into textBeforeNewline.
          +
          arg2 - Second positional argument to substitute into textBeforeNewline.
          +
          arg3 - Third positional argument to substitute into textBeforeNewline.
          +
          arg4 - Fourth positional argument to substitute into textBeforeNewline.
          +
          arg5 - Fifth positional argument to substitute into textBeforeNewline.
          +
          f - Runnable function to execute inside of the block.
          +
          Returns:
          +
          Returns this.
          +
          +
          • +
        + + + +
          +
        • +

          openBlock

          +
          public CodeWriter openBlock​(java.lang.String textBeforeNewline,
+                            java.lang.String textAfterNewline,
+                            java.lang.Object[] args,
+                            java.lang.Runnable f)
          +
          Deprecated.
          +
          Description copied from class: AbstractCodeWriter
          +
          Opens a block of syntax by writing textBeforeNewline, a newline, then + indenting, then executes the given Runnable, then closes the block of + syntax by writing a newline, dedenting, then writing textAfterNewline.
          +
          +
          Overrides:
          +
          openBlock in class AbstractCodeWriter<CodeWriter>
          +
          Parameters:
          +
          textBeforeNewline - Text to write before writing a newline and indenting.
          +
          textAfterNewline - Text to write after writing a newline and indenting.
          +
          args - Arguments to substitute into textBeforeNewline.
          +
          f - Runnable function to execute inside of the block.
          +
          Returns:
          +
          Returns this.
          +
          +
          • +
        + + + +
          +
        • +

          closeBlock

          +
          public CodeWriter closeBlock​(java.lang.String textAfterNewline,
+                             java.lang.Object... args)
          +
          Deprecated.
          +
          Description copied from class: AbstractCodeWriter
          +
          Closes a block of syntax by writing a newline, dedenting, then writing text.
          +
          +
          Overrides:
          +
          closeBlock in class AbstractCodeWriter<CodeWriter>
          +
          Parameters:
          +
          textAfterNewline - Text to write after writing a newline and dedenting.
          +
          args - String arguments to use for formatting.
          +
          Returns:
          +
          Returns this.
          +
          +
          • +
        + + + +
          +
        • +

          writeWithNoFormatting

          +
          public CodeWriter writeWithNoFormatting​(java.lang.Object content)
          +
          Deprecated.
          +
          Description copied from class: AbstractCodeWriter
          +
          Writes text to the AbstractCodeWriter and appends a newline. + +

          The provided text does not use any kind of expression formatting. + +

          Indentation and the newline prefix is only prepended if the writer's + cursor is at the beginning of a newline. + +

          Stack trace comments are written along with the given content if + AbstractCodeWriter.enableStackTraceComments(boolean) was called with true.

          +
          +
          Overrides:
          +
          writeWithNoFormatting in class AbstractCodeWriter<CodeWriter>
          +
          Parameters:
          +
          content - Content to write.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          call

          +
          public CodeWriter call​(java.lang.Runnable task)
          +
          Deprecated.
          +
          Description copied from class: AbstractCodeWriter
          +
          Allows calling out to arbitrary code for things like looping or + conditional writes without breaking method chaining.
          +
          +
          Overrides:
          +
          call in class AbstractCodeWriter<CodeWriter>
          +
          Parameters:
          +
          task - Method to invoke.
          +
          Returns:
          +
          Returns this.
          +
          +
          • +
        + + + +
          +
        • +

          write

          +
          public CodeWriter write​(java.lang.Object content,
+                        java.lang.Object... args)
          +
          Deprecated.
          +
          Description copied from class: AbstractCodeWriter
          +
          Writes text to the AbstractCodeWriter and appends a newline. + +

          The provided text is automatically formatted using variadic + arguments. + +

          Indentation and the newline prefix is only prepended if the writer's + cursor is at the beginning of a newline. + +

          If a subclass overrides this method, it should first + perform formatting and then delegate to AbstractCodeWriter.writeWithNoFormatting(java.lang.Object) + to perform the actual write.

          +
          +
          Overrides:
          +
          write in class AbstractCodeWriter<CodeWriter>
          +
          Parameters:
          +
          content - Content to write.
          +
          args - String arguments to use for formatting.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          writeInline

          +
          public CodeWriter writeInline​(java.lang.Object content,
+                              java.lang.Object... args)
          +
          Deprecated.
          +
          Description copied from class: AbstractCodeWriter
          +
          Writes text to the AbstractCodeWriter without appending a newline. + +

          The provided text is automatically formatted using variadic + arguments. + +

          Indentation and the newline prefix is only prepended if the writer's + cursor is at the beginning of a newline. + +

          If newlines are present in the given string, each of those lines will receive proper indentation. + +

          If a subclass overrides this method, it should first + perform formatting and then delegate to AbstractCodeWriter.writeInlineWithNoFormatting(java.lang.Object) + to perform the actual write.

          +
          +
          Overrides:
          +
          writeInline in class AbstractCodeWriter<CodeWriter>
          +
          Parameters:
          +
          content - Content to write.
          +
          args - String arguments to use for formatting.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          ensureNewline

          +
          public CodeWriter ensureNewline()
          +
          Deprecated.
          +
          Description copied from class: AbstractCodeWriter
          +
          Ensures that the last text written to the writer was a newline as defined in + the current state and inserts one if necessary.
          +
          +
          Overrides:
          +
          ensureNewline in class AbstractCodeWriter<CodeWriter>
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          writeOptional

          +
          public CodeWriter writeOptional​(java.lang.Object content)
          +
          Deprecated.
          +
          Description copied from class: AbstractCodeWriter
          +
          Optionally writes text to the AbstractCodeWriter and appends a newline + if a value is present. + +

          If the provided content value is null, nothing is + written. If the provided content value is an empty + Optional, nothing is written. If the result of calling + toString on content results in an empty string, + nothing is written. Finally, if the value is a non-empty string, + the content is written to the AbstractCodeWriter at the current + level of indentation, and a newline is appended.

          +
          +
          Overrides:
          +
          writeOptional in class AbstractCodeWriter<CodeWriter>
          +
          Parameters:
          +
          content - Content to write if present.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          unwrite

          +
          public CodeWriter unwrite​(java.lang.Object content,
+                          java.lang.Object... args)
          +
          Deprecated.
          +
          Description copied from class: AbstractCodeWriter
          +
          Remove the most recent text written to the AbstractCodeWriter if and only + if the last written text is exactly equal to the given expanded + content string. + +

          This can be useful, for example, for use cases like removing + trailing commas from lists of values. + +

          For example, the following will remove ", there." from the + end of the AbstractCodeWriter: + + 

          
+ SimpleCodeWriter = new SimpleCodeWriter();
+ writer.writeInline("Hello, there.");
+ writer.unwrite(", there.");
+ assert(writer.toString().equals("Hello\n"));
+
          + +

          However, the following call to unwrite will do nothing because + the last text written to the AbstractCodeWriter does not match: + + 

          
+ SimpleCodeWriter = new SimpleCodeWriter();
+ writer.writeInline("Hello.");
+ writer.unwrite("there.");
+ assert(writer.toString().equals("Hello.\n"));
+
          +
          +
          Overrides:
          +
          unwrite in class AbstractCodeWriter<CodeWriter>
          +
          Parameters:
          +
          content - Content to write.
          +
          args - String arguments to use for formatting.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          putContext

          +
          public CodeWriter putContext​(java.lang.String key,
+                             java.lang.Object value)
          +
          Deprecated.
          +
          Description copied from class: AbstractCodeWriter
          +
          Adds a named key-value pair to the context of the current state. + +

          These context values can be referenced by named interpolated + parameters.

          +
          +
          Overrides:
          +
          putContext in class AbstractCodeWriter<CodeWriter>
          +
          Parameters:
          +
          key - Key to add to the context.
          +
          value - Value to associate with the key.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          putContext

          +
          public CodeWriter putContext​(java.util.Map<java.lang.String,​java.lang.Object> mappings)
          +
          Deprecated.
          +
          Description copied from class: AbstractCodeWriter
          +
          Adds a map of named key-value pair to the context of the current state. + +

          These context values can be referenced by named interpolated + parameters.

          +
          +
          Overrides:
          +
          putContext in class AbstractCodeWriter<CodeWriter>
          +
          Parameters:
          +
          mappings - Key value pairs to add.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        + + + +
          +
        • +

          removeContext

          +
          public CodeWriter removeContext​(java.lang.String key)
          +
          Deprecated.
          +
          Description copied from class: AbstractCodeWriter
          +
          Removes a named key-value pair from the context of the current state. + +

          This method has no effect if the parent state defines the context key value pair.

          +
          +
          Overrides:
          +
          removeContext in class AbstractCodeWriter<CodeWriter>
          +
          Parameters:
          +
          key - Key to add to remove from the current context.
          +
          Returns:
          +
          Returns self.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/utils/CodeWriterDebugInfo.html b/javadoc/1.47.0/software/amazon/smithy/utils/CodeWriterDebugInfo.html new file mode 100644 index 00000000000..696888b7c6f --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/utils/CodeWriterDebugInfo.html @@ -0,0 +1,349 @@ + + + + + +CodeWriterDebugInfo (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.utils
    +

    Class CodeWriterDebugInfo

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.utils.CodeWriterDebugInfo
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class CodeWriterDebugInfo
+extends java.lang.Object
      +
      Provides debug information about the current state of a CodeWriter. + +

      The primary use case of this class is to be included in things like + exception messages thrown by CodeWriter. Additional metadata + can be appended to the debug info by calling putMetadata(java.lang.String, java.lang.String), + and this metadata will appear when toString() is called.

      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        java.lang.StringgetMetadata​(java.lang.String key) +
        Gets debug metadata by name.
        +
        java.lang.StringgetStateDebugPath() +
        Get the CodeWriter state path from which the debug information was collected.
        +
        voidputMetadata​(java.lang.String key, + java.lang.String value) +
        Put additional debug metadata on the object.
        +
        java.lang.StringtoString() +
        Returns a string representation that can be used in exception + messages and when debugging.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getStateDebugPath

          +
          public java.lang.String getStateDebugPath()
          +
          Get the CodeWriter state path from which the debug information was collected.
          +
          +
          Returns:
          +
          Returns the path as returned by AbstractCodeWriter.getDebugInfo();
          +
          +
          • +
        + + + +
          +
        • +

          putMetadata

          +
          public void putMetadata​(java.lang.String key,
+                        java.lang.String value)
          +
          Put additional debug metadata on the object.
          +
          +
          Parameters:
          +
          key - Name of the value to set.
          +
          value - Value to set that cannot be null.
          +
          +
          • +
        + + + +
          +
        • +

          getMetadata

          +
          public java.lang.String getMetadata​(java.lang.String key)
          +
          Gets debug metadata by name.
          +
          +
          Parameters:
          +
          key - Value to retrieve.
          +
          Returns:
          +
          Returns the string value or null if not found.
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          Returns a string representation that can be used in exception + messages and when debugging.
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          Returns:
          +
          Returns debug info as a string.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/utils/FunctionalUtils.html b/javadoc/1.47.0/software/amazon/smithy/utils/FunctionalUtils.html new file mode 100644 index 00000000000..0cdeb2e5946 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/utils/FunctionalUtils.html @@ -0,0 +1,299 @@ + + + + + +FunctionalUtils (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.utils
    +

    Class FunctionalUtils

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.utils.FunctionalUtils
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class FunctionalUtils
+extends java.lang.Object
      +
      Utilities for working with functions, predicates, etc.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static <T> java.util.function.Predicate<T>alwaysTrue() +
        Returns a Predicate that always returns true.
        +
        static <T> java.util.function.Predicate<T>not​(java.util.function.Predicate<T> predicate) +
        Negates a Predicate.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + +
          +
        • +

          not

          +
          public static <T> java.util.function.Predicate<T> not​(java.util.function.Predicate<T> predicate)
          +
          Negates a Predicate.
          +
          +
          Type Parameters:
          +
          T - Value type of the predicate.
          +
          Parameters:
          +
          predicate - Predicate to negate.
          +
          Returns:
          +
          Returns a predicate that negates the given predicate.
          +
          +
          • +
        + + + +
          +
        • +

          alwaysTrue

          +
          public static <T> java.util.function.Predicate<T> alwaysTrue()
          +
          Returns a Predicate that always returns true.
          +
          +
          Type Parameters:
          +
          T - Value that the predicate accepts.
          +
          Returns:
          +
          Returns the predicate.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/utils/IoUtils.html b/javadoc/1.47.0/software/amazon/smithy/utils/IoUtils.html new file mode 100644 index 00000000000..e0bd997fcea --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/utils/IoUtils.html @@ -0,0 +1,683 @@ + + + + + +IoUtils (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.utils
    +

    Class IoUtils

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.utils.IoUtils
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class IoUtils
+extends java.lang.Object
      +
      Utilities for IO operations.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static voidcopyDir​(java.nio.file.Path src, + java.nio.file.Path dest) 
        static java.lang.StringreadUtf8File​(java.lang.String path) +
        Reads a file into a UTF-8 encoded string.
        +
        static java.lang.StringreadUtf8File​(java.nio.file.Path path) +
        Reads a file into a UTF-8 encoded string.
        +
        static java.lang.StringreadUtf8Resource​(java.lang.Class<?> clazz, + java.lang.String resourcePath) +
        Reads a class resource into a UTF-8 string.
        +
        static java.lang.StringreadUtf8Resource​(java.lang.ClassLoader classLoader, + java.lang.String resourcePath) +
        Reads a class loader resource into a UTF-8 string.
        +
        static java.lang.StringreadUtf8Url​(java.net.URL url) +
        Reads a URL resource into a UTF-8 string.
        +
        static booleanrmdir​(java.nio.file.Path dir) +
        Delete a directory and all files within.
        +
        static java.lang.StringrunCommand​(java.lang.String command) +
        Helper to run a process.
        +
        static java.lang.StringrunCommand​(java.lang.String command, + java.nio.file.Path directory) +
        Helper to run a process.
        +
        static intrunCommand​(java.lang.String command, + java.nio.file.Path directory, + java.lang.Appendable output) +
        Helper to run a process.
        +
        static intrunCommand​(java.lang.String command, + java.nio.file.Path directory, + java.lang.Appendable output, + java.util.Map<java.lang.String,​java.lang.String> env) +
        Helper to run a process.
        +
        static intrunCommand​(java.util.List<java.lang.String> args, + java.nio.file.Path directory, + java.io.InputStream input, + java.lang.Appendable output, + java.util.Map<java.lang.String,​java.lang.String> env) +
        Helper to run a process.
        +
        static intrunCommand​(java.util.List<java.lang.String> args, + java.nio.file.Path directory, + java.lang.Appendable output, + java.util.Map<java.lang.String,​java.lang.String> env) +
        Helper to run a process.
        +
        static byte[]toByteArray​(java.io.InputStream is) +
        Reads and returns the rest of the given input stream as a byte array.
        +
        static java.lang.StringtoUtf8String​(java.io.InputStream is) +
        Reads and returns the rest of the given input stream as a string.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + +
          +
        • +

          toByteArray

          +
          public static byte[] toByteArray​(java.io.InputStream is)
          +
          Reads and returns the rest of the given input stream as a byte array. + Caller is responsible for closing the given input stream.
          +
          +
          Parameters:
          +
          is - The input stream to convert.
          +
          Returns:
          +
          The converted bytes.
          +
          +
          • +
        + + + +
          +
        • +

          toUtf8String

          +
          public static java.lang.String toUtf8String​(java.io.InputStream is)
          +
          Reads and returns the rest of the given input stream as a string. + Caller is responsible for closing the given input stream.
          +
          +
          Parameters:
          +
          is - The input stream to convert.
          +
          Returns:
          +
          The converted string.
          +
          +
          • +
        + + + +
          +
        • +

          readUtf8File

          +
          public static java.lang.String readUtf8File​(java.lang.String path)
          +
          Reads a file into a UTF-8 encoded string.
          +
          +
          Parameters:
          +
          path - Path to the file to read.
          +
          Returns:
          +
          Returns the contents of the file.
          +
          Throws:
          +
          java.lang.RuntimeException - if the file can't be read or encoded.
          +
          +
          • +
        + + + +
          +
        • +

          readUtf8File

          +
          public static java.lang.String readUtf8File​(java.nio.file.Path path)
          +
          Reads a file into a UTF-8 encoded string.
          +
          +
          Parameters:
          +
          path - Path to the file to read.
          +
          Returns:
          +
          Returns the contents of the file.
          +
          Throws:
          +
          java.lang.RuntimeException - if the file can't be read or encoded.
          +
          +
          • +
        + + + +
          +
        • +

          readUtf8Resource

          +
          public static java.lang.String readUtf8Resource​(java.lang.ClassLoader classLoader,
+                                                java.lang.String resourcePath)
          +
          Reads a class loader resource into a UTF-8 string. + +

          This is equivalent to reading the contents of an InputStream + from ClassLoader.getResourceAsStream(java.lang.String).

          +
          +
          Parameters:
          +
          classLoader - Class loader to load from.
          +
          resourcePath - Path to the resource to load.
          +
          Returns:
          +
          Returns the loaded resource.
          +
          Throws:
          +
          java.io.UncheckedIOException - if the resource cannot be loaded.
          +
          +
          • +
        + + + +
          +
        • +

          readUtf8Resource

          +
          public static java.lang.String readUtf8Resource​(java.lang.Class<?> clazz,
+                                                java.lang.String resourcePath)
          +
          Reads a class resource into a UTF-8 string. + +

          This is equivalent to reading the contents of an InputStream + from Class.getResourceAsStream(String).

          +
          +
          Parameters:
          +
          clazz - Class to load from.
          +
          resourcePath - Path to the resource to load.
          +
          Returns:
          +
          Returns the loaded resource.
          +
          Throws:
          +
          java.io.UncheckedIOException - if the resource cannot be loaded.
          +
          +
          • +
        + + + +
          +
        • +

          readUtf8Url

          +
          public static java.lang.String readUtf8Url​(java.net.URL url)
          +
          Reads a URL resource into a UTF-8 string.
          +
          +
          Parameters:
          +
          url - URL to load from.
          +
          Returns:
          +
          Returns the loaded resource.
          +
          Throws:
          +
          java.io.UncheckedIOException - if the resource cannot be loaded.
          +
          +
          • +
        + + + +
          +
        • +

          runCommand

          +
          public static java.lang.String runCommand​(java.lang.String command)
          +
          Helper to run a process. + +

          stderr is redirected to stdout in the return value of this method.

          +
          +
          Parameters:
          +
          command - String that contains the command and arguments of the command.
          +
          Returns:
          +
          Returns the combined stdout and stderr of the process.
          +
          Throws:
          +
          java.lang.RuntimeException - if the process returns a non-zero exit code or fails.
          +
          +
          • +
        + + + +
          +
        • +

          runCommand

          +
          public static java.lang.String runCommand​(java.lang.String command,
+                                          java.nio.file.Path directory)
          +
          Helper to run a process. + +

          stderr is redirected to stdout in the return value of this method.

          +
          +
          Parameters:
          +
          command - String that contains the command and arguments of the command.
          +
          directory - Directory to use as the working directory.
          +
          Returns:
          +
          Returns the combined stdout and stderr of the process.
          +
          Throws:
          +
          java.lang.RuntimeException - if the process returns a non-zero exit code or fails.
          +
          +
          • +
        + + + +
          +
        • +

          runCommand

          +
          public static int runCommand​(java.lang.String command,
+                             java.nio.file.Path directory,
+                             java.lang.Appendable output)
          +
          Helper to run a process. + +

          stderr is redirected to stdout when writing to output. + This method does not throw when a non-zero exit code is + encountered. For any more complex use cases, use ProcessBuilder + directly.

          +
          +
          Parameters:
          +
          command - String that contains the command and arguments of the command.
          +
          directory - Directory to use as the working directory.
          +
          output - Sink destination for lines from stdout and stderr of the process.
          +
          Returns:
          +
          Returns the exit code of the process.
          +
          +
          • +
        + + + +
          +
        • +

          runCommand

          +
          public static int runCommand​(java.lang.String command,
+                             java.nio.file.Path directory,
+                             java.lang.Appendable output,
+                             java.util.Map<java.lang.String,​java.lang.String> env)
          +
          Helper to run a process. + +

          stderr is redirected to stdout when writing to output. + This method does not throw when a non-zero exit code is + encountered. For any more complex use cases, use ProcessBuilder + directly.

          +
          +
          Parameters:
          +
          command - String that contains the command and arguments of the command.
          +
          directory - Directory to use as the working directory.
          +
          output - Sink destination for lines from stdout and stderr of the process.
          +
          env - Environment variables to set, possibly overriding specific inherited variables.
          +
          Returns:
          +
          Returns the exit code of the process.
          +
          +
          • +
        + + + +
          +
        • +

          runCommand

          +
          public static int runCommand​(java.util.List<java.lang.String> args,
+                             java.nio.file.Path directory,
+                             java.lang.Appendable output,
+                             java.util.Map<java.lang.String,​java.lang.String> env)
          +
          Helper to run a process. + +

          stderr is redirected to stdout when writing to output. + This method does not throw when a non-zero exit code is + encountered. For any more complex use cases, use ProcessBuilder + directly.

          +
          +
          Parameters:
          +
          args - List containing the program and the arguments.
          +
          directory - Directory to use as the working directory.
          +
          output - Sink destination for lines from stdout and stderr of the process.
          +
          env - Environment variables to set, possibly overriding specific inherited variables.
          +
          Returns:
          +
          Returns the exit code of the process.
          +
          +
          • +
        + + + +
          +
        • +

          runCommand

          +
          public static int runCommand​(java.util.List<java.lang.String> args,
+                             java.nio.file.Path directory,
+                             java.io.InputStream input,
+                             java.lang.Appendable output,
+                             java.util.Map<java.lang.String,​java.lang.String> env)
          +
          Helper to run a process. + +

          stderr is redirected to stdout when writing to output This method does not throw when a + non-zero exit code is encountered. For any more complex use cases, use ProcessBuilder directly.

          +
          +
          Parameters:
          +
          args - List containing the program and the arguments.
          +
          directory - Directory to use as the working directory.
          +
          input - Data to write to the stdin of the process. Use null to send no input.
          +
          output - Sink destination for lines from stdout and stderr of the process.
          +
          env - Environment variables to set, possibly overriding specific inherited variables.
          +
          Returns:
          +
          Returns the exit code of the process.
          +
          +
          • +
        + + + +
          +
        • +

          rmdir

          +
          public static boolean rmdir​(java.nio.file.Path dir)
          +
          Delete a directory and all files within. + +

          Any found symlink is deleted, but the contents of a symlink are not deleted.

          +
          +
          Parameters:
          +
          dir - Directory to delete.
          +
          Returns:
          +
          Returns true if the directory was deleted, or false if the directory does not exist.
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if the given path is not a directory.
          +
          java.lang.RuntimeException - if unable to delete a file or directory.
          +
          +
          • +
        + + + +
          +
        • +

          copyDir

          +
          public static void copyDir​(java.nio.file.Path src,
+                           java.nio.file.Path dest)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/utils/ListUtils.html b/javadoc/1.47.0/software/amazon/smithy/utils/ListUtils.html new file mode 100644 index 00000000000..5bbac149d25 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/utils/ListUtils.html @@ -0,0 +1,414 @@ + + + + + +ListUtils (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.utils
    +

    Class ListUtils

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.utils.ListUtils
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class ListUtils
+extends java.lang.Object
      +
      Immutable List utilities to polyfill Java 9+ features.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static <T> java.util.List<T>copyOf​(java.util.Collection<? extends T> values) +
        Creates an immutable copy of the given list.
        +
        static <T> java.util.List<T>of() +
        Returns an unmodifiable list containing zero entries.
        +
        static <T> java.util.List<T>of​(T value) +
        Returns an unmodifiable list containing a single entry.
        +
        static <T> java.util.List<T>of​(T... values) +
        Returns an unmodifiable list containing any number of entries.
        +
        static <T> java.util.List<T>of​(T value1, + T value2) +
        Returns an unmodifiable list containing two entries.
        +
        static <T> java.util.stream.Collector<T,​?,​java.util.List<T>>toUnmodifiableList() +
        Creates a collector that collects into an unmodifiable list.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + +
          +
        • +

          copyOf

          +
          public static <T> java.util.List<T> copyOf​(java.util.Collection<? extends T> values)
          +
          Creates an immutable copy of the given list.
          +
          +
          Type Parameters:
          +
          T - the List's value type.
          +
          Parameters:
          +
          values - The collection to make an immutable list of.
          +
          Returns:
          +
          An immutable List copy.
          +
          +
          • +
        + + + +
          +
        • +

          of

          +
          public static <T> java.util.List<T> of()
          +
          Returns an unmodifiable list containing zero entries.
          +
          +
          Type Parameters:
          +
          T - the List's value type.
          +
          Returns:
          +
          an empty List.
          +
          +
          • +
        + + + + + +
          +
        • +

          of

          +
          public static <T> java.util.List<T> of​(T value)
          +
          Returns an unmodifiable list containing a single entry.
          +
          +
          Type Parameters:
          +
          T - the List's value type.
          +
          Parameters:
          +
          value - the List's value.
          +
          Returns:
          +
          a List containing the specified value.
          +
          Throws:
          +
          java.lang.NullPointerException - if the value is null.
          +
          +
          • +
        + + + + + +
          +
        • +

          of

          +
          public static <T> java.util.List<T> of​(T value1,
+                                       T value2)
          +
          Returns an unmodifiable list containing two entries.
          +
          +
          Type Parameters:
          +
          T - the List's value type.
          +
          Parameters:
          +
          value1 - The first value.
          +
          value2 - The second value.
          +
          Returns:
          +
          a List containing the specified values.
          +
          +
          • +
        + + + + + +
          +
        • +

          of

          +
          @SafeVarargs
+public static <T> java.util.List<T> of​(T... values)
          +
          Returns an unmodifiable list containing any number of entries.
          +
          +
          Type Parameters:
          +
          T - the List's value type.
          +
          Parameters:
          +
          values - the List's values.
          +
          Returns:
          +
          a List containing the specified values.
          +
          Throws:
          +
          java.lang.NullPointerException - if any value is null.
          +
          +
          • +
        + + + +
          +
        • +

          toUnmodifiableList

          +
          public static <T> java.util.stream.Collector<T,​?,​java.util.List<T>> toUnmodifiableList()
          +
          Creates a collector that collects into an unmodifiable list. + +

          This is a polyfill equivalent of Java 10's + Collectors#toUnmodifiableList.

          +
          +
          Type Parameters:
          +
          T - Type of value to expect.
          +
          Returns:
          +
          a Collector that accumulates the entries into an unmodifiable List.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/utils/MapUtils.html b/javadoc/1.47.0/software/amazon/smithy/utils/MapUtils.html new file mode 100644 index 00000000000..efdbaaa5994 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/utils/MapUtils.html @@ -0,0 +1,1029 @@ + + + + + +MapUtils (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.utils
    +

    Class MapUtils

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.utils.MapUtils
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class MapUtils
+extends java.lang.Object
      +
      Immutable Map utilities to polyfill Java 9+ features.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static <K,​V>
        java.util.Map<K,​V>        		copyOf​(java.util.Map<? extends K,​? extends V> map) +
        Creates an immutable copy of the given map.
        +
        static <K,​V>
        java.util.Map.Entry<K,​V>        		entry​(K key, + V value) +
        Creates an immutable Map.Entry from the given key and value.
        +
        static <K,​V>
        java.util.Map<K,​V>        		of() +
        Returns an unmodifiable map containing zero mappings.
        +
        static <K,​V>
        java.util.Map<K,​V>        		of​(K k1, + V v1) +
        Returns an unmodifiable map containing a single mapping.
        +
        static <K,​V>
        java.util.Map<K,​V>        		of​(K k1, + V v1, + K k2, + V v2) +
        Returns an unmodifiable map containing two mappings.
        +
        static <K,​V>
        java.util.Map<K,​V>        		of​(K k1, + V v1, + K k2, + V v2, + K k3, + V v3) +
        Returns an unmodifiable map containing three mappings.
        +
        static <K,​V>
        java.util.Map<K,​V>        		of​(K k1, + V v1, + K k2, + V v2, + K k3, + V v3, + K k4, + V v4) +
        Returns an unmodifiable map containing four mappings.
        +
        static <K,​V>
        java.util.Map<K,​V>        		of​(K k1, + V v1, + K k2, + V v2, + K k3, + V v3, + K k4, + V v4, + K k5, + V v5) +
        Returns an unmodifiable map containing five mappings.
        +
        static <K,​V>
        java.util.Map<K,​V>        		of​(K k1, + V v1, + K k2, + V v2, + K k3, + V v3, + K k4, + V v4, + K k5, + V v5, + K k6, + V v6) +
        Returns an unmodifiable map containing six mappings.
        +
        static <K,​V>
        java.util.Map<K,​V>        		of​(K k1, + V v1, + K k2, + V v2, + K k3, + V v3, + K k4, + V v4, + K k5, + V v5, + K k6, + V v6, + K k7, + V v7) +
        Returns an unmodifiable map containing seven mappings.
        +
        static <K,​V>
        java.util.Map<K,​V>        		of​(K k1, + V v1, + K k2, + V v2, + K k3, + V v3, + K k4, + V v4, + K k5, + V v5, + K k6, + V v6, + K k7, + V v7, + K k8, + V v8) +
        Returns an unmodifiable map containing eight mappings.
        +
        static <K,​V>
        java.util.Map<K,​V>        		of​(K k1, + V v1, + K k2, + V v2, + K k3, + V v3, + K k4, + V v4, + K k5, + V v5, + K k6, + V v6, + K k7, + V v7, + K k8, + V v8, + K k9, + V v9) +
        Returns an unmodifiable map containing nine mappings.
        +
        static <K,​V>
        java.util.Map<K,​V>        		of​(K k1, + V v1, + K k2, + V v2, + K k3, + V v3, + K k4, + V v4, + K k5, + V v5, + K k6, + V v6, + K k7, + V v7, + K k8, + V v8, + K k9, + V v9, + K k10, + V v10) +
        Returns an unmodifiable map containing ten mappings.
        +
        static <K,​V>
        java.util.Map<K,​V>        		ofEntries​(java.util.Map.Entry<? extends K,​? extends V>... entries) +
        Creates an unmodifiable Map from an array of Map.Entry values.
        +
        static <K,​V>
        java.util.Map<K,​V>        		orderedCopyOf​(java.util.Map<? extends K,​? extends V> map) +
        Creates an ordered immutable copy of the given map.
        +
        static <T,​K,​U>
        java.util.stream.Collector<T,​?,​java.util.Map<K,​U>>        		toUnmodifiableMap​(java.util.function.Function<? super T,​? extends K> keyMapper, + java.util.function.Function<? super T,​? extends U> valueMapper) +
        Creates a collector that collects into an unmodifiable Map.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + +
          +
        • +

          copyOf

          +
          public static <K,​V> java.util.Map<K,​V> copyOf​(java.util.Map<? extends K,​? extends V> map)
          +
          Creates an immutable copy of the given map.
          +
          +
          Type Parameters:
          +
          K - the Map's key type
          +
          V - the Map's value type
          +
          Parameters:
          +
          map - The map to make an immutable copy of
          +
          Returns:
          +
          An immutable Map copy
          +
          +
          • +
        + + + +
          +
        • +

          orderedCopyOf

          +
          public static <K,​V> java.util.Map<K,​V> orderedCopyOf​(java.util.Map<? extends K,​? extends V> map)
          +
          Creates an ordered immutable copy of the given map.
          +
          +
          Type Parameters:
          +
          K - the Map's key type
          +
          V - the Map's value type
          +
          Parameters:
          +
          map - The map to make an immutable copy of
          +
          Returns:
          +
          An ordered immutable Map copy that maintains the order of the original.
          +
          +
          • +
        + + + +
          +
        • +

          of

          +
          public static <K,​V> java.util.Map<K,​V> of()
          +
          Returns an unmodifiable map containing zero mappings.
          +
          +
          Type Parameters:
          +
          K - the Map's key type
          +
          V - the Map's value type
          +
          Returns:
          +
          an empty Map
          +
          +
          • +
        + + + + + +
          +
        • +

          of

          +
          public static <K,​V> java.util.Map<K,​V> of​(K k1,
+                                                      V v1)
          +
          Returns an unmodifiable map containing a single mapping.
          +
          +
          Type Parameters:
          +
          K - the Map's key type
          +
          V - the Map's value type
          +
          Parameters:
          +
          k1 - the mapping's key
          +
          v1 - the mapping's value
          +
          Returns:
          +
          a Map containing the specified mapping
          +
          Throws:
          +
          java.lang.NullPointerException - if the key or the value is null
          +
          +
          • +
        + + + + + +
          +
        • +

          of

          +
          public static <K,​V> java.util.Map<K,​V> of​(K k1,
+                                                      V v1,
+                                                      K k2,
+                                                      V v2)
          +
          Returns an unmodifiable map containing two mappings.
          +
          +
          Type Parameters:
          +
          K - the Map's key type
          +
          V - the Map's value type
          +
          Parameters:
          +
          k1 - the first mapping's key
          +
          v1 - the first mapping's value
          +
          k2 - the second mapping's key
          +
          v2 - the second mapping's value
          +
          Returns:
          +
          a Map containing the specified mappings
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if the keys are duplicates
          +
          java.lang.NullPointerException - if any key or value is null
          +
          +
          • +
        + + + + + +
          +
        • +

          of

          +
          public static <K,​V> java.util.Map<K,​V> of​(K k1,
+                                                      V v1,
+                                                      K k2,
+                                                      V v2,
+                                                      K k3,
+                                                      V v3)
          +
          Returns an unmodifiable map containing three mappings.
          +
          +
          Type Parameters:
          +
          K - the Map's key type
          +
          V - the Map's value type
          +
          Parameters:
          +
          k1 - the first mapping's key
          +
          v1 - the first mapping's value
          +
          k2 - the second mapping's key
          +
          v2 - the second mapping's value
          +
          k3 - the third mapping's key
          +
          v3 - the third mapping's value
          +
          Returns:
          +
          a Map containing the specified mappings
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if there are any duplicate keys
          +
          java.lang.NullPointerException - if any key or value is null
          +
          +
          • +
        + + + + + +
          +
        • +

          of

          +
          public static <K,​V> java.util.Map<K,​V> of​(K k1,
+                                                      V v1,
+                                                      K k2,
+                                                      V v2,
+                                                      K k3,
+                                                      V v3,
+                                                      K k4,
+                                                      V v4)
          +
          Returns an unmodifiable map containing four mappings.
          +
          +
          Type Parameters:
          +
          K - the Map's key type
          +
          V - the Map's value type
          +
          Parameters:
          +
          k1 - the first mapping's key
          +
          v1 - the first mapping's value
          +
          k2 - the second mapping's key
          +
          v2 - the second mapping's value
          +
          k3 - the third mapping's key
          +
          v3 - the third mapping's value
          +
          k4 - the fourth mapping's key
          +
          v4 - the fourth mapping's value
          +
          Returns:
          +
          a Map containing the specified mappings
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if there are any duplicate keys
          +
          java.lang.NullPointerException - if any key or value is null
          +
          +
          • +
        + + + + + +
          +
        • +

          of

          +
          public static <K,​V> java.util.Map<K,​V> of​(K k1,
+                                                      V v1,
+                                                      K k2,
+                                                      V v2,
+                                                      K k3,
+                                                      V v3,
+                                                      K k4,
+                                                      V v4,
+                                                      K k5,
+                                                      V v5)
          +
          Returns an unmodifiable map containing five mappings.
          +
          +
          Type Parameters:
          +
          K - the Map's key type
          +
          V - the Map's value type
          +
          Parameters:
          +
          k1 - the first mapping's key
          +
          v1 - the first mapping's value
          +
          k2 - the second mapping's key
          +
          v2 - the second mapping's value
          +
          k3 - the third mapping's key
          +
          v3 - the third mapping's value
          +
          k4 - the fourth mapping's key
          +
          v4 - the fourth mapping's value
          +
          k5 - the fifth mapping's key
          +
          v5 - the fifth mapping's value
          +
          Returns:
          +
          a Map containing the specified mappings
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if there are any duplicate keys
          +
          java.lang.NullPointerException - if any key or value is null
          +
          +
          • +
        + + + + + +
          +
        • +

          of

          +
          public static <K,​V> java.util.Map<K,​V> of​(K k1,
+                                                      V v1,
+                                                      K k2,
+                                                      V v2,
+                                                      K k3,
+                                                      V v3,
+                                                      K k4,
+                                                      V v4,
+                                                      K k5,
+                                                      V v5,
+                                                      K k6,
+                                                      V v6)
          +
          Returns an unmodifiable map containing six mappings.
          +
          +
          Type Parameters:
          +
          K - the Map's key type
          +
          V - the Map's value type
          +
          Parameters:
          +
          k1 - the first mapping's key
          +
          v1 - the first mapping's value
          +
          k2 - the second mapping's key
          +
          v2 - the second mapping's value
          +
          k3 - the third mapping's key
          +
          v3 - the third mapping's value
          +
          k4 - the fourth mapping's key
          +
          v4 - the fourth mapping's value
          +
          k5 - the fifth mapping's key
          +
          v5 - the fifth mapping's value
          +
          k6 - the sixth mapping's key
          +
          v6 - the sixth mapping's value
          +
          Returns:
          +
          a Map containing the specified mappings
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if there are any duplicate keys
          +
          java.lang.NullPointerException - if any key or value is null
          +
          +
          • +
        + + + + + +
          +
        • +

          of

          +
          public static <K,​V> java.util.Map<K,​V> of​(K k1,
+                                                      V v1,
+                                                      K k2,
+                                                      V v2,
+                                                      K k3,
+                                                      V v3,
+                                                      K k4,
+                                                      V v4,
+                                                      K k5,
+                                                      V v5,
+                                                      K k6,
+                                                      V v6,
+                                                      K k7,
+                                                      V v7)
          +
          Returns an unmodifiable map containing seven mappings.
          +
          +
          Type Parameters:
          +
          K - the Map's key type
          +
          V - the Map's value type
          +
          Parameters:
          +
          k1 - the first mapping's key
          +
          v1 - the first mapping's value
          +
          k2 - the second mapping's key
          +
          v2 - the second mapping's value
          +
          k3 - the third mapping's key
          +
          v3 - the third mapping's value
          +
          k4 - the fourth mapping's key
          +
          v4 - the fourth mapping's value
          +
          k5 - the fifth mapping's key
          +
          v5 - the fifth mapping's value
          +
          k6 - the sixth mapping's key
          +
          v6 - the sixth mapping's value
          +
          k7 - the seventh mapping's key
          +
          v7 - the seventh mapping's value
          +
          Returns:
          +
          a Map containing the specified mappings
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if there are any duplicate keys
          +
          java.lang.NullPointerException - if any key or value is null
          +
          +
          • +
        + + + + + +
          +
        • +

          of

          +
          public static <K,​V> java.util.Map<K,​V> of​(K k1,
+                                                      V v1,
+                                                      K k2,
+                                                      V v2,
+                                                      K k3,
+                                                      V v3,
+                                                      K k4,
+                                                      V v4,
+                                                      K k5,
+                                                      V v5,
+                                                      K k6,
+                                                      V v6,
+                                                      K k7,
+                                                      V v7,
+                                                      K k8,
+                                                      V v8)
          +
          Returns an unmodifiable map containing eight mappings.
          +
          +
          Type Parameters:
          +
          K - the Map's key type
          +
          V - the Map's value type
          +
          Parameters:
          +
          k1 - the first mapping's key
          +
          v1 - the first mapping's value
          +
          k2 - the second mapping's key
          +
          v2 - the second mapping's value
          +
          k3 - the third mapping's key
          +
          v3 - the third mapping's value
          +
          k4 - the fourth mapping's key
          +
          v4 - the fourth mapping's value
          +
          k5 - the fifth mapping's key
          +
          v5 - the fifth mapping's value
          +
          k6 - the sixth mapping's key
          +
          v6 - the sixth mapping's value
          +
          k7 - the seventh mapping's key
          +
          v7 - the seventh mapping's value
          +
          k8 - the eighth mapping's key
          +
          v8 - the eighth mapping's value
          +
          Returns:
          +
          a Map containing the specified mappings
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if there are any duplicate keys
          +
          java.lang.NullPointerException - if any key or value is null
          +
          +
          • +
        + + + + + +
          +
        • +

          of

          +
          public static <K,​V> java.util.Map<K,​V> of​(K k1,
+                                                      V v1,
+                                                      K k2,
+                                                      V v2,
+                                                      K k3,
+                                                      V v3,
+                                                      K k4,
+                                                      V v4,
+                                                      K k5,
+                                                      V v5,
+                                                      K k6,
+                                                      V v6,
+                                                      K k7,
+                                                      V v7,
+                                                      K k8,
+                                                      V v8,
+                                                      K k9,
+                                                      V v9)
          +
          Returns an unmodifiable map containing nine mappings.
          +
          +
          Type Parameters:
          +
          K - the Map's key type
          +
          V - the Map's value type
          +
          Parameters:
          +
          k1 - the first mapping's key
          +
          v1 - the first mapping's value
          +
          k2 - the second mapping's key
          +
          v2 - the second mapping's value
          +
          k3 - the third mapping's key
          +
          v3 - the third mapping's value
          +
          k4 - the fourth mapping's key
          +
          v4 - the fourth mapping's value
          +
          k5 - the fifth mapping's key
          +
          v5 - the fifth mapping's value
          +
          k6 - the sixth mapping's key
          +
          v6 - the sixth mapping's value
          +
          k7 - the seventh mapping's key
          +
          v7 - the seventh mapping's value
          +
          k8 - the eighth mapping's key
          +
          v8 - the eighth mapping's value
          +
          k9 - the ninth mapping's key
          +
          v9 - the ninth mapping's value
          +
          Returns:
          +
          a Map containing the specified mappings
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if there are any duplicate keys
          +
          java.lang.NullPointerException - if any key or value is null
          +
          +
          • +
        + + + + + +
          +
        • +

          of

          +
          public static <K,​V> java.util.Map<K,​V> of​(K k1,
+                                                      V v1,
+                                                      K k2,
+                                                      V v2,
+                                                      K k3,
+                                                      V v3,
+                                                      K k4,
+                                                      V v4,
+                                                      K k5,
+                                                      V v5,
+                                                      K k6,
+                                                      V v6,
+                                                      K k7,
+                                                      V v7,
+                                                      K k8,
+                                                      V v8,
+                                                      K k9,
+                                                      V v9,
+                                                      K k10,
+                                                      V v10)
          +
          Returns an unmodifiable map containing ten mappings.
          +
          +
          Type Parameters:
          +
          K - the Map's key type
          +
          V - the Map's value type
          +
          Parameters:
          +
          k1 - the first mapping's key
          +
          v1 - the first mapping's value
          +
          k2 - the second mapping's key
          +
          v2 - the second mapping's value
          +
          k3 - the third mapping's key
          +
          v3 - the third mapping's value
          +
          k4 - the fourth mapping's key
          +
          v4 - the fourth mapping's value
          +
          k5 - the fifth mapping's key
          +
          v5 - the fifth mapping's value
          +
          k6 - the sixth mapping's key
          +
          v6 - the sixth mapping's value
          +
          k7 - the seventh mapping's key
          +
          v7 - the seventh mapping's value
          +
          k8 - the eighth mapping's key
          +
          v8 - the eighth mapping's value
          +
          k9 - the ninth mapping's key
          +
          v9 - the ninth mapping's value
          +
          k10 - the tenth mapping's key
          +
          v10 - the tenth mapping's value
          +
          Returns:
          +
          a Map containing the specified mappings
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if there are any duplicate keys
          +
          java.lang.NullPointerException - if any key or value is null
          +
          +
          • +
        + + + + + +
          +
        • +

          entry

          +
          public static <K,​V> java.util.Map.Entry<K,​V> entry​(K key,
+                                                               V value)
          +
          Creates an immutable Map.Entry from the given key and value.
          +
          +
          Type Parameters:
          +
          K - Key type.
          +
          V - Value type.
          +
          Parameters:
          +
          key - Key to set in the Map.Entry.
          +
          value - Value to set in the Map.Entry.
          +
          Returns:
          +
          Returns the created entry.
          +
          Throws:
          +
          java.lang.NullPointerException - if the key or value are null.
          +
          +
          • +
        + + + +
          +
        • +

          ofEntries

          +
          @SafeVarargs
+public static <K,​V> java.util.Map<K,​V> ofEntries​(java.util.Map.Entry<? extends K,​? extends V>... entries)
          +
          Creates an unmodifiable Map from an array of Map.Entry values.
          +
          +
          Type Parameters:
          +
          K - Map key type.
          +
          V - Map value type.
          +
          Parameters:
          +
          entries - Map entries to add to the created Map.
          +
          Returns:
          +
          Returns an unmodifiable map of the given entries.
          +
          +
          • +
        + + + +
          +
        • +

          toUnmodifiableMap

          +
          public static <T,​K,​U> java.util.stream.Collector<T,​?,​java.util.Map<K,​U>> toUnmodifiableMap​(java.util.function.Function<? super T,​? extends K> keyMapper,
+                                                                                                                         java.util.function.Function<? super T,​? extends U> valueMapper)
          +
          Creates a collector that collects into an unmodifiable Map. + +

          This is a polyfill equivalent of Java 10's + Collectors#toUnmodifiableMap.

          +
          +
          Type Parameters:
          +
          T - the type to retrieve keys and values from.
          +
          K - the Map's key type.
          +
          U - the Map's value type.
          +
          Parameters:
          +
          keyMapper - Function that retrieves the key.
          +
          valueMapper - Function that retrieves the value.
          +
          Returns:
          +
          a Collector that accumulates the entries into an unmodifiable Map.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/utils/MediaType.html b/javadoc/1.47.0/software/amazon/smithy/utils/MediaType.html new file mode 100644 index 00000000000..896f21a3fbb --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/utils/MediaType.html @@ -0,0 +1,475 @@ + + + + + +MediaType (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.utils
    +

    Class MediaType

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.utils.MediaType
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class MediaType
+extends java.lang.Object
      +
      Implements a simple media type parser based on the Content-Type grammar defined in + RFC 7231. + +

      The type, subtype, and parameter names are all canonicalized to + lowercase strings.

      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        booleanequals​(java.lang.Object o) 
        static MediaTypefrom​(java.lang.String value) +
        Create a parsed MediaType from the given string.
        +
        java.util.Map<java.lang.String,​java.lang.String>getParameters() +
        Gets the immutable map of parameters.
        +
        java.lang.StringgetSubtype() +
        Gets the "subtype" of the media type.
        +
        java.lang.StringgetSubtypeWithoutSuffix() +
        Gets the "subtype" of the media type with no structured syntax suffix.
        +
        java.util.Optional<java.lang.String>getSuffix() +
        Gets the optional structured syntax suffix.
        +
        java.lang.StringgetType() +
        Gets the "type" of the media type.
        +
        inthashCode() 
        static booleanisJson​(java.lang.String mediaType) +
        Detects if the given media type string is JSON, meaning it + is "application/json" or uses the "+json" structured syntax + suffix.
        +
        java.lang.StringtoString() 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          from

          +
          public static MediaType from​(java.lang.String value)
          +
          Create a parsed MediaType from the given string.
          +
          +
          Parameters:
          +
          value - Media type to parse (e.g., application/json).
          +
          Returns:
          +
          Returns the parsed media type.
          +
          Throws:
          +
          java.lang.RuntimeException - if the media type is invalid.
          +
          +
          • +
        + + + +
          +
        • +

          isJson

          +
          public static boolean isJson​(java.lang.String mediaType)
          +
          Detects if the given media type string is JSON, meaning it + is "application/json" or uses the "+json" structured syntax + suffix.
          +
          +
          Parameters:
          +
          mediaType - Media type to parse and test if it's JSON.
          +
          Returns:
          +
          Returns true if the given media type is JSON.
          +
          +
          • +
        + + + +
          +
        • +

          getType

          +
          public java.lang.String getType()
          +
          Gets the "type" of the media type.
          +
          +
          Returns:
          +
          Returns the type (e.g., "application").
          +
          +
          • +
        + + + +
          +
        • +

          getSubtype

          +
          public java.lang.String getSubtype()
          +
          Gets the "subtype" of the media type.
          +
          +
          Returns:
          +
          Returns the subtype (e.g., "json", "foo+json").
          +
          +
          • +
        + + + +
          +
        • +

          getSubtypeWithoutSuffix

          +
          public java.lang.String getSubtypeWithoutSuffix()
          +
          Gets the "subtype" of the media type with no structured syntax suffix. + +

          For example given, "application/foo+json", this method returns + "foo". Given "application/foo+baz+json", this method returns + "foo+baz".

          +
          +
          Returns:
          +
          Returns the subtype (e.g., "json", "foo+json").
          +
          +
          • +
        + + + +
          +
        • +

          getParameters

          +
          public java.util.Map<java.lang.String,​java.lang.String> getParameters()
          +
          Gets the immutable map of parameters.
          +
          +
          Returns:
          +
          Returns the parameters.
          +
          +
          • +
        + + + +
          +
        • +

          getSuffix

          +
          public java.util.Optional<java.lang.String> getSuffix()
          +
          Gets the optional structured syntax suffix. + +

          For example given, "application/foo+json", this method returns + "json". Given "application/foo+baz+json", this method returns + "json". Given "application/json", this method returns an empty + Optional.

          +
          +
          Returns:
          +
          Returns the optional structured syntax suffix value with no "+".
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/utils/OptionalUtils.html b/javadoc/1.47.0/software/amazon/smithy/utils/OptionalUtils.html new file mode 100644 index 00000000000..e172f84089b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/utils/OptionalUtils.html @@ -0,0 +1,339 @@ + + + + + +OptionalUtils (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.utils
    +

    Class OptionalUtils

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.utils.OptionalUtils
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class OptionalUtils
+extends java.lang.Object
      +
      Functions that make working with optionals easier.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static <T> voidifPresentOrElse​(java.util.Optional<T> value, + java.util.function.Consumer<T> action, + java.lang.Runnable emptyAction) +
        Invokes a consumer if the Optional has a value, otherwise invoked a + Runnable when the Optional is empty.
        +
        static <T> java.util.Optional<T>or​(java.util.Optional<T> value, + java.util.function.Supplier<java.util.Optional<? extends T>> supplier) +
        Retrieves the value of the optional if present or invokes the supplier + for a value.
        +
        static <T> java.util.stream.Stream<T>stream​(java.util.Optional<T> value) +
        Converts an Optional into a Stream that can be used in a flatmap.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + +
          +
        • +

          or

          +
          public static <T> java.util.Optional<T> or​(java.util.Optional<T> value,
+                                           java.util.function.Supplier<java.util.Optional<? extends T>> supplier)
          +
          Retrieves the value of the optional if present or invokes the supplier + for a value.
          +
          +
          Type Parameters:
          +
          T - Type of value.
          +
          Parameters:
          +
          value - Value to check.
          +
          supplier - Supplier for a value if no value is present.
          +
          Returns:
          +
          A value of type T.
          +
          +
          • +
        + + + +
          +
        • +

          stream

          +
          public static <T> java.util.stream.Stream<T> stream​(java.util.Optional<T> value)
          +
          Converts an Optional into a Stream that can be used in a flatmap. + +

          This is a polyfill of Java 9's Optional#stream.

          +
          +
          Type Parameters:
          +
          T - Value type.
          +
          Parameters:
          +
          value - Value to convert to a stream.
          +
          Returns:
          +
          A stream that contains a present value or a stream that is empty.
          +
          +
          • +
        + + + +
          +
        • +

          ifPresentOrElse

          +
          public static <T> void ifPresentOrElse​(java.util.Optional<T> value,
+                                       java.util.function.Consumer<T> action,
+                                       java.lang.Runnable emptyAction)
          +
          Invokes a consumer if the Optional has a value, otherwise invoked a + Runnable when the Optional is empty.
          +
          +
          Type Parameters:
          +
          T - Type of value.
          +
          Parameters:
          +
          value - Value to check.
          +
          action - Action to invoke if a value is present.
          +
          emptyAction - Runnable to invoke if a value is not present.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/utils/Pair.html b/javadoc/1.47.0/software/amazon/smithy/utils/Pair.html new file mode 100644 index 00000000000..a95a6d04dc6 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/utils/Pair.html @@ -0,0 +1,587 @@ + + + + + +Pair (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.utils
    +

    Class Pair<L,​R>

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.utils.Pair<L,​R>
        • +
      +
      • +
    +
    +
      +
    • +
      +
      Type Parameters:
      +
      L - Left value type.
      +
      R - Right value type.
      +
      +
      +
      All Implemented Interfaces:
      +
      java.util.Map.Entry<L,​R>
      +
      +
      +
      public final class Pair<L,​R>
+extends java.lang.Object
+implements java.util.Map.Entry<L,​R>
      +
      Generic immutable pair of values.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        Lleft 
        Rright 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Pair​(L left, + R right) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        booleanequals​(java.lang.Object o) 
        static <L,​R>
        java.util.stream.Stream<Pair<L,​R>>        		flatMapStream​(L left, + java.util.function.Function<L,​java.util.Optional<R>> f) +
        Creates a Stream of zero or one Pairs if the mapping function + returns a non-empty Optional.
        +
        static <L,​R>
        java.util.stream.Stream<Pair<L,​R>>        		flatMapStream​(L left, + java.util.function.Supplier<java.util.Optional<R>> f) 
        LgetKey() 
        LgetLeft() 
        RgetRight() 
        RgetValue() 
        inthashCode() 
        static <L,​R>
        Pair<L,​R>        		of​(L left, + R right) +
        Creates a Pair from the given values.
        +
        RsetValue​(R value) 
        java.lang.StringtoString() 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, finalize, getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          left

          +
          public final L left
          +
          • +
        + + + +
          +
        • +

          right

          +
          public final R right
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Detail

        + + + + + +
          +
        • +

          Pair

          +
          public Pair​(L left,
+            R right)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + +
          +
        • +

          of

          +
          public static <L,​R> Pair<L,​R> of​(L left,
+                                             R right)
          +
          Creates a Pair from the given values.
          +
          +
          Type Parameters:
          +
          L - Left value type.
          +
          R - Right value type.
          +
          Parameters:
          +
          left - Left value.
          +
          right - Right value.
          +
          Returns:
          +
          Returns the created Pair.
          +
          +
          • +
        + + + + + +
          +
        • +

          flatMapStream

          +
          public static <L,​R> java.util.stream.Stream<Pair<L,​R>> flatMapStream​(L left,
+                                                                                 java.util.function.Function<L,​java.util.Optional<R>> f)
          +
          Creates a Stream of zero or one Pairs if the mapping function + returns a non-empty Optional.
          +
          +
          Type Parameters:
          +
          L - Left value type.
          +
          R - Right value type.
          +
          Parameters:
          +
          left - Value to set as the left side of the pair.
          +
          f - Mapping function that accepts the left value and returns an + Optional value.
          +
          Returns:
          +
          Returns a Stream that contains either a single Pair if the + Optional is not empty, or an empty Stream.
          +
          +
          • +
        + + + + + +
          +
        • +

          flatMapStream

          +
          public static <L,​R> java.util.stream.Stream<Pair<L,​R>> flatMapStream​(L left,
+                                                                                 java.util.function.Supplier<java.util.Optional<R>> f)
          +
          • +
        + + + +
          +
        • +

          getLeft

          +
          public L getLeft()
          +
          • +
        + + + +
          +
        • +

          getRight

          +
          public R getRight()
          +
          • +
        + + + +
          +
        • +

          getKey

          +
          public L getKey()
          +
          +
          Specified by:
          +
          getKey in interface java.util.Map.Entry<L,​R>
          +
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public R getValue()
          +
          +
          Specified by:
          +
          getValue in interface java.util.Map.Entry<L,​R>
          +
          +
          • +
        + + + + + +
          +
        • +

          setValue

          +
          public R setValue​(R value)
          +
          +
          Specified by:
          +
          setValue in interface java.util.Map.Entry<L,​R>
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Specified by:
          +
          equals in interface java.util.Map.Entry<L,​R>
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Specified by:
          +
          hashCode in interface java.util.Map.Entry<L,​R>
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/utils/SetUtils.html b/javadoc/1.47.0/software/amazon/smithy/utils/SetUtils.html new file mode 100644 index 00000000000..b8468fdea6b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/utils/SetUtils.html @@ -0,0 +1,424 @@ + + + + + +SetUtils (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.utils
    +

    Class SetUtils

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.utils.SetUtils
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class SetUtils
+extends java.lang.Object
      +
      Immutable Set utilities to polyfill Java 9+ features.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static java.util.Set<java.lang.String>caseInsensitiveCopyOf​(java.util.Collection<? extends java.lang.String> values) 
        static <T> java.util.Set<T>copyOf​(java.util.Collection<? extends T> values) +
        Creates an immutable copy of the given set.
        +
        static <T> java.util.Set<T>of() +
        Returns an unmodifiable set containing zero entries.
        +
        static <T> java.util.Set<T>of​(T value) +
        Returns an unmodifiable set containing a single entry.
        +
        static <T> java.util.Set<T>of​(T... values) +
        Returns an unmodifiable set containing any number of entries.
        +
        static <T> java.util.Set<T>orderedCopyOf​(java.util.Collection<? extends T> values) +
        Creates an ordered immutable copy of the given set.
        +
        static <T> java.util.stream.Collector<T,​?,​java.util.Set<T>>toUnmodifiableSet() +
        Creates a collector that collects into an unmodifiable set.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + +
          +
        • +

          copyOf

          +
          public static <T> java.util.Set<T> copyOf​(java.util.Collection<? extends T> values)
          +
          Creates an immutable copy of the given set.
          +
          +
          Type Parameters:
          +
          T - the Set's value type.
          +
          Parameters:
          +
          values - The collection to make an immutable set of.
          +
          Returns:
          +
          An immutable Set copy.
          +
          +
          • +
        + + + +
          +
        • +

          orderedCopyOf

          +
          public static <T> java.util.Set<T> orderedCopyOf​(java.util.Collection<? extends T> values)
          +
          Creates an ordered immutable copy of the given set.
          +
          +
          Type Parameters:
          +
          T - the Set's value type.
          +
          Parameters:
          +
          values - The collection to make an immutable set of.
          +
          Returns:
          +
          An ordered immutable Set copy that maintains the order of the original.
          +
          +
          • +
        + + + +
          +
        • +

          caseInsensitiveCopyOf

          +
          public static java.util.Set<java.lang.String> caseInsensitiveCopyOf​(java.util.Collection<? extends java.lang.String> values)
          +
          • +
        + + + +
          +
        • +

          of

          +
          public static <T> java.util.Set<T> of()
          +
          Returns an unmodifiable set containing zero entries.
          +
          +
          Type Parameters:
          +
          T - the Set's value type.
          +
          Returns:
          +
          an empty Set.
          +
          +
          • +
        + + + + + +
          +
        • +

          of

          +
          public static <T> java.util.Set<T> of​(T value)
          +
          Returns an unmodifiable set containing a single entry.
          +
          +
          Type Parameters:
          +
          T - the Set's value type.
          +
          Parameters:
          +
          value - the Set's value.
          +
          Returns:
          +
          a Set containing the specified value.
          +
          Throws:
          +
          java.lang.NullPointerException - if the value is null.
          +
          +
          • +
        + + + + + +
          +
        • +

          of

          +
          @SafeVarargs
+public static <T> java.util.Set<T> of​(T... values)
          +
          Returns an unmodifiable set containing any number of entries.
          +
          +
          Type Parameters:
          +
          T - the Set's value type.
          +
          Parameters:
          +
          values - the Set's values.
          +
          Returns:
          +
          a Set containing the specified values.
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if any of the values is a duplicate.
          +
          java.lang.NullPointerException - if any value is null.
          +
          +
          • +
        + + + +
          +
        • +

          toUnmodifiableSet

          +
          public static <T> java.util.stream.Collector<T,​?,​java.util.Set<T>> toUnmodifiableSet()
          +
          Creates a collector that collects into an unmodifiable set. + +

          This is a polyfill equivalent of Java 10's + Collectors#toUnmodifiableSet.

          +
          +
          Type Parameters:
          +
          T - the Set's value type.
          +
          Returns:
          +
          a Collector that accumulates the entries into an unmodifiable Set.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/utils/SimpleCodeWriter.html b/javadoc/1.47.0/software/amazon/smithy/utils/SimpleCodeWriter.html new file mode 100644 index 00000000000..2919e5d730c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/utils/SimpleCodeWriter.html @@ -0,0 +1,281 @@ + + + + + +SimpleCodeWriter (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.utils
    +

    Class SimpleCodeWriter

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          SimpleCodeWriter

          +
          public SimpleCodeWriter()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/utils/SimpleParser.html b/javadoc/1.47.0/software/amazon/smithy/utils/SimpleParser.html new file mode 100644 index 00000000000..53dbc14668c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/utils/SimpleParser.html @@ -0,0 +1,943 @@ + + + + + +SimpleParser (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.utils
    +

    Class SimpleParser

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.utils.SimpleParser
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public class SimpleParser
+extends java.lang.Object
      +
      A simple expression parser that can be extended to implement parsers + for small domain-specific languages. + +

      This parser internally consumes characters of a CharSequence while tracking + the current 0-based position, 1-based line, and 1-based column. + Expectations can be made on the parser to require specific characters, + and when those expectations are not met, a syntax exception is thrown.

      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Summary

        + + + + + + + + + + + + +
        Fields 
        Modifier and TypeFieldDescription
        static charEOF 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        SimpleParser​(java.lang.CharSequence expression) +
        Creates a new SimpleParser and sets the expression to parse.
        +
        SimpleParser​(java.lang.CharSequence input, + int maxNestingLevel) +
        Creates a new SimpleParser and sets the expression to parse.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods Deprecated Methods 
        Modifier and TypeMethodDescription
        java.lang.CharSequenceborrowSliceFrom​(int start) +
        Gets a zero-copy slice of the expression starting from the given 0-based character position, read all the + way through to the current position of the parser.
        +
        java.lang.CharSequenceborrowSliceFrom​(int start, + int removeRight) +
        Gets a zero-copy slice of the expression starting from the given 0-based character position, read all the + way through to the current position of the parser minus removeRight.
        +
        voidbr() +
        Skips spaces then expects that the next character is either the end of + the expression or a line break (\n, \r\n, or \r).
        +
        intcolumn() +
        Gets the current 1-based column number of the parser.
        +
        voidconsumeRemainingCharactersOnLine() +
        Skips over the remaining characters on a line but does not consume + the newline character (\n or \r\n).
        +
        intconsumeUntilNoLongerMatches​(java.util.function.Predicate<java.lang.Character> predicate) +
        Deprecated.
        +
        intconsumeWhile​(java.util.function.IntPredicate predicate) +
        Reads a lexeme from the expression while the given predicate matches each peeked character.
        +
        voiddecreaseNestingLevel() +
        Decreases the current nesting level of the parser.
        +
        booleaneof() +
        Checks if the parser has reached the end of the expression.
        +
        charexpect​(char token) +
        Expects that the next character is the given character and consumes it.
        +
        charexpect​(char... tokens) +
        Expects that the next character is one of a fixed set of possible characters.
        +
        java.lang.Stringexpression() +
        Deprecated.
        +
        voidincreaseNestingLevel() +
        Increases the current nesting level of the parser.
        +
        java.lang.CharSequenceinput() +
        Gets the input being parsed as a CharSequence.
        +
        intline() +
        Gets the current 1-based line number of the parser.
        +
        intnestingLevel() +
        Gets the current 0-based nesting level of the parser.
        +
        charpeek() +
        Returns the current character of the expression, but does not consume it.
        +
        charpeek​(int offset) +
        Returns the current character of the expression + offset + characters, but does not consume it.
        +
        java.lang.StringpeekSingleCharForMessage() +
        Peeks the next character and returns [EOF] if the next character is past + the end of the expression.
        +
        intposition() +
        Gets the current 0-based position of the parser.
        +
        voidrewind​(int position, + int line, + int column) 
        voidskip() +
        Skips a single character while tracking lines and columns.
        +
        java.lang.StringsliceFrom​(int start) +
        Copies a slice of the expression into a string, starting from the given 0-based character position, + read all the way through to the current position of the parser.
        +
        voidsp() +
        Skip 0 or more spaces (that is, ' ' and '\t').
        +
        java.lang.RuntimeExceptionsyntax​(java.lang.String message) +
        Creates a syntax error that adds some context to the given message.
        +
        voidws() +
        Skip 0 or more whitespace characters (that is, ' ', '\t', '\r', and '\n').
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          SimpleParser

          +
          public SimpleParser​(java.lang.CharSequence expression)
          +
          Creates a new SimpleParser and sets the expression to parse.
          +
          +
          Parameters:
          +
          expression - Expression to parser.
          +
          +
          • +
        + + + +
          +
        • +

          SimpleParser

          +
          public SimpleParser​(java.lang.CharSequence input,
+                    int maxNestingLevel)
          +
          Creates a new SimpleParser and sets the expression to parse. + +

          By default, no maximum parsing level is enforced. Setting the + maxParsingLevel to 0 disables the enforcement of a + maximum parsing level.

          +
          +
          Parameters:
          +
          input - Input to parse that must not be null.
          +
          maxNestingLevel - The maximum allowed nesting level of the parser.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          input

          +
          public final java.lang.CharSequence input()
          +
          Gets the input being parsed as a CharSequence.
          +
          +
          Returns:
          +
          Returns the input being parsed.
          +
          +
          • +
        + + + +
          +
        • +

          expression

          +
          @Deprecated
+public final java.lang.String expression()
          +
          Deprecated.
          +
          • +
        + + + +
          +
        • +

          position

          +
          public final int position()
          +
          Gets the current 0-based position of the parser.
          +
          +
          Returns:
          +
          Returns the parser character position.
          +
          +
          • +
        + + + +
          +
        • +

          line

          +
          public final int line()
          +
          Gets the current 1-based line number of the parser.
          +
          +
          Returns:
          +
          Returns the current line number.
          +
          +
          • +
        + + + +
          +
        • +

          column

          +
          public final int column()
          +
          Gets the current 1-based column number of the parser.
          +
          +
          Returns:
          +
          Returns the current column number.
          +
          +
          • +
        + + + +
          +
        • +

          rewind

          +
          public final void rewind​(int position,
+                         int line,
+                         int column)
          +
          • +
        + + + +
          +
        • +

          eof

          +
          public final boolean eof()
          +
          Checks if the parser has reached the end of the expression.
          +
          +
          Returns:
          +
          Returns true if the parser has reached the end.
          +
          +
          • +
        + + + +
          +
        • +

          peek

          +
          public final char peek()
          +
          Returns the current character of the expression, but does not consume it.
          +
          +
          Returns:
          +
          Returns the peeked character.
          +
          +
          • +
        + + + +
          +
        • +

          peek

          +
          public final char peek​(int offset)
          +
          Returns the current character of the expression + offset + characters, but does not consume it. + +

          If the end of the expression is reached or if the peeked offset is + calculated to be less than 0, Character.MIN_VALUE is returned + (that is, '\0').

          +
          +
          Parameters:
          +
          offset - The number of characters to peek ahead (positive or negative).
          +
          Returns:
          +
          Returns the peeked character.
          +
          +
          • +
        + + + +
          +
        • +

          expect

          +
          public final char expect​(char token)
          +
          Expects that the next character is the given character and consumes it.
          +
          +
          Parameters:
          +
          token - The character to expect.
          +
          Returns:
          +
          Returns the expected character.
          +
          +
          • +
        + + + +
          +
        • +

          peekSingleCharForMessage

          +
          public final java.lang.String peekSingleCharForMessage()
          +
          Peeks the next character and returns [EOF] if the next character is past + the end of the expression.
          +
          +
          Returns:
          +
          Returns the peeked next character.
          +
          +
          • +
        + + + +
          +
        • +

          expect

          +
          public final char expect​(char... tokens)
          +
          Expects that the next character is one of a fixed set of possible characters.
          +
          +
          Parameters:
          +
          tokens - Characters to expect.
          +
          Returns:
          +
          Returns the consumed character.
          +
          +
          • +
        + + + +
          +
        • +

          syntax

          +
          public java.lang.RuntimeException syntax​(java.lang.String message)
          +
          Creates a syntax error that adds some context to the given message.
          +
          +
          Parameters:
          +
          message - Message for why the error occurred.
          +
          Returns:
          +
          Returns the created syntax error.
          +
          +
          • +
        + + + +
          +
        • +

          ws

          +
          public void ws()
          +
          Skip 0 or more whitespace characters (that is, ' ', '\t', '\r', and '\n').
          +
          • +
        + + + +
          +
        • +

          sp

          +
          public void sp()
          +
          Skip 0 or more spaces (that is, ' ' and '\t').
          +
          • +
        + + + +
          +
        • +

          br

          +
          public void br()
          +
          Skips spaces then expects that the next character is either the end of + the expression or a line break (\n, \r\n, or \r).
          +
          +
          Throws:
          +
          java.lang.RuntimeException - if the next non-space character is not EOF or a line break.
          +
          +
          • +
        + + + +
          +
        • +

          skip

          +
          public void skip()
          +
          Skips a single character while tracking lines and columns.
          +
          • +
        + + + +
          +
        • +

          consumeRemainingCharactersOnLine

          +
          public void consumeRemainingCharactersOnLine()
          +
          Skips over the remaining characters on a line but does not consume + the newline character (\n or \r\n). + +

          This method will also terminate when the end of the expression + is encountered. + +

          This method is useful, for example, for skipping the text of a + commented out line in an expression. If the contents of the skipped + line are required, then store the current position before invoking + this method using position(), then call this method, then get + the contents of the skipped characters using sliceFrom(int).

          +
          • +
        + + + +
          +
        • +

          sliceFrom

          +
          public final java.lang.String sliceFrom​(int start)
          +
          Copies a slice of the expression into a string, starting from the given 0-based character position, + read all the way through to the current position of the parser.
          +
          +
          Parameters:
          +
          start - Position to slice from, ending at the current position.
          +
          Returns:
          +
          Returns the copied slice of the expression from start to position.
          +
          +
          • +
        + + + +
          +
        • +

          borrowSliceFrom

          +
          public final java.lang.CharSequence borrowSliceFrom​(int start)
          +
          Gets a zero-copy slice of the expression starting from the given 0-based character position, read all the + way through to the current position of the parser.
          +
          +
          Parameters:
          +
          start - Position to slice from, ending at the current position.
          +
          Returns:
          +
          Returns the zero-copy slice of the expression from start to position.
          +
          +
          • +
        + + + +
          +
        • +

          borrowSliceFrom

          +
          public final java.lang.CharSequence borrowSliceFrom​(int start,
+                                                    int removeRight)
          +
          Gets a zero-copy slice of the expression starting from the given 0-based character position, read all the + way through to the current position of the parser minus removeRight.
          +
          +
          Parameters:
          +
          start - Position to slice from, ending at the current position.
          +
          removeRight - Number of characters to omit before the current position.
          +
          Returns:
          +
          Returns the zero-copy slice of the expression from start to position.
          +
          +
          • +
        + + + +
          +
        • +

          consumeUntilNoLongerMatches

          +
          @Deprecated
+public final int consumeUntilNoLongerMatches​(java.util.function.Predicate<java.lang.Character> predicate)
          +
          Deprecated.
          +
          • +
        + + + +
          +
        • +

          consumeWhile

          +
          public final int consumeWhile​(java.util.function.IntPredicate predicate)
          +
          Reads a lexeme from the expression while the given predicate matches each peeked character.
          +
          +
          Parameters:
          +
          predicate - Predicate that filters characters.
          +
          Returns:
          +
          Returns the consumed lexeme (or an empty string on no matches).
          +
          +
          • +
        + + + +
          +
        • +

          increaseNestingLevel

          +
          public final void increaseNestingLevel()
          +
          Increases the current nesting level of the parser. + +

          This method can be manually invoked when parsing in order to + prevent parsing too deeply using recursive descent parsers.

          +
          +
          Throws:
          +
          java.lang.RuntimeException - if the nesting level is deeper than the max allowed nesting.
          +
          +
          • +
        + + + +
          +
        • +

          decreaseNestingLevel

          +
          public final void decreaseNestingLevel()
          +
          Decreases the current nesting level of the parser.
          +
          • +
        + + + +
          +
        • +

          nestingLevel

          +
          public int nestingLevel()
          +
          Gets the current 0-based nesting level of the parser.
          +
          +
          Returns:
          +
          Returns the current nesting level.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/utils/SmithyBuilder.html b/javadoc/1.47.0/software/amazon/smithy/utils/SmithyBuilder.html new file mode 100644 index 00000000000..91ab5cd1b11 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/utils/SmithyBuilder.html @@ -0,0 +1,298 @@ + + + + + +SmithyBuilder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.utils
    +

    Interface SmithyBuilder<T>

    +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Abstract Methods 
        Modifier and TypeMethodDescription
        Tbuild() +
        Creates an immutable object that is created from the properties + that have been set on the builder.
        +
        static <T> TrequiredState​(java.lang.String method, + T value) +
        Convenience method for ensuring that a value was set on a builder, + and if not, throws an IllegalStateException with a useful message.
        +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          build

          +
          T build()
          +
          Creates an immutable object that is created from the properties + that have been set on the builder.
          +
          +
          Returns:
          +
          an instance of T
          +
          +
          • +
        + + + + + +
          +
        • +

          requiredState

          +
          static <T> T requiredState​(java.lang.String method,
+                           T value)
          +
          Convenience method for ensuring that a value was set on a builder, + and if not, throws an IllegalStateException with a useful message.
          +
          +
          Type Parameters:
          +
          T - Type of value being checked.
          +
          Parameters:
          +
          method - Method that needs to be called to set this value.
          +
          value - Value to check.
          +
          Returns:
          +
          Returns the value.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/utils/SmithyGenerated.html b/javadoc/1.47.0/software/amazon/smithy/utils/SmithyGenerated.html new file mode 100644 index 00000000000..3718164e91c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/utils/SmithyGenerated.html @@ -0,0 +1,187 @@ + + + + + +SmithyGenerated (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.utils
    +

    Annotation Type SmithyGenerated

    +
    +
    +
    +
      +
    • +
      +
      @Target({PACKAGE,TYPE})
+public @interface SmithyGenerated
      +
      Annotation used to indicate that a package or class was generated and + should not be edited directly.
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/utils/SmithyInternalApi.html b/javadoc/1.47.0/software/amazon/smithy/utils/SmithyInternalApi.html new file mode 100644 index 00000000000..aa486688a14 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/utils/SmithyInternalApi.html @@ -0,0 +1,190 @@ + + + + + +SmithyInternalApi (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.utils
    +

    Annotation Type SmithyInternalApi

    +
    +
    +
    +
      +
    • +
      +
      @Target({PACKAGE,TYPE,FIELD,CONSTRUCTOR,METHOD})
+public @interface SmithyInternalApi
      +
      Annotation used to indicate that an API is considered internal to Smithy + and subject to change. Breaking changes can and will be introduced to + elements marked as SmithyInternalApi. Users of Smithy should not + depend on any packages, types, fields, constructors, or methods with this + annotation.
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/utils/SmithyUnstableApi.html b/javadoc/1.47.0/software/amazon/smithy/utils/SmithyUnstableApi.html new file mode 100644 index 00000000000..1f4aaa8b4ab --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/utils/SmithyUnstableApi.html @@ -0,0 +1,191 @@ + + + + + +SmithyUnstableApi (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.utils
    +

    Annotation Type SmithyUnstableApi

    +
    +
    +
    +
      +
    • +
      +
      @Target({PACKAGE,TYPE,FIELD,CONSTRUCTOR,METHOD})
+public @interface SmithyUnstableApi
      +
      Annotation used to indicate that an API is considered unstable and subject + to change. + +

      Breaking changes may be introduced to elements marked as SmithyUnstableApi. + Users of Smithy may implement and use APIs marked as unstable with the caveat that + they may need to make changes to their implementations as unstable APIs evolve.

      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/utils/StringUtils.html b/javadoc/1.47.0/software/amazon/smithy/utils/StringUtils.html new file mode 100644 index 00000000000..a30decc824b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/utils/StringUtils.html @@ -0,0 +1,1766 @@ + + + + + +StringUtils (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.utils
    +

    Class StringUtils

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.utils.StringUtils
        • +
      +
      • +
    +
    +
      +
    • +
      +
      public final class StringUtils
+extends java.lang.Object
      +

      Operations on String that are null safe.

      + +
        +
      • IsEmpty/IsBlank + - checks if a String contains text
        • +
      • Trim + - removes leading and trailing whitespace
        • +
      • Equals/Compare + - compares two strings null-safe
        • +
      • Substring + - null-safe substring extraction
        • +
      • UpperCase/LowerCase/Capitalize/Uncapitalize + - changes the case of a String
        • +
      + +

      The StringUtils class defines certain words related to + String handling.

      + +
        +
      • null - null
        • +
      • empty - a zero-length string ("")
        • +
      • space - the space character (' ', char 32)
        • +
      • whitespace - the characters defined by Character.isWhitespace(char)
        • +
      • trim - the characters <= 32 as in String.trim()
        • +
      + +

      StringUtils handles null input Strings quietly. + That is to say that a null input will return null. + Where a boolean or int is being returned + details vary by method.

      + +

      A side effect of the null handling is that a + NullPointerException should be considered a bug in + StringUtils.

      + +

      This class's source was modified from the Apache commons-lang and + Apache commons-text libraries: https://github.com/apache/commons-lang/, + https://github.com/apache/commons-text/

      + +

      #ThreadSafe#

      +
      +
      See Also:
      +
      String, +Apache Commons Lang, +Apache Commons Text , +Elephant bird license
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static java.lang.Stringcapitalize​(java.lang.String str) +
        Capitalizes a String changing the first character to title case as + per Character.toTitleCase(int).
        +
        static booleanequals​(java.lang.String cs1, + java.lang.String cs2) +
        Compares two Strings, returning true if they represent + equal sequences of characters.
        +
        static java.lang.StringescapeJavaString​(java.lang.Object object, + java.lang.String indent) 
        static java.lang.Stringindent​(java.lang.String string, + int spaces) +
        Indents each line in the provided string by the provided number of spaces.
        +
        static booleanisBlank​(java.lang.CharSequence cs) +
        Checks if a CharSequence is empty (""), null or whitespace only.
        +
        static booleanisEmpty​(java.lang.CharSequence cs) +
        Checks if a CharSequence is empty ("") or null.
        +
        static booleanisNotBlank​(java.lang.CharSequence cs) +
        Checks if a CharSequence is not empty (""), not null and not whitespace only.
        +
        static java.lang.StringleftPad​(java.lang.String str, + int size) +
        Left pad a String with spaces (' ').
        +
        static java.lang.StringleftPad​(java.lang.String str, + int size, + char padChar) +
        Left pad a String with a specified character.
        +
        static java.lang.StringleftPad​(java.lang.String str, + int size, + java.lang.String padStr) +
        Left pad a String with a specified String.
        +
        static intlevenshteinDistance​(java.lang.CharSequence left, + java.lang.CharSequence right, + int threshold) +
        Find the Levenshtein distance between two CharSequences if it's less than or + equal to a given threshold.
        +
        static java.lang.StringlowerCase​(java.lang.String str) +
        Converts a String to lower case as per String.toLowerCase().
        +
        static java.lang.Stringrepeat​(char ch, + int repeat) +
        Returns padding using the specified delimiter repeated + to a given length.
        +
        static java.lang.Stringrepeat​(java.lang.String str, + int repeat) +
        Repeat a String repeat times to form a + new String.
        +
        static java.lang.StringrightPad​(java.lang.String str, + int size) +
        Right pad a String with spaces (' ').
        +
        static java.lang.StringrightPad​(java.lang.String str, + int size, + char padChar) +
        Right pad a String with a specified character.
        +
        static java.lang.StringrightPad​(java.lang.String str, + int size, + java.lang.String padStr) +
        Right pad a String with a specified String.
        +
        static booleanstartsWithIgnoreCase​(java.lang.String str, + java.lang.String prefix) +
        Tests if this string starts with the specified prefix ignoring case considerations.
        +
        static java.lang.Stringstrip​(java.lang.String str, + java.lang.String stripChars) +
        Strips any of a set of characters from the start and end of a String.
        +
        static java.lang.StringstripEnd​(java.lang.String str, + java.lang.String stripChars) +
        Strips any of a set of characters from the end of a String.
        +
        static java.lang.StringstripStart​(java.lang.String str, + java.lang.String stripChars) +
        Strips any of a set of characters from the start of a String.
        +
        static java.lang.StringstripToEmpty​(java.lang.String str) +
        Strips whitespace from the start and end of a String returning + an empty String if null input.
        +
        static java.lang.Stringsubstring​(java.lang.String str, + int start) +
        Gets a substring from the specified String avoiding exceptions.
        +
        static java.lang.Stringsubstring​(java.lang.String str, + int start, + int end) +
        Gets a substring from the specified String avoiding exceptions.
        +
        static java.lang.Stringtrim​(java.lang.String str) +
        Removes control characters (char <= 32) from both + ends of this String, handling null by returning + null.
        +
        static java.lang.StringtrimToEmpty​(java.lang.String str) +
        Removes control characters (char <= 32) from both + ends of this String returning an empty String ("") if the String + is empty ("") after the trim or if it is null.
        +
        static java.lang.StringtrimToNull​(java.lang.String str) +
        Removes control characters (char <= 32) from both + ends of this String returning null if the String is + empty ("") after the trim or if it is null.
        +
        static java.lang.Stringuncapitalize​(java.lang.String str) +
        Uncapitalizes a String, changing the first character to lower case as + per Character.toLowerCase(int).
        +
        static java.lang.StringupperCase​(java.lang.String str) +
        Converts a String to upper case as per String.toUpperCase().
        +
        static java.lang.Stringwrap​(java.lang.String str, + int wrapLength) +
        Wraps a single line of text, identifying words by ' '.
        +
        static java.lang.Stringwrap​(java.lang.String str, + int wrapLength, + java.lang.String newLineStr, + boolean wrapLongWords) +
        Wraps a single line of text, identifying words by ' '.
        +
        static java.lang.Stringwrap​(java.lang.String str, + int wrapLength, + java.lang.String newLineStr, + boolean wrapLongWords, + java.lang.String wrapOn) +
        Wraps a single line of text, identifying words by wrapOn.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

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

        Method Detail

        + + + +
          +
        • +

          isEmpty

          +
          public static boolean isEmpty​(java.lang.CharSequence cs)
          +

          Checks if a CharSequence is empty ("") or null.

          + + 
          + StringUtils.isEmpty(null)      = true
+ StringUtils.isEmpty("")        = true
+ StringUtils.isEmpty(" ")       = false
+ StringUtils.isEmpty("bob")     = false
+ StringUtils.isEmpty("  bob  ") = false
+
          + +

          NOTE: This method changed in Lang version 2.0. + It no longer trims the CharSequence. + That functionality is available in isBlank().

          +
          +
          Parameters:
          +
          cs - the CharSequence to check, may be null
          +
          Returns:
          +
          true if the CharSequence is empty or null
          +
          Since:
          +
          3.0 Changed signature from isEmpty(String) to isEmpty(CharSequence)
          +
          See Also:
          +
          Source
          +
          +
          • +
        + + + +
          +
        • +

          isBlank

          +
          public static boolean isBlank​(java.lang.CharSequence cs)
          +

          Checks if a CharSequence is empty (""), null or whitespace only.

          + +

          Whitespace is defined by Character.isWhitespace(char).

          + + 
          + StringUtils.isBlank(null)      = true
+ StringUtils.isBlank("")        = true
+ StringUtils.isBlank(" ")       = true
+ StringUtils.isBlank("bob")     = false
+ StringUtils.isBlank("  bob  ") = false
+
          +
          +
          Parameters:
          +
          cs - the CharSequence to check, may be null
          +
          Returns:
          +
          true if the CharSequence is null, empty or whitespace only
          +
          Since:
          +
          2.0, 3.0 Changed signature from isBlank(String) to isBlank(CharSequence)
          +
          See Also:
          +
          Source
          +
          +
          • +
        + + + +
          +
        • +

          isNotBlank

          +
          public static boolean isNotBlank​(java.lang.CharSequence cs)
          +

          Checks if a CharSequence is not empty (""), not null and not whitespace only.

          + +

          Whitespace is defined by Character.isWhitespace(char).

          + + 
          + StringUtils.isNotBlank(null)      = false
+ StringUtils.isNotBlank("")        = false
+ StringUtils.isNotBlank(" ")       = false
+ StringUtils.isNotBlank("bob")     = true
+ StringUtils.isNotBlank("  bob  ") = true
+
          +
          +
          Parameters:
          +
          cs - the CharSequence to check, may be null
          +
          Returns:
          +
          true if the CharSequence is not empty and not null and not whitespace only
          +
          Since:
          +
          2.0, 3.0 Changed signature from isNotBlank(String) to isNotBlank(CharSequence)
          +
          See Also:
          +
          Source
          +
          +
          • +
        + + + +
          +
        • +

          trim

          +
          public static java.lang.String trim​(java.lang.String str)
          +

          Removes control characters (char <= 32) from both + ends of this String, handling null by returning + null.

          + +

          The String is trimmed using String.trim(). + Trim removes start and end characters <= 32.

          + + 
          + StringUtils.trim(null)          = null
+ StringUtils.trim("")            = ""
+ StringUtils.trim("     ")       = ""
+ StringUtils.trim("abc")         = "abc"
+ StringUtils.trim("    abc    ") = "abc"
+
          +
          +
          Parameters:
          +
          str - the String to be trimmed, may be null
          +
          Returns:
          +
          the trimmed string, null if null String input
          +
          See Also:
          +
          Source
          +
          +
          • +
        + + + +
          +
        • +

          trimToNull

          +
          public static java.lang.String trimToNull​(java.lang.String str)
          +

          Removes control characters (char <= 32) from both + ends of this String returning null if the String is + empty ("") after the trim or if it is null. + +

          The String is trimmed using String.trim(). + Trim removes start and end characters <= 32.

          + + 
          + StringUtils.trimToNull(null)          = null
+ StringUtils.trimToNull("")            = null
+ StringUtils.trimToNull("     ")       = null
+ StringUtils.trimToNull("abc")         = "abc"
+ StringUtils.trimToNull("    abc    ") = "abc"
+
          +
          +
          Parameters:
          +
          str - the String to be trimmed, may be null
          +
          Returns:
          +
          the trimmed String, + null if only chars <= 32, empty or null String input
          +
          Since:
          +
          2.0
          +
          See Also:
          +
          Source
          +
          +
          • +
        + + + +
          +
        • +

          trimToEmpty

          +
          public static java.lang.String trimToEmpty​(java.lang.String str)
          +

          Removes control characters (char <= 32) from both + ends of this String returning an empty String ("") if the String + is empty ("") after the trim or if it is null. + +

          The String is trimmed using String.trim(). + Trim removes start and end characters <= 32.

          + + 
          + StringUtils.trimToEmpty(null)          = ""
+ StringUtils.trimToEmpty("")            = ""
+ StringUtils.trimToEmpty("     ")       = ""
+ StringUtils.trimToEmpty("abc")         = "abc"
+ StringUtils.trimToEmpty("    abc    ") = "abc"
+
          +
          +
          Parameters:
          +
          str - the String to be trimmed, may be null
          +
          Returns:
          +
          the trimmed String, or an empty String if null input
          +
          Since:
          +
          2.0
          +
          See Also:
          +
          Source
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public static boolean equals​(java.lang.String cs1,
+                             java.lang.String cs2)
          +

          Compares two Strings, returning true if they represent + equal sequences of characters.

          + +

          nulls are handled without exceptions. Two null + references are considered to be equal. The comparison is case sensitive.

          + + 
          + StringUtils.equals(null, null)   = true
+ StringUtils.equals(null, "abc")  = false
+ StringUtils.equals("abc", null)  = false
+ StringUtils.equals("abc", "abc") = true
+ StringUtils.equals("abc", "ABC") = false
+
          +
          +
          Parameters:
          +
          cs1 - the first String, may be null
          +
          cs2 - the second String, may be null
          +
          Returns:
          +
          true if the Strings are equal (case-sensitive), or both null
          +
          See Also:
          +
          Object.equals(Object), +Source
          +
          +
          • +
        + + + +
          +
        • +

          substring

          +
          public static java.lang.String substring​(java.lang.String str,
+                                         int start)
          +

          Gets a substring from the specified String avoiding exceptions.

          + +

          A negative start position can be used to start n + characters from the end of the String.

          + +

          A null String will return null. + An empty ("") String will return "".

          + + 
          + StringUtils.substring(null, *)   = null
+ StringUtils.substring("", *)     = ""
+ StringUtils.substring("abc", 0)  = "abc"
+ StringUtils.substring("abc", 2)  = "c"
+ StringUtils.substring("abc", 4)  = ""
+ StringUtils.substring("abc", -2) = "bc"
+ StringUtils.substring("abc", -4) = "abc"
+
          +
          +
          Parameters:
          +
          str - the String to get the substring from, may be null
          +
          start - the position to start from, negative means count back from the end of the String by this many + characters
          +
          Returns:
          +
          substring from start position, null if null String input
          +
          See Also:
          +
          Source
          +
          +
          • +
        + + + +
          +
        • +

          substring

          +
          public static java.lang.String substring​(java.lang.String str,
+                                         int start,
+                                         int end)
          +

          Gets a substring from the specified String avoiding exceptions.

          + +

          A negative start position can be used to start/end n + characters from the end of the String.

          + +

          The returned substring starts with the character in the start + position and ends before the end position. All position counting is + zero-based -- i.e., to start at the beginning of the string use + start = 0. Negative start and end positions can be used to + specify offsets relative to the end of the String.

          + +

          If start is not strictly to the left of end, "" + is returned.

          + + 
          + StringUtils.substring(null, *, *)    = null
+ StringUtils.substring("", * ,  *)    = "";
+ StringUtils.substring("abc", 0, 2)   = "ab"
+ StringUtils.substring("abc", 2, 0)   = ""
+ StringUtils.substring("abc", 2, 4)   = "c"
+ StringUtils.substring("abc", 4, 6)   = ""
+ StringUtils.substring("abc", 2, 2)   = ""
+ StringUtils.substring("abc", -2, -1) = "b"
+ StringUtils.substring("abc", -4, 2)  = "ab"
+
          +
          +
          Parameters:
          +
          str - the String to get the substring from, may be null
          +
          start - the position to start from, negative means count back from the end of the String by this many + characters
          +
          end - the position to end at (exclusive), negative means count back from the end of the String by this many + scharacters
          +
          Returns:
          +
          substring from start position to end position, + null if null String input
          +
          See Also:
          +
          Source
          +
          +
          • +
        + + + +
          +
        • +

          upperCase

          +
          public static java.lang.String upperCase​(java.lang.String str)
          +

          Converts a String to upper case as per String.toUpperCase().

          + +

          A null input String returns null.

          + + 
          + StringUtils.upperCase(null)  = null
+ StringUtils.upperCase("")    = ""
+ StringUtils.upperCase("aBc") = "ABC"
+
          + +

          This uses "ENGLISH" as the locale.

          +
          +
          Parameters:
          +
          str - the String to upper case, may be null
          +
          Returns:
          +
          the upper cased String, null if null String input
          +
          See Also:
          +
          Source
          +
          +
          • +
        + + + +
          +
        • +

          lowerCase

          +
          public static java.lang.String lowerCase​(java.lang.String str)
          +

          Converts a String to lower case as per String.toLowerCase().

          + +

          A null input String returns null.

          + + 
          + StringUtils.lowerCase(null)  = null
+ StringUtils.lowerCase("")    = ""
+ StringUtils.lowerCase("aBc") = "abc"
+
          + +

          This uses "ENGLISH" as the locale.

          +
          +
          Parameters:
          +
          str - the String to lower case, may be null
          +
          Returns:
          +
          the lower cased String, null if null String input
          +
          See Also:
          +
          Source
          +
          +
          • +
        + + + +
          +
        • +

          capitalize

          +
          public static java.lang.String capitalize​(java.lang.String str)
          +

          Capitalizes a String changing the first character to title case as + per Character.toTitleCase(int). No other characters are changed.

          + + 
          + StringUtils.capitalize(null)  = null
+ StringUtils.capitalize("")    = ""
+ StringUtils.capitalize("cat") = "Cat"
+ StringUtils.capitalize("cAt") = "CAt"
+ StringUtils.capitalize("'cat'") = "'cat'"
+
          +
          +
          Parameters:
          +
          str - the String to capitalize, may be null
          +
          Returns:
          +
          the capitalized String, null if null String input
          +
          Since:
          +
          2.0
          +
          See Also:
          +
          uncapitalize(String), +Source
          +
          +
          • +
        + + + +
          +
        • +

          uncapitalize

          +
          public static java.lang.String uncapitalize​(java.lang.String str)
          +

          Uncapitalizes a String, changing the first character to lower case as + per Character.toLowerCase(int). No other characters are changed.

          + + 
          + StringUtils.uncapitalize(null)  = null
+ StringUtils.uncapitalize("")    = ""
+ StringUtils.uncapitalize("cat") = "cat"
+ StringUtils.uncapitalize("Cat") = "cat"
+ StringUtils.uncapitalize("CAT") = "cAT"
+
          +
          +
          Parameters:
          +
          str - the String to uncapitalize, may be null
          +
          Returns:
          +
          the uncapitalized String, null if null String input
          +
          Since:
          +
          2.0
          +
          See Also:
          +
          capitalize(String), +Source
          +
          +
          • +
        + + + +
          +
        • +

          startsWithIgnoreCase

          +
          public static boolean startsWithIgnoreCase​(java.lang.String str,
+                                           java.lang.String prefix)
          +
          Tests if this string starts with the specified prefix ignoring case considerations.
          +
          +
          Parameters:
          +
          str - the string to be tested
          +
          prefix - the prefix
          +
          Returns:
          +
          true if the string starts with the prefix ignoring case
          +
          +
          • +
        + + + +
          +
        • +

          repeat

          +
          public static java.lang.String repeat​(java.lang.String str,
+                                      int repeat)
          +

          Repeat a String repeat times to form a + new String.

          + + 
          + StringUtils.repeat(null, 2) = null
+ StringUtils.repeat("", 0)   = ""
+ StringUtils.repeat("", 2)   = ""
+ StringUtils.repeat("a", 3)  = "aaa"
+ StringUtils.repeat("ab", 2) = "abab"
+ StringUtils.repeat("a", -2) = ""
+
          +
          +
          Parameters:
          +
          str - the String to repeat, may be null
          +
          repeat - number of times to repeat str, negative treated as zero
          +
          Returns:
          +
          a new String consisting of the original String repeated, + null if null String input
          +
          See Also:
          +
          Source
          +
          +
          • +
        + + + +
          +
        • +

          repeat

          +
          public static java.lang.String repeat​(char ch,
+                                      int repeat)
          +

          Returns padding using the specified delimiter repeated + to a given length.

          + + 
          + StringUtils.repeat('e', 0)  = ""
+ StringUtils.repeat('e', 3)  = "eee"
+ StringUtils.repeat('e', -2) = ""
+
          + +

          Note: this method does not support padding with + Unicode Supplementary Characters + as they require a pair of chars to be represented. + If you are needing to support full I18N of your applications + consider using repeat(String, int) instead. +

          +
          +
          Parameters:
          +
          ch - character to repeat
          +
          repeat - number of times to repeat char, negative treated as zero
          +
          Returns:
          +
          String with repeated character
          +
          See Also:
          +
          repeat(String, int), +Source
          +
          +
          • +
        + + + +
          +
        • +

          rightPad

          +
          public static java.lang.String rightPad​(java.lang.String str,
+                                        int size)
          +

          Right pad a String with spaces (' ').

          + +

          The String is padded to the size of size.

          + + 
          + StringUtils.rightPad(null, *)   = null
+ StringUtils.rightPad("", 3)     = "   "
+ StringUtils.rightPad("bat", 3)  = "bat"
+ StringUtils.rightPad("bat", 5)  = "bat  "
+ StringUtils.rightPad("bat", 1)  = "bat"
+ StringUtils.rightPad("bat", -1) = "bat"
+
          +
          +
          Parameters:
          +
          str - the String to pad out, may be null
          +
          size - the size to pad to
          +
          Returns:
          +
          right padded String or original String if no padding is necessary, + null if null String input
          +
          See Also:
          +
          Source
          +
          +
          • +
        + + + +
          +
        • +

          rightPad

          +
          public static java.lang.String rightPad​(java.lang.String str,
+                                        int size,
+                                        char padChar)
          +

          Right pad a String with a specified character.

          + +

          The String is padded to the size of size.

          + + 
          + StringUtils.rightPad(null, *, *)     = null
+ StringUtils.rightPad("", 3, 'z')     = "zzz"
+ StringUtils.rightPad("bat", 3, 'z')  = "bat"
+ StringUtils.rightPad("bat", 5, 'z')  = "batzz"
+ StringUtils.rightPad("bat", 1, 'z')  = "bat"
+ StringUtils.rightPad("bat", -1, 'z') = "bat"
+
          +
          +
          Parameters:
          +
          str - the String to pad out, may be null
          +
          size - the size to pad to
          +
          padChar - the character to pad with
          +
          Returns:
          +
          right padded String or original String if no padding is necessary, + null if null String input
          +
          Since:
          +
          2.0
          +
          See Also:
          +
          Source
          +
          +
          • +
        + + + +
          +
        • +

          rightPad

          +
          public static java.lang.String rightPad​(java.lang.String str,
+                                        int size,
+                                        java.lang.String padStr)
          +

          Right pad a String with a specified String.

          + +

          The String is padded to the size of size.

          + + 
          + StringUtils.rightPad(null, *, *)      = null
+ StringUtils.rightPad("", 3, "z")      = "zzz"
+ StringUtils.rightPad("bat", 3, "yz")  = "bat"
+ StringUtils.rightPad("bat", 5, "yz")  = "batyz"
+ StringUtils.rightPad("bat", 8, "yz")  = "batyzyzy"
+ StringUtils.rightPad("bat", 1, "yz")  = "bat"
+ StringUtils.rightPad("bat", -1, "yz") = "bat"
+ StringUtils.rightPad("bat", 5, null)  = "bat  "
+ StringUtils.rightPad("bat", 5, "")    = "bat  "
+
          +
          +
          Parameters:
          +
          str - the String to pad out, may be null
          +
          size - the size to pad to
          +
          padStr - the String to pad with, null or empty treated as single space
          +
          Returns:
          +
          right padded String or original String if no padding is necessary, + null if null String input
          +
          See Also:
          +
          Source
          +
          +
          • +
        + + + +
          +
        • +

          leftPad

          +
          public static java.lang.String leftPad​(java.lang.String str,
+                                       int size)
          +

          Left pad a String with spaces (' ').

          + +

          The String is padded to the size of size.

          + + 
          + StringUtils.leftPad(null, *)   = null
+ StringUtils.leftPad("", 3)     = "   "
+ StringUtils.leftPad("bat", 3)  = "bat"
+ StringUtils.leftPad("bat", 5)  = "  bat"
+ StringUtils.leftPad("bat", 1)  = "bat"
+ StringUtils.leftPad("bat", -1) = "bat"
+
          +
          +
          Parameters:
          +
          str - the String to pad out, may be null
          +
          size - the size to pad to
          +
          Returns:
          +
          left padded String or original String if no padding is necessary, + null if null String input
          +
          See Also:
          +
          Source
          +
          +
          • +
        + + + +
          +
        • +

          leftPad

          +
          public static java.lang.String leftPad​(java.lang.String str,
+                                       int size,
+                                       char padChar)
          +

          Left pad a String with a specified character.

          + +

          Pad to a size of size.

          + + 
          + StringUtils.leftPad(null, *, *)     = null
+ StringUtils.leftPad("", 3, 'z')     = "zzz"
+ StringUtils.leftPad("bat", 3, 'z')  = "bat"
+ StringUtils.leftPad("bat", 5, 'z')  = "zzbat"
+ StringUtils.leftPad("bat", 1, 'z')  = "bat"
+ StringUtils.leftPad("bat", -1, 'z') = "bat"
+
          +
          +
          Parameters:
          +
          str - the String to pad out, may be null
          +
          size - the size to pad to
          +
          padChar - the character to pad with
          +
          Returns:
          +
          left padded String or original String if no padding is necessary, + null if null String input
          +
          Since:
          +
          2.0
          +
          See Also:
          +
          Source
          +
          +
          • +
        + + + +
          +
        • +

          leftPad

          +
          public static java.lang.String leftPad​(java.lang.String str,
+                                       int size,
+                                       java.lang.String padStr)
          +

          Left pad a String with a specified String.

          + +

          Pad to a size of size.

          + + 
          + StringUtils.leftPad(null, *, *)      = null
+ StringUtils.leftPad("", 3, "z")      = "zzz"
+ StringUtils.leftPad("bat", 3, "yz")  = "bat"
+ StringUtils.leftPad("bat", 5, "yz")  = "yzbat"
+ StringUtils.leftPad("bat", 8, "yz")  = "yzyzybat"
+ StringUtils.leftPad("bat", 1, "yz")  = "bat"
+ StringUtils.leftPad("bat", -1, "yz") = "bat"
+ StringUtils.leftPad("bat", 5, null)  = "  bat"
+ StringUtils.leftPad("bat", 5, "")    = "  bat"
+
          +
          +
          Parameters:
          +
          str - the String to pad out, may be null
          +
          size - the size to pad to
          +
          padStr - the String to pad with, null or empty treated as single space
          +
          Returns:
          +
          left padded String or original String if no padding is necessary, + null if null String input
          +
          See Also:
          +
          Source
          +
          +
          • +
        + + + +
          +
        • +

          strip

          +
          public static java.lang.String strip​(java.lang.String str,
+                                     java.lang.String stripChars)
          +

          Strips any of a set of characters from the start and end of a String. + This is similar to String.trim() but allows the characters + to be stripped to be controlled.

          + +

          A null input String returns null. + An empty string ("") input returns the empty string.

          + +

          If the stripChars String is null, whitespace is + stripped as defined by Character.isWhitespace(char). + + 

          + StringUtils.strip(null, *)          = null
+ StringUtils.strip("", *)            = ""
+ StringUtils.strip("abc", null)      = "abc"
+ StringUtils.strip("  abc", null)    = "abc"
+ StringUtils.strip("abc  ", null)    = "abc"
+ StringUtils.strip(" abc ", null)    = "abc"
+ StringUtils.strip("  abcyx", "xyz") = "  abc"
+
          +
          +
          Parameters:
          +
          str - the String to remove characters from, may be null
          +
          stripChars - the characters to remove, null treated as whitespace
          +
          Returns:
          +
          the stripped String, null if null String input
          +
          See Also:
          +
          Source
          +
          +
          • +
        + + + +
          +
        • +

          stripEnd

          +
          public static java.lang.String stripEnd​(java.lang.String str,
+                                        java.lang.String stripChars)
          +

          Strips any of a set of characters from the end of a String.

          + +

          A null input String returns null. + An empty string ("") input returns the empty string.

          + +

          If the stripChars String is null, whitespace is + stripped as defined by Character.isWhitespace(char).

          + + 
          + StringUtils.stripEnd(null, *)          = null
+ StringUtils.stripEnd("", *)            = ""
+ StringUtils.stripEnd("abc", "")        = "abc"
+ StringUtils.stripEnd("abc", null)      = "abc"
+ StringUtils.stripEnd("  abc", null)    = "  abc"
+ StringUtils.stripEnd("abc  ", null)    = "abc"
+ StringUtils.stripEnd(" abc ", null)    = " abc"
+ StringUtils.stripEnd("  abcyx", "xyz") = "  abc"
+ StringUtils.stripEnd("120.00", ".0")   = "12"
+
          +
          +
          Parameters:
          +
          str - the String to remove characters from, may be null
          +
          stripChars - the set of characters to remove, null treated as whitespace
          +
          Returns:
          +
          the stripped String, null if null String input
          +
          See Also:
          +
          Source
          +
          +
          • +
        + + + +
          +
        • +

          stripStart

          +
          public static java.lang.String stripStart​(java.lang.String str,
+                                          java.lang.String stripChars)
          +

          Strips any of a set of characters from the start of a String.

          + +

          A null input String returns null. + An empty string ("") input returns the empty string.

          + +

          If the stripChars String is null, whitespace is + stripped as defined by Character.isWhitespace(char).

          + + 
          + StringUtils.stripStart(null, *)          = null
+ StringUtils.stripStart("", *)            = ""
+ StringUtils.stripStart("abc", "")        = "abc"
+ StringUtils.stripStart("abc", null)      = "abc"
+ StringUtils.stripStart("  abc", null)    = "abc"
+ StringUtils.stripStart("abc  ", null)    = "abc  "
+ StringUtils.stripStart(" abc ", null)    = "abc "
+ StringUtils.stripStart("yxabc  ", "xyz") = "abc  "
+
          +
          +
          Parameters:
          +
          str - the String to remove characters from, may be null
          +
          stripChars - the characters to remove, null treated as whitespace
          +
          Returns:
          +
          the stripped String, null if null String input
          +
          See Also:
          +
          Source
          +
          +
          • +
        + + + +
          +
        • +

          stripToEmpty

          +
          public static java.lang.String stripToEmpty​(java.lang.String str)
          +

          Strips whitespace from the start and end of a String returning + an empty String if null input.

          + +

          This is similar to trimToEmpty(String) but removes whitespace. + Whitespace is defined by Character.isWhitespace(char).

          + + 
          + StringUtils.stripToEmpty(null)     = ""
+ StringUtils.stripToEmpty("")       = ""
+ StringUtils.stripToEmpty("   ")    = ""
+ StringUtils.stripToEmpty("abc")    = "abc"
+ StringUtils.stripToEmpty("  abc")  = "abc"
+ StringUtils.stripToEmpty("abc  ")  = "abc"
+ StringUtils.stripToEmpty(" abc ")  = "abc"
+ StringUtils.stripToEmpty(" ab c ") = "ab c"
+
          +
          +
          Parameters:
          +
          str - the String to be stripped, may be null
          +
          Returns:
          +
          the trimmed String, or an empty String if null input
          +
          Since:
          +
          2.0
          +
          See Also:
          +
          Source
          +
          +
          • +
        + + + +
          +
        • +

          wrap

          +
          public static java.lang.String wrap​(java.lang.String str,
+                                    int wrapLength)
          +

          Wraps a single line of text, identifying words by ' '.

          + +

          New lines will be separated by the system property line separator. + Very long words, such as URLs will not be wrapped.

          + +

          Leading spaces on a new line are stripped. + Trailing spaces are not stripped.

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          Examples
          inputwrapLengthresult
          null*null
          ""*""
          "Here is one line of text that is going to be wrapped after 20 columns."20"Here is one line of\ntext that is going\nto be wrapped after\n20 columns."
          "Click here to jump to the commons website - http://commons.apache.org"20"Click here to jump\nto the commons\nwebsite -\nhttp://commons.apache.org"
          "Click here, http://commons.apache.org, to jump to the commons website"20"Click here,\nhttp://commons.apache.org,\nto jump to the\ncommons website"
          + + (assuming that '\n' is the systems line separator)
          +
          +
          Parameters:
          +
          str - the String to be word wrapped, may be null
          +
          wrapLength - the column to wrap the words at, less than 1 is treated as 1
          +
          Returns:
          +
          a line with newlines inserted, null if null input
          +
          See Also:
          +
          Source
          +
          +
          • +
        + + + +
          +
        • +

          wrap

          +
          public static java.lang.String wrap​(java.lang.String str,
+                                    int wrapLength,
+                                    java.lang.String newLineStr,
+                                    boolean wrapLongWords)
          +

          Wraps a single line of text, identifying words by ' '.

          + +

          Leading spaces on a new line are stripped. + Trailing spaces are not stripped.

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          Examples
          inputwrapLengthnewLineStringwrapLongWordsresult
          null**true/falsenull
          ""**true/false""
          "Here is one line of text that is going to be wrapped after 20 columns."20"\n"true/false"Here is one line of\ntext that is going\nto be wrapped after\n20 columns."
          "Here is one line of text that is going to be wrapped after 20 columns."20"<br />"true/false"Here is one line of<br />text that is going< + br />to be wrapped after<br />20 columns."
          "Here is one line of text that is going to be wrapped after 20 columns."20nulltrue/false"Here is one line of" + systemNewLine + "text that is going" + + systemNewLine + "to be wrapped after" + systemNewLine + "20 columns."
          "Click here to jump to the commons website - http://commons.apache.org"20"\n"false"Click here to jump\nto the commons\nwebsite -\nhttp://commons.apache.org"
          "Click here to jump to the commons website - http://commons.apache.org"20"\n"true"Click here to jump\nto the commons\nwebsite -\nhttp://commons.apach\ne.org"
          +
          +
          Parameters:
          +
          str - the String to be word wrapped, may be null
          +
          wrapLength - the column to wrap the words at, less than 1 is treated as 1
          +
          newLineStr - the string to insert for a new line, + null uses the system property line separator
          +
          wrapLongWords - true if long words (such as URLs) should be wrapped
          +
          Returns:
          +
          a line with newlines inserted, null if null input
          +
          See Also:
          +
          Source
          +
          +
          • +
        + + + +
          +
        • +

          wrap

          +
          public static java.lang.String wrap​(java.lang.String str,
+                                    int wrapLength,
+                                    java.lang.String newLineStr,
+                                    boolean wrapLongWords,
+                                    java.lang.String wrapOn)
          +

          Wraps a single line of text, identifying words by wrapOn.

          + +

          Leading spaces on a new line are stripped. + Trailing spaces are not stripped.

          + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
          Examples
          inputwrapLengthnewLineStringwrapLongWordswrapOnresult
          null**true/false*null
          ""**true/false*""
          "Here is one line of text that is going to be wrapped after 20 columns."20"\n"true/false" ""Here is one line of\ntext that is going\nto be wrapped after\n20 columns."
          "Here is one line of text that is going to be wrapped after 20 columns."20"<br />"true/false" ""Here is one line of<br />text that is going<br /> + to be wrapped after<br />20 columns."
          "Here is one line of text that is going to be wrapped after 20 columns."20nulltrue/false" ""Here is one line of" + systemNewLine + "text that is going" + + systemNewLine + "to be wrapped after" + systemNewLine + "20 columns."
          "Click here to jump to the commons website - http://commons.apache.org"20"\n"false" ""Click here to jump\nto the commons\nwebsite -\nhttp://commons.apache.org"
          "Click here to jump to the commons website - http://commons.apache.org"20"\n"true" ""Click here to jump\nto the commons\nwebsite -\nhttp://commons.apach\ne.org"
          "flammable/inflammable"20"\n"true"/""flammable\ninflammable"
          +
          +
          Parameters:
          +
          str - the String to be word wrapped, may be null
          +
          wrapLength - the column to wrap the words at, less than 1 is treated as 1
          +
          newLineStr - the string to insert for a new line, + null uses the system property line separator
          +
          wrapLongWords - true if long words (such as URLs) should be wrapped
          +
          wrapOn - regex expression to be used as a breakable characters, + if blank string is provided a space character will be used
          +
          Returns:
          +
          a line with newlines inserted, null if null input
          +
          See Also:
          +
          Source
          +
          +
          • +
        + + + +
          +
        • +

          escapeJavaString

          +
          public static java.lang.String escapeJavaString​(java.lang.Object object,
+                                                java.lang.String indent)
          +
          • +
        + + + +
          +
        • +

          levenshteinDistance

          +
          public static int levenshteinDistance​(java.lang.CharSequence left,
+                                      java.lang.CharSequence right,
+                                      int threshold)
          +
          Find the Levenshtein distance between two CharSequences if it's less than or + equal to a given threshold. + +

          This code is a copy of the limitedCompare method from + Apache commons-text LevenshteinDistance.java. + +

          + This implementation follows from Algorithms on Strings, Trees and + Sequences by Dan Gusfield and Chas Emerick's implementation of the + Levenshtein distance algorithm from http://www.merriampark.com/ld.htm +

          + + 
          + limitedCompare(null, *, *)             = IllegalArgumentException
+ limitedCompare(*, null, *)             = IllegalArgumentException
+ limitedCompare(*, *, -1)               = IllegalArgumentException
+ limitedCompare("","", 0)               = 0
+ limitedCompare("aaapppp", "", 8)       = 7
+ limitedCompare("aaapppp", "", 7)       = 7
+ limitedCompare("aaapppp", "", 6))      = -1
+ limitedCompare("elephant", "hippo", 7) = 7
+ limitedCompare("elephant", "hippo", 6) = -1
+ limitedCompare("hippo", "elephant", 7) = 7
+ limitedCompare("hippo", "elephant", 6) = -1
+
          +
          +
          Parameters:
          +
          left - the first CharSequence, must not be null
          +
          right - the second CharSequence, must not be null
          +
          threshold - the target threshold, must not be negative
          +
          Returns:
          +
          result distance, or -1
          +
          See Also:
          +
          LevenshteinDistance.java
          +
          +
          • +
        + + + +
          +
        • +

          indent

          +
          public static java.lang.String indent​(java.lang.String string,
+                                      int spaces)
          +
          Indents each line in the provided string by the provided number of spaces.
          +
          +
          Parameters:
          +
          string - the string to indent.
          +
          spaces - the number of spaces.
          +
          Returns:
          +
          the indented string.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/utils/Tagged.html b/javadoc/1.47.0/software/amazon/smithy/utils/Tagged.html new file mode 100644 index 00000000000..35ea6f167eb --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/utils/Tagged.html @@ -0,0 +1,283 @@ + + + + + +Tagged (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.utils
    +

    Interface Tagged

    +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Default Methods 
        Modifier and TypeMethodDescription
        default java.util.List<java.lang.String>getTags() +
        Gets the tags applied to an object.
        +
        default booleanhasTag​(java.lang.String tag) +
        Checks if the value has the given tag by name.
        +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getTags

          +
          default java.util.List<java.lang.String> getTags()
          +
          Gets the tags applied to an object.
          +
          +
          Returns:
          +
          Returns the tag values.
          +
          +
          • +
        + + + +
          +
        • +

          hasTag

          +
          default boolean hasTag​(java.lang.String tag)
          +
          Checks if the value has the given tag by name.
          +
          +
          Parameters:
          +
          tag - Tag value to search for.
          +
          Returns:
          +
          Returns true if the tag is present.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/utils/ToSmithyBuilder.html b/javadoc/1.47.0/software/amazon/smithy/utils/ToSmithyBuilder.html new file mode 100644 index 00000000000..bac5f71b1cd --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/utils/ToSmithyBuilder.html @@ -0,0 +1,269 @@ + + + + + +ToSmithyBuilder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.utils
    +

    Interface ToSmithyBuilder<T>

    +
    +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          toBuilder

          +
          SmithyBuilder<T> toBuilder()
          +
          Take this object and create a builder that contains all of the + current property values of this object.
          +
          +
          Returns:
          +
          a builder for type T
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/utils/TriConsumer.html b/javadoc/1.47.0/software/amazon/smithy/utils/TriConsumer.html new file mode 100644 index 00000000000..cfffa0f1024 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/utils/TriConsumer.html @@ -0,0 +1,302 @@ + + + + + +TriConsumer (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.utils
    +

    Interface TriConsumer<T,​U,​V>

    +
    +
    +
    +
      +
    • +
      +
      Type Parameters:
      +
      T - The first argument type.
      +
      U - The second argument type.
      +
      V - The third argument type.
      +
      +
      +
      Functional Interface:
      +
      This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
      +
      +
      +
      @FunctionalInterface
+public interface TriConsumer<T,​U,​V>
      +
      Similar to BiConsumer, but accepts three arguments.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + +
          +
        • +

          accept

          +
          void accept​(T t,
+            U u,
+            V v)
          +
          Performs the operation on the given inputs.
          +
          +
          Parameters:
          +
          t - is the first argument
          +
          u - is the second argument
          +
          v - is the third argument
          +
          +
          • +
        + + + +
          +
        • +

          andThen

          +
          default TriConsumer<T,​U,​V> andThen​(TriConsumer<? super T,​? super U,​? super V> after)
          +
          Returns a composed TriConsumer that performs, in sequence, this + operation followed by the after operation.
          +
          +
          Parameters:
          +
          after - the operation to perform after this operation
          +
          Returns:
          +
          a composed TriConsumer
          +
          Throws:
          +
          java.lang.NullPointerException - if after is null
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/utils/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/utils/package-summary.html new file mode 100644 index 00000000000..38694935450 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/utils/package-summary.html @@ -0,0 +1,350 @@ + + + + + +software.amazon.smithy.utils (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.utils

    +
    +
    +
      +
    • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Interface Summary 
      InterfaceDescription
      BuilderRef<T> +
      Manages the creation, copying, and reuse of values created by builders.
      +
      CodeInterceptor<S extends CodeSection,​W extends AbstractCodeWriter<W>> +
      A CodeSection interceptor for a specific type of CodeSection.
      +
      CodeInterceptor.Appender<S extends CodeSection,​W extends AbstractCodeWriter<W>> +
      A code section interceptor that adds text after the intercepted section.
      +
      CodeInterceptor.Prepender<S extends CodeSection,​W extends AbstractCodeWriter<W>> +
      A code section interceptor that adds text before the intercepted section.
      +
      CodeSection +
      Interface used for strongly typed AbstractCodeWriter section values.
      +
      SmithyBuilder<T> +
      A mutable object that can be used to create an immutable object of type T.
      +
      Tagged +
      A type that contains tags.
      +
      ToSmithyBuilder<T> +
      Provides a way to get from an instance of T to a SmithyBuilder.
      +
      TriConsumer<T,​U,​V> +
      Similar to BiConsumer, but accepts three arguments.
      +
      +
      • +
    • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      AbstractCodeWriter<T extends AbstractCodeWriter<T>> +
      Helper class for generating code.
      +
      CaseUtils +
      Provides support for camelCase, snake_case, and other kinds + of case conversions.
      +
      CodeWriterDeprecated. +
      prefer SimpleCodeWriter or a custom subclass of AbstractCodeWriter.
      +
      CodeWriterDebugInfo +
      Provides debug information about the current state of a CodeWriter.
      +
      FunctionalUtils +
      Utilities for working with functions, predicates, etc.
      +
      IoUtils +
      Utilities for IO operations.
      +
      ListUtils +
      Immutable List utilities to polyfill Java 9+ features.
      +
      MapUtils +
      Immutable Map utilities to polyfill Java 9+ features.
      +
      MediaType +
      Implements a simple media type parser based on the Content-Type grammar defined in + RFC 7231.
      +
      OptionalUtils +
      Functions that make working with optionals easier.
      +
      Pair<L,​R> +
      Generic immutable pair of values.
      +
      SetUtils +
      Immutable Set utilities to polyfill Java 9+ features.
      +
      SimpleCodeWriter +
      Helper class for generating code.
      +
      SimpleParser +
      A simple expression parser that can be extended to implement parsers + for small domain-specific languages.
      +
      StringUtils +
      Operations on String that are null safe.
      +
      +
      • +
    • + + + + + + + + + + + + + + + + + + + + +
      Annotation Types Summary 
      Annotation TypeDescription
      SmithyGenerated +
      Annotation used to indicate that a package or class was generated and + should not be edited directly.
      +
      SmithyInternalApi +
      Annotation used to indicate that an API is considered internal to Smithy + and subject to change.
      +
      SmithyUnstableApi +
      Annotation used to indicate that an API is considered unstable and subject + to change.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/utils/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/utils/package-tree.html new file mode 100644 index 00000000000..ae4dbe9866b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/utils/package-tree.html @@ -0,0 +1,207 @@ + + + + + +software.amazon.smithy.utils Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.utils

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +

    Annotation Type Hierarchy

    +
      +
    • software.amazon.smithy.utils.SmithyGenerated (implements java.lang.annotation.Annotation)
      • +
    • software.amazon.smithy.utils.SmithyInternalApi (implements java.lang.annotation.Annotation)
      • +
    • software.amazon.smithy.utils.SmithyUnstableApi (implements java.lang.annotation.Annotation)
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/waiters/Acceptor.html b/javadoc/1.47.0/software/amazon/smithy/waiters/Acceptor.html new file mode 100644 index 00000000000..77a38a9873b --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/waiters/Acceptor.html @@ -0,0 +1,430 @@ + + + + + +Acceptor (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.waiters
    +

    Class Acceptor

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.waiters.Acceptor
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ToNode
      +
      +
      +
      public final class Acceptor
+extends java.lang.Object
+implements ToNode
      +
      Represents an acceptor in a waiter's state machine.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Acceptor

          +
          public Acceptor​(AcceptorState state,
+                Matcher<?> matcher)
          +
          +
          Parameters:
          +
          state - State the acceptor transitions to when matched.
          +
          matcher - The matcher to match against.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getState

          +
          public AcceptorState getState()
          +
          Gets the state to transition to if matched.
          +
          +
          Returns:
          +
          Acceptor state to transition to.
          +
          +
          • +
        + + + +
          +
        • +

          getMatcher

          +
          public Matcher<?> getMatcher()
          +
          Gets the matcher used to test if the acceptor.
          +
          +
          Returns:
          +
          Returns the matcher.
          +
          +
          • +
        + + + +
          +
        • +

          fromNode

          +
          public static Acceptor fromNode​(Node node)
          +
          Creates an Acceptor from a Node.
          +
          +
          Parameters:
          +
          node - Node to create the Acceptor from.
          +
          Returns:
          +
          Returns the created Acceptor.
          +
          Throws:
          +
          ExpectationNotMetException - if the given Node is invalid.
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/waiters/AcceptorState.html b/javadoc/1.47.0/software/amazon/smithy/waiters/AcceptorState.html new file mode 100644 index 00000000000..526d7db37b3 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/waiters/AcceptorState.html @@ -0,0 +1,467 @@ + + + + + +AcceptorState (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.waiters
    +

    Enum AcceptorState

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Enum<AcceptorState>
        • +
      • +
          +
        • software.amazon.smithy.waiters.AcceptorState
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable, java.lang.Comparable<AcceptorState>, ToNode
      +
      +
      +
      public enum AcceptorState
+extends java.lang.Enum<AcceptorState>
+implements ToNode
      +
      The transition state of a waiter.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        FAILURE +
        Transition to a final failure state.
        +
        RETRY +
        Transition to an intermediate retry state.
        +
        SUCCESS +
        Transition to a final success state.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static AcceptorStatefromNode​(Node node) +
        Create an AcceptorState from a Node.
        +
        NodetoNode() +
        Converts a value to a Node.
        +
        java.lang.StringtoString() 
        static AcceptorStatevalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static AcceptorState[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + +
          +
        • +

          SUCCESS

          +
          public static final AcceptorState SUCCESS
          +
          Transition to a final success state.
          +
          • +
        + + + +
          +
        • +

          FAILURE

          +
          public static final AcceptorState FAILURE
          +
          Transition to a final failure state.
          +
          • +
        + + + +
          +
        • +

          RETRY

          +
          public static final AcceptorState RETRY
          +
          Transition to an intermediate retry state.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static AcceptorState[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (AcceptorState c : AcceptorState.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static AcceptorState valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Enum<AcceptorState>
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          fromNode

          +
          public static AcceptorState fromNode​(Node node)
          +
          Create an AcceptorState from a Node.
          +
          +
          Parameters:
          +
          node - Node to create the AcceptorState from.
          +
          Returns:
          +
          Returns the created AcceptorState.
          +
          Throws:
          +
          ExpectationNotMetException - when given an invalid Node.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/waiters/Matcher.ErrorTypeMember.html b/javadoc/1.47.0/software/amazon/smithy/waiters/Matcher.ErrorTypeMember.html new file mode 100644 index 00000000000..d63e958bee3 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/waiters/Matcher.ErrorTypeMember.html @@ -0,0 +1,427 @@ + + + + + +Matcher.ErrorTypeMember (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.waiters
    +

    Class Matcher.ErrorTypeMember

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ToNode
      +
      +
      +
      Enclosing class:
      +
      Matcher<T>
      +
      +
      +
      public static final class Matcher.ErrorTypeMember
+extends Matcher<java.lang.String>
      +
      Matches if an operation returns an error, and the error matches the + expected error type.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ErrorTypeMember

          +
          public ErrorTypeMember​(java.lang.String value)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getMemberName

          +
          public java.lang.String getMemberName()
          +
          Description copied from class: Matcher
          +
          Gets the member name of the matcher.
          +
          +
          Specified by:
          +
          getMemberName in class Matcher<java.lang.String>
          +
          Returns:
          +
          Returns the set member name.
          +
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public java.lang.String getValue()
          +
          Description copied from class: Matcher
          +
          Gets the value of the set matcher variant.
          +
          +
          Specified by:
          +
          getValue in class Matcher<java.lang.String>
          +
          Returns:
          +
          Returns the set variant's value.
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          accept

          +
          public <U> U accept​(Matcher.Visitor<U> visitor)
          +
          Description copied from class: Matcher
          +
          Visits the Matcher union type.
          +
          +
          Specified by:
          +
          accept in class Matcher<java.lang.String>
          +
          Type Parameters:
          +
          U - The type returned by the visitor.
          +
          Parameters:
          +
          visitor - Visitor to apply.
          +
          Returns:
          +
          Returns the return value of the visitor.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/waiters/Matcher.InputOutputMember.html b/javadoc/1.47.0/software/amazon/smithy/waiters/Matcher.InputOutputMember.html new file mode 100644 index 00000000000..4a8ae079cde --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/waiters/Matcher.InputOutputMember.html @@ -0,0 +1,355 @@ + + + + + +Matcher.InputOutputMember (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.waiters
    +

    Class Matcher.InputOutputMember

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ToNode
      +
      +
      +
      Enclosing class:
      +
      Matcher<T>
      +
      +
      +
      public static final class Matcher.InputOutputMember
+extends Matcher<PathMatcher>
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          InputOutputMember

          +
          public InputOutputMember​(PathMatcher value)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          accept

          +
          public <U> U accept​(Matcher.Visitor<U> visitor)
          +
          Description copied from class: Matcher
          +
          Visits the Matcher union type.
          +
          +
          Specified by:
          +
          accept in class Matcher<PathMatcher>
          +
          Type Parameters:
          +
          U - The type returned by the visitor.
          +
          Parameters:
          +
          visitor - Visitor to apply.
          +
          Returns:
          +
          Returns the return value of the visitor.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/waiters/Matcher.OutputMember.html b/javadoc/1.47.0/software/amazon/smithy/waiters/Matcher.OutputMember.html new file mode 100644 index 00000000000..edc05d80d09 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/waiters/Matcher.OutputMember.html @@ -0,0 +1,355 @@ + + + + + +Matcher.OutputMember (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.waiters
    +

    Class Matcher.OutputMember

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ToNode
      +
      +
      +
      Enclosing class:
      +
      Matcher<T>
      +
      +
      +
      public static final class Matcher.OutputMember
+extends Matcher<PathMatcher>
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          OutputMember

          +
          public OutputMember​(PathMatcher value)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          accept

          +
          public <U> U accept​(Matcher.Visitor<U> visitor)
          +
          Description copied from class: Matcher
          +
          Visits the Matcher union type.
          +
          +
          Specified by:
          +
          accept in class Matcher<PathMatcher>
          +
          Type Parameters:
          +
          U - The type returned by the visitor.
          +
          Parameters:
          +
          visitor - Visitor to apply.
          +
          Returns:
          +
          Returns the return value of the visitor.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/waiters/Matcher.SuccessMember.html b/javadoc/1.47.0/software/amazon/smithy/waiters/Matcher.SuccessMember.html new file mode 100644 index 00000000000..935bd605866 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/waiters/Matcher.SuccessMember.html @@ -0,0 +1,427 @@ + + + + + +Matcher.SuccessMember (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.waiters
    +

    Class Matcher.SuccessMember

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ToNode
      +
      +
      +
      Enclosing class:
      +
      Matcher<T>
      +
      +
      +
      public static final class Matcher.SuccessMember
+extends Matcher<java.lang.Boolean>
      +
      When set to true, matches when a call returns a success response. + When set to false, matches when a call fails with any error.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          SuccessMember

          +
          public SuccessMember​(boolean value)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getMemberName

          +
          public java.lang.String getMemberName()
          +
          Description copied from class: Matcher
          +
          Gets the member name of the matcher.
          +
          +
          Specified by:
          +
          getMemberName in class Matcher<java.lang.Boolean>
          +
          Returns:
          +
          Returns the set member name.
          +
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public java.lang.Boolean getValue()
          +
          Description copied from class: Matcher
          +
          Gets the value of the set matcher variant.
          +
          +
          Specified by:
          +
          getValue in class Matcher<java.lang.Boolean>
          +
          Returns:
          +
          Returns the set variant's value.
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          accept

          +
          public <U> U accept​(Matcher.Visitor<U> visitor)
          +
          Description copied from class: Matcher
          +
          Visits the Matcher union type.
          +
          +
          Specified by:
          +
          accept in class Matcher<java.lang.Boolean>
          +
          Type Parameters:
          +
          U - The type returned by the visitor.
          +
          Parameters:
          +
          visitor - Visitor to apply.
          +
          Returns:
          +
          Returns the return value of the visitor.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/waiters/Matcher.UnknownMember.html b/javadoc/1.47.0/software/amazon/smithy/waiters/Matcher.UnknownMember.html new file mode 100644 index 00000000000..d3a19213c33 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/waiters/Matcher.UnknownMember.html @@ -0,0 +1,428 @@ + + + + + +Matcher.UnknownMember (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.waiters
    +

    Class Matcher.UnknownMember

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ToNode
      +
      +
      +
      Enclosing class:
      +
      Matcher<T>
      +
      +
      +
      public static final class Matcher.UnknownMember
+extends Matcher<Node>
      +
      Represents an union value.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          UnknownMember

          +
          public UnknownMember​(java.lang.String key,
+                     Node value)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getMemberName

          +
          public java.lang.String getMemberName()
          +
          Description copied from class: Matcher
          +
          Gets the member name of the matcher.
          +
          +
          Specified by:
          +
          getMemberName in class Matcher<Node>
          +
          Returns:
          +
          Returns the set member name.
          +
          +
          • +
        + + + +
          +
        • +

          getValue

          +
          public Node getValue()
          +
          Description copied from class: Matcher
          +
          Gets the value of the set matcher variant.
          +
          +
          Specified by:
          +
          getValue in class Matcher<Node>
          +
          Returns:
          +
          Returns the set variant's value.
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          accept

          +
          public <U> U accept​(Matcher.Visitor<U> visitor)
          +
          Description copied from class: Matcher
          +
          Visits the Matcher union type.
          +
          +
          Specified by:
          +
          accept in class Matcher<Node>
          +
          Type Parameters:
          +
          U - The type returned by the visitor.
          +
          Parameters:
          +
          visitor - Visitor to apply.
          +
          Returns:
          +
          Returns the return value of the visitor.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/waiters/Matcher.Visitor.html b/javadoc/1.47.0/software/amazon/smithy/waiters/Matcher.Visitor.html new file mode 100644 index 00000000000..6f8604492c7 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/waiters/Matcher.Visitor.html @@ -0,0 +1,313 @@ + + + + + +Matcher.Visitor (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.waiters
    +

    Interface Matcher.Visitor<T>

    +
    +
    +
    +
      +
    • +
      +
      Type Parameters:
      +
      T - Type of value to return from the visitor.
      +
      +
      +
      Enclosing class:
      +
      Matcher<T>
      +
      +
      +
      public static interface Matcher.Visitor<T>
      +
      Visits the variants of the Matcher union type.
      +
      • +
    +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/waiters/Matcher.html b/javadoc/1.47.0/software/amazon/smithy/waiters/Matcher.html new file mode 100644 index 00000000000..b202711342d --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/waiters/Matcher.html @@ -0,0 +1,452 @@ + + + + + +Matcher (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.waiters
    +

    Class Matcher<T>

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.waiters.Matcher<T>
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getValue

          +
          public abstract T getValue()
          +
          Gets the value of the set matcher variant.
          +
          +
          Returns:
          +
          Returns the set variant's value.
          +
          +
          • +
        + + + +
          +
        • +

          getMemberName

          +
          public abstract java.lang.String getMemberName()
          +
          Gets the member name of the matcher.
          +
          +
          Returns:
          +
          Returns the set member name.
          +
          +
          • +
        + + + +
          +
        • +

          accept

          +
          public abstract <U> U accept​(Matcher.Visitor<U> visitor)
          +
          Visits the Matcher union type.
          +
          +
          Type Parameters:
          +
          U - The type returned by the visitor.
          +
          Parameters:
          +
          visitor - Visitor to apply.
          +
          Returns:
          +
          Returns the return value of the visitor.
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public final int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public final boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          fromNode

          +
          public static Matcher<?> fromNode​(Node node)
          +
          Creates a Matcher from a Node.
          +
          +
          Parameters:
          +
          node - Node to create a Matcher from.
          +
          Returns:
          +
          Returns the create Matcher.
          +
          Throws:
          +
          ExpectationNotMetException - if the given node is invalid.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/waiters/PathComparator.html b/javadoc/1.47.0/software/amazon/smithy/waiters/PathComparator.html new file mode 100644 index 00000000000..96fa78d9ad6 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/waiters/PathComparator.html @@ -0,0 +1,483 @@ + + + + + +PathComparator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.waiters
    +

    Enum PathComparator

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • java.lang.Enum<PathComparator>
        • +
      • +
          +
        • software.amazon.smithy.waiters.PathComparator
          • +
        +
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.io.Serializable, java.lang.Comparable<PathComparator>, ToNode
      +
      +
      +
      public enum PathComparator
+extends java.lang.Enum<PathComparator>
+implements ToNode
      +
      Defines a comparison to perform in a PathMatcher.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Summary

        + + + + + + + + + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        ALL_STRING_EQUALS +
        Matches if all values in the list matches the expected string.
        +
        ANY_STRING_EQUALS +
        Matches if any value in the list matches the expected string.
        +
        BOOLEAN_EQUALS +
        Matches if the return value is a boolean that is equal to the string literal 'true' or 'false'.
        +
        STRING_EQUALS +
        Matches if the return value is a string that is equal to the expected string.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static PathComparatorfromNode​(Node node) +
        Creates a PathComparator from a Node.
        +
        NodetoNode() +
        Converts a value to a Node.
        +
        java.lang.StringtoString() 
        static PathComparatorvalueOf​(java.lang.String name) +
        Returns the enum constant of this type with the specified name.
        +
        static PathComparator[]values() +
        Returns an array containing the constants of this enum type, in +the order they are declared.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Enum

          +clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
          • +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +getClass, notify, notifyAll, wait, wait, wait
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Enum Constant Detail

        + + + +
          +
        • +

          ALL_STRING_EQUALS

          +
          public static final PathComparator ALL_STRING_EQUALS
          +
          Matches if all values in the list matches the expected string.
          +
          • +
        + + + +
          +
        • +

          ANY_STRING_EQUALS

          +
          public static final PathComparator ANY_STRING_EQUALS
          +
          Matches if any value in the list matches the expected string.
          +
          • +
        + + + +
          +
        • +

          STRING_EQUALS

          +
          public static final PathComparator STRING_EQUALS
          +
          Matches if the return value is a string that is equal to the expected string.
          +
          • +
        + + + +
          +
        • +

          BOOLEAN_EQUALS

          +
          public static final PathComparator BOOLEAN_EQUALS
          +
          Matches if the return value is a boolean that is equal to the string literal 'true' or 'false'.
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          values

          +
          public static PathComparator[] values()
          +
          Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
          +for (PathComparator c : PathComparator.values())
+    System.out.println(c);
+
          +
          +
          Returns:
          +
          an array containing the constants of this enum type, in the order they are declared
          +
          +
          • +
        + + + +
          +
        • +

          valueOf

          +
          public static PathComparator valueOf​(java.lang.String name)
          +
          Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
          +
          +
          Parameters:
          +
          name - the name of the enum constant to be returned.
          +
          Returns:
          +
          the enum constant with the specified name
          +
          Throws:
          +
          java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
          +
          java.lang.NullPointerException - if the argument is null
          +
          +
          • +
        + + + +
          +
        • +

          fromNode

          +
          public static PathComparator fromNode​(Node node)
          +
          Creates a PathComparator from a Node.
          +
          +
          Parameters:
          +
          node - Node to create the PathComparator from.
          +
          Returns:
          +
          Returns the created PathComparator.
          +
          Throws:
          +
          ExpectationNotMetException - if the given node is invalid.
          +
          +
          • +
        + + + +
          +
        • +

          toString

          +
          public java.lang.String toString()
          +
          +
          Overrides:
          +
          toString in class java.lang.Enum<PathComparator>
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/waiters/PathMatcher.html b/javadoc/1.47.0/software/amazon/smithy/waiters/PathMatcher.html new file mode 100644 index 00000000000..521523bcd77 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/waiters/PathMatcher.html @@ -0,0 +1,457 @@ + + + + + +PathMatcher (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.waiters
    +

    Class PathMatcher

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.waiters.PathMatcher
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      ToNode
      +
      +
      +
      public final class PathMatcher
+extends java.lang.Object
+implements ToNode
      +
      A Matcher implementation for inputPathList, + outputPathList, and errorPathList.
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        PathMatcher​(java.lang.String path, + java.lang.String expected, + PathComparator comparator) 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          PathMatcher

          +
          public PathMatcher​(java.lang.String path,
+                   java.lang.String expected,
+                   PathComparator comparator)
          +
          +
          Parameters:
          +
          path - The path to execute.
          +
          expected - The expected value of the path.
          +
          comparator - Comparison performed on the list value.
          +
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getPath

          +
          public java.lang.String getPath()
          +
          Gets the path to execute.
          +
          +
          Returns:
          +
          Returns the path to execute.
          +
          +
          • +
        + + + +
          +
        • +

          getExpected

          +
          public java.lang.String getExpected()
          +
          Gets the expected return value of each element returned by the + path.
          +
          +
          Returns:
          +
          The return value to compare each result against.
          +
          +
          • +
        + + + +
          +
        • +

          getComparator

          +
          public PathComparator getComparator()
          +
          Gets the comparison performed on the list.
          +
          +
          Returns:
          +
          Returns the comparator.
          +
          +
          • +
        + + + +
          +
        • +

          fromNode

          +
          public static PathMatcher fromNode​(Node node)
          +
          Creates a new instance from a Node.
          +
          +
          Parameters:
          +
          node - Node tom create the PathMatcher from.
          +
          Returns:
          +
          Returns the created PathMatcher.
          +
          Throws:
          +
          ExpectationNotMetException - if the given Node is invalid.
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/waiters/UniqueWaiterNamesValidator.html b/javadoc/1.47.0/software/amazon/smithy/waiters/UniqueWaiterNamesValidator.html new file mode 100644 index 00000000000..056344e1313 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/waiters/UniqueWaiterNamesValidator.html @@ -0,0 +1,349 @@ + + + + + +UniqueWaiterNamesValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.waiters
    +

    Class UniqueWaiterNamesValidator

    +
    +
    + +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      Validator
      +
      +
      +
      public final class UniqueWaiterNamesValidator
+extends AbstractValidator
      +
      Ensures that no two waiters use the same case-insensitive name in the + closure of a service.
      +
      • +
    +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          UniqueWaiterNamesValidator

          +
          public UniqueWaiterNamesValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/waiters/WaitableTrait.Builder.html b/javadoc/1.47.0/software/amazon/smithy/waiters/WaitableTrait.Builder.html new file mode 100644 index 00000000000..1ee386e234c --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/waiters/WaitableTrait.Builder.html @@ -0,0 +1,338 @@ + + + + + +WaitableTrait.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.waiters
    +

    Class WaitableTrait.Builder

    +
    +
    + +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/waiters/WaitableTrait.Provider.html b/javadoc/1.47.0/software/amazon/smithy/waiters/WaitableTrait.Provider.html new file mode 100644 index 00000000000..5a18a977ffc --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/waiters/WaitableTrait.Provider.html @@ -0,0 +1,348 @@ + + + + + +WaitableTrait.Provider (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.waiters
    +

    Class WaitableTrait.Provider

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.waiters.WaitableTrait.Provider
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      TraitService
      +
      +
      +
      Enclosing class:
      +
      WaitableTrait
      +
      +
      +
      public static final class WaitableTrait.Provider
+extends java.lang.Object
+implements TraitService
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Provider() 
        +
        • +
      +
      + +
      + +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          Provider

          +
          public Provider()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          getShapeId

          +
          public ShapeId getShapeId()
          +
          +
          Specified by:
          +
          getShapeId in interface TraitService
          +
          Returns:
          +
          Gets the shape ID of the trait that this provider created.
          +
          +
          • +
        + + + +
          +
        • +

          createTrait

          +
          public Trait createTrait​(ShapeId target,
+                         Node value)
          +
          Description copied from interface: TraitService
          +
          Creates the trait from a node value.
          +
          +
          Specified by:
          +
          createTrait in interface TraitService
          +
          Parameters:
          +
          target - The shape targeted by the trait.
          +
          value - The value of the trait.
          +
          Returns:
          +
          Returns the created trait.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/waiters/WaitableTrait.html b/javadoc/1.47.0/software/amazon/smithy/waiters/WaitableTrait.html new file mode 100644 index 00000000000..cf6830a7416 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/waiters/WaitableTrait.html @@ -0,0 +1,433 @@ + + + + + +WaitableTrait (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.waiters
    +

    Class WaitableTrait

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Field Detail

        + + + +
          +
        • +

          ID

          +
          public static final ShapeId ID
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + + + + + +
          +
        • +

          getWaiters

          +
          public java.util.Map<java.lang.String,​Waiter> getWaiters()
          +
          Gets the waiters defined on the trait.
          +
          +
          Returns:
          +
          Returns the defined waiters.
          +
          +
          • +
        + + + +
          +
        • +

          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.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/waiters/WaitableTraitValidator.html b/javadoc/1.47.0/software/amazon/smithy/waiters/WaitableTraitValidator.html new file mode 100644 index 00000000000..818263b28be --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/waiters/WaitableTraitValidator.html @@ -0,0 +1,347 @@ + + + + + +WaitableTraitValidator (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.waiters
    +

    Class WaitableTraitValidator

    +
    +
    + +
    + +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          WaitableTraitValidator

          +
          public WaitableTraitValidator()
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          validate

          +
          public java.util.List<ValidationEvent> validate​(Model model)
          +
          Description copied from interface: Validator
          +
          Validates a model and returns a list of validation events.
          +
          +
          Parameters:
          +
          model - Model to validate.
          +
          Returns:
          +
          List of validation events.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/javadoc/1.47.0/software/amazon/smithy/waiters/Waiter.Builder.html b/javadoc/1.47.0/software/amazon/smithy/waiters/Waiter.Builder.html new file mode 100644 index 00000000000..13ca0bacdcf --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/waiters/Waiter.Builder.html @@ -0,0 +1,425 @@ + + + + + +Waiter.Builder (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.waiters
    +

    Class Waiter.Builder

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.waiters.Waiter.Builder
        • +
      +
      • +
    +
    + +
    +
    + +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/waiters/Waiter.html b/javadoc/1.47.0/software/amazon/smithy/waiters/Waiter.html new file mode 100644 index 00000000000..8adf96922a4 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/waiters/Waiter.html @@ -0,0 +1,544 @@ + + + + + +Waiter (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package software.amazon.smithy.waiters
    +

    Class Waiter

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • software.amazon.smithy.waiters.Waiter
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Nested Class Summary

        + + + + + + + + + + + + +
        Nested Classes 
        Modifier and TypeClassDescription
        static class Waiter.Builder 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Static Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        static Waiter.Builderbuilder() 
        booleanequals​(java.lang.Object o) 
        static WaiterfromNode​(Node node) +
        Create a Waiter from a Node.
        +
        java.util.List<Acceptor>getAcceptors() +
        Gets the list of Acceptors.
        +
        java.util.Optional<java.lang.String>getDocumentation() +
        Gets the documentation of the waiter.
        +
        intgetMaxDelay() +
        Gets the maximum amount of time allowed to wait between + retries in seconds.
        +
        intgetMinDelay() +
        Gets the minimum amount of time to wait between retries + in seconds.
        +
        java.util.List<java.lang.String>getTags() +
        Gets the tags applied to an object.
        +
        inthashCode() 
        booleanisDeprecated() +
        Checks if the waiter is deprecated.
        +
        SmithyBuilder<Waiter>toBuilder() +
        Take this object and create a builder that contains all of the + current property values of this object.
        +
        NodetoNode() +
        Converts a value to a Node.
        +
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
          • +
        +
          +
        • + + +

          Methods inherited from interface software.amazon.smithy.utils.Tagged

          +hasTag
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Method Detail

        + + + + + + + +
          +
        • +

          toBuilder

          +
          public SmithyBuilder<Waiter> 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<Waiter>
          +
          Returns:
          +
          a builder for type T
          +
          +
          • +
        + + + +
          +
        • +

          fromNode

          +
          public static Waiter fromNode​(Node node)
          +
          Create a Waiter from a Node.
          +
          +
          Parameters:
          +
          node - Node to create the Waiter from.
          +
          Returns:
          +
          Returns the created Waiter.
          +
          Throws:
          +
          ExpectationNotMetException - if the given node is invalid.
          +
          +
          • +
        + + + +
          +
        • +

          getDocumentation

          +
          public java.util.Optional<java.lang.String> getDocumentation()
          +
          Gets the documentation of the waiter.
          +
          +
          Returns:
          +
          Return the optional documentation.
          +
          +
          • +
        + + + +
          +
        • +

          getAcceptors

          +
          public java.util.List<Acceptor> getAcceptors()
          +
          Gets the list of Acceptors.
          +
          +
          Returns:
          +
          Returns the acceptors of the waiter.
          +
          +
          • +
        + + + +
          +
        • +

          getMinDelay

          +
          public int getMinDelay()
          +
          Gets the minimum amount of time to wait between retries + in seconds.
          +
          +
          Returns:
          +
          Gets the minimum retry wait time in seconds.
          +
          +
          • +
        + + + +
          +
        • +

          getMaxDelay

          +
          public int getMaxDelay()
          +
          Gets the maximum amount of time allowed to wait between + retries in seconds.
          +
          +
          Returns:
          +
          Gets the maximum retry wait time in seconds.
          +
          +
          • +
        + + + +
          +
        • +

          getTags

          +
          public java.util.List<java.lang.String> getTags()
          +
          Description copied from interface: Tagged
          +
          Gets the tags applied to an object.
          +
          +
          Specified by:
          +
          getTags in interface Tagged
          +
          Returns:
          +
          Returns the tag values.
          +
          +
          • +
        + + + +
          +
        • +

          isDeprecated

          +
          public boolean isDeprecated()
          +
          Checks if the waiter is deprecated.
          +
          +
          Returns:
          +
          Returns true if the waiter is deprecated.
          +
          +
          • +
        + + + +
          +
        • +

          toNode

          +
          public Node toNode()
          +
          Description copied from interface: ToNode
          +
          Converts a value to a Node.
          +
          +
          Specified by:
          +
          toNode in interface ToNode
          +
          Returns:
          +
          Returns the creates Node.
          +
          +
          • +
        + + + +
          +
        • +

          equals

          +
          public boolean equals​(java.lang.Object o)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/waiters/package-summary.html b/javadoc/1.47.0/software/amazon/smithy/waiters/package-summary.html new file mode 100644 index 00000000000..42b28c33b41 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/waiters/package-summary.html @@ -0,0 +1,282 @@ + + + + + +software.amazon.smithy.waiters (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package software.amazon.smithy.waiters

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/javadoc/1.47.0/software/amazon/smithy/waiters/package-tree.html b/javadoc/1.47.0/software/amazon/smithy/waiters/package-tree.html new file mode 100644 index 00000000000..bd4d3022f55 --- /dev/null +++ b/javadoc/1.47.0/software/amazon/smithy/waiters/package-tree.html @@ -0,0 +1,211 @@ + + + + + +software.amazon.smithy.waiters Class Hierarchy (Smithy API 1.47.0) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package software.amazon.smithy.waiters

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +

    Enum Hierarchy

    +
      +
    • java.lang.Object +
        +
      • java.lang.Enum<E> (implements java.lang.Comparable<T>, java.io.Serializable) +
          +
        • software.amazon.smithy.waiters.AcceptorState (implements software.amazon.smithy.model.node.ToNode)
          • +
        • software.amazon.smithy.waiters.PathComparator (implements software.amazon.smithy.model.node.ToNode)
          • +
        +
        • +
      +
      • +
    +
    +
    +
    + + + diff --git a/javadoc/1.47.0/stylesheet.css b/javadoc/1.47.0/stylesheet.css new file mode 100644 index 00000000000..de945eda261 --- /dev/null +++ b/javadoc/1.47.0/stylesheet.css @@ -0,0 +1,910 @@ +/* + * Javadoc style sheet + */ + +@import url('resources/fonts/dejavu.css'); + +/* + * Styles for individual HTML elements. + * + * These are styles that are specific to individual HTML elements. Changing them affects the style of a particular + * HTML element throughout the page. + */ + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; + padding:0; + height:100%; + width:100%; +} +iframe { + margin:0; + padding:0; + height:100%; + width:100%; + overflow-y:scroll; + border:none; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a[href]:hover, a[href]:focus { + text-decoration:none; + color:#bb7a2a; +} +a[name] { + color:#353833; +} +a[name]:before, a[name]:target, a[id]:before, a[id]:target { + content:""; + display:inline-block; + position:relative; + padding-top:129px; + margin-top:-129px; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} + +/* + * Styles for HTML generated by javadoc. + * + * These are style classes that are used by the standard doclet to generate HTML documentation. + */ + +/* + * Styles for document title and copyright. + */ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* + * Styles for navigation bar. + */ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.navPadding { + padding-top: 107px; +} +.fixedNav { + position:fixed; + width:100%; + z-index:999; + background-color:#ffffff; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.navListSearch { + float:right; + margin:0 0 0 0; + padding:0; +} +ul.navListSearch li { + list-style:none; + float:right; + padding: 5px 6px; + text-transform:uppercase; +} +ul.navListSearch li label { + position:relative; + right:-16px; +} +ul.subNavList li { + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* + * Styles for page header and footer. + */ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexNav { + position:relative; + font-size:12px; + background-color:#dee3e9; +} +.indexNav ul { + margin-top:0; + padding:5px; +} +.indexNav ul li { + display:inline; + list-style-type:none; + padding-right:10px; + text-transform:uppercase; +} +.indexNav h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* + * Styles for headings. + */ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* + * Styles for page layout containers. + */ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer, +.allClassesContainer, .allPackagesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* + * Styles for lists. + */ +li.circle { + list-style:circle; +} +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* + * Styles for tables. + */ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary, +.requiresSummary, .packagesSummary, .providesSummary, .usesSummary { + width:100%; + border-spacing:0; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary, .requiresSummary, .packagesSummary, .providesSummary, .usesSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption, +.requiresSummary caption, .packagesSummary caption, .providesSummary caption, .usesSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.constantsSummary caption a:link, .constantsSummary caption a:visited, +.useSummary caption a:link, .useSummary caption a:visited { + color:#1f389c; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.deprecatedSummary caption a:link, +.requiresSummary caption a:link, .packagesSummary caption a:link, .providesSummary caption a:link, +.usesSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.requiresSummary caption a:hover, .packagesSummary caption a:hover, .providesSummary caption a:hover, +.usesSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.requiresSummary caption a:active, .packagesSummary caption a:active, .providesSummary caption a:active, +.usesSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.deprecatedSummary caption a:visited, +.requiresSummary caption a:visited, .packagesSummary caption a:visited, .providesSummary caption a:visited, +.usesSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span, +.requiresSummary caption span, .packagesSummary caption span, .providesSummary caption span, +.usesSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span, .packagesSummary caption span.activeTableTab span, +.overviewSummary caption span.activeTableTab span, .typeSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span, .packagesSummary caption span.tableTab span, +.overviewSummary caption span.tableTab span, .typeSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab, +.packagesSummary caption span.tableTab, .packagesSummary caption span.activeTableTab, +.overviewSummary caption span.tableTab, .overviewSummary caption span.activeTableTab, +.typeSummary caption span.tableTab, .typeSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd, +.requiresSummary .tabEnd, .packagesSummary .tabEnd, .providesSummary .tabEnd, .usesSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd, .packagesSummary .activeTableTab .tabEnd, +.overviewSummary .activeTableTab .tabEnd, .typeSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd, .packagesSummary .tableTab .tabEnd, +.overviewSummary .tableTab .tabEnd, .typeSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; +} +.rowColor th, .altColor th { + font-weight:normal; +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td, +.requiresSummary td, .packagesSummary td, .providesSummary td, .usesSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colFirst, th.colSecond, th.colLast, th.colConstructorName, th.colDeprecatedItemName, .useSummary th, +.constantsSummary th, .packagesSummary th, td.colFirst, td.colSecond, td.colLast, .useSummary td, +.constantsSummary td { + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colSecond, th.colLast, th.colConstructorName, th.colDeprecatedItemName, .constantsSummary th, +.packagesSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + font-size:13px; +} +td.colSecond, th.colSecond, td.colLast, th.colConstructorName, th.colDeprecatedItemName, th.colLast { + font-size:13px; +} +.constantsSummary th, .packagesSummary th { + font-size:13px; +} +.providesSummary th.colFirst, .providesSummary th.colLast, .providesSummary td.colFirst, +.providesSummary td.colLast { + white-space:normal; + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.requiresSummary td.colFirst, .requiresSummary th.colFirst, +.packagesSummary td.colFirst, .packagesSummary td.colSecond, .packagesSummary th.colFirst, .packagesSummary th, +.usesSummary td.colFirst, .usesSummary th.colFirst, +.providesSummary td.colFirst, .providesSummary th.colFirst, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colSecond, .memberSummary th.colSecond, .memberSummary th.colConstructorName, +.typeSummary td.colFirst, .typeSummary th.colFirst { + vertical-align:top; +} +.packagesSummary th.colLast, .packagesSummary td.colLast { + white-space:normal; +} +td.colFirst a:link, td.colFirst a:visited, +td.colSecond a:link, td.colSecond a:visited, +th.colFirst a:link, th.colFirst a:visited, +th.colSecond a:link, th.colSecond a:visited, +th.colConstructorName a:link, th.colConstructorName a:visited, +th.colDeprecatedItemName a:link, th.colDeprecatedItemName a:visited, +.constantValuesContainer td a:link, .constantValuesContainer td a:visited, +.allClassesContainer td a:link, .allClassesContainer td a:visited, +.allPackagesContainer td a:link, .allPackagesContainer td a:visited { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor, .altColor th { + background-color:#FFFFFF; +} +.rowColor, .rowColor th { + background-color:#EEEEEF; +} +/* + * Styles for contents. + */ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} +td.colLast div { + padding-top:0px; +} +td.colLast a { + padding-bottom:3px; +} +/* + * Styles for formatting effect. + */ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .implementationLabel, .memberNameLabel, .memberNameLink, +.moduleLabelInPackage, .moduleLabelInType, .overrideSpecifyLabel, .packageLabelInType, +.packageHierarchyLabel, .paramLabel, .returnLabel, .seeLabel, .simpleTagLabel, +.throwsLabel, .typeNameLabel, .typeNameLink, .searchTagLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} +.deprecationBlock { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; + border-style:solid; + border-width:thin; + border-radius:10px; + padding:10px; + margin-bottom:10px; + margin-right:10px; + display:inline-block; +} +div.block div.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} +div.contentContainer ul.blockList li.blockList h2 { + padding-bottom:0px; +} +/* + * Styles for IFRAME. + */ +.mainContainer { + margin:0 auto; + padding:0; + height:100%; + width:100%; + position:fixed; + top:0; + left:0; +} +.leftContainer { + height:100%; + position:fixed; + width:320px; +} +.leftTop { + position:relative; + float:left; + width:315px; + top:0; + left:0; + height:30%; + border-right:6px solid #ccc; + border-bottom:6px solid #ccc; +} +.leftBottom { + position:relative; + float:left; + width:315px; + bottom:0; + left:0; + height:70%; + border-right:6px solid #ccc; + border-top:1px solid #000; +} +.rightContainer { + position:absolute; + left:320px; + top:0; + bottom:0; + height:100%; + right:0; + border-left:1px solid #000; +} +.rightIframe { + margin:0; + padding:0; + height:100%; + right:30px; + width:100%; + overflow:visible; + margin-bottom:30px; +} +/* + * Styles specific to HTML5 elements. + */ +main, nav, header, footer, section { + display:block; +} +/* + * Styles for javadoc search. + */ +.ui-autocomplete-category { + font-weight:bold; + font-size:15px; + padding:7px 0 7px 3px; + background-color:#4D7A97; + color:#FFFFFF; +} +.resultItem { + font-size:13px; +} +.ui-autocomplete { + max-height:85%; + max-width:65%; + overflow-y:scroll; + overflow-x:scroll; + white-space:nowrap; + box-shadow: 0 3px 6px rgba(0,0,0,0.16), 0 3px 6px rgba(0,0,0,0.23); +} +ul.ui-autocomplete { + position:fixed; + z-index:999999; + background-color: #FFFFFF; +} +ul.ui-autocomplete li { + float:left; + clear:both; + width:100%; +} +.resultHighlight { + font-weight:bold; +} +.ui-autocomplete .result-item { + font-size: inherit; +} +#search { + background-image:url('resources/glass.png'); + background-size:13px; + background-repeat:no-repeat; + background-position:2px 3px; + padding-left:20px; + position:relative; + right:-18px; +} +#reset { + background-color: rgb(255,255,255); + background-image:url('resources/x.png'); + background-position:center; + background-repeat:no-repeat; + background-size:12px; + border:0 none; + width:16px; + height:17px; + position:relative; + left:-4px; + top:-4px; + font-size:0px; +} +.watermark { + color:#545454; +} +.searchTagDescResult { + font-style:italic; + font-size:11px; +} +.searchTagHolderResult { + font-style:italic; + font-size:12px; +} +.searchTagResult:before, .searchTagResult:target { + color:red; +} +.moduleGraph span { + display:none; + position:absolute; +} +.moduleGraph:hover span { + display:block; + margin: -100px 0 0 100px; + z-index: 1; +} +.methodSignature { + white-space:normal; +} + +/* + * Styles for user-provided tables. + * + * borderless: + * No borders, vertical margins, styled caption. + * This style is provided for use with existing doc comments. + * In general, borderless tables should not be used for layout purposes. + * + * plain: + * Plain borders around table and cells, vertical margins, styled caption. + * Best for small tables or for complex tables for tables with cells that span + * rows and columns, when the "striped" style does not work well. + * + * striped: + * Borders around the table and vertical borders between cells, striped rows, + * vertical margins, styled caption. + * Best for tables that have a header row, and a body containing a series of simple rows. + */ + +table.borderless, +table.plain, +table.striped { + margin-top: 10px; + margin-bottom: 10px; +} +table.borderless > caption, +table.plain > caption, +table.striped > caption { + font-weight: bold; + font-size: smaller; +} +table.borderless th, table.borderless td, +table.plain th, table.plain td, +table.striped th, table.striped td { + padding: 2px 5px; +} +table.borderless, +table.borderless > thead > tr > th, table.borderless > tbody > tr > th, table.borderless > tr > th, +table.borderless > thead > tr > td, table.borderless > tbody > tr > td, table.borderless > tr > td { + border: none; +} +table.borderless > thead > tr, table.borderless > tbody > tr, table.borderless > tr { + background-color: transparent; +} +table.plain { + border-collapse: collapse; + border: 1px solid black; +} +table.plain > thead > tr, table.plain > tbody tr, table.plain > tr { + background-color: transparent; +} +table.plain > thead > tr > th, table.plain > tbody > tr > th, table.plain > tr > th, +table.plain > thead > tr > td, table.plain > tbody > tr > td, table.plain > tr > td { + border: 1px solid black; +} +table.striped { + border-collapse: collapse; + border: 1px solid black; +} +table.striped > thead { + background-color: #E3E3E3; +} +table.striped > thead > tr > th, table.striped > thead > tr > td { + border: 1px solid black; +} +table.striped > tbody > tr:nth-child(even) { + background-color: #EEE +} +table.striped > tbody > tr:nth-child(odd) { + background-color: #FFF +} +table.striped > tbody > tr > th, table.striped > tbody > tr > td { + border-left: 1px solid black; + border-right: 1px solid black; +} +table.striped > tbody > tr > th { + font-weight: normal; +} diff --git a/javadoc/1.47.0/type-search-index.js b/javadoc/1.47.0/type-search-index.js new file mode 100644 index 00000000000..96e7f2e9a33 --- /dev/null +++ b/javadoc/1.47.0/type-search-index.js @@ -0,0 +1 @@ +typeSearchIndex = [{"p":"software.amazon.smithy.linters","l":"AbbreviationNameValidator"},{"p":"software.amazon.smithy.utils","l":"AbstractCodeWriter"},{"p":"software.amazon.smithy.diff.evaluators","l":"AbstractDiffEvaluator"},{"p":"software.amazon.smithy.model.shapes","l":"AbstractShapeBuilder"},{"p":"software.amazon.smithy.model.traits","l":"AbstractTrait"},{"p":"software.amazon.smithy.model.traits","l":"AbstractTraitBuilder"},{"p":"software.amazon.smithy.model.validation","l":"AbstractValidator"},{"p":"software.amazon.smithy.waiters","l":"Acceptor"},{"p":"software.amazon.smithy.waiters","l":"AcceptorState"},{"p":"software.amazon.smithy.aws.iam.traits","l":"ActionNameTrait"},{"p":"software.amazon.smithy.aws.iam.traits","l":"ActionPermissionDescriptionTrait"},{"p":"software.amazon.smithy.aws.iam.traits","l":"ActionResource"},{"p":"software.amazon.smithy.aws.iam.traits","l":"ActionResources"},{"p":"software.amazon.smithy.model.traits","l":"AddedDefaultTrait"},{"p":"software.amazon.smithy.diff.evaluators","l":"AddedEntityBinding"},{"p":"software.amazon.smithy.diff.evaluators","l":"AddedMetadata"},{"p":"software.amazon.smithy.diff.evaluators","l":"AddedOperationError"},{"p":"software.amazon.smithy.diff.evaluators","l":"AddedRequiredMember"},{"p":"software.amazon.smithy.diff.evaluators","l":"AddedServiceError"},{"p":"software.amazon.smithy.diff.evaluators","l":"AddedShape"},{"p":"software.amazon.smithy.diff.evaluators","l":"AddedTraitDefinition"},{"l":"All Classes","url":"allclasses-index.html"},{"p":"software.amazon.smithy.jmespath.ast","l":"AndExpression"},{"p":"software.amazon.smithy.model.traits","l":"AnnotationTrait"},{"p":"software.amazon.smithy.cli","l":"AnsiColorFormatter"},{"p":"software.amazon.smithy.rulesengine.language.evaluation.type","l":"AnyType"},{"p":"software.amazon.smithy.aws.apigateway.openapi","l":"ApiGatewayConfig"},{"p":"software.amazon.smithy.aws.apigateway.openapi","l":"ApiGatewayDefaults"},{"p":"software.amazon.smithy.aws.apigateway.openapi","l":"ApiGatewayExtension"},{"p":"software.amazon.smithy.aws.apigateway.openapi","l":"ApiGatewayMapper"},{"p":"software.amazon.smithy.aws.apigateway.traits","l":"ApiKeySourceTrait"},{"p":"software.amazon.smithy.aws.apigateway.openapi","l":"ApiGatewayConfig.ApiType"},{"p":"software.amazon.smithy.utils","l":"CodeInterceptor.Appender"},{"p":"software.amazon.smithy.protocoltests.traits","l":"AppliesTo"},{"p":"software.amazon.smithy.build.transforms","l":"Apply"},{"p":"software.amazon.smithy.cli","l":"ArgumentReceiver"},{"p":"software.amazon.smithy.cli","l":"Arguments"},{"p":"software.amazon.smithy.aws.traits","l":"ArnIndex"},{"p":"software.amazon.smithy.aws.traits","l":"ArnReferenceTrait"},{"p":"software.amazon.smithy.aws.traits","l":"ArnTemplateValidator"},{"p":"software.amazon.smithy.aws.traits","l":"ArnTrait"},{"p":"software.amazon.smithy.model.node","l":"ArrayNode"},{"p":"software.amazon.smithy.rulesengine.language.evaluation.type","l":"ArrayType"},{"p":"software.amazon.smithy.rulesengine.language.evaluation.value","l":"ArrayValue"},{"p":"software.amazon.smithy.codegen.core.trace","l":"ArtifactDefinitions"},{"p":"software.amazon.smithy.model.selector","l":"AttributeValue"},{"p":"software.amazon.smithy.model.traits","l":"AuthDefinitionTrait"},{"p":"software.amazon.smithy.aws.apigateway.traits","l":"AuthorizerDefinition"},{"p":"software.amazon.smithy.aws.apigateway.traits","l":"AuthorizerIndex"},{"p":"software.amazon.smithy.aws.apigateway.traits","l":"AuthorizersTrait"},{"p":"software.amazon.smithy.aws.apigateway.traits","l":"AuthorizersTraitValidator"},{"p":"software.amazon.smithy.aws.apigateway.traits","l":"AuthorizerTrait"},{"p":"software.amazon.smithy.model.knowledge","l":"ServiceIndex.AuthSchemeMode"},{"p":"software.amazon.smithy.rulesengine.validators","l":"AuthSchemeValidator"},{"p":"software.amazon.smithy.model.traits","l":"AuthTrait"},{"p":"software.amazon.smithy.model.validation.validators","l":"AuthTraitValidator"},{"p":"software.amazon.smithy.rulesengine.aws.language.functions","l":"AwsArn"},{"p":"software.amazon.smithy.rulesengine.aws.language.functions","l":"AwsBuiltIns"},{"p":"software.amazon.smithy.aws.traits.protocols","l":"AwsJson1_0Trait"},{"p":"software.amazon.smithy.aws.traits.protocols","l":"AwsJson1_1Trait"},{"p":"software.amazon.smithy.rulesengine.aws.language.functions","l":"AwsPartition"},{"p":"software.amazon.smithy.aws.traits.protocols","l":"AwsProtocolTrait"},{"p":"software.amazon.smithy.aws.traits.protocols","l":"AwsQueryCompatibleTrait"},{"p":"software.amazon.smithy.aws.traits.protocols","l":"AwsQueryErrorTrait"},{"p":"software.amazon.smithy.aws.traits.protocols","l":"AwsQueryTrait"},{"p":"software.amazon.smithy.openapi.fromsmithy.protocols","l":"AwsRestJson1Protocol"},{"p":"software.amazon.smithy.rulesengine.aws.language.functions","l":"AwsRuleSetExtension"},{"p":"software.amazon.smithy.aws.smoketests.model","l":"AwsSmokeTestModel"},{"p":"software.amazon.smithy.rulesengine.aws.validators","l":"AwsSpecialCaseEndpointValidator"},{"p":"software.amazon.smithy.aws.traits.tagging","l":"AwsTagIndex"},{"p":"software.amazon.smithy.openapi.fromsmithy.security","l":"AwsV4Converter"},{"p":"software.amazon.smithy.aws.smoketests.model","l":"AwsVendorParams"},{"p":"software.amazon.smithy.aws.smoketests.model","l":"BaseAwsVendorParams"},{"p":"software.amazon.smithy.model.shapes","l":"BigDecimalShape"},{"p":"software.amazon.smithy.model.shapes","l":"BigIntegerShape"},{"p":"software.amazon.smithy.jmespath.ast","l":"BinaryExpression"},{"p":"software.amazon.smithy.model.knowledge","l":"IdentifierBindingIndex.BindingType"},{"p":"software.amazon.smithy.model.shapes","l":"BlobShape"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions.functions","l":"BooleanEquals"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions.literal","l":"BooleanLiteral"},{"p":"software.amazon.smithy.model.node","l":"BooleanNode"},{"p":"software.amazon.smithy.model.shapes","l":"BooleanShape"},{"p":"software.amazon.smithy.rulesengine.language.evaluation.type","l":"BooleanType"},{"p":"software.amazon.smithy.rulesengine.language.evaluation.value","l":"BooleanValue"},{"p":"software.amazon.smithy.model.knowledge","l":"BottomUpIndex"},{"p":"software.amazon.smithy.model.knowledge","l":"BoxIndex"},{"p":"software.amazon.smithy.model.traits","l":"BoxTrait"},{"p":"software.amazon.smithy.model.traits","l":"TraitDefinition.BreakingChangeRule"},{"p":"software.amazon.smithy.aws.apigateway.traits","l":"AuthorizerDefinition.Builder"},{"p":"software.amazon.smithy.aws.apigateway.traits","l":"AuthorizersTrait.Builder"},{"p":"software.amazon.smithy.aws.apigateway.traits","l":"IntegrationResponse.Builder"},{"p":"software.amazon.smithy.aws.apigateway.traits","l":"IntegrationTrait.Builder"},{"p":"software.amazon.smithy.aws.apigateway.traits","l":"MockIntegrationTrait.Builder"},{"p":"software.amazon.smithy.aws.cloudformation.schema.model","l":"Handler.Builder"},{"p":"software.amazon.smithy.aws.cloudformation.schema.model","l":"Property.Builder"},{"p":"software.amazon.smithy.aws.cloudformation.schema.model","l":"Remote.Builder"},{"p":"software.amazon.smithy.aws.cloudformation.schema.model","l":"ResourceSchema.Builder"},{"p":"software.amazon.smithy.aws.cloudformation.schema.model","l":"Tagging.Builder"},{"p":"software.amazon.smithy.aws.cloudformation.traits","l":"CfnResource.Builder"},{"p":"software.amazon.smithy.aws.cloudformation.traits","l":"CfnResourceProperty.Builder"},{"p":"software.amazon.smithy.aws.cloudformation.traits","l":"CfnResourceTrait.Builder"},{"p":"software.amazon.smithy.aws.iam.traits","l":"ActionResource.Builder"},{"p":"software.amazon.smithy.aws.iam.traits","l":"ActionResources.Builder"},{"p":"software.amazon.smithy.aws.iam.traits","l":"ConditionKeyDefinition.Builder"},{"p":"software.amazon.smithy.aws.iam.traits","l":"ConditionKeysTrait.Builder"},{"p":"software.amazon.smithy.aws.iam.traits","l":"DefineConditionKeysTrait.Builder"},{"p":"software.amazon.smithy.aws.iam.traits","l":"IamActionTrait.Builder"},{"p":"software.amazon.smithy.aws.iam.traits","l":"IamResourceTrait.Builder"},{"p":"software.amazon.smithy.aws.iam.traits","l":"RequiredActionsTrait.Builder"},{"p":"software.amazon.smithy.aws.iam.traits","l":"SupportedPrincipalTypesTrait.Builder"},{"p":"software.amazon.smithy.aws.traits","l":"ArnReferenceTrait.Builder"},{"p":"software.amazon.smithy.aws.traits","l":"ArnTrait.Builder"},{"p":"software.amazon.smithy.aws.traits","l":"HttpChecksumTrait.Builder"},{"p":"software.amazon.smithy.aws.traits","l":"ServiceTrait.Builder"},{"p":"software.amazon.smithy.aws.traits.auth","l":"CognitoUserPoolsTrait.Builder"},{"p":"software.amazon.smithy.aws.traits.auth","l":"SigV4ATrait.Builder"},{"p":"software.amazon.smithy.aws.traits.auth","l":"SigV4Trait.Builder"},{"p":"software.amazon.smithy.aws.traits.clientendpointdiscovery","l":"ClientDiscoveredEndpointTrait.Builder"},{"p":"software.amazon.smithy.aws.traits.clientendpointdiscovery","l":"ClientEndpointDiscoveryTrait.Builder"},{"p":"software.amazon.smithy.aws.traits.protocols","l":"AwsJson1_0Trait.Builder"},{"p":"software.amazon.smithy.aws.traits.protocols","l":"AwsJson1_1Trait.Builder"},{"p":"software.amazon.smithy.aws.traits.protocols","l":"AwsProtocolTrait.Builder"},{"p":"software.amazon.smithy.aws.traits.protocols","l":"AwsQueryErrorTrait.Builder"},{"p":"software.amazon.smithy.aws.traits.protocols","l":"RestJson1Trait.Builder"},{"p":"software.amazon.smithy.aws.traits.protocols","l":"RestXmlTrait.Builder"},{"p":"software.amazon.smithy.aws.traits.tagging","l":"TagEnabledTrait.Builder"},{"p":"software.amazon.smithy.aws.traits.tagging","l":"TaggableApiConfig.Builder"},{"p":"software.amazon.smithy.aws.traits.tagging","l":"TaggableTrait.Builder"},{"p":"software.amazon.smithy.build","l":"PluginContext.Builder"},{"p":"software.amazon.smithy.build","l":"ProjectionResult.Builder"},{"p":"software.amazon.smithy.build","l":"SmithyBuildResult.Builder"},{"p":"software.amazon.smithy.build","l":"TransformContext.Builder"},{"p":"software.amazon.smithy.build.model","l":"MavenConfig.Builder"},{"p":"software.amazon.smithy.build.model","l":"MavenRepository.Builder"},{"p":"software.amazon.smithy.build.model","l":"ProjectionConfig.Builder"},{"p":"software.amazon.smithy.build.model","l":"SmithyBuildConfig.Builder"},{"p":"software.amazon.smithy.build.model","l":"TransformConfig.Builder"},{"p":"software.amazon.smithy.codegen.core","l":"MappedReservedWords.Builder"},{"p":"software.amazon.smithy.codegen.core","l":"ReservedWordSymbolProvider.Builder"},{"p":"software.amazon.smithy.codegen.core","l":"Symbol.Builder"},{"p":"software.amazon.smithy.codegen.core","l":"SymbolDependency.Builder"},{"p":"software.amazon.smithy.codegen.core","l":"SymbolReference.Builder"},{"p":"software.amazon.smithy.codegen.core.trace","l":"ArtifactDefinitions.Builder"},{"p":"software.amazon.smithy.codegen.core.trace","l":"ShapeLink.Builder"},{"p":"software.amazon.smithy.codegen.core.trace","l":"TraceFile.Builder"},{"p":"software.amazon.smithy.codegen.core.trace","l":"TraceMetadata.Builder"},{"p":"software.amazon.smithy.codegen.core.trace","l":"TracingSymbolProvider.Builder"},{"p":"software.amazon.smithy.diff","l":"ModelDiff.Builder"},{"p":"software.amazon.smithy.jsonschema","l":"JsonSchemaConverter.Builder"},{"p":"software.amazon.smithy.jsonschema","l":"Schema.Builder"},{"p":"software.amazon.smithy.jsonschema","l":"SchemaDocument.Builder"},{"p":"software.amazon.smithy.model","l":"Model.Builder"},{"p":"software.amazon.smithy.model.node","l":"ArrayNode.Builder"},{"p":"software.amazon.smithy.model.node","l":"ObjectNode.Builder"},{"p":"software.amazon.smithy.model.pattern","l":"SmithyPattern.Builder"},{"p":"software.amazon.smithy.model.shapes","l":"BigDecimalShape.Builder"},{"p":"software.amazon.smithy.model.shapes","l":"BigIntegerShape.Builder"},{"p":"software.amazon.smithy.model.shapes","l":"BlobShape.Builder"},{"p":"software.amazon.smithy.model.shapes","l":"BooleanShape.Builder"},{"p":"software.amazon.smithy.model.shapes","l":"ByteShape.Builder"},{"p":"software.amazon.smithy.model.shapes","l":"CollectionShape.Builder"},{"p":"software.amazon.smithy.model.shapes","l":"DocumentShape.Builder"},{"p":"software.amazon.smithy.model.shapes","l":"DoubleShape.Builder"},{"p":"software.amazon.smithy.model.shapes","l":"EntityShape.Builder"},{"p":"software.amazon.smithy.model.shapes","l":"EnumShape.Builder"},{"p":"software.amazon.smithy.model.shapes","l":"FloatShape.Builder"},{"p":"software.amazon.smithy.model.shapes","l":"IntEnumShape.Builder"},{"p":"software.amazon.smithy.model.shapes","l":"IntegerShape.Builder"},{"p":"software.amazon.smithy.model.shapes","l":"ListShape.Builder"},{"p":"software.amazon.smithy.model.shapes","l":"LongShape.Builder"},{"p":"software.amazon.smithy.model.shapes","l":"MapShape.Builder"},{"p":"software.amazon.smithy.model.shapes","l":"MemberShape.Builder"},{"p":"software.amazon.smithy.model.shapes","l":"ModelSerializer.Builder"},{"p":"software.amazon.smithy.model.shapes","l":"OperationShape.Builder"},{"p":"software.amazon.smithy.model.shapes","l":"ResourceShape.Builder"},{"p":"software.amazon.smithy.model.shapes","l":"ServiceShape.Builder"},{"p":"software.amazon.smithy.model.shapes","l":"SetShape.Builder"},{"p":"software.amazon.smithy.model.shapes","l":"ShortShape.Builder"},{"p":"software.amazon.smithy.model.shapes","l":"SmithyIdlModelSerializer.Builder"},{"p":"software.amazon.smithy.model.shapes","l":"StringShape.Builder"},{"p":"software.amazon.smithy.model.shapes","l":"StructureShape.Builder"},{"p":"software.amazon.smithy.model.shapes","l":"TimestampShape.Builder"},{"p":"software.amazon.smithy.model.shapes","l":"UnionShape.Builder"},{"p":"software.amazon.smithy.model.traits","l":"AuthDefinitionTrait.Builder"},{"p":"software.amazon.smithy.model.traits","l":"CorsTrait.Builder"},{"p":"software.amazon.smithy.model.traits","l":"DeprecatedTrait.Builder"},{"p":"software.amazon.smithy.model.traits","l":"EffectiveTraitQuery.Builder"},{"p":"software.amazon.smithy.model.traits","l":"EndpointTrait.Builder"},{"p":"software.amazon.smithy.model.traits","l":"EnumDefinition.Builder"},{"p":"software.amazon.smithy.model.traits","l":"EnumTrait.Builder"},{"p":"software.amazon.smithy.model.traits","l":"EnumValueTrait.Builder"},{"p":"software.amazon.smithy.model.traits","l":"ExamplesTrait.Builder"},{"p":"software.amazon.smithy.model.traits","l":"ExamplesTrait.ErrorExample.Builder"},{"p":"software.amazon.smithy.model.traits","l":"ExamplesTrait.Example.Builder"},{"p":"software.amazon.smithy.model.traits","l":"ExternalDocumentationTrait.Builder"},{"p":"software.amazon.smithy.model.traits","l":"HttpApiKeyAuthTrait.Builder"},{"p":"software.amazon.smithy.model.traits","l":"HttpTrait.Builder"},{"p":"software.amazon.smithy.model.traits","l":"IdRefTrait.Builder"},{"p":"software.amazon.smithy.model.traits","l":"LengthTrait.Builder"},{"p":"software.amazon.smithy.model.traits","l":"MixinTrait.Builder"},{"p":"software.amazon.smithy.model.traits","l":"PaginatedTrait.Builder"},{"p":"software.amazon.smithy.model.traits","l":"PropertyTrait.Builder"},{"p":"software.amazon.smithy.model.traits","l":"ProtocolDefinitionTrait.Builder"},{"p":"software.amazon.smithy.model.traits","l":"RangeTrait.Builder"},{"p":"software.amazon.smithy.model.traits","l":"RecommendedTrait.Builder"},{"p":"software.amazon.smithy.model.traits","l":"ReferencesTrait.Builder"},{"p":"software.amazon.smithy.model.traits","l":"ReferencesTrait.Reference.Builder"},{"p":"software.amazon.smithy.model.traits","l":"RequestCompressionTrait.Builder"},{"p":"software.amazon.smithy.model.traits","l":"RetryableTrait.Builder"},{"p":"software.amazon.smithy.model.traits","l":"StringListTrait.Builder"},{"p":"software.amazon.smithy.model.traits","l":"SuppressTrait.Builder"},{"p":"software.amazon.smithy.model.traits","l":"TagsTrait.Builder"},{"p":"software.amazon.smithy.model.traits","l":"TraitDefinition.Builder"},{"p":"software.amazon.smithy.model.traits","l":"TraitValidatorsTrait.Builder"},{"p":"software.amazon.smithy.model.traits","l":"XmlNamespaceTrait.Builder"},{"p":"software.amazon.smithy.model.traits.synthetic","l":"SyntheticEnumTrait.Builder"},{"p":"software.amazon.smithy.model.validation","l":"NodeValidationVisitor.Builder"},{"p":"software.amazon.smithy.model.validation","l":"ValidationEvent.Builder"},{"p":"software.amazon.smithy.openapi.model","l":"CallbackObject.Builder"},{"p":"software.amazon.smithy.openapi.model","l":"Component.Builder"},{"p":"software.amazon.smithy.openapi.model","l":"ComponentsObject.Builder"},{"p":"software.amazon.smithy.openapi.model","l":"EncodingObject.Builder"},{"p":"software.amazon.smithy.openapi.model","l":"ExampleObject.Builder"},{"p":"software.amazon.smithy.openapi.model","l":"ExternalDocumentation.Builder"},{"p":"software.amazon.smithy.openapi.model","l":"InfoObject.Builder"},{"p":"software.amazon.smithy.openapi.model","l":"LinkObject.Builder"},{"p":"software.amazon.smithy.openapi.model","l":"MediaTypeObject.Builder"},{"p":"software.amazon.smithy.openapi.model","l":"OpenApi.Builder"},{"p":"software.amazon.smithy.openapi.model","l":"OperationObject.Builder"},{"p":"software.amazon.smithy.openapi.model","l":"ParameterObject.Builder"},{"p":"software.amazon.smithy.openapi.model","l":"PathItem.Builder"},{"p":"software.amazon.smithy.openapi.model","l":"RequestBodyObject.Builder"},{"p":"software.amazon.smithy.openapi.model","l":"ResponseObject.Builder"},{"p":"software.amazon.smithy.openapi.model","l":"SecurityScheme.Builder"},{"p":"software.amazon.smithy.openapi.model","l":"ServerObject.Builder"},{"p":"software.amazon.smithy.openapi.model","l":"TagObject.Builder"},{"p":"software.amazon.smithy.openapi.model","l":"XmlObject.Builder"},{"p":"software.amazon.smithy.openapi.traits","l":"SpecificationExtensionTrait.Builder"},{"p":"software.amazon.smithy.protocol.traits","l":"Rpcv2CborTrait.Builder"},{"p":"software.amazon.smithy.protocoltests.traits","l":"HttpMalformedRequestDefinition.Builder"},{"p":"software.amazon.smithy.protocoltests.traits","l":"HttpMalformedRequestTestCase.Builder"},{"p":"software.amazon.smithy.protocoltests.traits","l":"HttpMalformedResponseBodyDefinition.Builder"},{"p":"software.amazon.smithy.protocoltests.traits","l":"HttpMalformedResponseDefinition.Builder"},{"p":"software.amazon.smithy.protocoltests.traits","l":"HttpRequestTestCase.Builder"},{"p":"software.amazon.smithy.protocoltests.traits","l":"HttpResponseTestCase.Builder"},{"p":"software.amazon.smithy.rulesengine.aws.language.functions","l":"AwsArn.Builder"},{"p":"software.amazon.smithy.rulesengine.aws.language.functions.partition","l":"Partition.Builder"},{"p":"software.amazon.smithy.rulesengine.aws.language.functions.partition","l":"PartitionOutputs.Builder"},{"p":"software.amazon.smithy.rulesengine.aws.language.functions.partition","l":"Partitions.Builder"},{"p":"software.amazon.smithy.rulesengine.aws.language.functions.partition","l":"RegionOverride.Builder"},{"p":"software.amazon.smithy.rulesengine.aws.traits","l":"PartitionEndpointSpecialCase.Builder"},{"p":"software.amazon.smithy.rulesengine.aws.traits","l":"PartitionSpecialCase.Builder"},{"p":"software.amazon.smithy.rulesengine.aws.traits","l":"RegionSpecialCase.Builder"},{"p":"software.amazon.smithy.rulesengine.aws.traits","l":"StandardPartitionalEndpointsTrait.Builder"},{"p":"software.amazon.smithy.rulesengine.aws.traits","l":"StandardRegionalEndpointsTrait.Builder"},{"p":"software.amazon.smithy.rulesengine.language","l":"Endpoint.Builder"},{"p":"software.amazon.smithy.rulesengine.language","l":"EndpointRuleSet.Builder"},{"p":"software.amazon.smithy.rulesengine.language.evaluation.value","l":"EndpointValue.Builder"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions.functions","l":"FunctionNode.Builder"},{"p":"software.amazon.smithy.rulesengine.language.syntax.parameters","l":"Parameter.Builder"},{"p":"software.amazon.smithy.rulesengine.language.syntax.parameters","l":"Parameters.Builder"},{"p":"software.amazon.smithy.rulesengine.language.syntax.rule","l":"Condition.Builder"},{"p":"software.amazon.smithy.rulesengine.language.syntax.rule","l":"Rule.Builder"},{"p":"software.amazon.smithy.rulesengine.traits","l":"ClientContextParamDefinition.Builder"},{"p":"software.amazon.smithy.rulesengine.traits","l":"ClientContextParamsTrait.Builder"},{"p":"software.amazon.smithy.rulesengine.traits","l":"ContextParamTrait.Builder"},{"p":"software.amazon.smithy.rulesengine.traits","l":"EndpointRuleSetTrait.Builder"},{"p":"software.amazon.smithy.rulesengine.traits","l":"EndpointTestCase.Builder"},{"p":"software.amazon.smithy.rulesengine.traits","l":"EndpointTestExpectation.Builder"},{"p":"software.amazon.smithy.rulesengine.traits","l":"EndpointTestOperationInput.Builder"},{"p":"software.amazon.smithy.rulesengine.traits","l":"EndpointTestsTrait.Builder"},{"p":"software.amazon.smithy.rulesengine.traits","l":"ExpectedEndpoint.Builder"},{"p":"software.amazon.smithy.rulesengine.traits","l":"StaticContextParamDefinition.Builder"},{"p":"software.amazon.smithy.rulesengine.traits","l":"StaticContextParamsTrait.Builder"},{"p":"software.amazon.smithy.smoketests.traits","l":"SmokeTestCase.Builder"},{"p":"software.amazon.smithy.syntax","l":"CapturedToken.Builder"},{"p":"software.amazon.smithy.waiters","l":"WaitableTrait.Builder"},{"p":"software.amazon.smithy.waiters","l":"Waiter.Builder"},{"p":"software.amazon.smithy.traitcodegen.sections","l":"BuilderClassSection"},{"p":"software.amazon.smithy.utils","l":"BuilderRef"},{"p":"software.amazon.smithy.build.plugins","l":"BuildInfo"},{"p":"software.amazon.smithy.build.plugins","l":"BuildInfoPlugin"},{"p":"software.amazon.smithy.cli","l":"BuildParameterBuilder"},{"p":"software.amazon.smithy.rulesengine.language.syntax.parameters","l":"BuiltIns"},{"p":"software.amazon.smithy.model.shapes","l":"ByteShape"},{"p":"software.amazon.smithy.openapi.model","l":"CallbackObject"},{"p":"software.amazon.smithy.linters","l":"CamelCaseValidator"},{"p":"software.amazon.smithy.syntax","l":"CapturedToken"},{"p":"software.amazon.smithy.utils","l":"CaseUtils"},{"p":"software.amazon.smithy.model.shapes","l":"ShapeType.Category"},{"p":"software.amazon.smithy.aws.cloudformation.traits","l":"CfnAdditionalIdentifierTrait"},{"p":"software.amazon.smithy.aws.cloudformation.schema","l":"CfnConfig"},{"p":"software.amazon.smithy.aws.cloudformation.schema.fromsmithy","l":"CfnConverter"},{"p":"software.amazon.smithy.aws.cloudformation.traits","l":"CfnDefaultValueTrait"},{"p":"software.amazon.smithy.aws.cloudformation.schema","l":"CfnException"},{"p":"software.amazon.smithy.aws.cloudformation.traits","l":"CfnExcludePropertyTrait"},{"p":"software.amazon.smithy.aws.cloudformation.schema.fromsmithy","l":"CfnMapper"},{"p":"software.amazon.smithy.aws.cloudformation.traits","l":"CfnMutabilityTrait"},{"p":"software.amazon.smithy.aws.cloudformation.traits","l":"CfnMutabilityTraitValidator"},{"p":"software.amazon.smithy.aws.cloudformation.traits","l":"CfnNameTrait"},{"p":"software.amazon.smithy.aws.cloudformation.traits","l":"CfnResource"},{"p":"software.amazon.smithy.aws.cloudformation.traits","l":"CfnResourceIndex"},{"p":"software.amazon.smithy.aws.cloudformation.traits","l":"CfnResourceProperty"},{"p":"software.amazon.smithy.aws.cloudformation.traits","l":"CfnResourcePropertyValidator"},{"p":"software.amazon.smithy.aws.cloudformation.traits","l":"CfnResourceTrait"},{"p":"software.amazon.smithy.diff.evaluators","l":"ChangedDefault"},{"p":"software.amazon.smithy.diff.evaluators","l":"ChangedEnumTrait"},{"p":"software.amazon.smithy.diff.evaluators","l":"ChangedLengthTrait"},{"p":"software.amazon.smithy.diff.evaluators","l":"ChangedMemberOrder"},{"p":"software.amazon.smithy.diff.evaluators","l":"ChangedMemberTarget"},{"p":"software.amazon.smithy.diff","l":"ChangedMetadata"},{"p":"software.amazon.smithy.diff.evaluators","l":"ChangedMetadata"},{"p":"software.amazon.smithy.diff.evaluators","l":"ChangedNullability"},{"p":"software.amazon.smithy.diff.evaluators","l":"ChangedOperationInput"},{"p":"software.amazon.smithy.diff.evaluators","l":"ChangedOperationOutput"},{"p":"software.amazon.smithy.diff.evaluators","l":"ChangedRangeTrait"},{"p":"software.amazon.smithy.diff.evaluators","l":"ChangedResourceIdentifiers"},{"p":"software.amazon.smithy.diff","l":"ChangedShape"},{"p":"software.amazon.smithy.diff.evaluators","l":"ChangedShapeType"},{"p":"software.amazon.smithy.model.transform","l":"ChangeShapeTypeOption"},{"p":"software.amazon.smithy.build.transforms","l":"ChangeStringEnumsToEnumShapes"},{"p":"software.amazon.smithy.model.traits","l":"TraitDefinition.ChangeType"},{"p":"software.amazon.smithy.build.transforms","l":"ChangeTypes"},{"p":"software.amazon.smithy.openapi.fromsmithy.mappers","l":"CheckForGreedyLabels"},{"p":"software.amazon.smithy.openapi.fromsmithy.mappers","l":"CheckForPrefixHeaders"},{"p":"software.amazon.smithy.model.knowledge","l":"NullableIndex.CheckMode"},{"p":"software.amazon.smithy.cli","l":"BuildParameterBuilder.ClassPathTagMatcher"},{"p":"software.amazon.smithy.traitcodegen.sections","l":"ClassSection"},{"p":"software.amazon.smithy.model.transform.plugins","l":"CleanBindings"},{"p":"software.amazon.smithy.aws.traits.clientendpointdiscovery","l":"CleanClientDiscoveryTraitTransformer"},{"p":"software.amazon.smithy.rulesengine.traits","l":"CleanEndpointTestOperationInput"},{"p":"software.amazon.smithy.model.transform.plugins","l":"CleanOperationStructures"},{"p":"software.amazon.smithy.model.transform.plugins","l":"CleanResourceReferences"},{"p":"software.amazon.smithy.model.transform.plugins","l":"CleanServiceRenames"},{"p":"software.amazon.smithy.model.transform.plugins","l":"CleanStructureAndUnionMembers"},{"p":"software.amazon.smithy.model.transform.plugins","l":"CleanTraitDefinitions"},{"p":"software.amazon.smithy.cli","l":"Cli"},{"p":"software.amazon.smithy.rulesengine.traits","l":"ClientContextParamDefinition"},{"p":"software.amazon.smithy.rulesengine.traits","l":"ClientContextParamsTrait"},{"p":"software.amazon.smithy.aws.traits.clientendpointdiscovery","l":"ClientDiscoveredEndpointTrait"},{"p":"software.amazon.smithy.aws.traits.clientendpointdiscovery","l":"ClientEndpointDiscoveryIdTrait"},{"p":"software.amazon.smithy.aws.traits.clientendpointdiscovery","l":"ClientEndpointDiscoveryIndex"},{"p":"software.amazon.smithy.aws.traits.clientendpointdiscovery","l":"ClientEndpointDiscoveryInfo"},{"p":"software.amazon.smithy.aws.traits.clientendpointdiscovery","l":"ClientEndpointDiscoveryTrait"},{"p":"software.amazon.smithy.aws.traits.clientendpointdiscovery","l":"ClientEndpointDiscoveryValidator"},{"p":"software.amazon.smithy.model.traits","l":"ClientOptionalTrait"},{"p":"software.amazon.smithy.cli","l":"CliError"},{"p":"software.amazon.smithy.cli","l":"CliPrinter"},{"p":"software.amazon.smithy.codegen.core","l":"CodegenContext"},{"p":"software.amazon.smithy.codegen.core.directed","l":"CodegenDirector"},{"p":"software.amazon.smithy.codegen.core","l":"CodegenException"},{"p":"software.amazon.smithy.codegen.core.writer","l":"CodegenWriter"},{"p":"software.amazon.smithy.codegen.core.writer","l":"CodegenWriterDelegator"},{"p":"software.amazon.smithy.codegen.core.writer","l":"CodegenWriterFactory"},{"p":"software.amazon.smithy.utils","l":"CodeInterceptor"},{"p":"software.amazon.smithy.utils","l":"CodeSection"},{"p":"software.amazon.smithy.utils","l":"CodeWriter"},{"p":"software.amazon.smithy.utils","l":"CodeWriterDebugInfo"},{"p":"software.amazon.smithy.aws.traits.auth","l":"CognitoUserPoolsTrait"},{"p":"software.amazon.smithy.model.shapes","l":"CollectionShape"},{"p":"software.amazon.smithy.cli","l":"ColorBuffer"},{"p":"software.amazon.smithy.cli","l":"ColorFormatter"},{"p":"software.amazon.smithy.cli","l":"ColorTheme"},{"p":"software.amazon.smithy.cli","l":"Command"},{"p":"software.amazon.smithy.jmespath.ast","l":"ComparatorExpression"},{"p":"software.amazon.smithy.jmespath.ast","l":"ComparatorType"},{"p":"software.amazon.smithy.openapi.model","l":"Component"},{"p":"software.amazon.smithy.openapi.model","l":"ComponentsObject"},{"p":"software.amazon.smithy.rulesengine.language.syntax.rule","l":"Condition"},{"p":"software.amazon.smithy.aws.iam.traits","l":"ConditionKeyDefinition"},{"p":"software.amazon.smithy.aws.iam.traits","l":"ConditionKeysIndex"},{"p":"software.amazon.smithy.aws.iam.traits","l":"ConditionKeysTrait"},{"p":"software.amazon.smithy.aws.iam.traits","l":"ConditionKeysValidator"},{"p":"software.amazon.smithy.aws.iam.traits","l":"ConditionKeyValueTrait"},{"p":"software.amazon.smithy.build.transforms","l":"Apply.Config"},{"p":"software.amazon.smithy.build.transforms","l":"ChangeStringEnumsToEnumShapes.Config"},{"p":"software.amazon.smithy.build.transforms","l":"ChangeTypes.Config"},{"p":"software.amazon.smithy.build.transforms","l":"ExcludeMetadata.Config"},{"p":"software.amazon.smithy.build.transforms","l":"ExcludeShapesBySelector.Config"},{"p":"software.amazon.smithy.build.transforms","l":"ExcludeShapesByTag.Config"},{"p":"software.amazon.smithy.build.transforms","l":"ExcludeShapesByTrait.Config"},{"p":"software.amazon.smithy.build.transforms","l":"ExcludeTags.Config"},{"p":"software.amazon.smithy.build.transforms","l":"ExcludeTraits.Config"},{"p":"software.amazon.smithy.build.transforms","l":"ExcludeTraitsByTag.Config"},{"p":"software.amazon.smithy.build.transforms","l":"FilterSuppressions.Config"},{"p":"software.amazon.smithy.build.transforms","l":"FlattenNamespaces.Config"},{"p":"software.amazon.smithy.build.transforms","l":"IncludeMetadata.Config"},{"p":"software.amazon.smithy.build.transforms","l":"IncludeNamespaces.Config"},{"p":"software.amazon.smithy.build.transforms","l":"IncludeServices.Config"},{"p":"software.amazon.smithy.build.transforms","l":"IncludeShapesBySelector.Config"},{"p":"software.amazon.smithy.build.transforms","l":"IncludeShapesByTag.Config"},{"p":"software.amazon.smithy.build.transforms","l":"IncludeTags.Config"},{"p":"software.amazon.smithy.build.transforms","l":"IncludeTraits.Config"},{"p":"software.amazon.smithy.build.transforms","l":"IncludeTraitsByTag.Config"},{"p":"software.amazon.smithy.build.transforms","l":"RemoveTraitDefinitions.Config"},{"p":"software.amazon.smithy.build.transforms","l":"RemoveUnusedShapes.Config"},{"p":"software.amazon.smithy.build.transforms","l":"RenameShapes.Config"},{"p":"software.amazon.smithy.linters","l":"AbbreviationNameValidator.Config"},{"p":"software.amazon.smithy.linters","l":"CamelCaseValidator.Config"},{"p":"software.amazon.smithy.linters","l":"MissingClientOptionalTrait.Config"},{"p":"software.amazon.smithy.linters","l":"MissingPaginatedTraitValidator.Config"},{"p":"software.amazon.smithy.linters","l":"MissingSensitiveTraitValidator.Config"},{"p":"software.amazon.smithy.linters","l":"NoninclusiveTermsValidator.Config"},{"p":"software.amazon.smithy.linters","l":"RepeatedShapeNameValidator.Config"},{"p":"software.amazon.smithy.linters","l":"ReservedWordsValidator.Config"},{"p":"software.amazon.smithy.linters","l":"ShouldHaveUsedTimestampValidator.Config"},{"p":"software.amazon.smithy.linters","l":"StandardOperationVerbValidator.Config"},{"p":"software.amazon.smithy.model.validation.linters","l":"EmitEachSelectorValidator.Config"},{"p":"software.amazon.smithy.model.validation.linters","l":"EmitNoneSelectorValidator.Config"},{"p":"software.amazon.smithy.model.validation.linters","l":"UnreferencedShapeValidator.Config"},{"p":"software.amazon.smithy.build.transforms","l":"ConfigurableProjectionTransformer"},{"p":"software.amazon.smithy.build.plugins","l":"ConfigurableSmithyBuildPlugin"},{"p":"software.amazon.smithy.jsonschema","l":"ConflictingShapeNameException"},{"p":"software.amazon.smithy.cli","l":"Style.Constant"},{"p":"software.amazon.smithy.aws.cloudformation.schema.fromsmithy","l":"Context"},{"p":"software.amazon.smithy.model.validation.node","l":"NodeValidatorPlugin.Context"},{"p":"software.amazon.smithy.openapi.fromsmithy","l":"Context"},{"p":"software.amazon.smithy.rulesengine.traits","l":"ContextIndex"},{"p":"software.amazon.smithy.codegen.core","l":"SymbolReference.ContextOption"},{"p":"software.amazon.smithy.rulesengine.traits","l":"ContextParamTrait"},{"p":"software.amazon.smithy.codegen.core.directed","l":"ContextualDirective"},{"p":"software.amazon.smithy.model.validation","l":"ContextualValidationEventFormatter"},{"p":"software.amazon.smithy.aws.traits","l":"ControlPlaneTrait"},{"p":"software.amazon.smithy.aws.cloudformation.schema.fromsmithy.mappers","l":"CoreExtension"},{"p":"software.amazon.smithy.openapi.fromsmithy","l":"CoreExtension"},{"p":"software.amazon.smithy.rulesengine.language","l":"CoreExtension"},{"p":"software.amazon.smithy.traitcodegen.integrations.core","l":"CoreIntegration"},{"p":"software.amazon.smithy.aws.apigateway.openapi","l":"CorsHttpIntegration"},{"p":"software.amazon.smithy.model.traits","l":"CorsTrait"},{"p":"software.amazon.smithy.rulesengine.analysis","l":"CoverageChecker"},{"p":"software.amazon.smithy.rulesengine.analysis","l":"CoverageChecker.CoverageResult"},{"p":"software.amazon.smithy.codegen.core.directed","l":"CreateContextDirective"},{"p":"software.amazon.smithy.codegen.core.directed","l":"CreateSymbolProviderDirective"},{"p":"software.amazon.smithy.jmespath.ast","l":"CurrentExpression"},{"p":"software.amazon.smithy.codegen.core.directed","l":"CustomizeDirective"},{"p":"software.amazon.smithy.model.loader","l":"TopologicalShapeSort.CycleException"},{"p":"software.amazon.smithy.aws.traits","l":"DataPlaneTrait"},{"p":"software.amazon.smithy.model.shapes","l":"ShapeVisitor.DataShapeVisitor"},{"p":"software.amazon.smithy.aws.traits","l":"DataTrait"},{"p":"software.amazon.smithy.model.node","l":"NodeVisitor.Default"},{"p":"software.amazon.smithy.model.shapes","l":"ShapeVisitor.Default"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions","l":"ExpressionVisitor.Default"},{"p":"software.amazon.smithy.model.traits","l":"DefaultTrait"},{"p":"software.amazon.smithy.model.validation.validators","l":"DefaultTraitValidator"},{"p":"software.amazon.smithy.model.validation.validators","l":"DefaultValueInUpdateValidator"},{"p":"software.amazon.smithy.aws.iam.traits","l":"DefineConditionKeysTrait"},{"p":"software.amazon.smithy.rulesengine.aws.language.functions","l":"AwsPartition.Definition"},{"p":"software.amazon.smithy.rulesengine.aws.language.functions","l":"IsVirtualHostableS3Bucket.Definition"},{"p":"software.amazon.smithy.rulesengine.aws.language.functions","l":"ParseArn.Definition"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions.functions","l":"BooleanEquals.Definition"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions.functions","l":"GetAttr.Definition"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions.functions","l":"IsSet.Definition"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions.functions","l":"IsValidHostLabel.Definition"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions.functions","l":"Not.Definition"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions.functions","l":"ParseUrl.Definition"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions.functions","l":"StringEquals.Definition"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions.functions","l":"Substring.Definition"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions.functions","l":"UriEncode.Definition"},{"p":"software.amazon.smithy.cli.dependencies","l":"DependencyResolver"},{"p":"software.amazon.smithy.cli.dependencies","l":"DependencyResolverException"},{"p":"software.amazon.smithy.codegen.core","l":"DependencyTracker"},{"p":"software.amazon.smithy.rulesengine.language.syntax.parameters","l":"Deprecated"},{"p":"software.amazon.smithy.model.traits","l":"DeprecatedTrait"},{"p":"software.amazon.smithy.model.validation.validators","l":"DeprecatedTraitValidator"},{"p":"software.amazon.smithy.diff","l":"Differences"},{"p":"software.amazon.smithy.diff","l":"DiffEvaluator"},{"p":"software.amazon.smithy.codegen.core.directed","l":"DirectedCodegen"},{"p":"software.amazon.smithy.codegen.core.directed","l":"Directive"},{"p":"software.amazon.smithy.aws.iam.traits","l":"DisableConditionKeyInferenceTrait"},{"p":"software.amazon.smithy.model.traits","l":"DocumentationTrait"},{"p":"software.amazon.smithy.codegen.core.writer","l":"DocumentationWriter"},{"p":"software.amazon.smithy.model.shapes","l":"DocumentShape"},{"p":"software.amazon.smithy.codegen.core.writer","l":"DocWriter"},{"p":"software.amazon.smithy.model.shapes","l":"DoubleShape"},{"p":"software.amazon.smithy.rulesengine.aws.traits","l":"DualStackOnlyEndpointsTrait"},{"p":"software.amazon.smithy.model.traits","l":"DynamicTrait"},{"p":"software.amazon.smithy.aws.traits.protocols","l":"Ec2QueryNameTrait"},{"p":"software.amazon.smithy.aws.traits.protocols","l":"Ec2QueryTrait"},{"p":"software.amazon.smithy.model.traits","l":"EffectiveTraitQuery"},{"p":"software.amazon.smithy.model.validation.linters","l":"EmitEachSelectorValidator"},{"p":"software.amazon.smithy.model.validation.linters","l":"EmitNoneSelectorValidator"},{"p":"software.amazon.smithy.model.validation.node","l":"NodeValidatorPlugin.Emitter"},{"p":"software.amazon.smithy.rulesengine.language.evaluation.type","l":"EmptyType"},{"p":"software.amazon.smithy.rulesengine.language.evaluation.value","l":"EmptyValue"},{"p":"software.amazon.smithy.openapi.model","l":"EncodingObject"},{"p":"software.amazon.smithy.rulesengine.language","l":"Endpoint"},{"p":"software.amazon.smithy.rulesengine.aws.language.functions","l":"EndpointAuthUtils"},{"p":"software.amazon.smithy.rulesengine.language","l":"EndpointComponentFactory"},{"p":"software.amazon.smithy.rulesengine.aws.traits","l":"EndpointModifierIndex"},{"p":"software.amazon.smithy.rulesengine.aws.traits","l":"EndpointModifierTrait"},{"p":"software.amazon.smithy.rulesengine.aws.traits","l":"EndpointPatternType"},{"p":"software.amazon.smithy.rulesengine.language.syntax.rule","l":"EndpointRule"},{"p":"software.amazon.smithy.rulesengine.language","l":"EndpointRuleSet"},{"p":"software.amazon.smithy.rulesengine.language","l":"EndpointRuleSetExtension"},{"p":"software.amazon.smithy.rulesengine.traits","l":"EndpointRuleSetTrait"},{"p":"software.amazon.smithy.rulesengine.traits","l":"EndpointTestCase"},{"p":"software.amazon.smithy.rulesengine.traits","l":"EndpointTestExpectation"},{"p":"software.amazon.smithy.rulesengine.traits","l":"EndpointTestOperationInput"},{"p":"software.amazon.smithy.rulesengine.traits","l":"EndpointTestsTrait"},{"p":"software.amazon.smithy.rulesengine.traits","l":"EndpointTestsTraitValidator"},{"p":"software.amazon.smithy.model.traits","l":"EndpointTrait"},{"p":"software.amazon.smithy.rulesengine.language.evaluation.type","l":"EndpointType"},{"p":"software.amazon.smithy.rulesengine.language.evaluation.value","l":"EndpointValue"},{"p":"software.amazon.smithy.model.shapes","l":"EntityShape"},{"p":"software.amazon.smithy.model.traits","l":"EnumDefinition"},{"p":"software.amazon.smithy.model.shapes","l":"EnumShape"},{"p":"software.amazon.smithy.model.validation.validators","l":"EnumShapeValidator"},{"p":"software.amazon.smithy.model.traits","l":"EnumTrait"},{"p":"software.amazon.smithy.model.validation.validators","l":"EnumTraitValidator"},{"p":"software.amazon.smithy.codegen.core.directed","l":"GenerateEnumDirective.EnumType"},{"p":"software.amazon.smithy.model.traits","l":"EnumValueTrait"},{"p":"software.amazon.smithy.traitcodegen.sections","l":"EnumVariantSection"},{"p":"software.amazon.smithy.cli","l":"Command.Env"},{"p":"software.amazon.smithy.cli","l":"EnvironmentVariable"},{"p":"software.amazon.smithy.model.validation.testrunner","l":"SmithyTestCase.Error"},{"p":"software.amazon.smithy.model.validation.testrunner","l":"SmithyTestSuite.Error"},{"p":"software.amazon.smithy.model.traits","l":"ExamplesTrait.ErrorExample"},{"p":"software.amazon.smithy.aws.traits","l":"ErrorRenameValidator"},{"p":"software.amazon.smithy.rulesengine.language.syntax.rule","l":"ErrorRule"},{"p":"software.amazon.smithy.openapi","l":"OpenApiConfig.ErrorStatusConflictHandlingStrategy"},{"p":"software.amazon.smithy.model.traits","l":"ErrorTrait"},{"p":"software.amazon.smithy.waiters","l":"Matcher.ErrorTypeMember"},{"p":"software.amazon.smithy.codegen.core","l":"ReservedWordSymbolProvider.Escaper"},{"p":"software.amazon.smithy.rulesengine.language.error","l":"RuleError.Evaluator"},{"p":"software.amazon.smithy.model.traits","l":"EventHeaderTrait"},{"p":"software.amazon.smithy.model.traits","l":"EventPayloadTrait"},{"p":"software.amazon.smithy.model.validation.validators","l":"EventPayloadTraitValidator"},{"p":"software.amazon.smithy.aws.traits","l":"EventSourceValidator"},{"p":"software.amazon.smithy.model.knowledge","l":"EventStreamIndex"},{"p":"software.amazon.smithy.model.knowledge","l":"EventStreamInfo"},{"p":"software.amazon.smithy.model.traits","l":"ExamplesTrait.Example"},{"p":"software.amazon.smithy.openapi.model","l":"ExampleObject"},{"p":"software.amazon.smithy.model.traits","l":"ExamplesTrait"},{"p":"software.amazon.smithy.model.validation.validators","l":"ExamplesTraitValidator"},{"p":"software.amazon.smithy.build.transforms","l":"ExcludeMetadata"},{"p":"software.amazon.smithy.build.transforms","l":"ExcludeShapesBySelector"},{"p":"software.amazon.smithy.build.transforms","l":"ExcludeShapesByTag"},{"p":"software.amazon.smithy.build.transforms","l":"ExcludeShapesByTrait"},{"p":"software.amazon.smithy.build.transforms","l":"ExcludeTags"},{"p":"software.amazon.smithy.build.transforms","l":"ExcludeTraits"},{"p":"software.amazon.smithy.build.transforms","l":"ExcludeTraitsByTag"},{"p":"software.amazon.smithy.model.validation.validators","l":"ExclusiveStructureMemberTraitValidator"},{"p":"software.amazon.smithy.smoketests.traits","l":"Expectation"},{"p":"software.amazon.smithy.model.node","l":"ExpectationNotMetException"},{"p":"software.amazon.smithy.rulesengine.traits","l":"ExpectedEndpoint"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions","l":"Expression"},{"p":"software.amazon.smithy.jmespath","l":"ExpressionProblem"},{"p":"software.amazon.smithy.jmespath","l":"ExpressionSerializer"},{"p":"software.amazon.smithy.jmespath.ast","l":"ExpressionTypeExpression"},{"p":"software.amazon.smithy.jmespath","l":"ExpressionVisitor"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions","l":"ExpressionVisitor"},{"p":"software.amazon.smithy.openapi.model","l":"ExternalDocumentation"},{"p":"software.amazon.smithy.model.traits","l":"ExternalDocumentationTrait"},{"p":"software.amazon.smithy.cli.dependencies","l":"DependencyResolver.Factory"},{"p":"software.amazon.smithy.codegen.core","l":"SymbolWriter.Factory"},{"p":"software.amazon.smithy.smoketests.traits","l":"FailureExpectation"},{"p":"software.amazon.smithy.model.validation","l":"NodeValidationVisitor.Feature"},{"p":"software.amazon.smithy.jmespath.ast","l":"FieldExpression"},{"p":"software.amazon.smithy.cli.dependencies","l":"FileCacheResolver"},{"p":"software.amazon.smithy.build","l":"FileManifest"},{"p":"software.amazon.smithy.cli.dependencies","l":"FilterCliVersionResolver"},{"p":"software.amazon.smithy.jmespath.ast","l":"FilterProjectionExpression"},{"p":"software.amazon.smithy.build.transforms","l":"FilterSuppressions"},{"p":"software.amazon.smithy.jmespath.ast","l":"FlattenExpression"},{"p":"software.amazon.smithy.build.transforms","l":"FlattenNamespaces"},{"p":"software.amazon.smithy.model.shapes","l":"FloatShape"},{"p":"software.amazon.smithy.model.traits","l":"TimestampFormatTrait.Format"},{"p":"software.amazon.smithy.syntax","l":"Formatter"},{"p":"software.amazon.smithy.model","l":"FromSourceLocation"},{"p":"software.amazon.smithy.utils","l":"FunctionalUtils"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions.functions","l":"FunctionDefinition"},{"p":"software.amazon.smithy.jmespath.ast","l":"FunctionExpression"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions.functions","l":"FunctionNode"},{"p":"software.amazon.smithy.codegen.core.directed","l":"GenerateEnumDirective"},{"p":"software.amazon.smithy.codegen.core.directed","l":"GenerateErrorDirective"},{"p":"software.amazon.smithy.codegen.core.directed","l":"GenerateIntEnumDirective"},{"p":"software.amazon.smithy.codegen.core.directed","l":"GenerateOperationDirective"},{"p":"software.amazon.smithy.codegen.core.directed","l":"GenerateResourceDirective"},{"p":"software.amazon.smithy.codegen.core.directed","l":"GenerateServiceDirective"},{"p":"software.amazon.smithy.codegen.core.directed","l":"GenerateStructureDirective"},{"p":"software.amazon.smithy.traitcodegen","l":"GenerateTraitDirective"},{"p":"software.amazon.smithy.codegen.core.directed","l":"GenerateUnionDirective"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions.functions","l":"GetAttr"},{"p":"software.amazon.smithy.traitcodegen.sections","l":"GetterSection"},{"p":"software.amazon.smithy.aws.cloudformation.schema.model","l":"Handler"},{"p":"software.amazon.smithy.aws.cloudformation.schema.fromsmithy.mappers","l":"HandlerPermissionMapper"},{"p":"software.amazon.smithy.cli","l":"HelpPrinter"},{"p":"software.amazon.smithy.model.traits","l":"HostLabelTrait"},{"p":"software.amazon.smithy.model.validation.validators","l":"HostLabelTraitValidator"},{"p":"software.amazon.smithy.openapi.fromsmithy.security","l":"HttpApiKeyAuthConverter"},{"p":"software.amazon.smithy.model.traits","l":"HttpApiKeyAuthTrait"},{"p":"software.amazon.smithy.model.validation.validators","l":"HttpApiKeyAuthTraitValidator"},{"p":"software.amazon.smithy.model.traits","l":"HttpBasicAuthTrait"},{"p":"software.amazon.smithy.openapi.fromsmithy.security","l":"HttpBasicConverter"},{"p":"software.amazon.smithy.model.traits","l":"HttpBearerAuthTrait"},{"p":"software.amazon.smithy.openapi.fromsmithy.security","l":"HttpBearerConverter"},{"p":"software.amazon.smithy.model.knowledge","l":"HttpBinding"},{"p":"software.amazon.smithy.model.knowledge","l":"HttpBindingIndex"},{"p":"software.amazon.smithy.model.validation.validators","l":"HttpBindingsMissingValidator"},{"p":"software.amazon.smithy.model.validation.validators","l":"HttpBindingTraitIgnoredValidator"},{"p":"software.amazon.smithy.model.traits","l":"HttpChecksumRequiredTrait"},{"p":"software.amazon.smithy.aws.traits","l":"HttpChecksumTrait"},{"p":"software.amazon.smithy.aws.traits","l":"HttpChecksumTraitValidator"},{"p":"software.amazon.smithy.model.traits","l":"HttpDigestAuthTrait"},{"p":"software.amazon.smithy.openapi.fromsmithy.security","l":"HttpDigestConverter"},{"p":"software.amazon.smithy.model.traits","l":"HttpErrorTrait"},{"p":"software.amazon.smithy.model.traits","l":"HttpHeaderTrait"},{"p":"software.amazon.smithy.model.validation.validators","l":"HttpHeaderTraitValidator"},{"p":"software.amazon.smithy.model.traits","l":"HttpLabelTrait"},{"p":"software.amazon.smithy.model.validation.validators","l":"HttpLabelTraitValidator"},{"p":"software.amazon.smithy.protocoltests.traits","l":"HttpMalformedRequestDefinition"},{"p":"software.amazon.smithy.protocoltests.traits","l":"HttpMalformedRequestTestCase"},{"p":"software.amazon.smithy.protocoltests.traits","l":"HttpMalformedRequestTestsTrait"},{"p":"software.amazon.smithy.protocoltests.traits","l":"HttpMalformedRequestTestsValidator"},{"p":"software.amazon.smithy.protocoltests.traits","l":"HttpMalformedResponseBodyDefinition"},{"p":"software.amazon.smithy.protocoltests.traits","l":"HttpMalformedResponseDefinition"},{"p":"software.amazon.smithy.protocoltests.traits","l":"HttpMessageTestCase"},{"p":"software.amazon.smithy.model.validation.validators","l":"HttpMethodSemanticsValidator"},{"p":"software.amazon.smithy.model.traits","l":"HttpPayloadTrait"},{"p":"software.amazon.smithy.model.validation.validators","l":"HttpPayloadValidator"},{"p":"software.amazon.smithy.openapi","l":"OpenApiConfig.HttpPrefixHeadersStrategy"},{"p":"software.amazon.smithy.model.traits","l":"HttpPrefixHeadersTrait"},{"p":"software.amazon.smithy.model.validation.validators","l":"HttpPrefixHeadersTraitValidator"},{"p":"software.amazon.smithy.model.traits","l":"HttpQueryParamsTrait"},{"p":"software.amazon.smithy.model.validation.validators","l":"HttpQueryParamsTraitValidator"},{"p":"software.amazon.smithy.model.traits","l":"HttpQueryTrait"},{"p":"software.amazon.smithy.model.validation.validators","l":"HttpQueryTraitValidator"},{"p":"software.amazon.smithy.protocoltests.traits","l":"HttpRequestTestCase"},{"p":"software.amazon.smithy.protocoltests.traits","l":"HttpRequestTestsInputValidator"},{"p":"software.amazon.smithy.protocoltests.traits","l":"HttpRequestTestsTrait"},{"p":"software.amazon.smithy.model.validation.validators","l":"HttpResponseCodeSemanticsValidator"},{"p":"software.amazon.smithy.model.traits","l":"HttpResponseCodeTrait"},{"p":"software.amazon.smithy.protocoltests.traits","l":"HttpResponseTestCase"},{"p":"software.amazon.smithy.protocoltests.traits","l":"HttpResponseTestsErrorValidator"},{"p":"software.amazon.smithy.protocoltests.traits","l":"HttpResponseTestsOutputValidator"},{"p":"software.amazon.smithy.protocoltests.traits","l":"HttpResponseTestsTrait"},{"p":"software.amazon.smithy.model.traits","l":"HttpTrait"},{"p":"software.amazon.smithy.model.validation.validators","l":"HttpUriConflictValidator"},{"p":"software.amazon.smithy.model.validation.validators","l":"HttpUriFormatValidator"},{"p":"software.amazon.smithy.aws.iam.traits","l":"IamActionTrait"},{"p":"software.amazon.smithy.aws.iam.traits","l":"IamActionValidator"},{"p":"software.amazon.smithy.aws.iam.traits","l":"IamResourceTrait"},{"p":"software.amazon.smithy.aws.iam.traits","l":"IamResourceTraitValidator"},{"p":"software.amazon.smithy.model.traits","l":"IdempotencyTokenTrait"},{"p":"software.amazon.smithy.model.traits","l":"IdempotentTrait"},{"p":"software.amazon.smithy.rulesengine.language.syntax","l":"Identifier"},{"p":"software.amazon.smithy.model.knowledge","l":"IdentifierBindingIndex"},{"p":"software.amazon.smithy.model.loader","l":"IdlToken"},{"p":"software.amazon.smithy.model.loader","l":"IdlTokenizer"},{"p":"software.amazon.smithy.traitcodegen.integrations.idref","l":"IdRefDecoratorIntegration"},{"p":"software.amazon.smithy.model.traits","l":"IdRefTrait"},{"p":"software.amazon.smithy.codegen.core","l":"ImportContainer"},{"p":"software.amazon.smithy.codegen.core.writer","l":"ImportContainer"},{"p":"software.amazon.smithy.build.transforms","l":"IncludeMetadata"},{"p":"software.amazon.smithy.build.transforms","l":"IncludeNamespaces"},{"p":"software.amazon.smithy.build.transforms","l":"IncludeServices"},{"p":"software.amazon.smithy.build.transforms","l":"IncludeShapesBySelector"},{"p":"software.amazon.smithy.build.transforms","l":"IncludeShapesByTag"},{"p":"software.amazon.smithy.build.transforms","l":"IncludeTags"},{"p":"software.amazon.smithy.build.transforms","l":"IncludeTraits"},{"p":"software.amazon.smithy.build.transforms","l":"IncludeTraitsByTag"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions.functions","l":"GetAttr.Part.Index"},{"p":"software.amazon.smithy.jmespath.ast","l":"IndexExpression"},{"p":"software.amazon.smithy.openapi.model","l":"InfoObject"},{"p":"software.amazon.smithy.rulesengine.language.error","l":"InnerParseError"},{"p":"software.amazon.smithy.waiters","l":"Matcher.InputOutputMember"},{"p":"software.amazon.smithy.linters","l":"InputOutputStructureReuseValidator"},{"p":"software.amazon.smithy.model.traits","l":"InputTrait"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions.literal","l":"IntegerLiteral"},{"p":"software.amazon.smithy.model.shapes","l":"IntegerShape"},{"p":"software.amazon.smithy.rulesengine.language.evaluation.type","l":"IntegerType"},{"p":"software.amazon.smithy.rulesengine.language.evaluation.value","l":"IntegerValue"},{"p":"software.amazon.smithy.aws.apigateway.traits","l":"IntegrationResponse"},{"p":"software.amazon.smithy.aws.apigateway.traits","l":"IntegrationTrait"},{"p":"software.amazon.smithy.aws.apigateway.traits","l":"IntegrationTraitIndex"},{"p":"software.amazon.smithy.model.shapes","l":"IntEnumShape"},{"p":"software.amazon.smithy.model.traits","l":"InternalTrait"},{"p":"software.amazon.smithy.model.pattern","l":"InvalidPatternException"},{"p":"software.amazon.smithy.rulesengine.language.error","l":"InvalidRulesException"},{"p":"software.amazon.smithy.model.pattern","l":"InvalidUriPatternException"},{"p":"software.amazon.smithy.utils","l":"IoUtils"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions.functions","l":"IsSet"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions.functions","l":"IsValidHostLabel"},{"p":"software.amazon.smithy.rulesengine.aws.language.functions","l":"IsVirtualHostableS3Bucket"},{"p":"software.amazon.smithy.cli","l":"BuildParameterBuilder.JarFileClassPathTagMatcher"},{"p":"software.amazon.smithy.traitcodegen.integrations.javadoc","l":"JavaDocIntegration"},{"p":"software.amazon.smithy.traitcodegen.sections","l":"JavaDocSection"},{"p":"software.amazon.smithy.codegen.core.writer","l":"JavaStyleDocumentationWriterBuilder"},{"p":"software.amazon.smithy.jmespath","l":"JmespathException"},{"p":"software.amazon.smithy.jmespath","l":"JmespathExpression"},{"p":"software.amazon.smithy.model.traits","l":"JsonNameTrait"},{"p":"software.amazon.smithy.model.validation.validators","l":"JsonNameValidator"},{"p":"software.amazon.smithy.jsonschema","l":"JsonSchemaConfig"},{"p":"software.amazon.smithy.jsonschema","l":"JsonSchemaConverter"},{"p":"software.amazon.smithy.jsonschema","l":"JsonSchemaMapper"},{"p":"software.amazon.smithy.jsonschema","l":"JsonSchemaMapperContext"},{"p":"software.amazon.smithy.jsonschema","l":"JsonSchemaVersion"},{"p":"software.amazon.smithy.build","l":"JsonSubstitutions"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions.functions","l":"GetAttr.Part.Key"},{"p":"software.amazon.smithy.model.knowledge","l":"KnowledgeIndex"},{"p":"software.amazon.smithy.model.traits","l":"LengthTrait"},{"p":"software.amazon.smithy.model.validation.validators","l":"LengthTraitValidator"},{"p":"software.amazon.smithy.mqtt.traits","l":"Topic.Level"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions.functions","l":"LibraryFunction"},{"p":"software.amazon.smithy.model.loader.sourcecontext","l":"SourceContextLoader.Line"},{"p":"software.amazon.smithy.model.validation","l":"LineValidationEventFormatter"},{"p":"software.amazon.smithy.openapi.model","l":"LinkObject"},{"p":"software.amazon.smithy.jmespath","l":"LinterResult"},{"p":"software.amazon.smithy.model.shapes","l":"ListShape"},{"p":"software.amazon.smithy.utils","l":"ListUtils"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions","l":"Template.Literal"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions.literal","l":"Literal"},{"p":"software.amazon.smithy.jmespath.ast","l":"LiteralExpression"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions.literal","l":"LiteralVisitor"},{"p":"software.amazon.smithy.model.knowledge","l":"HttpBinding.Location"},{"p":"software.amazon.smithy.model.traits","l":"HttpApiKeyAuthTrait.Location"},{"p":"software.amazon.smithy.model.shapes","l":"LongShape"},{"p":"software.amazon.smithy.codegen.core","l":"MappedReservedWords"},{"p":"software.amazon.smithy.model.shapes","l":"MapShape"},{"p":"software.amazon.smithy.jsonschema","l":"JsonSchemaConfig.MapStrategy"},{"p":"software.amazon.smithy.utils","l":"MapUtils"},{"p":"software.amazon.smithy.waiters","l":"Matcher"},{"p":"software.amazon.smithy.build.model","l":"MavenConfig"},{"p":"software.amazon.smithy.cli.dependencies","l":"MavenDependencyResolver"},{"p":"software.amazon.smithy.build.model","l":"MavenRepository"},{"p":"software.amazon.smithy.utils","l":"MediaType"},{"p":"software.amazon.smithy.openapi.model","l":"MediaTypeObject"},{"p":"software.amazon.smithy.model.traits","l":"MediaTypeTrait"},{"p":"software.amazon.smithy.model.validation.validators","l":"MediaTypeValidator"},{"p":"software.amazon.smithy.linters","l":"CamelCaseValidator.MemberNameHandling"},{"p":"software.amazon.smithy.model.shapes","l":"MemberShape"},{"p":"software.amazon.smithy.linters","l":"MissingClientOptionalTrait"},{"p":"software.amazon.smithy.linters","l":"MissingPaginatedTraitValidator"},{"p":"software.amazon.smithy.linters","l":"MissingSensitiveTraitValidator"},{"p":"software.amazon.smithy.model.traits","l":"MixinTrait"},{"p":"software.amazon.smithy.aws.apigateway.traits","l":"MockIntegrationTrait"},{"p":"software.amazon.smithy.build","l":"MockManifest"},{"p":"software.amazon.smithy.model","l":"Model"},{"p":"software.amazon.smithy.model.loader","l":"ModelAssembler"},{"p":"software.amazon.smithy.model.validation.suppressions","l":"ModelBasedEventDecorator"},{"p":"software.amazon.smithy.diff","l":"ModelDiff"},{"p":"software.amazon.smithy.model.loader","l":"ModelDiscovery"},{"p":"software.amazon.smithy.model.loader","l":"ModelImportException"},{"p":"software.amazon.smithy.model.loader","l":"ModelManifestException"},{"p":"software.amazon.smithy.build.plugins","l":"ModelPlugin"},{"p":"software.amazon.smithy.model.shapes","l":"ModelSerializer"},{"p":"software.amazon.smithy.model.loader","l":"ModelSyntaxException"},{"p":"software.amazon.smithy.model.transform","l":"ModelTransformer"},{"p":"software.amazon.smithy.model.transform","l":"ModelTransformerPlugin"},{"p":"software.amazon.smithy.model.transform","l":"ModelTransformException"},{"p":"software.amazon.smithy.diff.evaluators","l":"ModifiedTrait"},{"p":"software.amazon.smithy.mqtt.traits","l":"MqttJsonTrait"},{"p":"software.amazon.smithy.mqtt.traits.validators","l":"MqttTopicConflictValidator"},{"p":"software.amazon.smithy.mqtt.traits.validators","l":"MqttTopicLabelValidator"},{"p":"software.amazon.smithy.cli","l":"Style.Multi"},{"p":"software.amazon.smithy.jmespath.ast","l":"MultiSelectHashExpression"},{"p":"software.amazon.smithy.jmespath.ast","l":"MultiSelectListExpression"},{"p":"software.amazon.smithy.aws.cloudformation.traits","l":"CfnResourceIndex.Mutability"},{"p":"software.amazon.smithy.model.neighbor","l":"NeighborProvider"},{"p":"software.amazon.smithy.model.knowledge","l":"NeighborProviderIndex"},{"p":"software.amazon.smithy.model.traits","l":"NestedPropertiesTrait"},{"p":"software.amazon.smithy.model.traits.synthetic","l":"NoAuthTrait"},{"p":"software.amazon.smithy.model.node","l":"Node"},{"p":"software.amazon.smithy.model.node","l":"NodeDeserializationException"},{"p":"software.amazon.smithy.model.node.internal","l":"NodeHandler"},{"p":"software.amazon.smithy.model.node","l":"NodeMapper"},{"p":"software.amazon.smithy.model.node","l":"NodePointer"},{"p":"software.amazon.smithy.model.node","l":"NodeSerializationException"},{"p":"software.amazon.smithy.model.node","l":"NodeType"},{"p":"software.amazon.smithy.model.validation","l":"NodeValidationVisitor"},{"p":"software.amazon.smithy.model.validation.node","l":"NodeValidatorPlugin"},{"p":"software.amazon.smithy.model.node","l":"NodeVisitor"},{"p":"software.amazon.smithy.model.validation.validators","l":"NoInlineDocumentSupportValidator"},{"p":"software.amazon.smithy.linters","l":"NoninclusiveTermsValidator"},{"p":"software.amazon.smithy.model.node","l":"Node.NonNumericFloat"},{"p":"software.amazon.smithy.model.traits","l":"NoReplaceTrait"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions.functions","l":"Not"},{"p":"software.amazon.smithy.jmespath.ast","l":"NotExpression"},{"p":"software.amazon.smithy.model.traits","l":"NotPropertyTrait"},{"p":"software.amazon.smithy.build.plugins","l":"NullabilityReportPlugin"},{"p":"software.amazon.smithy.model.knowledge","l":"NullableIndex"},{"p":"software.amazon.smithy.model.node","l":"NullNode"},{"p":"software.amazon.smithy.model.node","l":"NumberNode"},{"p":"software.amazon.smithy.model.shapes","l":"NumberShape"},{"p":"software.amazon.smithy.model.node","l":"ObjectNode"},{"p":"software.amazon.smithy.jmespath.ast","l":"ObjectProjectionExpression"},{"p":"software.amazon.smithy.openapi.model","l":"OpenApi"},{"p":"software.amazon.smithy.openapi","l":"OpenApiConfig"},{"p":"software.amazon.smithy.openapi.fromsmithy","l":"OpenApiConverter"},{"p":"software.amazon.smithy.openapi","l":"OpenApiException"},{"p":"software.amazon.smithy.openapi.fromsmithy.mappers","l":"OpenApiJsonAdd"},{"p":"software.amazon.smithy.openapi.fromsmithy","l":"OpenApiJsonSchemaMapper"},{"p":"software.amazon.smithy.openapi.fromsmithy.mappers","l":"OpenApiJsonSubstitutions"},{"p":"software.amazon.smithy.openapi.fromsmithy","l":"OpenApiMapper"},{"p":"software.amazon.smithy.openapi.fromsmithy","l":"OpenApiProtocol"},{"p":"software.amazon.smithy.openapi","l":"OpenApiUtils"},{"p":"software.amazon.smithy.openapi","l":"OpenApiVersion"},{"p":"software.amazon.smithy.openapi.fromsmithy","l":"OpenApiProtocol.Operation"},{"p":"software.amazon.smithy.model.knowledge","l":"OperationIndex"},{"p":"software.amazon.smithy.openapi.model","l":"OperationObject"},{"p":"software.amazon.smithy.model.shapes","l":"OperationShape"},{"p":"software.amazon.smithy.model.validation.validators","l":"OperationValidator"},{"p":"software.amazon.smithy.codegen.core","l":"SymbolReference.Option"},{"p":"software.amazon.smithy.model.traits","l":"OptionalAuthTrait"},{"p":"software.amazon.smithy.rulesengine.language.evaluation.type","l":"OptionalType"},{"p":"software.amazon.smithy.utils","l":"OptionalUtils"},{"p":"software.amazon.smithy.jmespath.ast","l":"OrExpression"},{"p":"software.amazon.smithy.model.traits.synthetic","l":"OriginalShapeIdTrait"},{"p":"software.amazon.smithy.waiters","l":"Matcher.OutputMember"},{"p":"software.amazon.smithy.model.traits","l":"OutputTrait"},{"p":"software.amazon.smithy.model.knowledge","l":"PaginatedIndex"},{"p":"software.amazon.smithy.model.traits","l":"PaginatedTrait"},{"p":"software.amazon.smithy.model.validation.validators","l":"PaginatedTraitValidator"},{"p":"software.amazon.smithy.model.knowledge","l":"PaginationInfo"},{"p":"software.amazon.smithy.utils","l":"Pair"},{"p":"software.amazon.smithy.rulesengine.language.syntax.parameters","l":"Parameter"},{"p":"software.amazon.smithy.openapi.model","l":"ParameterObject"},{"p":"software.amazon.smithy.rulesengine.language.syntax.parameters","l":"Parameters"},{"p":"software.amazon.smithy.rulesengine.language.syntax.parameters","l":"ParameterType"},{"p":"software.amazon.smithy.rulesengine.aws.language.functions","l":"ParseArn"},{"p":"software.amazon.smithy.model.loader","l":"ParserUtils"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions.functions","l":"ParseUrl"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions","l":"Template.Part"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions.functions","l":"GetAttr.Part"},{"p":"software.amazon.smithy.rulesengine.aws.language.functions.partition","l":"Partition"},{"p":"software.amazon.smithy.rulesengine.aws.traits","l":"PartitionEndpointSpecialCase"},{"p":"software.amazon.smithy.rulesengine.aws.language.functions.partition","l":"PartitionOutputs"},{"p":"software.amazon.smithy.rulesengine.aws.language.functions.partition","l":"Partitions"},{"p":"software.amazon.smithy.rulesengine.aws.traits","l":"PartitionSpecialCase"},{"p":"software.amazon.smithy.model.selector","l":"PathFinder.Path"},{"p":"software.amazon.smithy.waiters","l":"PathComparator"},{"p":"software.amazon.smithy.model.selector","l":"PathFinder"},{"p":"software.amazon.smithy.openapi.model","l":"PathItem"},{"p":"software.amazon.smithy.waiters","l":"PathMatcher"},{"p":"software.amazon.smithy.model.traits","l":"PatternTrait"},{"p":"software.amazon.smithy.model.validation.validators","l":"PatternTraitValidator"},{"p":"software.amazon.smithy.aws.traits","l":"PlaneIndex"},{"p":"software.amazon.smithy.build","l":"PluginContext"},{"p":"software.amazon.smithy.model.loader","l":"Prelude"},{"p":"software.amazon.smithy.utils","l":"CodeInterceptor.Prepender"},{"p":"software.amazon.smithy.model.validation.validators","l":"PrivateAccessValidator"},{"p":"software.amazon.smithy.model.traits","l":"PrivateTrait"},{"p":"software.amazon.smithy.build.model","l":"ProjectionConfig"},{"p":"software.amazon.smithy.jmespath.ast","l":"ProjectionExpression"},{"p":"software.amazon.smithy.build","l":"ProjectionResult"},{"p":"software.amazon.smithy.build","l":"ProjectionTransformer"},{"p":"software.amazon.smithy.aws.cloudformation.schema.model","l":"Property"},{"p":"software.amazon.smithy.model.knowledge","l":"PropertyBindingIndex"},{"p":"software.amazon.smithy.jsonschema","l":"PropertyNamingStrategy"},{"p":"software.amazon.smithy.model.traits","l":"PropertyTrait"},{"p":"software.amazon.smithy.model.traits","l":"ProtocolDefinitionTrait"},{"p":"software.amazon.smithy.aws.traits.protocols","l":"ProtocolHttpPayloadValidator"},{"p":"software.amazon.smithy.aws.traits.protocols","l":"ProtocolHttpValidator"},{"p":"software.amazon.smithy.aws.apigateway.traits","l":"ApiKeySourceTrait.Provider"},{"p":"software.amazon.smithy.aws.apigateway.traits","l":"AuthorizerTrait.Provider"},{"p":"software.amazon.smithy.aws.apigateway.traits","l":"AuthorizersTrait.Provider"},{"p":"software.amazon.smithy.aws.apigateway.traits","l":"IntegrationTrait.Provider"},{"p":"software.amazon.smithy.aws.apigateway.traits","l":"MockIntegrationTrait.Provider"},{"p":"software.amazon.smithy.aws.apigateway.traits","l":"RequestValidatorTrait.Provider"},{"p":"software.amazon.smithy.aws.cloudformation.traits","l":"CfnAdditionalIdentifierTrait.Provider"},{"p":"software.amazon.smithy.aws.cloudformation.traits","l":"CfnDefaultValueTrait.Provider"},{"p":"software.amazon.smithy.aws.cloudformation.traits","l":"CfnExcludePropertyTrait.Provider"},{"p":"software.amazon.smithy.aws.cloudformation.traits","l":"CfnMutabilityTrait.Provider"},{"p":"software.amazon.smithy.aws.cloudformation.traits","l":"CfnNameTrait.Provider"},{"p":"software.amazon.smithy.aws.cloudformation.traits","l":"CfnResourceTrait.Provider"},{"p":"software.amazon.smithy.aws.iam.traits","l":"ActionNameTrait.Provider"},{"p":"software.amazon.smithy.aws.iam.traits","l":"ActionPermissionDescriptionTrait.Provider"},{"p":"software.amazon.smithy.aws.iam.traits","l":"ConditionKeyValueTrait.Provider"},{"p":"software.amazon.smithy.aws.iam.traits","l":"ConditionKeysTrait.Provider"},{"p":"software.amazon.smithy.aws.iam.traits","l":"DefineConditionKeysTrait.Provider"},{"p":"software.amazon.smithy.aws.iam.traits","l":"DisableConditionKeyInferenceTrait.Provider"},{"p":"software.amazon.smithy.aws.iam.traits","l":"IamActionTrait.Provider"},{"p":"software.amazon.smithy.aws.iam.traits","l":"IamResourceTrait.Provider"},{"p":"software.amazon.smithy.aws.iam.traits","l":"RequiredActionsTrait.Provider"},{"p":"software.amazon.smithy.aws.iam.traits","l":"ServiceResolvedConditionKeysTrait.Provider"},{"p":"software.amazon.smithy.aws.iam.traits","l":"SupportedPrincipalTypesTrait.Provider"},{"p":"software.amazon.smithy.aws.traits","l":"ArnReferenceTrait.Provider"},{"p":"software.amazon.smithy.aws.traits","l":"ArnTrait.Provider"},{"p":"software.amazon.smithy.aws.traits","l":"ControlPlaneTrait.Provider"},{"p":"software.amazon.smithy.aws.traits","l":"DataPlaneTrait.Provider"},{"p":"software.amazon.smithy.aws.traits","l":"DataTrait.Provider"},{"p":"software.amazon.smithy.aws.traits","l":"HttpChecksumTrait.Provider"},{"p":"software.amazon.smithy.aws.traits","l":"ServiceTrait.Provider"},{"p":"software.amazon.smithy.aws.traits.auth","l":"CognitoUserPoolsTrait.Provider"},{"p":"software.amazon.smithy.aws.traits.auth","l":"SigV4ATrait.Provider"},{"p":"software.amazon.smithy.aws.traits.auth","l":"SigV4Trait.Provider"},{"p":"software.amazon.smithy.aws.traits.auth","l":"UnsignedPayloadTrait.Provider"},{"p":"software.amazon.smithy.aws.traits.clientendpointdiscovery","l":"ClientDiscoveredEndpointTrait.Provider"},{"p":"software.amazon.smithy.aws.traits.clientendpointdiscovery","l":"ClientEndpointDiscoveryIdTrait.Provider"},{"p":"software.amazon.smithy.aws.traits.clientendpointdiscovery","l":"ClientEndpointDiscoveryTrait.Provider"},{"p":"software.amazon.smithy.aws.traits.customizations","l":"S3UnwrappedXmlOutputTrait.Provider"},{"p":"software.amazon.smithy.aws.traits.protocols","l":"AwsJson1_0Trait.Provider"},{"p":"software.amazon.smithy.aws.traits.protocols","l":"AwsJson1_1Trait.Provider"},{"p":"software.amazon.smithy.aws.traits.protocols","l":"AwsQueryCompatibleTrait.Provider"},{"p":"software.amazon.smithy.aws.traits.protocols","l":"AwsQueryErrorTrait.Provider"},{"p":"software.amazon.smithy.aws.traits.protocols","l":"AwsQueryTrait.Provider"},{"p":"software.amazon.smithy.aws.traits.protocols","l":"Ec2QueryNameTrait.Provider"},{"p":"software.amazon.smithy.aws.traits.protocols","l":"Ec2QueryTrait.Provider"},{"p":"software.amazon.smithy.aws.traits.protocols","l":"RestJson1Trait.Provider"},{"p":"software.amazon.smithy.aws.traits.protocols","l":"RestXmlTrait.Provider"},{"p":"software.amazon.smithy.aws.traits.tagging","l":"TagEnabledTrait.Provider"},{"p":"software.amazon.smithy.aws.traits.tagging","l":"TaggableTrait.Provider"},{"p":"software.amazon.smithy.linters","l":"AbbreviationNameValidator.Provider"},{"p":"software.amazon.smithy.linters","l":"CamelCaseValidator.Provider"},{"p":"software.amazon.smithy.linters","l":"InputOutputStructureReuseValidator.Provider"},{"p":"software.amazon.smithy.linters","l":"MissingClientOptionalTrait.Provider"},{"p":"software.amazon.smithy.linters","l":"MissingPaginatedTraitValidator.Provider"},{"p":"software.amazon.smithy.linters","l":"MissingSensitiveTraitValidator.Provider"},{"p":"software.amazon.smithy.linters","l":"NoninclusiveTermsValidator.Provider"},{"p":"software.amazon.smithy.linters","l":"RepeatedShapeNameValidator.Provider"},{"p":"software.amazon.smithy.linters","l":"ReservedWordsValidator.Provider"},{"p":"software.amazon.smithy.linters","l":"ShouldHaveUsedTimestampValidator.Provider"},{"p":"software.amazon.smithy.linters","l":"StandardOperationVerbValidator.Provider"},{"p":"software.amazon.smithy.linters","l":"StutteredShapeNameValidator.Provider"},{"p":"software.amazon.smithy.model.traits","l":"AbstractTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"AddedDefaultTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"AnnotationTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"AuthDefinitionTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"AuthTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"BoxTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"ClientOptionalTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"CorsTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"DefaultTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"DeprecatedTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"DocumentationTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"EndpointTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"EnumTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"EnumValueTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"ErrorTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"EventHeaderTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"EventPayloadTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"ExamplesTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"ExternalDocumentationTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"HostLabelTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"HttpApiKeyAuthTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"HttpBasicAuthTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"HttpBearerAuthTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"HttpChecksumRequiredTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"HttpDigestAuthTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"HttpErrorTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"HttpHeaderTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"HttpLabelTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"HttpPayloadTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"HttpPrefixHeadersTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"HttpQueryParamsTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"HttpQueryTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"HttpResponseCodeTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"HttpTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"IdRefTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"IdempotencyTokenTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"IdempotentTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"InputTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"InternalTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"JsonNameTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"LengthTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"MediaTypeTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"MixinTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"NestedPropertiesTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"NoReplaceTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"NotPropertyTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"OptionalAuthTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"OutputTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"PaginatedTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"PatternTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"PrivateTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"PropertyTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"ProtocolDefinitionTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"RangeTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"ReadonlyTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"RecommendedTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"ReferencesTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"RequestCompressionTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"RequiredTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"RequiresLengthTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"ResourceIdentifierTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"RetryableTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"SensitiveTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"SinceTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"SparseTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"StreamingTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"StringListTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"StringTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"SuppressTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"TagsTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"TimestampFormatTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"TitleTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"TraitDefinition.Provider"},{"p":"software.amazon.smithy.model.traits","l":"TraitValidatorsTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"UniqueItemsTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"UnitTypeTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"UnstableTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"XmlAttributeTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"XmlFlattenedTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"XmlNameTrait.Provider"},{"p":"software.amazon.smithy.model.traits","l":"XmlNamespaceTrait.Provider"},{"p":"software.amazon.smithy.model.validation","l":"ValidatorService.Provider"},{"p":"software.amazon.smithy.model.validation.linters","l":"EmitEachSelectorValidator.Provider"},{"p":"software.amazon.smithy.model.validation.linters","l":"EmitNoneSelectorValidator.Provider"},{"p":"software.amazon.smithy.model.validation.linters","l":"UnreferencedShapeValidator.Provider"},{"p":"software.amazon.smithy.mqtt.traits","l":"MqttJsonTrait.Provider"},{"p":"software.amazon.smithy.mqtt.traits","l":"PublishTrait.Provider"},{"p":"software.amazon.smithy.mqtt.traits","l":"SubscribeTrait.Provider"},{"p":"software.amazon.smithy.mqtt.traits","l":"TopicLabelTrait.Provider"},{"p":"software.amazon.smithy.openapi.traits","l":"SpecificationExtensionTrait.Provider"},{"p":"software.amazon.smithy.protocol.traits","l":"Rpcv2CborTrait.Provider"},{"p":"software.amazon.smithy.protocoltests.traits","l":"HttpMalformedRequestTestsTrait.Provider"},{"p":"software.amazon.smithy.protocoltests.traits","l":"HttpRequestTestsTrait.Provider"},{"p":"software.amazon.smithy.protocoltests.traits","l":"HttpResponseTestsTrait.Provider"},{"p":"software.amazon.smithy.rulesengine.aws.traits","l":"DualStackOnlyEndpointsTrait.Provider"},{"p":"software.amazon.smithy.rulesengine.aws.traits","l":"EndpointModifierTrait.Provider"},{"p":"software.amazon.smithy.rulesengine.aws.traits","l":"RuleBasedEndpointsTrait.Provider"},{"p":"software.amazon.smithy.rulesengine.aws.traits","l":"StandardPartitionalEndpointsTrait.Provider"},{"p":"software.amazon.smithy.rulesengine.aws.traits","l":"StandardRegionalEndpointsTrait.Provider"},{"p":"software.amazon.smithy.rulesengine.traits","l":"ClientContextParamsTrait.Provider"},{"p":"software.amazon.smithy.rulesengine.traits","l":"ContextParamTrait.Provider"},{"p":"software.amazon.smithy.rulesengine.traits","l":"EndpointRuleSetTrait.Provider"},{"p":"software.amazon.smithy.rulesengine.traits","l":"EndpointTestsTrait.Provider"},{"p":"software.amazon.smithy.rulesengine.traits","l":"StaticContextParamsTrait.Provider"},{"p":"software.amazon.smithy.smoketests.traits","l":"SmokeTestsTrait.Provider"},{"p":"software.amazon.smithy.waiters","l":"WaitableTrait.Provider"},{"p":"software.amazon.smithy.mqtt.traits","l":"PublishTrait"},{"p":"software.amazon.smithy.model.traits","l":"RangeTrait"},{"p":"software.amazon.smithy.model.validation.validators","l":"RangeTraitValidator"},{"p":"software.amazon.smithy.model.traits","l":"ReadonlyTrait"},{"p":"software.amazon.smithy.model.traits","l":"RecommendedTrait"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions.literal","l":"RecordLiteral"},{"p":"software.amazon.smithy.rulesengine.language.evaluation.type","l":"RecordType"},{"p":"software.amazon.smithy.rulesengine.language.evaluation.value","l":"RecordValue"},{"p":"software.amazon.smithy.openapi.model","l":"Ref"},{"p":"software.amazon.smithy.model.traits","l":"ReferencesTrait.Reference"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions","l":"Reference"},{"p":"software.amazon.smithy.model.traits","l":"ReferencesTrait"},{"p":"software.amazon.smithy.model.validation.validators","l":"ReferencesTraitValidator"},{"p":"software.amazon.smithy.rulesengine.aws.language.functions.partition","l":"RegionOverride"},{"p":"software.amazon.smithy.rulesengine.aws.traits","l":"RegionSpecialCase"},{"p":"software.amazon.smithy.model.neighbor","l":"Relationship"},{"p":"software.amazon.smithy.model.neighbor","l":"RelationshipDirection"},{"p":"software.amazon.smithy.model.neighbor","l":"RelationshipType"},{"p":"software.amazon.smithy.aws.cloudformation.schema.model","l":"Remote"},{"p":"software.amazon.smithy.diff.evaluators","l":"RemovedAuthenticationScheme"},{"p":"software.amazon.smithy.diff.evaluators","l":"RemovedEntityBinding"},{"p":"software.amazon.smithy.diff.evaluators","l":"RemovedMetadata"},{"p":"software.amazon.smithy.diff.evaluators","l":"RemovedOperationError"},{"p":"software.amazon.smithy.diff.evaluators","l":"RemovedServiceError"},{"p":"software.amazon.smithy.diff.evaluators","l":"RemovedShape"},{"p":"software.amazon.smithy.diff.evaluators","l":"RemovedTraitDefinition"},{"p":"software.amazon.smithy.openapi.fromsmithy.mappers","l":"RemoveEmptyComponents"},{"p":"software.amazon.smithy.model.transform.plugins","l":"RemoveMixins"},{"p":"software.amazon.smithy.build.transforms","l":"RemoveTraitDefinitions"},{"p":"software.amazon.smithy.model.transform.plugins","l":"RemoveTraits"},{"p":"software.amazon.smithy.openapi.fromsmithy.mappers","l":"RemoveUnusedComponents"},{"p":"software.amazon.smithy.build.transforms","l":"RemoveUnusedShapes"},{"p":"software.amazon.smithy.build.transforms","l":"RenameShapes"},{"p":"software.amazon.smithy.linters","l":"RepeatedShapeNameValidator"},{"p":"software.amazon.smithy.openapi.model","l":"RequestBodyObject"},{"p":"software.amazon.smithy.model.traits","l":"RequestCompressionTrait"},{"p":"software.amazon.smithy.model.validation.validators","l":"RequestCompressionTraitValidator"},{"p":"software.amazon.smithy.aws.apigateway.traits","l":"RequestValidatorTrait"},{"p":"software.amazon.smithy.aws.iam.traits","l":"RequiredActionsTrait"},{"p":"software.amazon.smithy.aws.cloudformation.schema.fromsmithy.mappers","l":"RequiredMapper"},{"p":"software.amazon.smithy.model.traits","l":"RequiredTrait"},{"p":"software.amazon.smithy.model.traits","l":"RequiresLengthTrait"},{"p":"software.amazon.smithy.codegen.core","l":"ReservedWords"},{"p":"software.amazon.smithy.linters","l":"ReservedWordsValidator.ReservedWords"},{"p":"software.amazon.smithy.codegen.core","l":"ReservedWordsBuilder"},{"p":"software.amazon.smithy.linters","l":"ReservedWordsValidator"},{"p":"software.amazon.smithy.codegen.core","l":"ReservedWordSymbolProvider"},{"p":"software.amazon.smithy.cli.dependencies","l":"ResolvedArtifact"},{"p":"software.amazon.smithy.mqtt.traits","l":"ResolvedTopicIndex"},{"p":"software.amazon.smithy.model.validation.validators","l":"ResourceCycleValidator"},{"p":"software.amazon.smithy.model.validation.validators","l":"ResourceIdentifierBindingValidator"},{"p":"software.amazon.smithy.model.traits","l":"ResourceIdentifierTrait"},{"p":"software.amazon.smithy.model.validation.validators","l":"ResourceIdentifierValidator"},{"p":"software.amazon.smithy.model.validation.validators","l":"ResourceLifecycleValidator"},{"p":"software.amazon.smithy.model.validation.validators","l":"ResourceOperationInputOutputValidator"},{"p":"software.amazon.smithy.aws.cloudformation.schema.model","l":"ResourceSchema"},{"p":"software.amazon.smithy.model.shapes","l":"ResourceShape"},{"p":"software.amazon.smithy.openapi.model","l":"ResponseObject"},{"p":"software.amazon.smithy.aws.traits.protocols","l":"RestJson1Trait"},{"p":"software.amazon.smithy.aws.traits.protocols","l":"RestXmlTrait"},{"p":"software.amazon.smithy.cli","l":"BuildParameterBuilder.Result"},{"p":"software.amazon.smithy.diff","l":"ModelDiff.Result"},{"p":"software.amazon.smithy.model.validation.testrunner","l":"SmithyTestCase.Result"},{"p":"software.amazon.smithy.model.validation.testrunner","l":"SmithyTestSuite.Result"},{"p":"software.amazon.smithy.model.traits","l":"RetryableTrait"},{"p":"software.amazon.smithy.protocol.traits","l":"Rpcv2CborTrait"},{"p":"software.amazon.smithy.protocol.traits","l":"Rpcv2CborTraitValidator"},{"p":"software.amazon.smithy.rulesengine.language.syntax.rule","l":"Rule"},{"p":"software.amazon.smithy.rulesengine.aws.traits","l":"RuleBasedEndpointsTrait"},{"p":"software.amazon.smithy.rulesengine.language.error","l":"RuleError"},{"p":"software.amazon.smithy.rulesengine.language.evaluation","l":"RuleEvaluator"},{"p":"software.amazon.smithy.rulesengine.language","l":"RulesComponentBuilder"},{"p":"software.amazon.smithy.rulesengine.validators","l":"RuleSetAuthSchemesValidator"},{"p":"software.amazon.smithy.rulesengine.aws.validators","l":"RuleSetAwsBuiltInValidator"},{"p":"software.amazon.smithy.rulesengine.validators","l":"RuleSetBuiltInValidator"},{"p":"software.amazon.smithy.rulesengine.validators","l":"RuleSetParameterValidator"},{"p":"software.amazon.smithy.rulesengine.validators","l":"RuleSetParamMissingDocsValidator"},{"p":"software.amazon.smithy.rulesengine.validators","l":"RuleSetTestCaseValidator"},{"p":"software.amazon.smithy.rulesengine.validators","l":"RuleSetUriValidator"},{"p":"software.amazon.smithy.rulesengine.language.syntax.rule","l":"RuleValueVisitor"},{"p":"software.amazon.smithy.model.selector","l":"Selector.Runner"},{"p":"software.amazon.smithy.build.plugins","l":"RunPlugin"},{"p":"software.amazon.smithy.jmespath","l":"RuntimeType"},{"p":"software.amazon.smithy.aws.traits.customizations","l":"S3UnwrappedXmlOutputTrait"},{"p":"software.amazon.smithy.aws.smoketests.model","l":"S3VendorParams"},{"p":"software.amazon.smithy.jsonschema","l":"Schema"},{"p":"software.amazon.smithy.jsonschema","l":"SchemaDocument"},{"p":"software.amazon.smithy.rulesengine.language.evaluation","l":"Scope"},{"p":"software.amazon.smithy.aws.traits","l":"SdkServiceIdValidator"},{"p":"software.amazon.smithy.openapi.model","l":"SecurityScheme"},{"p":"software.amazon.smithy.openapi.fromsmithy","l":"SecuritySchemeConverter"},{"p":"software.amazon.smithy.model.pattern","l":"SmithyPattern.Segment"},{"p":"software.amazon.smithy.model.selector","l":"Selector"},{"p":"software.amazon.smithy.model.selector","l":"SelectorException"},{"p":"software.amazon.smithy.model.selector","l":"SelectorSyntaxException"},{"p":"software.amazon.smithy.model.traits","l":"SensitiveTrait"},{"p":"software.amazon.smithy.openapi.model","l":"ServerObject"},{"p":"software.amazon.smithy.model.validation.validators","l":"ServiceAuthDefinitionsValidator"},{"p":"software.amazon.smithy.model.knowledge","l":"ServiceIndex"},{"p":"software.amazon.smithy.diff.evaluators","l":"ServiceRename"},{"p":"software.amazon.smithy.aws.iam.traits","l":"ServiceResolvedConditionKeysTrait"},{"p":"software.amazon.smithy.model.shapes","l":"ServiceShape"},{"p":"software.amazon.smithy.aws.traits.tagging","l":"ServiceTaggingValidator"},{"p":"software.amazon.smithy.aws.traits","l":"ServiceTrait"},{"p":"software.amazon.smithy.model.validation.validators","l":"ServiceValidator"},{"p":"software.amazon.smithy.model.shapes","l":"SetShape"},{"p":"software.amazon.smithy.build.plugins","l":"RunPlugin.Settings"},{"p":"software.amazon.smithy.utils","l":"SetUtils"},{"p":"software.amazon.smithy.model.validation.validators","l":"SetValidator"},{"p":"software.amazon.smithy.jmespath","l":"ExpressionProblem.Severity"},{"p":"software.amazon.smithy.model.validation","l":"Severity"},{"p":"software.amazon.smithy.model.validation.suppressions","l":"SeverityOverride"},{"p":"software.amazon.smithy.model.shapes","l":"Shape"},{"p":"software.amazon.smithy.codegen.core.directed","l":"ShapeDirective"},{"p":"software.amazon.smithy.codegen.core","l":"ShapeGenerationOrder"},{"p":"software.amazon.smithy.traitcodegen.generators","l":"ShapeGenerator"},{"p":"software.amazon.smithy.model.shapes","l":"ShapeId"},{"p":"software.amazon.smithy.model.validation.validators","l":"ShapeIdConflictValidator"},{"p":"software.amazon.smithy.model.shapes","l":"ShapeIdSyntaxException"},{"p":"software.amazon.smithy.codegen.core.trace","l":"ShapeLink"},{"p":"software.amazon.smithy.model.selector","l":"Selector.ShapeMatch"},{"p":"software.amazon.smithy.model.validation.validators","l":"ShapeRecursionValidator"},{"p":"software.amazon.smithy.model.shapes","l":"ShapeType"},{"p":"software.amazon.smithy.model.shapes","l":"ShapeVisitor"},{"p":"software.amazon.smithy.model.shapes","l":"ShortShape"},{"p":"software.amazon.smithy.linters","l":"ShouldHaveUsedTimestampValidator"},{"p":"software.amazon.smithy.aws.traits.auth","l":"SigV4ATrait"},{"p":"software.amazon.smithy.aws.traits.auth","l":"SigV4Trait"},{"p":"software.amazon.smithy.aws.traits.auth","l":"SigV4TraitsValidator"},{"p":"software.amazon.smithy.utils","l":"SimpleCodeWriter"},{"p":"software.amazon.smithy.utils","l":"SimpleParser"},{"p":"software.amazon.smithy.model.shapes","l":"SimpleShape"},{"p":"software.amazon.smithy.model.traits","l":"SinceTrait"},{"p":"software.amazon.smithy.model.validation.validators","l":"SingleOperationBindingValidator"},{"p":"software.amazon.smithy.model.validation.validators","l":"SingleResourceBindingValidator"},{"p":"software.amazon.smithy.jmespath.ast","l":"SliceExpression"},{"p":"software.amazon.smithy.aws.cloudformation.schema.fromsmithy","l":"Smithy2Cfn"},{"p":"software.amazon.smithy.aws.cloudformation.schema.fromsmithy","l":"Smithy2CfnExtension"},{"p":"software.amazon.smithy.openapi.fromsmithy","l":"Smithy2OpenApi"},{"p":"software.amazon.smithy.openapi.fromsmithy","l":"Smithy2OpenApiExtension"},{"p":"software.amazon.smithy.build.processor","l":"SmithyAnnotationProcessor"},{"p":"software.amazon.smithy.build","l":"SmithyBuild"},{"p":"software.amazon.smithy.build.model","l":"SmithyBuildConfig"},{"p":"software.amazon.smithy.utils","l":"SmithyBuilder"},{"p":"software.amazon.smithy.build","l":"SmithyBuildException"},{"p":"software.amazon.smithy.build","l":"SmithyBuildPlugin"},{"p":"software.amazon.smithy.build","l":"SmithyBuildResult"},{"p":"software.amazon.smithy.cli","l":"SmithyCli"},{"p":"software.amazon.smithy.cli.commands","l":"SmithyCommand"},{"p":"software.amazon.smithy.utils","l":"SmithyGenerated"},{"p":"software.amazon.smithy.model.shapes","l":"SmithyIdlComponentOrder"},{"p":"software.amazon.smithy.model.shapes","l":"SmithyIdlModelSerializer"},{"p":"software.amazon.smithy.codegen.core","l":"SmithyIntegration"},{"p":"software.amazon.smithy.utils","l":"SmithyInternalApi"},{"p":"software.amazon.smithy.jsonschema","l":"SmithyJsonSchemaException"},{"p":"software.amazon.smithy.model.pattern","l":"SmithyPattern"},{"p":"software.amazon.smithy.model.validation.testrunner","l":"SmithyTestCase"},{"p":"software.amazon.smithy.model.validation.testrunner","l":"SmithyTestSuite"},{"p":"software.amazon.smithy.utils","l":"SmithyUnstableApi"},{"p":"software.amazon.smithy.smoketests.traits","l":"SmokeTestCase"},{"p":"software.amazon.smithy.smoketests.traits","l":"SmokeTestCaseValidator"},{"p":"software.amazon.smithy.smoketests.traits","l":"SmokeTestsTrait"},{"p":"software.amazon.smithy.model.loader.sourcecontext","l":"SourceContextLoader"},{"p":"software.amazon.smithy.model","l":"SourceException"},{"p":"software.amazon.smithy.model","l":"SourceLocation"},{"p":"software.amazon.smithy.build","l":"SourcesConflictException"},{"p":"software.amazon.smithy.build.plugins","l":"SourcesPlugin"},{"p":"software.amazon.smithy.model.traits","l":"SparseTrait"},{"p":"software.amazon.smithy.openapi.fromsmithy.mappers","l":"SpecificationExtensionsMapper"},{"p":"software.amazon.smithy.openapi.traits","l":"SpecificationExtensionTrait"},{"p":"software.amazon.smithy.linters","l":"StandardOperationVerbValidator"},{"p":"software.amazon.smithy.cli","l":"StandardOptions"},{"p":"software.amazon.smithy.rulesengine.aws.traits","l":"StandardPartitionalEndpointsTrait"},{"p":"software.amazon.smithy.rulesengine.aws.traits","l":"StandardRegionalEndpointsTrait"},{"p":"software.amazon.smithy.model.selector","l":"Selector.StartingContext"},{"p":"software.amazon.smithy.rulesengine.traits","l":"StaticContextParamDefinition"},{"p":"software.amazon.smithy.rulesengine.traits","l":"StaticContextParamsTrait"},{"p":"software.amazon.smithy.rulesengine.traits","l":"StaticContextParamsTraitValidator"},{"p":"software.amazon.smithy.build","l":"MockManifest.StoreMode"},{"p":"software.amazon.smithy.model.traits","l":"StreamingTrait"},{"p":"software.amazon.smithy.model.validation.validators","l":"StreamingTraitValidator"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions.functions","l":"StringEquals"},{"p":"software.amazon.smithy.model.traits","l":"StringListTrait"},{"p":"software.amazon.smithy.model.traits","l":"StringListTrait.StringListTraitConstructor"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions.literal","l":"StringLiteral"},{"p":"software.amazon.smithy.model.node","l":"StringNode"},{"p":"software.amazon.smithy.model.shapes","l":"StringShape"},{"p":"software.amazon.smithy.model.loader","l":"StringTable"},{"p":"software.amazon.smithy.model.traits","l":"StringTrait"},{"p":"software.amazon.smithy.rulesengine.language.evaluation.type","l":"StringType"},{"p":"software.amazon.smithy.utils","l":"StringUtils"},{"p":"software.amazon.smithy.rulesengine.language.evaluation.value","l":"StringValue"},{"p":"software.amazon.smithy.model.traits","l":"TraitDefinition.StructurallyExclusive"},{"p":"software.amazon.smithy.model.shapes","l":"StructureShape"},{"p":"software.amazon.smithy.linters","l":"StutteredShapeNameValidator"},{"p":"software.amazon.smithy.cli","l":"Style"},{"p":"software.amazon.smithy.jmespath.ast","l":"Subexpression"},{"p":"software.amazon.smithy.mqtt.traits","l":"SubscribeTrait"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions.functions","l":"Substring"},{"p":"software.amazon.smithy.waiters","l":"Matcher.SuccessMember"},{"p":"software.amazon.smithy.aws.iam.traits","l":"SupportedPrincipalTypesTrait"},{"p":"software.amazon.smithy.model.validation.suppressions","l":"Suppression"},{"p":"software.amazon.smithy.model.traits","l":"SuppressTrait"},{"p":"software.amazon.smithy.codegen.core","l":"Symbol"},{"p":"software.amazon.smithy.codegen.core","l":"SymbolContainer"},{"p":"software.amazon.smithy.codegen.core","l":"SymbolDependency"},{"p":"software.amazon.smithy.codegen.core","l":"SymbolDependencyContainer"},{"p":"software.amazon.smithy.traitcodegen","l":"SymbolProperties"},{"p":"software.amazon.smithy.codegen.core","l":"SymbolProvider"},{"p":"software.amazon.smithy.codegen.core","l":"SymbolReference"},{"p":"software.amazon.smithy.codegen.core","l":"SymbolWriter"},{"p":"software.amazon.smithy.codegen.core.writer","l":"SymbolWriter"},{"p":"software.amazon.smithy.rulesengine.language.syntax","l":"SyntaxElement"},{"p":"software.amazon.smithy.model.traits.synthetic","l":"SyntheticEnumTrait"},{"p":"software.amazon.smithy.aws.traits.tagging","l":"TagEnabledServiceValidator"},{"p":"software.amazon.smithy.aws.traits.tagging","l":"TagEnabledTrait"},{"p":"software.amazon.smithy.aws.traits.tagging","l":"TaggableApiConfig"},{"p":"software.amazon.smithy.aws.traits.tagging","l":"TaggableResourceValidator"},{"p":"software.amazon.smithy.aws.traits.tagging","l":"TaggableTrait"},{"p":"software.amazon.smithy.utils","l":"Tagged"},{"p":"software.amazon.smithy.aws.cloudformation.schema.model","l":"Tagging"},{"p":"software.amazon.smithy.openapi.model","l":"TagObject"},{"p":"software.amazon.smithy.aws.traits.tagging","l":"TagResourcePropertyNameValidator"},{"p":"software.amazon.smithy.aws.traits.tagging","l":"TagResourcePropertyTypeValidator"},{"p":"software.amazon.smithy.model.traits","l":"TagsTrait"},{"p":"software.amazon.smithy.model.validation.validators","l":"TargetValidator"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions","l":"Template"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions","l":"TemplateVisitor"},{"p":"software.amazon.smithy.rulesengine.language.evaluation","l":"TestEvaluator"},{"p":"software.amazon.smithy.model.knowledge","l":"TextIndex"},{"p":"software.amazon.smithy.model.knowledge","l":"TextInstance"},{"p":"software.amazon.smithy.model.knowledge","l":"TextInstance.TextLocationType"},{"p":"software.amazon.smithy.model.traits","l":"TimestampFormatTrait"},{"p":"software.amazon.smithy.model.shapes","l":"TimestampShape"},{"p":"software.amazon.smithy.model.validation.node","l":"TimestampValidationStrategy"},{"p":"software.amazon.smithy.model.traits","l":"TitleTrait"},{"p":"software.amazon.smithy.rulesengine.language.syntax","l":"ToCondition"},{"p":"software.amazon.smithy.rulesengine.language.syntax","l":"ToExpression"},{"p":"software.amazon.smithy.syntax","l":"TokenTree"},{"p":"software.amazon.smithy.model.node","l":"ToNode"},{"p":"software.amazon.smithy.model.knowledge","l":"TopDownIndex"},{"p":"software.amazon.smithy.mqtt.traits","l":"Topic"},{"p":"software.amazon.smithy.mqtt.traits","l":"TopicBinding"},{"p":"software.amazon.smithy.mqtt.traits","l":"TopicLabelTrait"},{"p":"software.amazon.smithy.mqtt.traits","l":"TopicSyntaxException"},{"p":"software.amazon.smithy.codegen.core","l":"TopologicalIndex"},{"p":"software.amazon.smithy.model.loader","l":"TopologicalShapeSort"},{"p":"software.amazon.smithy.model.shapes","l":"ToShapeId"},{"p":"software.amazon.smithy.utils","l":"ToSmithyBuilder"},{"p":"software.amazon.smithy.codegen.core.trace","l":"TraceFile"},{"p":"software.amazon.smithy.codegen.core.trace","l":"TraceMetadata"},{"p":"software.amazon.smithy.codegen.core.trace","l":"TracingSymbolProvider"},{"p":"software.amazon.smithy.model.traits","l":"Trait"},{"p":"software.amazon.smithy.diff.evaluators","l":"TraitBreakingChange"},{"p":"software.amazon.smithy.model.validation.validators","l":"TraitBreakingChangesValidator"},{"p":"software.amazon.smithy.traitcodegen","l":"TraitCodegenContext"},{"p":"software.amazon.smithy.traitcodegen.integrations","l":"TraitCodegenIntegration"},{"p":"software.amazon.smithy.traitcodegen","l":"TraitCodegenPlugin"},{"p":"software.amazon.smithy.traitcodegen","l":"TraitCodegenSettings"},{"p":"software.amazon.smithy.traitcodegen","l":"TraitCodegenUtils"},{"p":"software.amazon.smithy.traitcodegen.writer","l":"TraitCodegenWriter"},{"p":"software.amazon.smithy.model.validation.validators","l":"TraitConflictValidator"},{"p":"software.amazon.smithy.model.traits","l":"TraitDefinition"},{"p":"software.amazon.smithy.model.traits","l":"TraitFactory"},{"p":"software.amazon.smithy.model.traits","l":"TraitService"},{"p":"software.amazon.smithy.model.validation.validators","l":"TraitTargetValidator"},{"p":"software.amazon.smithy.model.traits","l":"TraitValidatorsTrait"},{"p":"software.amazon.smithy.model.validation.validators","l":"TraitValidatorsValidator"},{"p":"software.amazon.smithy.model.validation.validators","l":"TraitValueValidator"},{"p":"software.amazon.smithy.build.model","l":"TransformConfig"},{"p":"software.amazon.smithy.build","l":"TransformContext"},{"p":"software.amazon.smithy.rulesengine.language","l":"TraversingVisitor"},{"p":"software.amazon.smithy.syntax","l":"TreeCursor"},{"p":"software.amazon.smithy.rulesengine.language.syntax.rule","l":"TreeRule"},{"p":"software.amazon.smithy.syntax","l":"TreeType"},{"p":"software.amazon.smithy.utils","l":"TriConsumer"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions.literal","l":"TupleLiteral"},{"p":"software.amazon.smithy.rulesengine.language.evaluation.type","l":"TupleType"},{"p":"software.amazon.smithy.model.pattern","l":"SmithyPattern.Segment.Type"},{"p":"software.amazon.smithy.rulesengine.language.evaluation.type","l":"Type"},{"p":"software.amazon.smithy.rulesengine.language.evaluation","l":"TypeCheck"},{"p":"software.amazon.smithy.model.shapes","l":"UnionShape"},{"p":"software.amazon.smithy.jsonschema","l":"JsonSchemaConfig.UnionStrategy"},{"p":"software.amazon.smithy.model.validation.validators","l":"UnionValidator"},{"p":"software.amazon.smithy.traitcodegen.integrations.uniqueitems","l":"UniqueItemDecoratorIntegration"},{"p":"software.amazon.smithy.model.traits","l":"UniqueItemsTrait"},{"p":"software.amazon.smithy.protocoltests.traits","l":"UniqueProtocolTestCaseIdValidator"},{"p":"software.amazon.smithy.smoketests.traits","l":"UniqueSmokeTestCaseIdValidator"},{"p":"software.amazon.smithy.waiters","l":"UniqueWaiterNamesValidator"},{"p":"software.amazon.smithy.model.traits","l":"UnitTypeTrait"},{"p":"software.amazon.smithy.model.validation.validators","l":"UnitTypeValidator"},{"p":"software.amazon.smithy.waiters","l":"Matcher.UnknownMember"},{"p":"software.amazon.smithy.build","l":"UnknownProjectionException"},{"p":"software.amazon.smithy.build","l":"UnknownTransformException"},{"p":"software.amazon.smithy.model.neighbor","l":"UnreferencedShapes"},{"p":"software.amazon.smithy.model.validation.linters","l":"UnreferencedShapeValidator"},{"p":"software.amazon.smithy.model.validation.validators","l":"UnreferencedShapeValidator"},{"p":"software.amazon.smithy.model.neighbor","l":"UnreferencedTraitDefinitions"},{"p":"software.amazon.smithy.aws.traits.auth","l":"UnsignedPayloadTrait"},{"p":"software.amazon.smithy.model.traits","l":"UnstableTrait"},{"p":"software.amazon.smithy.model.validation.validators","l":"UnstableTraitValidator"},{"p":"software.amazon.smithy.openapi.fromsmithy.mappers","l":"UnsupportedTraits"},{"p":"software.amazon.smithy.rulesengine.language.syntax.expressions.functions","l":"UriEncode"},{"p":"software.amazon.smithy.model.pattern","l":"UriPattern"},{"p":"software.amazon.smithy.model.validation","l":"ValidatedResult"},{"p":"software.amazon.smithy.model.validation","l":"ValidatedResultException"},{"p":"software.amazon.smithy.model.validation","l":"ValidationEvent"},{"p":"software.amazon.smithy.model.validation","l":"ValidationEventDecorator"},{"p":"software.amazon.smithy.model.validation","l":"ValidationEventFormatter"},{"p":"software.amazon.smithy.model.validation","l":"ValidationUtils"},{"p":"software.amazon.smithy.model.traits","l":"TraitValidatorsTrait.Validator"},{"p":"software.amazon.smithy.model.validation","l":"Validator"},{"p":"software.amazon.smithy.model.validation","l":"ValidatorFactory"},{"p":"software.amazon.smithy.model.validation","l":"ValidatorService"},{"p":"software.amazon.smithy.rulesengine.language.evaluation.value","l":"Value"},{"p":"software.amazon.smithy.waiters","l":"Matcher.Visitor"},{"p":"software.amazon.smithy.waiters","l":"WaitableTrait"},{"p":"software.amazon.smithy.waiters","l":"WaitableTraitValidator"},{"p":"software.amazon.smithy.waiters","l":"Waiter"},{"p":"software.amazon.smithy.model.neighbor","l":"Walker"},{"p":"software.amazon.smithy.model.node","l":"NodeMapper.WhenMissing"},{"p":"software.amazon.smithy.codegen.core","l":"WriterDelegator"},{"p":"software.amazon.smithy.model.traits","l":"XmlAttributeTrait"},{"p":"software.amazon.smithy.model.traits","l":"XmlFlattenedTrait"},{"p":"software.amazon.smithy.model.traits","l":"XmlNamespaceTrait"},{"p":"software.amazon.smithy.model.validation.validators","l":"XmlNamespaceTraitValidator"},{"p":"software.amazon.smithy.model.traits","l":"XmlNameTrait"},{"p":"software.amazon.smithy.openapi.model","l":"XmlObject"}] \ No newline at end of file diff --git a/javadoc/1.47.0/type-search-index.zip b/javadoc/1.47.0/type-search-index.zip new file mode 100644 index 0000000000000000000000000000000000000000..4242ac4e7d457bd8aa1ca8ae73d9757f73511bd9 GIT binary patch literal 10526 zcmZvCQ*b2=&}GbtZQITbW@6pgoY=M}zOn5a+t$RG*tRvXHT(Vhvb$A#`k}k3yZZHX zpE}AwXc%k=1Ox;KxKuxFi2n9ZrHAERjjXP1ZE|btE=2xgkSE?PW-t=JZG6yn>CWJtf7+j*<=Y`e2Xd?zUA+q#dfH)gXW z5Qa-%=P53*mHgA@GdO0v2$e~q1?JT^+En{x2ucoBSjm84>+JD zWclZC*~%aJhj8BVyV$gzif4;u7+jKH3!v8vMX%EAJ7wRpojZFb!snzk{P9W@h;=AV>sZ}lID z96B$*g=ZVR!35^l7d-iCFtL2kINlwpOhB1__%|^C3kI~2yjO9!DTM$j^Q;$zQ-3w~ zzrRQ>E}hBwSgbNhhy-o6@~>?0Z<78Eyre@Lm(~nlY`>C%P2#Oqqf^Se4B+X@7n{ME zm$-x0gwuI?ONJLqw|}YZ@7J{`&9*Xj8K=J_U#)(`9tWKa2~;Y+WMzeAv0Nw*eRwlf zIl@jodl(TU%C#&@VS27H3D4>sHv6=(aaZR^1?{+7G*kSn{o(M+6l(jv_x|VCY3VCa z&%y_Z@S#nY*@VIQE@91X<;1Hu!y|h)@J`Pl^~b+^$FUawya%p`Q12OE%4MF@ocy}& zo>#{H>@O`~2f8t;*oVaotcPI^O(hkO5kJCosA&qh4wVXE-G?>0E#+QoKakS%PX6T~ zO_Xw~M^?#K2@BvU^Icc`x}*Qqp|L}C0Wd&=xs~CPiUO)GTyXx-tR7;SEX^it+?g2k z8TF_3oxM6ZE6lQBv7D+1_kRsXFAt+fB?kDH+l9y zX%*h06+@7We8PBZuBxF@dc`f`Ra2W-P%14QptxltSLF7vkH^kSIhGtlOQbyX=&J~a z{G4C{EtfS??C>@FHu-Q0vQ<`si@U$7XohY6iISNi{jjm3Xh&$P&h1lshMk%UZSL_(lu}4kCtRVNJu;Pw zCy~b&#KK}+v5C$YSRR8&E8&(j&`W>EuAb#5HIlWoV?w%*3>*PHJze0;f?2c0i=_XK zPpOEhlMG|tnbc}_?wm2$t?5bZYjqdBUF{P8Mv0raJlb?RR!gOELox2?1IbF79xmuPdM%G%0 z0hIj!P|T@Vl!(TuDB-(T>|(N`}*mJ9qd|<3|_vG?@ngN9$YvW8b92n zta+ex0f`vO*QcOvl`EX%&A zxI$&%-$ABT+*Zfhi}ei{;JqHR6~)ma?!Op<`+`%wnnLiv8q)QICP9+CDlzUI!HGR- z5j6FXLP#z3Oo|i&FZRho0SuxZE$6y({*RO%7NiT0|LYWO9lGndI=Oojoe2HGCJ0 zGa5Lt?3mxjkT##u6qvZ|`9g))?c9iKQk$DoM0CCJ#j2bDT#G31CN)|jXYbTLB z-R5XUxHe$he-bHKqcz0DOG*|JnKLQ5-nz?j!#ik`d`j`9t_o8Uh`B^b(F4z|qCRY- z0aRh#;}PWUrTYyU=h!=m#6_=>qZ08MTeiao6zA#oKZ`FK4F+{Sv~g2-ZFNbv=Ho9# zE$rWu?P>N5>6$Cs~+DjhXqWmKRdG0<^%=hc=%^O(@oM?v#)PK21Ac6q!RF z%m~$F_s$GxF=0!Ssvl`)`kjXIqhM)^Gyzw)n4C<(CjR`d2_W8#YzBWrWH?cPX!$hi z)0zG%f-^_rXCbQ2xav(RFY|?Z!LjSErm%BmT2wyUR=Q!v{H8Rg@Ajjh7?Xv9PxyKR zP!)TI+IK;>l0GRTNrOO-1i9jX$<4qbmD^Q8WPV>7DM1=364GHJo$Y7MDUM+tyx zew~VxChoEXy_yo^ZIR57$XrHIa;8Ltr)~p8YJzWp++BXB<`-7YV<}{9*$v%nszDst zTV`d~@Hs3##ES*z?CEwkbvwY>W2KjmwfJQcizzif!QuPw=#Iczs9`sSS&5>pIANt; zfIs*J>*FcjFYqBJF^~1^*2it4!(}>sR!R0N^u9T+h7~v34Im%BMJ%Y)?I7x){FnGX zX2#ytj_3x~W3p)aH37aeos9}tb9z@R@c=#+_2d{sbB6au2lyViXtaf2QPBlT0ql8e z*{iOm_2+tsD9v3b>|=O5#59*8s*J30g7{DJxSitcLOL-HGN0!BMmCSxgfFaUCVZG} z^3qA0XJc;f+OAeDs*kW-kJ=GMJNbymT~_dKDroy07ZJQ(gow8$9>%zb=FH@gV=-tg zf>w5hkzxg@L)y32ob;kt}pnm?bnNfIJ-$FrnwPIo%FfBb$1xlK30y#F!w~c zo!1m~LrjywB7EdI1P;{gW9bSDN%p0?Ex|0y)tA=VHcOR@I0$|&5IW!wjbjIZ*=$Sl zjtm{*#uGLeSa=jw!djeP2n*4^mmqlvt^isk|AfMD>onp;uk_SnY$jBu@8hH#BB3I2 z{9t3JlKFlo>yO&Ni$PW#?Bps-*je{tbHf=pdKfOm*XTiZDWb3h(Q4|=xO$V}|7&LX zy9a166n;|M+Y<|}z70<1W_o4EJW$X`Bqj9?QFHEivBOtkBkM*cgh`{vewcCw3HRp& z4ke@41kxKS)&=gVa}GLeoCD~g={q#1c^&`H4qKrB7%dX*0nkOPiQ99!N=gue47T(} z=&$3z8lpaLYCk1W9K!UtNWmOTmlfPF9g;%+D_L3;IVPbZ?H&an@dzvZ*7R>i4|zdh zO7L9*1X|jnHXm>Jyy*834=olkzJr81Pzkfb;kP=ns_6(}YJr#4PVsw+>rQRaqkA-* zNO+79R2#u-9d6%u?OQ`Y$?F+NXu-V!>s!yseob#cAvJsqV}LTHa3nHTzG@If0fSZ? zFOhqDGTv~!Spblb;zNRjfWvZl4uX_qkF_K`Hj)Gs`PF``%~oE^)|-|=YR^-+=*pR} zT76C@>ie(_ySz^P9qpvT~eVlAuKeP4XF96o3nZ1VcU6uwk zucJQvM`H-la#oByW=JU$rf>E5$1z7c{eA(O&Wb$^BEHL2_)sX%vJ6WJy7r>3W^NSHp7%f z!a2Ea7IF{C38p9Uoez8{O+`%wFMV$mvlCi|ms>L)zD4Rtt^i^kF=Iz=q#=ek1ku!H z15W9JX>v`dtR9Rwx?d2DMGFBgmu{<@)>>H`Y(vio8`TLMb6#hv4Q) zk1<3u^fFPJH+|!VIQUm80J12a^99Ax+34ZjRdTe_PAtyqZqCG4L8KLaIy}7lzRQT` zc;V|kn)ZnSlqRGRI$pOKcAD%+%YqGli5(W-I8YV*6oC#ZFFar`kHKWPe;6AL;U3?(_FogVKhToHEV0K&-=b46Om4f!9WU5o zfX2IO8cb{%TRUvJ4Sl>PUKw7=S#mSC>>f^0{bV=YhSpR~djA6H>@N(Qu6Of_NBn?4x-tV_7nOVM+=CiJka5rY!s3PL~X# zpsjJVx~mocd5-3+MJ4d!A{V1|S8#TK54 zI1JmmNoms|%y=k-kza{{OD<$2<1ia885_*Sy>y}qgEfA{xRYKMEH3`)=9HDQusx%4 z^bQA6OWrFod{d459sRswo#*OF&=d8Vfd?__D{E|w{C6ZHSaxAJZ*qAVQz!F|`M`!; z-8}{}82pxq!|9c9Q&+j%bsbUB$lR3!CMm0l%VIf?gnAKzRD#3mZ{_-ym9Wiz`ub|j z51QOyH(My{Qk5aFX=%EZ%QQ@UPlfk7JGyLe9>=Zxd}1(n-*zhzNH-F+CW0?35;Dsu z>&4$oC_$eZT8>}km7)Y|VbHd@2z+N})(m{$mU+Tj)MXiPwO{}$f2@^=54-=E%_h_& z+jPz$ggp~xvxasqrhD}E!$n8JcNN5tEbxgsIWTs zn7EDFJg*rPu&t6&)J4sTD_UDEu=9t|8H!mXsml6Dy)H9;^H`O4QRK#$*4C!x*sMQt zh{QK17(8@NBanAT1{f++jSGo=1XZ5GRReE%Qk$V>Q5X89B_rGE=)83@Yyc!wDtx>P z>wi;rSX}DxeL=RWgA9N`310~FEkwjDNxIW&zL-EVy+oMY??XZFNXO~u(gb?IvI60x z6jlUhdTSdJ*;y(oNa#h*ggvuK1Ho_)EK4|^?&Csy$~avty&%!GuF8&7OSRotSpMe2 zju<#Fh&egf|Aluz0qKpusq~xu*`)F zv=y7N6|N2B?~JXMUPdQ04cm%T?b)M8p4as4*+YBCAy=e6NkrF8t`@O~49=e@qh{RY z)`jvSE$^3nJ)dt9f+%1&u+dg(;=2W`7(PqKMVg#Ww;aXWlPO;;Ag~xnYhmwW@t}jy zGO&aGCRY_DK^)!kFw7nPQyjl+-j%K3#aCA?zr|3PXx`__5LhIOGg{x_Fn?5!U}Wc* zUu2VVWkh#r3Sv+=$)y2Bm#U`1N{$=cce5Y*j-$!*ATrZB*0p|0L{qWDB(T}m@`%V6 z>pFSw4(8Kc8QEhN>eMGQ;}gRXrg`x9`zjT1;L&1wirSZQ%g9MX0>NeuMm;3qdJ;lKWD+D8eI zlHL?h(q`E49*F&mXFeZ|ppRU2l95%MR&kN;7N*$s3ssBH+|3hYQ+nyxReYwM7nv4A z!9BdqF&&$YuEq39Z$O7KCSW?KGs|(OKhS?al*#iZ>-U0gRudL?|FD%b2v6il%PwRd z9#M#l46a)>>&+)VDixh+!jp;0X0}Y(;G!Gdg@XHkT*2qej4e=7@vp z?F^Chi777T(9Ih0h=G>WCInF6tFepJVG)stfLvAsaWQ7h3mD;h86I>(WtavdL>9%9 z7izdYG;1Ho7c6?6YcOqFoS?bt+_ygAhP$#W;MXZ#EZ)+%5o5OkbLN!CwCMcFB4E?+ zi0)~=Om-k<XSiGyaN!mY zvq$mkk9E-Wkn1nda0Hao%s5d@v5U6s?ghbOg`>;PR^*K}(>C~p`%O7$S8(S2LUhci z=pR`t`Inb`1F35|X472KS)a+>$=&0Vt^rv2wUyr}##jxehzJ)8tTky;EOB@&*6Np9d*h4o2%2T5LQw&0Sx;^{wd?#qw5ili4eE0CDMl*6cyRR!H zSToR+PP2D76?Cv3<^DqPJr2#U7A2RWX_!MQn*63XwUCx&(YJlt+l7%jz-z75<6;De zMV7x1yhGR~x*X%uWp!LsfyVv0NHw`tPiWyUh^=5&kTMWSqVeFw9D3LZNh&aa$}7@- zVrDB>+7|q%iGHfmVDqafNSAJqxjTX1vtEOC+ba-P(Vo8p%l!u!E*Pq^@BFJLk$QLd z!s$H11e|%GA<>5|GiZL4)?L*c3K3~KLLi25Q*doj`JW1sO1RuERRo|ah@9&j=vOQv zp_n7xyzLXbu~EgSNlT)ve3V4XBu0YDBAb1n7R|}*rWUQv45g+h3iP+UmCM**^c`e$ z2MyFQqq#e}SOmTCef^Y9eOF#Fv4WUvr8Dg%6<|b(z%zL`ma{o`@LFCCv5G;W5a$H_ zR!#@=VuR~k5_Ah0MxLng4}mC!GW8PVzh&8agS#rHd;TcO@{GZq)e3-$rM(KV@nILZ zCzx+8{xsO|Oog}`j!HlirYWErwCxiyfQ+JjdC6~!1P1o(2}HC@?nA5-c@k#I0r#SQs{XzkAAE z2;R?)*dPkB#xN9AMhP~g&FL%0rSN^ju^9Zu=q=z=g3_eB(1moS#~BqtpnfWs$GI3> zuJqilp)im_slDy;tz2Y<&N0^LO~7&P9cgc#o3Sg}4g`rr3is`}Bo0?HO}qrIN6kuu zmg&Txg(d7|onfyepe=z7N^<9Q$XnF01EX6|g=L!asG6jaRegU~3mr_OEusGvSn@L^ zs?!GjXeu~7(&iw_$ntB^7;pIaS#CKm^lK zf5>A8>79|%^~C@MB%xm?oM{Cb^Eqy?wY7yB=n;GMD4`8?muCB5=E&!O5S*g*vvB({Q^D&7~+0GDp);;5eAe1KztM*=FbQBY6!V5)X(Wwh* zO*v@%SEbE7THqKqHH@2O)7?kCd879h?}ag-YzgjXq3`pLTp#MCtCfX;5Q!@6W-yAs zmw)*qQu)LA71TtV4+p)t+Ao?4T zrHscqG}!(`-3BEN9l(Ir1aqG*so&FI=&v)Z4K}lsGwmj%0}0}~NTWJqys5~25Ab$p zz7n?%j76M8G|yq5!W5^JhiIVR&Y22nCEs}b*-dn6zeK4)tjolDT|LuZy&yVzOezch zE|^4Zgymjv;U(mK^mZ>^i=~)U_^hY+m0*nY_s|LJZA%AT_3oW%@9o-0QTc z4=W&m#EZN-jjR4U`5{gX*L0lmy}1~fg(3>EW%Ohq4noeea8hTQ059q_s6N7ihB%iu zD!=w;R4Mnb`;kgsr7g8%Qk^WbdQMa6nm82luKTF;+&cg%j%X~_O?Oj-ja$#YWqd(zQ^>3PJ)Edu*b5vzIZR%15w3(+SR>tr!YzV&PIYBVx zJ$}^PUS~xyjZo4}!HNOjGm_tVk+{=$*g@yVnUR#<$q_8WH7tzIUI~%1SNyysylP;Wb2eaBCB>JJS>#L5Bor|{@ zS);h>(V`Ei&s%+aIaI#g1*N>d@cE&?TWa9mI=+bfkJJkaz8wU2)x_ivj|fTGY}o&L z!XBf(D}r2#)I4NW6a{C-;jP_Z{babL=%^f}#}qd-eW#Z`!$Xg^=GOp4F~~qsg=kTW z4V%g{gRK%`M#<1_OHkwYc@RM@P!G{Q+?8qzBYdlBe}?Ai6t0u&v#1-l)hY%>q(i>= zvFG_f!flAH-jMIwGIK@p^_9rln1C%O_11XwRcdBwzSfv9S$0RaH7Ay@^DMJEUSye5 zjlq5BtIDLjzmWgw7MS6`IS{=DTwcl$rv2ab>j{}i<=N-$zhm9Q3Z{KDghH!}Ed#8Y zQ5NJQ7&8&I7i1V9H_V>${HZ&Mo1P6>^BdNisrcuP>DLS@>2ffH6ldUQ+1@$~T8dYB zsD0m=<1n74sg9tT?={0s#XU|bb&um_3s7d19etZN08mN$Iq}}$cl8;km$$3gc5s-L z^vNG+3(8`D@3jWOs1!`CibOTbP5W4+Q@r)+#{!?CypG?=JMfE(?tLGO-(eAKqPw(G zlAwErmAcVH=KLk^hl3>#iHDE}5Bc-KNAT@K5ny?NIyTYOELN~}DxJtjW>sLHXt>5f=rqjF zoIJyb$eC_5-G%m`%u~f2P_C!*lzV)qDawe}B2-K1H4Iq?TkVPvM=5%5$tos5C8+Gu zFPQ?6po0*l)L_AslA}Mx6ds8Q!>{BjIvHY$9oeh=ugOiBqzd`bhqHGi|bvzZ0EA>Z`Sg^XPUPk|P z!gTbh3*m)9aIyThBY->7@ar2b==K9vC(E~iCyMTzl=1P~m;*zb`RdbRvcHyXfAWlbK6Pz zUxKWCP|xh8{FG1x^LocEc-bQ2rkbpzXnCOWN`mw+1iJHduc*x@vz;f5Z>?l-^&p{< z4tvSRtFEzeoFBk6P?D}lwsORaX(7@xisLn0m5X*J!Lsj4cX_uRc?6fiL0FYN*bTF+-f4#Yf& z%QO#AyHjWi8&v?QzY1Zw{RsZ?sJ)EdJp)28h9!K2^omRi!YUw(Z_%Ix8+q)S&_^P)DxC%aih z>ExGk+a9r2u`AdCj~t~C+rmcY?qz=pX0_z-&}IB~<<0pW4N2!QTl7`Vl24L3pe^p` z;f7{?F?@!lfuAXB1;Wg7ahQ(auC5xcz{79w{q!>d=KZOh-Cu^NMk+m%^24BMLa&r-Hoh!@Sgb^RJmiV(wC-; z@UOM5J`*4=6D$Jrai#R^$t0iiwDu9)(Ca8^8Tlu+hgLb7+u5Ki%|+R`{I{Z~3Ry~9 zyN!!q(TyBPcEsEe2_Iz?*{w;JsSx0CbI2FQ0K zh$P)Poei!*XMFP}?}_epflJUSGk2$rPsmdr#yHE`^zU|slVj%?n$~&fJZ6vmdV{Vm z#GiPUDA>W7hoYce`FqGZ3kdvhd37PRvOFXCwK~tN57o=_tzB0N=^$0!Ot~X#_dD^N z|Fa;>iAYKwnkMpz*8(1>gx87I#Sp*TG81=*Mk+ro{LI<{X^{Im{df}Ml)dYU zTx!3pQ6A+wj5Oi+MPy5dyOOqmEfhXwV-83Km?vvvSQ6oLqARSd6xel2M^)EIf+-HTJ* zOx4VQQK;@LCO>5)_@fx2fzgiKP8FLjm9hfPD(y437TPBK^xzm8$Fy~N;Vt5}LTTL+ zX-2qbUnQXRNWQe|1mc7f1%!l!=;QZH!+vX3>n2_^$~qod`uGZw`S%Zu)eT!KxhVYU?Nd4<-ARq4r4BmpQQ=i7PkPL;;EVI` z84aBr0SFv{7?N{v$H}<$Q{Fo#HVO;PruCcFCi;w>W2U!d8PWsK2=AbJx4V-9s5%|v zRv*=Dq5Mq{X` z&Ii%Uzc!=OL}+bmKwoTWVTVv%a%I1l4M<$GH?R33`tW~eL{Kz2Y_r+zLEolnZY zud!vNt_c_`<}k@9^#}0bCm?l57totn#pu(|;GKNFuSKvy*H8N+YyibZ$da+>M$HgX zV?Az)c$3|TRiW8pIGAdYbQ}g0XjdMPrd%2o z_3ijDQuK>lhh-pu7T=+*)K^ll8Z-aH^5MkUvgF;IC}3o{xu-ExPyduPA&E)PXPT9~YB#PblZe~x?pgkG|%(;nt+7Z0mI7N}snH;Nso zH%BYU-DZq(;0&E4w~kF-Dx7*Z2@Q}|u#5Czq7>%h%L)_t!BRttgh#Exf7e&40r@-g z+s#(8!q_zvfr`>T24(P%t2QigKa>XaV9g>s(r>npAvc@ZP49C?qiG1D?v4uF7gcYH zj4k!qBkd;s|7i?^rJ`qpA9!L)B|>Rw^~eQ#rKU(xq#tVGzmXdsxlb3^JqZ8%JIF$7YKDz{7mfLcJ;mEs@abo%Fb=c))6Qlz z($!%1KUy-dFe*vxGL0Sx@+gNhB8-8GEi%SFEY2PL!*fXDN7E{G*4oX@Uo(!vFRbW< za6P`HHb?6v>{5keNa_xgI|>nBh|ffj;2#s<3X>OvD`qZ@jk3Ag(u~<0=0`J3)NWM= zolfXv@6+}ACI`eirWUEHTH?}b2EU6C*e1cz#_U-HAewFh{^;&M_aJgg;gZmnAa?Mk zi2^5EZvTD!PzJ&yBz@}F1=2%648%i1C<7s(up$1Bi}C;N{f~?B|Hc2`)2IxDh5Mg5 Q$p1p(zdZEcZU~6~1q&zY{{R30 literal 0 HcmV?d00001 diff --git a/javadoc/latest/index.html b/javadoc/latest/index.html index 61bcd682516..58127737b77 100644 --- a/javadoc/latest/index.html +++ b/javadoc/latest/index.html @@ -1,4 +1,4 @@ Redirecting to latest javadocs - +