Interface MatchNeighborSet

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<MatchNeighborSet>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<GenericConditions>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, MatchSetOptionsRestrictedGroup

    @Generated("mdsal-binding-generator")
    public interface MatchNeighborSet
    extends org.opendaylight.yangtools.yang.binding.ChildOf<GenericConditions>, org.opendaylight.yangtools.yang.binding.Augmentable<MatchNeighborSet>, MatchSetOptionsRestrictedGroup
    Match a referenced neighbor set according to the logic defined in the match-set-options-leaf

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

     container match-neighbor-set {
       presence
         "The presence of this container indicates that the routes
          should match the neighbour set referenced";
       leaf neighbor-set {
         type leafref {
           path /routing-policy/defined-sets/neighbor-sets/neighbor-set/neighbor-set-name;
         }
       }
       uses match-set-options-restricted-group;
     }
     
    The schema path to identify an instance is openconfig-routing-policygeneric-conditionsmatch-neighbor-set

    To create instances of this class use MatchNeighborSetBuilder.

    See Also:
    MatchNeighborSetBuilder
    • Field Detail

      • QNAME

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

      • implementedInterface

        default Class<MatchNeighborSet> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
        Specified by:
        implementedInterface in interface MatchSetOptionsRestrictedGroup
      • bindingHashCode

        static int bindingHashCode​(@NonNull MatchNeighborSet 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 MatchNeighborSet 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 MatchNeighborSet 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
      • getNeighborSet

        String getNeighborSet()
        Return neighborSet, or null if it is not present.
             
                 References a defined neighbor set
             
         
        Returns:
        String neighborSet, or null if it is not present.
      • requireNeighborSet

        default @NonNull String requireNeighborSet()
        Return neighborSet, guaranteed to be non-null.
             
                 References a defined neighbor set
             
         
        Returns:
        String neighborSet, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if neighborSet is not present