Interface Users

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

    @Generated("mdsal-binding-generator")
    public interface Users
    extends org.opendaylight.yangtools.yang.binding.ChildOf<AaaAuthenticationUserTop>, org.opendaylight.yangtools.yang.binding.Augmentable<Users>
    Enclosing container list of local users

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

     container users {
       list user {
         key username;
         leaf username {
           type leafref {
             path ../config/username;
           }
         }
         container config {
           uses aaa-authentication-user-config;
         }
         container state {
           config false;
           uses aaa-authentication-user-config;
           uses aaa-authentication-user-state;
         }
       }
     }
     
    The schema path to identify an instance is openconfig-aaaaaa-authentication-user-topusers

    To create instances of this class use UsersBuilder.

    See Also:
    UsersBuilder
    • Field Detail

      • QNAME

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

      • implementedInterface

        default Class<Users> 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 Users 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 Users 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 Users 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
      • getUser

        @Nullable Map<UserKey,​User> getUser()
        Return user, or null if it is not present.
             
                 List of local users on the system
             
         
        Returns:
        Map<UserKey, User> user, or null if it is not present.
      • nonnullUser

        default @NonNull Map<UserKey,​User> nonnullUser()
        Return user, or an empty list if it is not present.
        Returns:
        Map<UserKey, User> user, or an empty list if it is not present.