Class Dependable

  • All Implemented Interfaces:
    software.amazon.jsii.JsiiSerializable

    @Generated(value="jsii-pacmak/1.53.0 (build c071d26)",
               date="2022-02-12T00:09:13.300Z")
    @Stability(Experimental)
    public abstract class Dependable
    extends software.amazon.jsii.JsiiObject
    (experimental) Trait for IDependable.

    Traits are interfaces that are privately implemented by objects. Instead of showing up in the public interface of a class, they need to be queried explicitly. This is used to implement certain framework features that are not intended to be used by Construct consumers, and so should be hidden from accidental use.

    Example:

     // Usage
     const roots = DependableTrait.get(construct).dependencyRoots;
     // Definition
     DependableTrait.implement(construct, {
       get dependencyRoots() { return []; }
     });
     
    • Constructor Detail

      • Dependable

        protected Dependable​(software.amazon.jsii.JsiiObjectRef objRef)
      • Dependable

        protected Dependable​(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
      • Dependable

        @Stability(Stable)
        protected Dependable()
    • Method Detail

      • get

        @Stability(Deprecated)
        @Deprecated
        @NotNull
        public static Dependable get​(@NotNull
                                     IDependable instance)
        Deprecated.
        use `of`
        (deprecated) Return the matching Dependable for the given class instance.

        Parameters:
        instance - This parameter is required.
      • implement

        @Stability(Experimental)
        public static void implement​(@NotNull
                                     IDependable instance,
                                     @NotNull
                                     Dependable trait)
        (experimental) Turn any object into an IDependable.

        Parameters:
        instance - This parameter is required.
        trait - This parameter is required.
      • of

        @Stability(Experimental)
        @NotNull
        public static Dependable of​(@NotNull
                                    IDependable instance)
        (experimental) Return the matching Dependable for the given class instance.

        Parameters:
        instance - This parameter is required.
      • getDependencyRoots

        @Stability(Experimental)
        @NotNull
        public abstract List<IConstruct> getDependencyRoots()
        (experimental) The set of constructs that form the root of this dependable.

        All resources under all returned constructs are included in the ordering dependency.