Package org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.meter.band.headers

Interface MeterBandHeader

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<MeterBandHeader>, BandType, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<MeterBandHeaders>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<MeterBandHeaderKey>
    @Generated("mdsal-binding-generator")
public interface MeterBandHeader
extends org.opendaylight.yangtools.yang.binding.ChildOf<MeterBandHeaders>, org.opendaylight.yangtools.yang.binding.Augmentable<MeterBandHeader>, BandType, org.opendaylight.yangtools.yang.binding.Identifiable<MeterBandHeaderKey>

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

     list meter-band-header {
   key band-id;
   leaf band-id {
     type band-id;
   }
   container meter-band-types {
     leaf flags {
       type meter-band-type;
     }
   }
   leaf band-rate {
     type uint32;
   }
   leaf band-burst-size {
     type uint32;
   }
   uses band-type;
 }
    The schema path to identify an instance is opendaylight-meter-types/meter/meter-band-headers/meter-band-header

    To create instances of this class use MeterBandHeaderBuilder.

    See Also:
    MeterBandHeaderBuilder, MeterBandHeaderKey

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

        default Class<MeterBandHeader> implementedInterface()
        Specified by:
        implementedInterface in interface BandType
        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 MeterBandHeader 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 MeterBandHeader 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 MeterBandHeader 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

      • getBandId

        BandId getBandId()
        Return bandId, or null if it is not present. 
             
         Meter band id
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.BandId bandId, or null if it is not present.

      • getMeterBandTypes

        MeterBandTypes getMeterBandTypes()
        Return meterBandTypes, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.meter.meter.band.headers.meter.band.header.MeterBandTypes meterBandTypes, or null if it is not present.

      • getBandRate

        org.opendaylight.yangtools.yang.common.Uint32 getBandRate()
        Return bandRate, or null if it is not present. 
             
         Rate for this band
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 bandRate, or null if it is not present.

      • getBandBurstSize

        org.opendaylight.yangtools.yang.common.Uint32 getBandBurstSize()
        Return bandBurstSize, or null if it is not present. 
             
         Size of bursts
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 bandBurstSize, or null if it is not present.