Interface TspecObject

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<TspecObject>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<TspecObject>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, RsvpTeObject

    @Generated("mdsal-binding-generator")
    public interface TspecObject
    extends org.opendaylight.yangtools.yang.binding.ChildOf<TspecObject>, org.opendaylight.yangtools.yang.binding.Augmentable<TspecObject>, RsvpTeObject
    SENDER TSPEC Object

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

     container tspec-object {
       uses rsvp-te-object;
       leaf token-bucket-rate {
         type ieee754:float32;
       }
       leaf token-bucket-size {
         type ieee754:float32;
       }
       leaf peak-data-rate {
         type ieee754:float32;
       }
       leaf minimum-policed-unit {
         type uint32;
       }
       leaf maximum-packet-size {
         type uint32;
       }
     }
     

    To create instances of this class use TspecObjectBuilder.

    See Also:
    TspecObjectBuilder
    • 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<TspecObject> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
        Specified by:
        implementedInterface in interface RsvpTeObject
      • bindingHashCode

        static int bindingHashCode​(@NonNull TspecObject 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 TspecObject 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 TspecObject 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
      • getTokenBucketRate

        Float32 getTokenBucketRate()
        Return tokenBucketRate, or null if it is not present.
        Returns:
        Float32 tokenBucketRate, or null if it is not present.
      • requireTokenBucketRate

        default @NonNull Float32 requireTokenBucketRate()
        Return tokenBucketRate, guaranteed to be non-null.
        Returns:
        Float32 tokenBucketRate, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if tokenBucketRate is not present
      • getTokenBucketSize

        Float32 getTokenBucketSize()
        Return tokenBucketSize, or null if it is not present.
        Returns:
        Float32 tokenBucketSize, or null if it is not present.
      • requireTokenBucketSize

        default @NonNull Float32 requireTokenBucketSize()
        Return tokenBucketSize, guaranteed to be non-null.
        Returns:
        Float32 tokenBucketSize, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if tokenBucketSize is not present
      • getPeakDataRate

        Float32 getPeakDataRate()
        Return peakDataRate, or null if it is not present.
        Returns:
        Float32 peakDataRate, or null if it is not present.
      • requirePeakDataRate

        default @NonNull Float32 requirePeakDataRate()
        Return peakDataRate, guaranteed to be non-null.
        Returns:
        Float32 peakDataRate, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if peakDataRate is not present
      • getMinimumPolicedUnit

        org.opendaylight.yangtools.yang.common.Uint32 getMinimumPolicedUnit()
        Return minimumPolicedUnit, or null if it is not present.
        Returns:
        Uint32 minimumPolicedUnit, or null if it is not present.
      • requireMinimumPolicedUnit

        default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireMinimumPolicedUnit()
        Return minimumPolicedUnit, guaranteed to be non-null.
        Returns:
        Uint32 minimumPolicedUnit, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if minimumPolicedUnit is not present
      • getMaximumPacketSize

        org.opendaylight.yangtools.yang.common.Uint32 getMaximumPacketSize()
        Return maximumPacketSize, or null if it is not present.
        Returns:
        Uint32 maximumPacketSize, or null if it is not present.
      • requireMaximumPacketSize

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