add accessors to scoped metadata

ClusterlessHQ · Oct 20, 2023 · f5a02b0 · f5a02b0
1 parent 00e6eb5
commit f5a02b0
Show file tree

Hide file tree

Showing 2 changed files with 53 additions and 0 deletions.
diff --git a/...mmons-aws/src/main/java/clusterless/commons/substrate/aws/cdk/scoped/ScopedConstruct.java b/...mmons-aws/src/main/java/clusterless/commons/substrate/aws/cdk/scoped/ScopedConstruct.java
@@ -8,7 +8,10 @@
 
 package clusterless.commons.substrate.aws.cdk.scoped;
 
+import clusterless.commons.naming.Label;
 import clusterless.commons.naming.Ref;
+import clusterless.commons.naming.Stage;
+import clusterless.commons.naming.Version;
 import clusterless.commons.substrate.aws.cdk.naming.ArnRefs;
 import org.jetbrains.annotations.NotNull;
 import software.constructs.Construct;
@@ -25,6 +28,33 @@ public ScopedConstruct(@NotNull Construct scope, @NotNull String id) {
         super(scope, id);
     }
 
+    /**
+     * The {@link Stage} of the {@link ScopedApp} that this construct is scoped to.
+     *
+     * @return the {@link Stage} of the {@link ScopedApp} that this construct is scoped to.
+     */
+    protected Stage stage() {
+        return ScopedApp.scopedOf(this).stage();
+    }
+
+    /**
+     * The name of the {@link ScopedApp} that this construct is scoped to.
+     *
+     * @return the name of the {@link ScopedApp} that this construct is scoped to.
+     */
+    protected Label scopedName() {
+        return ScopedApp.scopedOf(this).name();
+    }
+
+    /**
+     * The version of the {@link ScopedApp} that this construct is scoped to.
+     *
+     * @return the version of the {@link ScopedApp} that this construct is scoped to.
+     */
+    protected Version scopedVersion() {
+        return ScopedApp.scopedOf(this).version();
+    }
+
     protected void addArnRefFor(Ref ref, Construct construct, String value, String description) {
         ScopedStack.scopedOf(this)
                 .addArnRef(ref, construct, value, description);

diff --git a/...s-commons-aws/src/main/java/clusterless/commons/substrate/aws/cdk/scoped/ScopedStack.java b/...s-commons-aws/src/main/java/clusterless/commons/substrate/aws/cdk/scoped/ScopedStack.java
@@ -54,10 +54,33 @@ public ScopedStack(@NotNull ScopedApp app) {
         stage = app.stage();
     }
 
+    /**
+     * The {@link Stage} of the {@link ScopedApp} that this construct is scoped to.
+     *
+     * @return the {@link Stage} of the {@link ScopedApp} that this construct is scoped to.
+     */
     public Stage stage() {
         return stage;
     }
 
+    /**
+     * The name of the {@link ScopedApp} that this construct is scoped to.
+     *
+     * @return the name of the {@link ScopedApp} that this construct is scoped to.
+     */
+    protected Label scopedName() {
+        return ScopedApp.scopedOf(this).name();
+    }
+
+    /**
+     * The version of the {@link ScopedApp} that this construct is scoped to.
+     *
+     * @return the version of the {@link ScopedApp} that this construct is scoped to.
+     */
+    protected Version scopedVersion() {
+        return ScopedApp.scopedOf(this).version();
+    }
+
     protected void addNameRefFor(Ref ref, String value, String description) {
         addNameRefFor(ref, null, value, description);
     }