Interface Protocol
-
- All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<Protocol>
,org.opendaylight.yangtools.yang.binding.BindingObject
,org.opendaylight.yangtools.yang.binding.ChildOf<Protocols>
,org.opendaylight.yangtools.yang.binding.DataContainer
,org.opendaylight.yangtools.yang.binding.DataObject
,org.opendaylight.yangtools.yang.binding.Identifiable<ProtocolKey>
@Generated("mdsal-binding-generator") public interface Protocol extends org.opendaylight.yangtools.yang.binding.ChildOf<Protocols>, org.opendaylight.yangtools.yang.binding.Augmentable<Protocol>, org.opendaylight.yangtools.yang.binding.Identifiable<ProtocolKey>
A process (instance) of a routing protocol. Some systems may not support more than one instance of a particular routing protocolThis class represents the following YANG schema fragment defined in module openconfig-network-instance
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-instanceprotocolsprotocolTo create instances of this class use
ProtocolBuilder
.- See Also:
ProtocolBuilder
,ProtocolKey
-
-
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 Protocol thisObj, Object obj)
Default implementation ofObject.equals(Object)
contract for this interface.static int
bindingHashCode(@NonNull Protocol obj)
Default implementation ofObject.hashCode()
contract for this interface.static String
bindingToString(@NonNull Protocol obj)
Default implementation ofObject.toString()
contract for this interface.Aggregate
getAggregate()
Return aggregate, ornull
if it is not present.Config
getConfig()
Return config, ornull
if it is not present.Class<? extends InstallProtocolType>
getIdentifier()
Return identifier, ornull
if it is not present.String
getName()
Return name, ornull
if it is not present.State
getState()
Return state, ornull
if it is not present.Static
getStatic()
Return static, ornull
if it is not present.default Class<Protocol>
implementedInterface()
ProtocolKey
key()
default @NonNull Class<? extends InstallProtocolType>
requireIdentifier()
Return identifier, guaranteed to be non-null.default @NonNull String
requireName()
Return name, guaranteed to be non-null.
-
-
-
Method Detail
-
implementedInterface
default Class<Protocol> 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 Protocol 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 Protocol 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 Protocol 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
ProtocolKey key()
- Specified by:
key
in interfaceorg.opendaylight.yangtools.yang.binding.Identifiable<ProtocolKey>
-
getIdentifier
Class<? extends InstallProtocolType> getIdentifier()
Return identifier, ornull
if it is not present.The protocol name for the routing or forwarding protocol to be instantiated
- Returns:
Class<? extends InstallProtocolType>
identifier, ornull
if it is not present.
-
requireIdentifier
default @NonNull Class<? extends InstallProtocolType> requireIdentifier()
Return identifier, guaranteed to be non-null.The protocol name for the routing or forwarding protocol to be instantiated
- Returns:
Class<? extends InstallProtocolType>
identifier, guaranteed to be non-null.- Throws:
NoSuchElementException
- if identifier is not present
-
getName
String getName()
Return name, ornull
if it is not present.An operator-assigned identifier for the routing or forwarding protocol. For some processes this leaf may be system defined.
- Returns:
String
name, ornull
if it is not present.
-
requireName
default @NonNull String requireName()
Return name, guaranteed to be non-null.An operator-assigned identifier for the routing or forwarding protocol. For some processes this leaf may be system defined.
- Returns:
String
name, guaranteed to be non-null.- Throws:
NoSuchElementException
- if name is not present
-
getConfig
Config getConfig()
Return config, ornull
if it is not present.Configuration parameters relating to the routing protocol instance
- Returns:
Config
config, ornull
if it is not present.
-
getState
State getState()
Return state, ornull
if it is not present.State parameters relating to the routing protocol instance
- Returns:
State
state, ornull
if it is not present.
-
getStatic
Static getStatic()
Return static, ornull
if it is not present.Configuration and state parameters relating to static routes
- Returns:
Static
static, ornull
if it is not present.
-
getAggregate
Aggregate getAggregate()
Return aggregate, ornull
if it is not present.Configuration and state parameters relating to locally generated aggregate routes
- Returns:
Aggregate
aggregate, ornull
if it is not present.
-
-