Interface Locks

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

    @Generated("mdsal-binding-generator")
    public interface Locks
    extends org.opendaylight.yangtools.yang.binding.ChildOf<LockManagerData>, org.opendaylight.yangtools.yang.binding.Augmentable<Locks>
    Holds the list of lock name and lock owner

    This class represents the following YANG schema fragment defined in module lock-manager

     container locks {
       list lock {
         key lock-name;
         leaf lock-name {
           type string;
         }
         leaf lock-owner {
           type string;
         }
       }
     }
     
    The schema path to identify an instance is lock-manager/locks

    To create instances of this class use LocksBuilder.

    See Also:
    LocksBuilder
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static @NonNull org.opendaylight.yangtools.yang.common.QName QNAME  
    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      static boolean bindingEquals​(@NonNull Locks thisObj, java.lang.Object obj)
      Default implementation of Object.equals(Object) contract for this interface.
      static int bindingHashCode​(@NonNull Locks obj)
      Default implementation of Object.hashCode() contract for this interface.
      static java.lang.String bindingToString​(@NonNull Locks obj)
      Default implementation of Object.toString() contract for this interface.
      @Nullable java.util.Map<LockKey,​Lock> getLock()
      Return lock, or null if it is not present.
      default java.lang.Class<Locks> implementedInterface()  
      default @NonNull java.util.Map<LockKey,​Lock> nonnullLock()
      Return lock, or an empty list if it is not present.
      • Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

        augmentation, augmentations
    • Field Detail

      • QNAME

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

      • implementedInterface

        default java.lang.Class<Locks> implementedInterface()
        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 Locks 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:
        java.lang.NullPointerException - if obj is null
      • bindingEquals

        static boolean bindingEquals​(@NonNull Locks thisObj,
                                     java.lang.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:
        java.lang.NullPointerException - if thisObj is null
      • bindingToString

        static java.lang.String bindingToString​(@NonNull Locks 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:
        java.lang.NullPointerException - if obj is null
      • getLock

        @Nullable java.util.Map<LockKey,​Lock> getLock()
        Return lock, or null if it is not present.
        Returns:
        java.util.Map lock, or null if it is not present.
      • nonnullLock

        default @NonNull java.util.Map<LockKey,​Lock> nonnullLock()
        Return lock, or an empty list if it is not present.
        Returns:
        java.util.Map lock, or an empty list if it is not present.