software.amazon.awscdk.Construct Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cdk Show documentation
AWS Cloud Development Kit Core Library
There is a newer version: 0.36.1
package software.amazon.awscdk;

/**
 * Represents the building block of the construct graph.
 * 
 * All constructs besides the root construct must be created within the scope of
 * another construct.
 */
@javax.annotation.Generated(value = "jsii-pacmak/0.10.5 (build 46bc9b0)", date = "2019-05-06T20:49:40.942Z")
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.$Module.class, fqn = "@aws-cdk/cdk.Construct")
public class Construct extends software.amazon.jsii.JsiiObject implements software.amazon.awscdk.IConstruct {
    protected Construct(final software.amazon.jsii.JsiiObject.InitializationMode mode) {
        super(mode);
    }
    /**
     * Creates a new construct node.
     * 
     * @param scope The scope in which to define this construct.
     * @param id The scoped construct ID.
     */
    public Construct(final software.amazon.awscdk.Construct scope, final java.lang.String id) {
        super(software.amazon.jsii.JsiiObject.InitializationMode.Jsii);
        software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(scope, "scope is required"), java.util.Objects.requireNonNull(id, "id is required") });
    }

    /**
     * Return whether the given object is a Construct.
     */
    public static java.lang.Boolean isConstruct(final software.amazon.awscdk.IConstruct x) {
        return software.amazon.jsii.JsiiObject.jsiiStaticCall(software.amazon.awscdk.Construct.class, "isConstruct", java.lang.Boolean.class, new Object[] { java.util.Objects.requireNonNull(x, "x is required") });
    }

    /**
     * Perform final modifications before synthesis.
     * 
     * This method can be implemented by derived constructs in order to perform
     * final changes before synthesis. prepare() will be called after child
     * constructs have been prepared.
     * 
     * This is an advanced framework feature. Only use this if you
     * understand the implications.
     */
    protected void prepare() {
        this.jsiiCall("prepare", Void.class);
    }

    /**
     * Returns a string representation of this construct.
     */
    public java.lang.String toString() {
        return this.jsiiCall("toString", java.lang.String.class);
    }

    /**
     * Validate the current construct.
     * 
     * This method can be implemented by derived constructs in order to perform
     * validation logic. It is called on all constructs before synthesis.
     * 
     * @return An array of validation error messages, or an empty array if there the construct is valid.
     */
    protected java.util.List validate() {
        return this.jsiiCall("validate", java.util.List.class);
    }

    /**
     * The set of constructs that form the root of this dependable.
     * 
     * All resources under all returned constructs are included in the ordering
     * dependency.
     */
    @Override
    public java.util.List getDependencyRoots() {
        return this.jsiiGet("dependencyRoots", java.util.List.class);
    }

    /**
     * Construct node.
     */
    @Override
    public software.amazon.awscdk.ConstructNode getNode() {
        return this.jsiiGet("node", software.amazon.awscdk.ConstructNode.class);
    }
}