Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.path.computation.rev220324

Interface ConstrainedPath

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<ConstrainedPath>, org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<PathComputationData>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, PathConstraints, PathDescriptions
@Generated("mdsal-binding-generator") public interface ConstrainedPath extends org.opendaylight.yangtools.yang.binding.ChildOf<PathComputationData>, org.opendaylight.yangtools.yang.binding.Augmentable<ConstrainedPath>, PathConstraints, PathDescriptions
Computed Path as result of Path Computation Algorithms

This class represents the following YANG schema fragment defined in module path-computation 

 container constrained-path {
   uses path-constraints;
   leaf source {
     type uint64;
   }
   leaf destination {
     type uint64;
   }
   uses path-descriptions;
   leaf status {
     type computation-status;
   }
 }

To create instances of this class use ConstrainedPathBuilder.

See Also:

  • Field Details

    • QNAME

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

  • Method Details

    • implementedInterface

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

    • bindingHashCode

      static int bindingHashCode(@NonNull ConstrainedPath 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 ConstrainedPath 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 ConstrainedPath 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

    • getSource

      org.opendaylight.yangtools.yang.common.Uint64 getSource()
      Return source, or null if it is not present.
      Returns:
      Uint64 source, or null if it is not present.

    • requireSource

      default @NonNull org.opendaylight.yangtools.yang.common.Uint64 requireSource()
      Return source, guaranteed to be non-null.
      Returns:
      Uint64 source, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if source is not present

    • getDestination

      org.opendaylight.yangtools.yang.common.Uint64 getDestination()
      Return destination, or null if it is not present.
      Returns:
      Uint64 destination, or null if it is not present.

    • requireDestination

      default @NonNull org.opendaylight.yangtools.yang.common.Uint64 requireDestination()
      Return destination, guaranteed to be non-null.
      Returns:
      Uint64 destination, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if destination is not present

    • getStatus

      ComputationStatus getStatus()
      Return status, or null if it is not present.
      Returns:
      ComputationStatus status, or null if it is not present.

    • requireStatus

      default @NonNull ComputationStatus requireStatus()
      Return status, guaranteed to be non-null.
      Returns:
      ComputationStatus status, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if status is not present