Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev200120.role.set

Interface RoleSet

All Superinterfaces:
org.opendaylight.yangtools.binding.Augmentable<RoleSet>, org.opendaylight.yangtools.binding.BindingContract<org.opendaylight.yangtools.binding.DataContainer>, org.opendaylight.yangtools.binding.BindingObject, org.opendaylight.yangtools.binding.ChildOf<RoleSet>, org.opendaylight.yangtools.binding.DataContainer, org.opendaylight.yangtools.binding.DataObject, org.opendaylight.yangtools.binding.EntryObject<RoleSet,RoleSetKey>, org.opendaylight.yangtools.binding.KeyAware<RoleSetKey>
@Generated("mdsal-binding-generator") public interface RoleSet extends org.opendaylight.yangtools.binding.ChildOf<RoleSet>, org.opendaylight.yangtools.binding.EntryObject<RoleSet,RoleSetKey>
List of the defined role sets

This class represents the following YANG schema fragment defined in module odl-bgp-policy 

 list role-set {
   key role-set-name;
   leaf role-set-name {
     type string;
   }
   leaf-list role {
     type rib:peer-role;
   }
 }

To create instances of this class use RoleSetBuilder.

See Also:

  • 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<RoleSet> implementedInterface()
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.binding.BindingContract<org.opendaylight.yangtools.binding.DataContainer>
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.binding.DataObject

    • bindingHashCode

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

      RoleSetKey key()
      Specified by:
      key in interface org.opendaylight.yangtools.binding.KeyAware<RoleSetKey>

    • getRoleSetName

      String getRoleSetName()
      Return roleSetName, or null if it is not present. 
           
         name / label of the role set -- this is used to reference the set in match
         conditions
      Returns:
      String roleSetName, or null if it is not present.

    • requireRoleSetName

      default @NonNull String requireRoleSetName()
      Return roleSetName, guaranteed to be non-null. 
           
         name / label of the role set -- this is used to reference the set in match
         conditions
      Returns:
      String roleSetName, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if roleSetName is not present

    • getRole

      @Nullable Set<PeerRole> getRole()
      Return role, or null if it is not present. 
           
         List of role expressions that are part of the set
      Returns:
      Set<PeerRole> role, or null if it is not present.

    • requireRole

      default @NonNull Set<PeerRole> requireRole()
      Return role, guaranteed to be non-null. 
           
         List of role expressions that are part of the set
      Returns:
      Set<PeerRole> role, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if role is not present