Interface Remote

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Remote>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChoiceIn<InstanceEndpointLocalRemote>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, LocalRemote

    @Generated("mdsal-binding-generator")
    public interface Remote
    extends LocalRemote, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Augmentable<Remote>

    This class represents the following YANG schema fragment defined in module openconfig-network-instance

     case remote {
       leaf neighbor {
         type inet:ip-address;
       }
       leaf virtual-circuit-identifier {
         type uint32;
       }
     }
     
    • 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<Remote> 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 Remote 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 Remote 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 Remote 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
      • getNeighbor

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getNeighbor()
        Return neighbor, or null if it is not present.
             
                 The IP address of the device which hosts the remote end-point
             
         
        Returns:
        IpAddress neighbor, or null if it is not present.
      • requireNeighbor

        default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress requireNeighbor()
        Return neighbor, guaranteed to be non-null.
             
                 The IP address of the device which hosts the remote end-point
             
         
        Returns:
        IpAddress neighbor, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if neighbor is not present
      • getVirtualCircuitIdentifier

        org.opendaylight.yangtools.yang.common.Uint32 getVirtualCircuitIdentifier()
        Return virtualCircuitIdentifier, or null if it is not present.
             
                 The virtual-circuit identifier that identifies the connection at the remote
                 end-point
             
         
        Returns:
        Uint32 virtualCircuitIdentifier, or null if it is not present.
      • requireVirtualCircuitIdentifier

        default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireVirtualCircuitIdentifier()
        Return virtualCircuitIdentifier, guaranteed to be non-null.
             
                 The virtual-circuit identifier that identifies the connection at the remote
                 end-point
             
         
        Returns:
        Uint32 virtualCircuitIdentifier, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if virtualCircuitIdentifier is not present