Interface Tunnel
-
- All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<Tunnel>
,org.opendaylight.yangtools.yang.binding.BindingObject
,org.opendaylight.yangtools.yang.binding.ChildOf<Match>
,org.opendaylight.yangtools.yang.binding.DataContainer
,org.opendaylight.yangtools.yang.binding.DataObject
@Generated("mdsal-binding-generator") public interface Tunnel extends org.opendaylight.yangtools.yang.binding.ChildOf<Match>, org.opendaylight.yangtools.yang.binding.Augmentable<Tunnel>
This class represents the following YANG schema fragment defined in module opendaylight-match-types
container tunnel { leaf tunnel-id { type uint64; } leaf tunnel-mask { type uint64; } }
To create instances of this class use
TunnelBuilder
.- See Also:
TunnelBuilder
-
-
Field Summary
Fields Modifier and Type Field Description static @NonNull org.opendaylight.yangtools.yang.common.QName
QNAME
YANG identifier of the statement represented by this class.
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description static boolean
bindingEquals(@NonNull Tunnel thisObj, Object obj)
Default implementation ofObject.equals(Object)
contract for this interface.static int
bindingHashCode(@NonNull Tunnel obj)
Default implementation ofObject.hashCode()
contract for this interface.static String
bindingToString(@NonNull Tunnel obj)
Default implementation ofObject.toString()
contract for this interface.org.opendaylight.yangtools.yang.common.Uint64
getTunnelId()
Return tunnelId, ornull
if it is not present.org.opendaylight.yangtools.yang.common.Uint64
getTunnelMask()
Return tunnelMask, ornull
if it is not present.default Class<Tunnel>
implementedInterface()
default @NonNull org.opendaylight.yangtools.yang.common.Uint64
requireTunnelId()
Return tunnelId, guaranteed to be non-null.default @NonNull org.opendaylight.yangtools.yang.common.Uint64
requireTunnelMask()
Return tunnelMask, guaranteed to be non-null.
-
-
-
Method Detail
-
implementedInterface
default Class<Tunnel> implementedInterface()
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataContainer
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataObject
-
bindingHashCode
static int bindingHashCode(@NonNull Tunnel obj)
Default implementation ofObject.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
- ifobj
is null
-
bindingEquals
static boolean bindingEquals(@NonNull Tunnel thisObj, Object obj)
Default implementation ofObject.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 invocationobj
- Object acting as argument to equals invocation- Returns:
- True if thisObj and obj are considered equal
- Throws:
NullPointerException
- ifthisObj
is null
-
bindingToString
static String bindingToString(@NonNull Tunnel obj)
Default implementation ofObject.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
- ifobj
is null
-
getTunnelId
org.opendaylight.yangtools.yang.common.Uint64 getTunnelId()
Return tunnelId, ornull
if it is not present.Metadata associated in the logical port
- Returns:
Uint64
tunnelId, ornull
if it is not present.
-
requireTunnelId
default @NonNull org.opendaylight.yangtools.yang.common.Uint64 requireTunnelId()
Return tunnelId, guaranteed to be non-null.Metadata associated in the logical port
- Returns:
Uint64
tunnelId, guaranteed to be non-null.- Throws:
NoSuchElementException
- if tunnelId is not present
-
getTunnelMask
org.opendaylight.yangtools.yang.common.Uint64 getTunnelMask()
Return tunnelMask, ornull
if it is not present.- Returns:
Uint64
tunnelMask, ornull
if it is not present.
-
requireTunnelMask
default @NonNull org.opendaylight.yangtools.yang.common.Uint64 requireTunnelMask()
Return tunnelMask, guaranteed to be non-null.- Returns:
Uint64
tunnelMask, guaranteed to be non-null.- Throws:
NoSuchElementException
- if tunnelMask is not present
-
-