Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.alarms.rev190709.alarms.top

Interface Alarms

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<Alarms>, org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<AlarmsTop>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
@Generated("mdsal-binding-generator") public interface Alarms extends org.opendaylight.yangtools.yang.binding.ChildOf<AlarmsTop>, org.opendaylight.yangtools.yang.binding.Augmentable<Alarms>
Top-level container for device alarms

This class represents the following YANG schema fragment defined in module openconfig-alarms 

 container alarms {
   config false;
   list alarm {
     key id;
     leaf id {
       type leafref {
         path ../state/id;
       }
     }
     container config {
       uses alarm-config;
     }
     container state {
       config false;
       uses alarm-config;
       uses alarm-state;
     }
   }
 }

To create instances of this class use AlarmsBuilder.

See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final @NonNull org.opendaylight.yangtools.yang.common.QName
    QNAME
    YANG identifier of the statement represented by this class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static boolean
    bindingEquals(@NonNull Alarms thisObj, Object obj)
    Default implementation of Object.equals(Object) contract for this interface.
    static int
    bindingHashCode(@NonNull Alarms obj)
    Default implementation of Object.hashCode() contract for this interface.
    static String
    bindingToString(@NonNull Alarms obj)
    Default implementation of Object.toString() contract for this interface.
    @Nullable Map<AlarmKey,Alarm>
    getAlarm()
    Return alarm, or null if it is not present.
    default Class<Alarms>
    implementedInterface()
     
    default @NonNull Map<AlarmKey,Alarm>
    nonnullAlarm()
    Return alarm, or an empty list if it is not present.

    Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

    augmentation, augmentationOrElseThrow, augmentationOrElseThrow, augmentations

  • 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<Alarms> 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

    • bindingHashCode

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

    • getAlarm

      @Nullable Map<AlarmKey,Alarm> getAlarm()
      Return alarm, or null if it is not present. 
           
         List of alarms, keyed by a unique id
      Returns:
      Map<AlarmKey, Alarm> alarm, or null if it is not present.

    • nonnullAlarm

      default @NonNull Map<AlarmKey,Alarm> nonnullAlarm()
      Return alarm, or an empty list if it is not present.
      Returns:
      Map<AlarmKey, Alarm> alarm, or an empty list if it is not present.