Interface Neighbor

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Neighbor>, 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<NeighborKey>

    @Generated("mdsal-binding-generator")
    public interface Neighbor
    extends org.opendaylight.yangtools.yang.binding.ChildOf<NeighborSet>, org.opendaylight.yangtools.yang.binding.Augmentable<Neighbor>, org.opendaylight.yangtools.yang.binding.Identifiable<NeighborKey>
    list of addresses that are part of the neighbor set

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

     list neighbor {
       key address;
       leaf address {
         type inet:ip-address;
       }
     }
     

    To create instances of this class use NeighborBuilder.

    See Also:
    NeighborBuilder, NeighborKey
    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
        YANG identifier of the statement represented by this class.
    • Method Detail

      • implementedInterface

        default Class<Neighbor> 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 Neighbor 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 Neighbor 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 Neighbor 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

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

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getAddress()
        Return address, or null if it is not present.
             
                 IP address of the neighbor set member
             
         
        Returns:
        IpAddress address, or null if it is not present.
      • requireAddress

        default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress requireAddress()
        Return address, guaranteed to be non-null.
             
                 IP address of the neighbor set member
             
         
        Returns:
        IpAddress address, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if address is not present