Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.metric.object

Interface Metric

All Superinterfaces:
org.opendaylight.yangtools.binding.Augmentable<Metric>, org.opendaylight.yangtools.binding.BindingContract<org.opendaylight.yangtools.binding.DataContainer>, org.opendaylight.yangtools.binding.BindingObject, org.opendaylight.yangtools.binding.ChildOf<MetricObject>, org.opendaylight.yangtools.binding.DataContainer, org.opendaylight.yangtools.binding.DataObject, org.opendaylight.yangtools.binding.Grouping, Object, ObjectHeader
@Generated("mdsal-binding-generator") public interface Metric extends org.opendaylight.yangtools.binding.ChildOf<MetricObject>, org.opendaylight.yangtools.binding.Augmentable<Metric>, Object

This class represents the following YANG schema fragment defined in module pcep-types 

 container metric {
   uses object;
   leaf metric-type {
     type uint8;
   }
   leaf bound {
     type boolean;
     default false;
   }
   leaf computed {
     type boolean;
     default false;
   }
   leaf value {
     type ieee754:float32;
   }
 }

To create instances of this class use MetricBuilder.

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<Metric> 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 Metric 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 Metric thisObj, Object obj)
      Default implementation of Object.equals(java.lang.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 Metric 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

    • getMetricType

      org.opendaylight.yangtools.yang.common.Uint8 getMetricType()
      Return metricType, or null if it is not present.
      Returns:
      Uint8 metricType, or null if it is not present.

    • requireMetricType

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

    • getBound

      Boolean getBound()
      Return bound, or null if it is not present.
      Returns:
      Boolean bound, or null if it is not present.

    • requireBound

      default @NonNull Boolean requireBound()
      Return bound, guaranteed to be non-null.
      Returns:
      Boolean bound, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if bound is not present

    • getComputed

      Boolean getComputed()
      Return computed, or null if it is not present.
      Returns:
      Boolean computed, or null if it is not present.

    • requireComputed

      default @NonNull Boolean requireComputed()
      Return computed, guaranteed to be non-null.
      Returns:
      Boolean computed, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if computed is not present

    • getValue

      Float32 getValue()
      Return value, or null if it is not present.
      Returns:
      Float32 value, or null if it is not present.

    • requireValue

      default @NonNull Float32 requireValue()
      Return value, guaranteed to be non-null.
      Returns:
      Float32 value, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if value is not present