Interface Paths

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Paths>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<Topology1>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<PathsKey>

    @Generated("mdsal-binding-generator")
    public interface Paths
    extends org.opendaylight.yangtools.yang.binding.ChildOf<Topology1>, org.opendaylight.yangtools.yang.binding.Augmentable<Paths>, org.opendaylight.yangtools.yang.binding.Identifiable<PathsKey>

    This class represents the following YANG schema fragment defined in module topology-tunnel

     list paths {
       config false;
       leaf path-id {
         type path-id;
       }
       key path-id;
       container path-types {
       }
     }
     
    The schema path to identify an instance is topology-tunnelnetwork-topologytopology(urn:opendaylight:params:xml:ns:yang:topology:tunnel?revision=2013-08-19)paths

    To create instances of this class use PathsBuilder.

    See Also:
    PathsBuilder, PathsKey
    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
    • Method Detail

      • implementedInterface

        default Class<Paths> 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 Paths 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 Paths 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 Paths 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

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

        PathId getPathId()
        Return pathId, or null if it is not present.
        Returns:
        PathId pathId, or null if it is not present.
      • requirePathId

        default @NonNull PathId requirePathId()
        Return pathId, guaranteed to be non-null.
        Returns:
        PathId pathId, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if pathId is not present
      • getPathTypes

        PathTypes getPathTypes()
        Return pathTypes, or null if it is not present.
             
                 A path can have multiple traits, each of which is indicated by a presence
                 container under this one. Such containers should not carry any data.
             
         
        Returns:
        PathTypes pathTypes, or null if it is not present.