Interface Subinterface
-
- All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<Subinterface>
,org.opendaylight.yangtools.yang.binding.BindingObject
,org.opendaylight.yangtools.yang.binding.ChildOf<Subinterfaces>
,org.opendaylight.yangtools.yang.binding.DataContainer
,org.opendaylight.yangtools.yang.binding.DataObject
,org.opendaylight.yangtools.yang.binding.Identifiable<SubinterfaceKey>
@Generated("mdsal-binding-generator") public interface Subinterface extends org.opendaylight.yangtools.yang.binding.ChildOf<Subinterfaces>, org.opendaylight.yangtools.yang.binding.Augmentable<Subinterface>, org.opendaylight.yangtools.yang.binding.Identifiable<SubinterfaceKey>
The list of subinterfaces (logical interfaces) associated with a physical interfaceThis class represents the following YANG schema fragment defined in module openconfig-interfaces
list subinterface { key index; leaf index { type leafref { path ../oc-if:config/oc-if:index; } } container config { uses subinterfaces-config; } container state { config false; uses subinterfaces-config; uses subinterfaces-state; } }
To create instances of this class use
SubinterfaceBuilder
.- See Also:
SubinterfaceBuilder
,SubinterfaceKey
-
-
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 Subinterface thisObj, Object obj)
Default implementation ofObject.equals(Object)
contract for this interface.static int
bindingHashCode(@NonNull Subinterface obj)
Default implementation ofObject.hashCode()
contract for this interface.static String
bindingToString(@NonNull Subinterface obj)
Default implementation ofObject.toString()
contract for this interface.Config
getConfig()
Return config, ornull
if it is not present.org.opendaylight.yangtools.yang.common.Uint32
getIndex()
Return index, ornull
if it is not present.State
getState()
Return state, ornull
if it is not present.default Class<Subinterface>
implementedInterface()
SubinterfaceKey
key()
default @NonNull org.opendaylight.yangtools.yang.common.Uint32
requireIndex()
Return index, guaranteed to be non-null.
-
-
-
Method Detail
-
implementedInterface
default Class<Subinterface> 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 Subinterface 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 Subinterface 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 Subinterface 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
-
key
SubinterfaceKey key()
- Specified by:
key
in interfaceorg.opendaylight.yangtools.yang.binding.Identifiable<SubinterfaceKey>
-
getIndex
org.opendaylight.yangtools.yang.common.Uint32 getIndex()
Return index, ornull
if it is not present.The index number of the subinterface -- used to address the logical interface
- Returns:
Uint32
index, ornull
if it is not present.
-
requireIndex
default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requireIndex()
Return index, guaranteed to be non-null.The index number of the subinterface -- used to address the logical interface
- Returns:
Uint32
index, guaranteed to be non-null.- Throws:
NoSuchElementException
- if index is not present
-
getConfig
Config getConfig()
Return config, ornull
if it is not present.Configurable items at the subinterface level
- Returns:
Config
config, ornull
if it is not present.
-
getState
State getState()
Return state, ornull
if it is not present.Operational state data for logical interfaces
- Returns:
State
state, ornull
if it is not present.
-
-