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

Interface ConstrainedPath

All Superinterfaces:
org.opendaylight.yangtools.binding.Augmentable<ConstrainedPath>, org.opendaylight.yangtools.binding.BindingContract<org.opendaylight.yangtools.binding.DataContainer>, org.opendaylight.yangtools.binding.BindingObject, org.opendaylight.yangtools.binding.ChildOf<PathComputationData>, ComputedMetrics, ComputedPath, org.opendaylight.yangtools.binding.DataContainer, org.opendaylight.yangtools.binding.DataObject, org.opendaylight.yangtools.binding.Grouping, PathConstraints, PathDescriptions
@Generated("mdsal-binding-generator") public interface ConstrainedPath extends org.opendaylight.yangtools.binding.ChildOf<PathComputationData>, org.opendaylight.yangtools.binding.Augmentable<ConstrainedPath>, PathConstraints, ComputedPath
Description of Computed Paths

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

 container constrained-path {
   uses path-constraints;
   uses computed-path;
   container divert-path {
     when ../path-constraints/path-diversity;
     uses computed-path;
   }
 }

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.binding.BindingContract<org.opendaylight.yangtools.binding.DataContainer>
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.binding.DataObject

    • 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

    • getDivertPath

      DivertPath getDivertPath()
      Return divertPath, or null if it is not present.
      Returns:
      DivertPath divertPath, or null if it is not present.

    • nonnullDivertPath

      @NonNull DivertPath nonnullDivertPath()
      Return divertPath, or an empty instance if it is not present.
      Returns:
      DivertPath divertPath, or an empty instance if it is not present.