Allow getting to metadata from a region object. Small method renames for consistency.

millems · millems · commit 08d55a4159d8 · 2018-11-16T16:12:15.000-08:00
diff --git a/codegen-lite-maven-plugin/src/main/java/software/amazon/awssdk/codegen/lite/maven/plugin/RegionGenerationMojo.java b/codegen-lite-maven-plugin/src/main/java/software/amazon/awssdk/codegen/lite/maven/plugin/RegionGenerationMojo.java
@@ -77,7 +77,7 @@ public void execute() throws MojoExecutionException {
 
     public void generatePartitionMetadataClass(Path baseSourcesDirectory, Partitions partitions) {
         Path sourcesDirectory = baseSourcesDirectory.resolve(PARTITION_METADATA_BASE.replace(".", "/"));
-        partitions.getPartitions().stream()
+        partitions.getPartitions()
                   .forEach(p -> new CodeGenerator(sourcesDirectory.toString(),
                                                   new PartitionMetadataGenerator(p,
                                                                                  PARTITION_METADATA_BASE,
@@ -104,7 +104,6 @@ public void generateServiceMetadata(Path baseSourcesDirectory, Partitions partit
     public void generateRegions(Path baseSourcesDirectory, Partitions partitions) {
         Path sourcesDirectory = baseSourcesDirectory.resolve(REGION_METADATA_BASE.replace(".", "/"));
         partitions.getPartitions()
-                  .stream()
                   .forEach(p -> p.getRegions().forEach((k, v) ->
                                                            new CodeGenerator(sourcesDirectory.toString(),
                                                                              new RegionMetadataGenerator(p,
diff --git a/codegen-lite/src/main/java/software/amazon/awssdk/codegen/lite/regions/PartitionMetadataGenerator.java b/codegen-lite/src/main/java/software/amazon/awssdk/codegen/lite/regions/PartitionMetadataGenerator.java
@@ -71,7 +71,7 @@ public TypeSpec poetClass() {
                                           .addModifiers(PRIVATE, FINAL, STATIC)
                                           .initializer("$S", partition.getPartition())
                                           .build())
-                       .addField(FieldSpec.builder(String.class, "PARTITION_NAME")
+                       .addField(FieldSpec.builder(String.class, "NAME")
                                           .addModifiers(PRIVATE, FINAL, STATIC)
                                           .initializer("$S", partition.getPartitionName())
                                           .build())
@@ -82,7 +82,7 @@ public TypeSpec poetClass() {
                        .addMethod(getter("dnsSuffix", "DNS_SUFFIX"))
                        .addMethod(getter("hostname", "HOSTNAME"))
                        .addMethod(getter("id", "ID"))
-                       .addMethod(getter("partitionName", "PARTITION_NAME"))
+                       .addMethod(getter("name", "NAME"))
                        .addMethod(getter("regionRegex", "REGION_REGEX"))
                        .build();
     }
diff --git a/codegen-lite/src/main/java/software/amazon/awssdk/codegen/lite/regions/RegionGenerator.java b/codegen-lite/src/main/java/software/amazon/awssdk/codegen/lite/regions/RegionGenerator.java
@@ -80,8 +80,9 @@ public TypeSpec poetClass() {
                                   .build())
                .addMethod(regionOf())
                .addMethod(regionOfGlobal())
-               .addMethod(id())
                .addMethod(regionsGetter())
+               .addMethod(id())
+               .addMethod(metadata())
                .addMethod(isGlobalRegion())
                .addMethod(regionToString());
 
@@ -165,6 +166,15 @@ private MethodSpec id() {
                          .build();
     }
 
+    private MethodSpec metadata() {
+        ClassName regionMetadataClass = ClassName.get("software.amazon.awssdk.regions", "RegionMetadata");
+        return MethodSpec.methodBuilder("metadata")
+                         .addModifiers(PUBLIC)
+                         .returns(regionMetadataClass)
+                         .addStatement("return $T.of(this)", regionMetadataClass)
+                         .build();
+    }
+
     private MethodSpec regionsGetter() {
         return MethodSpec.methodBuilder("regions")
                          .addModifiers(PUBLIC, STATIC)
diff --git a/codegen-lite/src/main/java/software/amazon/awssdk/codegen/lite/regions/RegionMetadataGenerator.java b/codegen-lite/src/main/java/software/amazon/awssdk/codegen/lite/regions/RegionMetadataGenerator.java
@@ -64,40 +64,45 @@ public TypeSpec poetClass() {
                        .addAnnotation(SdkPublicApi.class)
                        .addModifiers(FINAL)
                        .addSuperinterface(ClassName.get(regionBasePackage, "RegionMetadata"))
-                       .addField(FieldSpec.builder(String.class, "NAME")
-                                          .addModifiers(PRIVATE, FINAL, STATIC)
-                                          .initializer("$S", region)
-                                          .build())
-                       .addField(FieldSpec.builder(String.class, "DOMAIN")
-                                          .addModifiers(PRIVATE, FINAL, STATIC)
-                                          .initializer("$S", partition.getDnsSuffix())
-                                          .build())
-                       .addField(FieldSpec.builder(String.class, "DESCRIPTION")
-                                          .addModifiers(PRIVATE, FINAL, STATIC)
-                                          .initializer("$S", regionDescription)
-                                          .build())
-                       .addField(FieldSpec.builder(String.class, "PARTITION")
-                                          .addModifiers(PRIVATE, FINAL, STATIC)
-                                          .initializer("$S", partition.getPartition())
-                                          .build())
-                       .addMethod(getter("name"))
-                       .addMethod(getter("domain"))
-                       .addMethod(getter("description"))
-                       .addMethod(getter("partition"))
+                       .addField(staticFinalField("ID", region))
+                       .addField(staticFinalField("DOMAIN", partition.getDnsSuffix()))
+                       .addField(staticFinalField("DESCRIPTION", regionDescription))
+                       .addField(staticFinalField("PARTITION_ID", partition.getPartition()))
+                       .addMethod(getter("id", "ID"))
+                       .addMethod(getter("domain", "DOMAIN"))
+                       .addMethod(getter("description", "DESCRIPTION"))
+                       .addMethod(partition())
                        .build();
     }
 
+    private MethodSpec partition() {
+        ClassName regionMetadataClass = ClassName.get("software.amazon.awssdk.regions", "PartitionMetadata");
+        return MethodSpec.methodBuilder("partition")
+                         .addAnnotation(Override.class)
+                         .addModifiers(Modifier.PUBLIC)
+                         .returns(regionMetadataClass)
+                         .addStatement("return $T.of(PARTITION_ID)", regionMetadataClass)
+                         .build();
+    }
+
     @Override
     public ClassName className() {
         return ClassName.get(basePackage, Stream.of(region.split("-")).map(Utils::capitalize).collect(Collectors.joining()));
     }
 
-    private MethodSpec getter(String field) {
-        return MethodSpec.methodBuilder(field)
+    private FieldSpec staticFinalField(String fieldName, String fieldValue) {
+        return FieldSpec.builder(String.class, fieldName)
+                        .addModifiers(PRIVATE, FINAL, STATIC)
+                        .initializer("$S", fieldValue)
+                        .build();
+    }
+
+    private MethodSpec getter(String getterName, String fieldName) {
+        return MethodSpec.methodBuilder(getterName)
                          .addAnnotation(Override.class)
                          .addModifiers(Modifier.PUBLIC)
                          .returns(String.class)
-                         .addStatement("return $L", field.toUpperCase(Locale.US))
+                         .addStatement("return $L", fieldName.toUpperCase(Locale.US))
                          .build();
     }
 }
diff --git a/codegen-lite/src/test/resources/software/amazon/awssdk/codegen/lite/regions/partition-metadata.java b/codegen-lite/src/test/resources/software/amazon/awssdk/codegen/lite/regions/partition-metadata.java
@@ -13,7 +13,7 @@ public final class AwsPartitionMetadata implements PartitionMetadata {
 
     private static final String ID = "aws";
 
-    private static final String PARTITION_NAME = "AWS Standard";
+    private static final String NAME = "AWS Standard";
 
     private static final String REGION_REGEX = "^(us|eu|ap|sa|ca)\\-\\w+\\-\\d+$";
 
@@ -33,8 +33,8 @@ public String id() {
     }
 
     @Override
-    public String partitionName() {
-        return PARTITION_NAME;
+    public String name() {
+        return NAME;
     }
 
     @Override
diff --git a/codegen-lite/src/test/resources/software/amazon/awssdk/codegen/lite/regions/regions.java b/codegen-lite/src/test/resources/software/amazon/awssdk/codegen/lite/regions/regions.java
@@ -100,12 +100,16 @@ private static Region of(String value, boolean isGlobalRegion) {
         return RegionCache.put(value, isGlobalRegion);
     }
 
+    public static List<Region> regions() {
+        return REGIONS;
+    }
+
     public String id() {
         return this.id;
     }
 
-    public static List<Region> regions() {
-        return REGIONS;
+    public RegionMetadata metadata() {
+        return RegionMetadata.of(this);
     }
 
     public boolean isGlobalRegion() {
diff --git a/codegen-lite/src/test/resources/software/amazon/awssdk/codegen/lite/regions/us-east-1.java b/codegen-lite/src/test/resources/software/amazon/awssdk/codegen/lite/regions/us-east-1.java
@@ -2,22 +2,23 @@
 
 import software.amazon.awssdk.annotations.Generated;
 import software.amazon.awssdk.annotations.SdkPublicApi;
+import software.amazon.awssdk.regions.PartitionMetadata;
 import software.amazon.awssdk.regions.RegionMetadata;
 
 @Generated("software.amazon.awssdk:codegen")
 @SdkPublicApi
 public final class UsEast1 implements RegionMetadata {
-    private static final String NAME = "us-east-1";
+    private static final String ID = "us-east-1";
 
     private static final String DOMAIN = "amazonaws.com";
 
     private static final String DESCRIPTION = "US East (N. Virginia)";
 
-    private static final String PARTITION = "aws";
+    private static final String PARTITION_ID = "aws";
 
     @Override
-    public String name() {
-        return NAME;
+    public String id() {
+        return ID;
     }
 
     @Override
@@ -31,7 +32,7 @@ public String description() {
     }
 
     @Override
-    public String partition() {
-        return PARTITION;
+    public PartitionMetadata partition() {
+        return PartitionMetadata.of(PARTITION_ID);
     }
 }
diff --git a/core/regions/src/main/java/software/amazon/awssdk/regions/PartitionMetadata.java b/core/regions/src/main/java/software/amazon/awssdk/regions/PartitionMetadata.java
@@ -52,7 +52,7 @@ public interface PartitionMetadata {
      *
      * @return The name of this partition
      */
-    String partitionName();
+    String name();
 
     /**
      * Returns the region regex used for pattern matching for this partition.
diff --git a/core/regions/src/main/java/software/amazon/awssdk/regions/RegionMetadata.java b/core/regions/src/main/java/software/amazon/awssdk/regions/RegionMetadata.java
@@ -28,7 +28,7 @@ public interface RegionMetadata {
      *
      * @return The unique system ID for this region.
      */
-    String name();
+    String id();
 
     /**
      * Returns the domain for this region; ex: &quot;amazonaws.com&quot;.
@@ -38,11 +38,9 @@ public interface RegionMetadata {
     String domain();
 
     /**
-     * Returns the partition this region is in. I.E. 'aws' or 'aws-cn'
-     *
-     * @return The partition this region is in.
+     * Returns the metadata for this region's partition.
      */
-    String partition();
+    PartitionMetadata partition();
 
     /**
      * Returns the description of this region; ex: &quot;US East (N. Virginia)&quot;.
diff --git a/services/s3/src/main/java/software/amazon/awssdk/services/s3/internal/handlers/EndpointAddressInterceptor.java b/services/s3/src/main/java/software/amazon/awssdk/services/s3/internal/handlers/EndpointAddressInterceptor.java
@@ -92,7 +92,7 @@ private URI resolveEndpoint(SdkHttpFullRequest request,
     }
 
     private static URI dualstackEndpoint(RegionMetadata metadata, String protocol) {
-        String serviceEndpoint = String.format("%s.%s.%s.%s", "s3", "dualstack", metadata.name(), metadata.domain());
+        String serviceEndpoint = String.format("%s.%s.%s.%s", "s3", "dualstack", metadata.id(), metadata.domain());
         return toUri(protocol, serviceEndpoint);
     }
 

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ public final class AwsPartitionMetadata implements PartitionMetadata {`
`13`	`13`
`14`	`14`	`private static final String ID = "aws";`
`15`	`15`
`16`		`- private static final String PARTITION_NAME = "AWS Standard";`
	`16`	`+ private static final String NAME = "AWS Standard";`
`17`	`17`
`18`	`18`	`private static final String REGION_REGEX = "^(us\|eu\|ap\|sa\|ca)\\-\\w+\\-\\d+$";`
`19`	`19`
`@@ -33,8 +33,8 @@ public String id() {`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`@Override`
`36`		`- public String partitionName() {`
`37`		`- return PARTITION_NAME;`
	`36`	`+ public String name() {`
	`37`	`+ return NAME;`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -100,12 +100,16 @@ private static Region of(String value, boolean isGlobalRegion) {`
`100`	`100`	`return RegionCache.put(value, isGlobalRegion);`
`101`	`101`	`}`
`102`	`102`
	`103`	`+ public static List<Region> regions() {`
	`104`	`+ return REGIONS;`
	`105`	`+ }`
	`106`	`+`
`103`	`107`	`public String id() {`
`104`	`108`	`return this.id;`
`105`	`109`	`}`
`106`	`110`
`107`		`- public static List<Region> regions() {`
`108`		`- return REGIONS;`
	`111`	`+ public RegionMetadata metadata() {`
	`112`	`+ return RegionMetadata.of(this);`
`109`	`113`	`}`
`110`	`114`
`111`	`115`	`public boolean isGlobalRegion() {`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ public interface PartitionMetadata {`
`52`	`52`	`*`
`53`	`53`	`* @return The name of this partition`
`54`	`54`	`*/`
`55`		`- String partitionName();`
	`55`	`+ String name();`
`56`	`56`
`57`	`57`	`/**`
`58`	`58`	`* Returns the region regex used for pattern matching for this partition.`
Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,7 @@ private URI resolveEndpoint(SdkHttpFullRequest request,`
`92`	`92`	`}`
`93`	`93`
`94`	`94`	`private static URI dualstackEndpoint(RegionMetadata metadata, String protocol) {`
`95`		`- String serviceEndpoint = String.format("%s.%s.%s.%s", "s3", "dualstack", metadata.name(), metadata.domain());`
	`95`	`+ String serviceEndpoint = String.format("%s.%s.%s.%s", "s3", "dualstack", metadata.id(), metadata.domain());`
`96`	`96`	`return toUri(protocol, serviceEndpoint);`
`97`	`97`	`}`
`98`	`98`