Interface NeighborSet

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<NeighborSet>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<NeighborSet>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<NeighborSetKey>

    @Generated("mdsal-binding-generator")
    public interface NeighborSet
    extends org.opendaylight.yangtools.yang.binding.ChildOf<NeighborSet>, org.opendaylight.yangtools.yang.binding.Augmentable<NeighborSet>, org.opendaylight.yangtools.yang.binding.Identifiable<NeighborSetKey>
    Definitions for neighbor sets

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

     list neighbor-set {
       key neighbor-set-name;
       leaf neighbor-set-name {
         type string;
       }
       list neighbor {
         key address;
         leaf address {
           type inet:ip-address;
         }
       }
     }
     
    The schema path to identify an instance is openconfig-routing-policyneighbor-setneighbor-set

    To create instances of this class use NeighborSetBuilder.

    See Also:
    NeighborSetBuilder, NeighborSetKey
    • Field Detail

      • QNAME

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

      • implementedInterface

        default Class<NeighborSet> 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 NeighborSet 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 NeighborSet 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 NeighborSet 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
      • getNeighborSetName

        String getNeighborSetName()
        Return neighborSetName, or null if it is not present.
             
                 name / label of the neighbor set -- this is used to reference the set in match
                 conditions
             
         
        Returns:
        String neighborSetName, or null if it is not present.
      • requireNeighborSetName

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

        @Nullable Map<NeighborKey,​Neighbor> getNeighbor()
        Return neighbor, or null if it is not present.
             
                 list of addresses that are part of the neighbor set
             
         
        Returns:
        Map<NeighborKey, Neighbor> neighbor, or null if it is not present.
      • nonnullNeighbor

        default @NonNull Map<NeighborKey,​Neighbor> nonnullNeighbor()
        Return neighbor, or an empty list if it is not present.
        Returns:
        Map<NeighborKey, Neighbor> neighbor, or an empty list if it is not present.