Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.graph.rev191125.graph.topology

Interface Graph

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Graph>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<GraphTopology>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<GraphKey>
    @Generated("mdsal-binding-generator")
public interface Graph
extends org.opendaylight.yangtools.yang.binding.ChildOf<GraphTopology>, org.opendaylight.yangtools.yang.binding.Augmentable<Graph>, org.opendaylight.yangtools.yang.binding.Identifiable<GraphKey>
    Graph representation of the Network Topology

    This class represents the following YANG schema fragment defined in module graph 

     list graph {
   key name;
   leaf name {
     type string;
   }
   leaf domain-scope {
     type enumeration {
       enum intra-domain {
         value 1;
       }
       enum inter-domain {
         value 2;
       }
     }
     default intra-domain;
   }
   leaf asn {
     type uint32;
   }
   list vertex {
     key vertex-id;
     uses vertex;
   }
   list edge {
     key edge-id;
     uses edge;
   }
   list prefix {
     key prefix;
     uses prefix;
   }
 }

    To create instances of this class use GraphBuilder.

    See Also:
    GraphBuilder, GraphKey

    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
        YANG identifier of the statement represented by this class.

    • Method Detail

      • implementedInterface

        default Class<Graph> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

      • bindingHashCode

        static int bindingHashCode​(@NonNull Graph obj)
        Default implementation of Object.hashCode() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent hashing results across all implementations.
        Parameters:
        obj - Object for which to generate hashCode() result.
        Returns:
        Hash code value of data modeled by this interface.
        Throws:
        NullPointerException - if obj is null

      • bindingEquals

        static boolean bindingEquals​(@NonNull Graph thisObj,
                             Object obj)
        Default implementation of Object.equals(Object) contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent equality results across all implementations.
        Parameters:
        thisObj - Object acting as the receiver of equals invocation
        obj - Object acting as argument to equals invocation
        Returns:
        True if thisObj and obj are considered equal
        Throws:
        NullPointerException - if thisObj is null

      • bindingToString

        static String bindingToString​(@NonNull Graph obj)
        Default implementation of Object.toString() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent string representations across all implementations.
        Parameters:
        obj - Object for which to generate toString() result.
        Returns:
        String value of data modeled by this interface.
        Throws:
        NullPointerException - if obj is null

      • key

        GraphKey key()
        Specified by:
        key in interface org.opendaylight.yangtools.yang.binding.Identifiable<GraphKey>

      • getName

        String getName()
        Return name, or null if it is not present.
        Returns:
        String name, or null if it is not present.

      • requireName

        default @NonNull String requireName()
        Return name, guaranteed to be non-null.
        Returns:
        String name, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if name is not present

      • getDomainScope

        Graph.DomainScope getDomainScope()
        Return domainScope, or null if it is not present. 
             
         Network domain scope: intra or inter domain
        Returns:
        DomainScope domainScope, or null if it is not present.

      • requireDomainScope

        default @NonNull Graph.DomainScope requireDomainScope()
        Return domainScope, guaranteed to be non-null. 
             
         Network domain scope: intra or inter domain
        Returns:
        DomainScope domainScope, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if domainScope is not present

      • getAsn

        org.opendaylight.yangtools.yang.common.Uint32 getAsn()
        Return asn, or null if it is not present. 
             
         AS Number
        Returns:
        Uint32 asn, or null if it is not present.

      • requireAsn

        default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireAsn()
        Return asn, guaranteed to be non-null. 
             
         AS Number
        Returns:
        Uint32 asn, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if asn is not present

      • getVertex

        @Nullable Map<VertexKey,​Vertex> getVertex()
        Return vertex, or null if it is not present. 
             
         The list of Vertices defined for the Graph.
        Returns:
        Map<VertexKey, Vertex> vertex, or null if it is not present.

      • nonnullVertex

        default @NonNull Map<VertexKey,​Vertex> nonnullVertex()
        Return vertex, or an empty list if it is not present.
        Returns:
        Map<VertexKey, Vertex> vertex, or an empty list if it is not present.

      • getEdge

        @Nullable Map<EdgeKey,​Edge> getEdge()
        Return edge, or null if it is not present. 
             
         The list of Edges defined for the Graph.
        Returns:
        Map<EdgeKey, Edge> edge, or null if it is not present.

      • nonnullEdge

        default @NonNull Map<EdgeKey,​Edge> nonnullEdge()
        Return edge, or an empty list if it is not present.
        Returns:
        Map<EdgeKey, Edge> edge, or an empty list if it is not present.

      • getPrefix

        @Nullable Map<PrefixKey,​Prefix> getPrefix()
        Return prefix, or null if it is not present. 
             
         The list of prefixes for the Graph.
        Returns:
        Map<PrefixKey, Prefix> prefix, or null if it is not present.

      • nonnullPrefix

        default @NonNull Map<PrefixKey,​Prefix> nonnullPrefix()
        Return prefix, or an empty list if it is not present.
        Returns:
        Map<PrefixKey, Prefix> prefix, or an empty list if it is not present.