Interface Port
-
- All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<Port>
,org.opendaylight.yangtools.yang.binding.BindingObject
,org.opendaylight.yangtools.yang.binding.ChildOf<Port>
,CommonPort
,CommonPortWithMask
,org.opendaylight.yangtools.yang.binding.DataContainer
,org.opendaylight.yangtools.yang.binding.DataObject
,org.opendaylight.yangtools.yang.binding.Identifiable<PortKey>
@Generated("mdsal-binding-generator") public interface Port extends org.opendaylight.yangtools.yang.binding.ChildOf<Port>, org.opendaylight.yangtools.yang.binding.Augmentable<Port>, CommonPortWithMask, org.opendaylight.yangtools.yang.binding.Identifiable<PortKey>
This class represents the following YANG schema fragment defined in module opendaylight-port-types
list port { key port-mod-order; leaf port-mod-order { type uint32; } uses common-port-with-mask; leaf container-name { type string; } leaf port-name { type string; } leaf barrier { type boolean; } }
The schema path to identify an instance is opendaylight-port-typesport-modportportTo create instances of this class use
PortBuilder
.- See Also:
PortBuilder
,PortKey
-
-
Field Summary
Fields Modifier and Type Field Description static @NonNull org.opendaylight.yangtools.yang.common.QName
QNAME
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description static boolean
bindingEquals(@NonNull Port thisObj, Object obj)
Default implementation ofObject.equals(Object)
contract for this interface.static int
bindingHashCode(@NonNull Port obj)
Default implementation ofObject.hashCode()
contract for this interface.static String
bindingToString(@NonNull Port obj)
Default implementation ofObject.toString()
contract for this interface.Boolean
getBarrier()
Return barrier, ornull
if it is not present.String
getContainerName()
Return containerName, ornull
if it is not present.org.opendaylight.yangtools.yang.common.Uint32
getPortModOrder()
Return portModOrder, ornull
if it is not present.String
getPortName()
Return portName, ornull
if it is not present.default Class<Port>
implementedInterface()
PortKey
key()
default @NonNull Boolean
requireBarrier()
Return barrier, guaranteed to be non-null.default @NonNull String
requireContainerName()
Return containerName, guaranteed to be non-null.default @NonNull org.opendaylight.yangtools.yang.common.Uint32
requirePortModOrder()
Return portModOrder, guaranteed to be non-null.default @NonNull String
requirePortName()
Return portName, guaranteed to be non-null.-
Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable
augmentation, augmentations
-
Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.CommonPort
getAdvertisedFeatures, getConfiguration, getHardwareAddress, getPortNumber, requireAdvertisedFeatures, requireConfiguration, requireHardwareAddress, requirePortNumber
-
Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.CommonPortWithMask
getMask, requireMask
-
-
-
-
Method Detail
-
implementedInterface
default Class<Port> implementedInterface()
- Specified by:
implementedInterface
in interfaceCommonPort
- Specified by:
implementedInterface
in interfaceCommonPortWithMask
- 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 Port 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 Port 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 Port 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
PortKey key()
- Specified by:
key
in interfaceorg.opendaylight.yangtools.yang.binding.Identifiable<PortKey>
-
getPortModOrder
org.opendaylight.yangtools.yang.common.Uint32 getPortModOrder()
Return portModOrder, ornull
if it is not present.- Returns:
Uint32
portModOrder, ornull
if it is not present.
-
requirePortModOrder
default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requirePortModOrder()
Return portModOrder, guaranteed to be non-null.- Returns:
Uint32
portModOrder, guaranteed to be non-null.- Throws:
NoSuchElementException
- if portModOrder is not present
-
getContainerName
String getContainerName()
Return containerName, ornull
if it is not present.- Returns:
String
containerName, ornull
if it is not present.
-
requireContainerName
default @NonNull String requireContainerName()
Return containerName, guaranteed to be non-null.- Returns:
String
containerName, guaranteed to be non-null.- Throws:
NoSuchElementException
- if containerName is not present
-
getPortName
String getPortName()
Return portName, ornull
if it is not present.- Returns:
String
portName, ornull
if it is not present.
-
requirePortName
default @NonNull String requirePortName()
Return portName, guaranteed to be non-null.- Returns:
String
portName, guaranteed to be non-null.- Throws:
NoSuchElementException
- if portName is not present
-
getBarrier
Boolean getBarrier()
Return barrier, ornull
if it is not present.- Returns:
Boolean
barrier, ornull
if it is not present.
-
requireBarrier
default @NonNull Boolean requireBarrier()
Return barrier, guaranteed to be non-null.- Returns:
Boolean
barrier, guaranteed to be non-null.- Throws:
NoSuchElementException
- if barrier is not present
-
-