Class DefaultNamingStrategy

java.lang.Object
software.amazon.awssdk.codegen.naming.DefaultNamingStrategy
All Implemented Interfaces:
NamingStrategy
public class DefaultNamingStrategy extends Object implements NamingStrategy
Default implementation of naming strategy respecting.

  • Constructor Details

  • Method Details

    • getServiceName

      public String getServiceName()
      Description copied from interface: NamingStrategy
      Retrieve the service name that should be used based on the model.
      Specified by:
      getServiceName in interface NamingStrategy

    • getServiceNameForEnvironmentVariables

      public String getServiceNameForEnvironmentVariables()
      Description copied from interface: NamingStrategy
      Retrieve the service name that should be used for environment variables.
      Specified by:
      getServiceNameForEnvironmentVariables in interface NamingStrategy

    • getServiceNameForSystemProperties

      public String getServiceNameForSystemProperties()
      Description copied from interface: NamingStrategy
      Retrieve the service name that should be used for system properties.
      Specified by:
      getServiceNameForSystemProperties in interface NamingStrategy

    • getServiceNameForProfileFile

      public String getServiceNameForProfileFile()
      Description copied from interface: NamingStrategy
      Retrieve the service name that should be used for profile properties.
      Specified by:
      getServiceNameForProfileFile in interface NamingStrategy

    • getClientPackageName

      public String getClientPackageName(String serviceName)
      Description copied from interface: NamingStrategy
      Retrieve the client package name that should be used based on the service name.
      Specified by:
      getClientPackageName in interface NamingStrategy

    • getModelPackageName

      public String getModelPackageName(String serviceName)
      Description copied from interface: NamingStrategy
      Retrieve the model package name that should be used based on the service name.
      Specified by:
      getModelPackageName in interface NamingStrategy

    • getTransformPackageName

      public String getTransformPackageName(String serviceName)
      Description copied from interface: NamingStrategy
      Retrieve the transform package name that should be used based on the service name.
      Specified by:
      getTransformPackageName in interface NamingStrategy

    • getRequestTransformPackageName

      public String getRequestTransformPackageName(String serviceName)
      Description copied from interface: NamingStrategy
      Retrieve the request transform package name that should be used based on the service name.
      Specified by:
      getRequestTransformPackageName in interface NamingStrategy

    • getPaginatorsPackageName

      public String getPaginatorsPackageName(String serviceName)
      Description copied from interface: NamingStrategy
      Retrieve the paginators package name that should be used based on the service name.
      Specified by:
      getPaginatorsPackageName in interface NamingStrategy

    • getWaitersPackageName

      public String getWaitersPackageName(String serviceName)
      Description copied from interface: NamingStrategy
      Retrieve the waiters package name that should be used based on the service name.
      Specified by:
      getWaitersPackageName in interface NamingStrategy

    • getEndpointRulesPackageName

      public String getEndpointRulesPackageName(String serviceName)
      Description copied from interface: NamingStrategy
      Retrieve the endpoint rules package name that should be used based on the service name.
      Specified by:
      getEndpointRulesPackageName in interface NamingStrategy

    • getAuthSchemePackageName

      public String getAuthSchemePackageName(String serviceName)
      Description copied from interface: NamingStrategy
      Retrieve the auth scheme package name that should be used based on the service name.
      Specified by:
      getAuthSchemePackageName in interface NamingStrategy

    • getJmesPathPackageName

      public String getJmesPathPackageName(String serviceName)
      Description copied from interface: NamingStrategy
      Retrieve the path runtime package name that should be used based on the service name.
      Specified by:
      getJmesPathPackageName in interface NamingStrategy

    • getBatchManagerPackageName

      public String getBatchManagerPackageName(String serviceName)
      Description copied from interface: NamingStrategy
      Retrieve the batchManager package name that should be used based on the service name.
      Specified by:
      getBatchManagerPackageName in interface NamingStrategy

    • getSmokeTestPackageName

      public String getSmokeTestPackageName(String serviceName)
      Description copied from interface: NamingStrategy
      Retrieve the smote test package name that should be used based on the service name.
      Specified by:
      getSmokeTestPackageName in interface NamingStrategy

    • getExceptionName

      public String getExceptionName(String errorShapeName)
      Specified by:
      getExceptionName in interface NamingStrategy
      Parameters:
      errorShapeName - Name of error shape to derive exception class name from.
      Returns:
      Appropriate name to use for a Java exception class name

    • getRequestClassName

      public String getRequestClassName(String operationName)
      Specified by:
      getRequestClassName in interface NamingStrategy
      Parameters:
      operationName - Name of operation used to derive request class name.
      Returns:
      Appropriate name to use for the Java class representing the request shape.

    • getResponseClassName

      public String getResponseClassName(String operationName)
      Specified by:
      getResponseClassName in interface NamingStrategy
      Parameters:
      operationName - Name of operation used to derive response class name.
      Returns:
      Appropriate name to use for the Java class representing the response shape.

    • getVariableName

      public String getVariableName(String name)
      Specified by:
      getVariableName in interface NamingStrategy
      Parameters:
      name - Some contextual name to derive variable name from (i.e. member name, java class name, etc).
      Returns:
      Appropriate name to use for a Java variable or field.

    • getEnumValueName

      public String getEnumValueName(String enumValue)
      Specified by:
      getEnumValueName in interface NamingStrategy
      Parameters:
      enumValue - Enum value as defined in the service model used to derive the java name.
      Returns:
      Appropriate name to use for a Java enum value

    • getShapeClassName

      public String getShapeClassName(String shapeName)
      Specified by:
      getShapeClassName in interface NamingStrategy
      Parameters:
      shapeName - Name of structure used to derive Java class name.
      Returns:
      Appropriate name to use for a Java class for an arbitrary (not a request, response, error) structure.

    • getFluentGetterMethodName

      public String getFluentGetterMethodName(String memberName, Shape parentShape, Shape shape)
      Specified by:
      getFluentGetterMethodName in interface NamingStrategy
      Parameters:
      memberName - Member name to name getter for.
      shape - The shape associated with the member.
      Returns:
      Name of the getter method for a model class member.

    • getFluentEnumGetterMethodName

      public String getFluentEnumGetterMethodName(String memberName, Shape parentShape, Shape shape)
      Specified by:
      getFluentEnumGetterMethodName in interface NamingStrategy
      Parameters:
      memberName - The full member to get the name for.
      shape - The shape associated with the member.
      Returns:
      Name of the getter method for an enum model class member.

    • getExistenceCheckMethodName

      public String getExistenceCheckMethodName(String memberName, Shape parentShape)
      Description copied from interface: NamingStrategy
      Names a method that would check for existence of the member in the response.
      Specified by:
      getExistenceCheckMethodName in interface NamingStrategy
      Parameters:
      memberName - The member name to get the method name for.
      parentShape - The shape containing the member.
      Returns:
      Name of an existence check method.

    • getBeanStyleGetterMethodName

      public String getBeanStyleGetterMethodName(String memberName, Shape parentShape, Shape c2jShape)
      Specified by:
      getBeanStyleGetterMethodName in interface NamingStrategy
      Parameters:
      memberName - Member name to name getter for.
      Returns:
      Name of the JavaBean getter method for model class member.

    • getBeanStyleSetterMethodName

      public String getBeanStyleSetterMethodName(String memberName, Shape parentShape, Shape c2jShape)
      Specified by:
      getBeanStyleSetterMethodName in interface NamingStrategy
      Parameters:
      memberName - Member name to name setter for.
      Returns:
      Name of the JavaBean setter method for model class member.

    • getFluentSetterMethodName

      public String getFluentSetterMethodName(String memberName, Shape parentShape, Shape shape)
      Specified by:
      getFluentSetterMethodName in interface NamingStrategy
      Parameters:
      memberName - Member name to name fluent setter for.
      Returns:
      Appropriate name to use for fluent setter method (i.e. withFoo) for a model class member.

    • getFluentEnumSetterMethodName

      public String getFluentEnumSetterMethodName(String memberName, Shape parentShape, Shape shape)
      Specified by:
      getFluentEnumSetterMethodName in interface NamingStrategy
      Parameters:
      memberName - The full member to get the name for.
      shape - The shape associated with the member.
      Returns:
      Name of the getter method for an enum model class member.

    • getSdkFieldFieldName

      public String getSdkFieldFieldName(MemberModel memberModel)
      Description copied from interface: NamingStrategy
      Stuttering is intentional, returns the name of the SdkField field.
      Specified by:
      getSdkFieldFieldName in interface NamingStrategy
      Parameters:
      memberModel - Member to generate field name for.
      Returns:
      Name of field for SdkField pojo.

    • getUnionEnumTypeName

      public String getUnionEnumTypeName(MemberModel memberModel)
      Description copied from interface: NamingStrategy
      Returns the name of the provided member as if it will be included in an enum (as in, when the parent shape is a union and we need to create an enum with each member name in it).
      Specified by:
      getUnionEnumTypeName in interface NamingStrategy
      Parameters:
      memberModel - Member to generate the union enum type name for.

    • getSigningName

      public String getSigningName()
      Description copied from interface: NamingStrategy
      Retrieve the service's signing name that should be used based on the model.
      Specified by:
      getSigningName in interface NamingStrategy

    • getSigningNameForEnvironmentVariables

      public String getSigningNameForEnvironmentVariables()
      Description copied from interface: NamingStrategy
      Retrieve the service's signing name that should be used for environment variables.
      Specified by:
      getSigningNameForEnvironmentVariables in interface NamingStrategy

    • getSigningNameForSystemProperties

      public String getSigningNameForSystemProperties()
      Description copied from interface: NamingStrategy
      Retrieve the service's signing name that should be used for system properties.
      Specified by:
      getSigningNameForSystemProperties in interface NamingStrategy

    • validateCustomerVisibleNaming

      public void validateCustomerVisibleNaming(IntermediateModel trimmedModel)
      Description copied from interface: NamingStrategy
      Verify the customer-visible naming in the provided intermediate model will compile and is idiomatic to Java.
      Specified by:
      validateCustomerVisibleNaming in interface NamingStrategy