Interface Group

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Group>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<Groups>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<GroupKey>

    @Generated("mdsal-binding-generator")
    public interface Group
    extends org.opendaylight.yangtools.yang.binding.ChildOf<Groups>, org.opendaylight.yangtools.yang.binding.Augmentable<Group>, org.opendaylight.yangtools.yang.binding.Identifiable<GroupKey>
    One NACM group entry. This list will only contain configured entries, not any entries learned from any transport protocols.

    This class represents the following YANG schema fragment defined in module ietf-netconf-acm

     list group {
       key name;
       leaf name {
         type group-name-type;
       }
       leaf-list user-name {
         type user-name-type;
       }
     }
     
    The schema path to identify an instance is ietf-netconf-acmnacmgroupsgroup

    To create instances of this class use GroupBuilder.

    See Also:
    GroupBuilder, GroupKey
    • Field Detail

      • QNAME

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

      • implementedInterface

        default Class<Group> 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 Group 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 Group 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 Group 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
      • key

        GroupKey key()
        Specified by:
        key in interface org.opendaylight.yangtools.yang.binding.Identifiable<GroupKey>
      • getName

        GroupNameType getName()
        Return name, or null if it is not present.
             
                 Group name associated with this entry.
             
         
        Returns:
        GroupNameType name, or null if it is not present.
      • requireName

        default @NonNull GroupNameType requireName()
        Return name, guaranteed to be non-null.
             
                 Group name associated with this entry.
             
         
        Returns:
        GroupNameType name, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if name is not present
      • getUserName

        @Nullable List<UserNameType> getUserName()
        Return userName, or null if it is not present.
             
                 Each entry identifies the username of a member of the group associated with this
                 entry.
             
         
        Returns:
        List<UserNameType> userName, or null if it is not present.
      • requireUserName

        default @NonNull List<UserNameType> requireUserName()
        Return userName, guaranteed to be non-null.
             
                 Each entry identifies the username of a member of the group associated with this
                 entry.
             
         
        Returns:
        List<UserNameType> userName, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if userName is not present