Interface Protocols
-
- All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<Protocols>
,org.opendaylight.yangtools.yang.binding.BindingObject
,org.opendaylight.yangtools.yang.binding.ChildOf<NetworkInstance>
,org.opendaylight.yangtools.yang.binding.DataContainer
,org.opendaylight.yangtools.yang.binding.DataObject
@Generated("mdsal-binding-generator") public interface Protocols extends org.opendaylight.yangtools.yang.binding.ChildOf<NetworkInstance>, org.opendaylight.yangtools.yang.binding.Augmentable<Protocols>
The routing protocols that are enabled for this network-instance.This class represents the following YANG schema fragment defined in module openconfig-network-instance
container protocols { list protocol { key "identifier name"; leaf identifier { type leafref { path ../config/identifier; } } leaf name { type leafref { path ../config/name; } } container config { uses protocols-config; } container state { config false; uses protocols-config; uses protocols-state; } container static { when "../config/identifier = 'STATIC'" { } uses lroute:local-static-top; } container aggregate { when "../config/identifier = 'LOCAL-AGGREGATE'" { } uses lroute:local-aggregate-top; } } }
The schema path to identify an instance is openconfig-network-instancenetwork-instance-topnetwork-instancesnetwork-instanceprotocolsTo create instances of this class use
ProtocolsBuilder
.- See Also:
ProtocolsBuilder
-
-
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 Protocols thisObj, Object obj)
Default implementation ofObject.equals(Object)
contract for this interface.static int
bindingHashCode(@NonNull Protocols obj)
Default implementation ofObject.hashCode()
contract for this interface.static String
bindingToString(@NonNull Protocols obj)
Default implementation ofObject.toString()
contract for this interface.@Nullable Map<ProtocolKey,Protocol>
getProtocol()
Return protocol, ornull
if it is not present.default Class<Protocols>
implementedInterface()
default @NonNull Map<ProtocolKey,Protocol>
nonnullProtocol()
Return protocol, or an empty list if it is not present.
-
-
-
Method Detail
-
implementedInterface
default Class<Protocols> 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 Protocols 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 Protocols 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 Protocols 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
-
getProtocol
@Nullable Map<ProtocolKey,Protocol> getProtocol()
Return protocol, ornull
if it is not present.A process (instance) of a routing protocol. Some systems may not support more than one instance of a particular routing protocol
- Returns:
Map<ProtocolKey, Protocol>
protocol, ornull
if it is not present.
-
nonnullProtocol
default @NonNull Map<ProtocolKey,Protocol> nonnullProtocol()
Return protocol, or an empty list if it is not present.- Returns:
Map<ProtocolKey, Protocol>
protocol, or an empty list if it is not present.
-
-