Package software.aws.awsprototypingsdk.cdkgraph

Class Edge

    • Constructor Detail

      • Edge

        protected Edge​(software.amazon.jsii.JsiiObjectRef objRef)

      • Edge

        protected Edge​(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

      • Edge

        @Stability(Experimental)
public Edge​(@NotNull
            IEdgeProps props)
        Parameters:
        props - This parameter is required.

    • Method Detail

      • findAllInChain

        @Stability(Experimental)
@NotNull
public static List<Edge> findAllInChain​(@NotNull
                                        List<? extends Object> chain,
                                        @NotNull
                                        IEdgePredicate predicate)
        (experimental) Find all matching edges based on predicate within an EdgeChain.

        Parameters:
        chain - This parameter is required.
        predicate - This parameter is required.

      • findInChain

        @Stability(Experimental)
@Nullable
public static Edge findInChain​(@NotNull
                               List<? extends Object> chain,
                               @NotNull
                               IEdgePredicate predicate)
        (experimental) Find first edge matching predicate within an EdgeChain.

        Parameters:
        chain - This parameter is required.
        predicate - This parameter is required.

      • isEquivalent

        @Stability(Experimental)
@NotNull
public Boolean isEquivalent​(@NotNull
                            Edge edge)
        (experimental) Indicates if this edge is equivalent to another edge.

        Edges are considered equivalent if they share same type, source, and target.

        Parameters:
        edge - This parameter is required.

      • mutateConsume

        @Stability(Experimental)
public void mutateConsume​(@NotNull
                          Edge edge)
        (experimental) Merge an equivalent edge's data into this edge and destroy the other edge.

        Used during filtering operations to consolidate equivalent edges.

        Parameters:
        edge -
        • The edge to consume.
        This parameter is required.

      • mutateDestroy

        @Stability(Experimental)
public void mutateDestroy​(@Nullable
                          Boolean _strict)
        (experimental) Destroy the edge.

        Remove all references and remove from store.

        Specified by:
        mutateDestroy in class BaseEntity
        Parameters:
        _strict -

      • mutateDestroy

        @Stability(Experimental)
public void mutateDestroy()
        (experimental) Destroy the edge.

        Remove all references and remove from store.

        Specified by:
        mutateDestroy in class BaseEntity

      • mutateDirection

        @Stability(Experimental)
public void mutateDirection​(@NotNull
                            EdgeDirectionEnum direction)
        (experimental) Change the edge direction.

        Parameters:
        direction - This parameter is required.

      • mutateSource

        @Stability(Experimental)
public void mutateSource​(@NotNull
                         Node node)
        (experimental) Change the edge source.

        Parameters:
        node - This parameter is required.

      • mutateTarget

        @Stability(Experimental)
public void mutateTarget​(@NotNull
                         Node node)
        (experimental) Change the edge target.

        Parameters:
        node - This parameter is required.

      • toString

        @Stability(Experimental)
@NotNull
public String toString()
        (experimental) Get string representation of this edge.
        Overrides:
        toString in class Object

      • getAllowDestructiveMutations

        @Stability(Experimental)
@NotNull
public Boolean getAllowDestructiveMutations()
        (experimental) Indicates if edge allows destructive mutations.

      • getDirection

        @Stability(Experimental)
@NotNull
public EdgeDirectionEnum getDirection()
        (experimental) Indicates the direction in which the edge is directed.

      • getEdgeType

        @Stability(Experimental)
@NotNull
public EdgeTypeEnum getEdgeType()
        (experimental) Type of edge.

      • getIsClosed

        @Stability(Experimental)
@NotNull
public Boolean getIsClosed()
        (experimental) Indicates if the Edge's source and target are the same, or were the same when it was created (prior to mutations).

        To check whether it was originally closed, use hasFlag(FlagEnum.CLOSED_EDGE) instead.

      • getIsCrossStack

        @Stability(Experimental)
@NotNull
public Boolean getIsCrossStack()
        (experimental) Indicates if source and target nodes reside in different root stacks.

      • getIsExtraneous

        @Stability(Experimental)
@NotNull
public Boolean getIsExtraneous()
        (experimental) Indicates if edge is extraneous which is determined by explicitly having EXTRANEOUS flag added and/or being a closed loop (source===target).

      • getSource

        @Stability(Experimental)
@NotNull
public Node getSource()
        (experimental) Edge source is the node that defines the edge (tail).

      • getTarget

        @Stability(Experimental)
@NotNull
public Node getTarget()
        (experimental) Edge target is the node being referenced by the source (head).