Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.monitor.config.rev200120.odl.bmp.monitors.bmp.monitor.config

Interface MonitoredRouter

All Superinterfaces:

org.opendaylight.yangtools.yang.binding.Augmentable<MonitoredRouter>, org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<BmpMonitorConfig>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.KeyAware<MonitoredRouterKey>

@Generated("mdsal-binding-generator")
public interface MonitoredRouter
extends org.opendaylight.yangtools.yang.binding.ChildOf<BmpMonitorConfig>, org.opendaylight.yangtools.yang.binding.Augmentable<MonitoredRouter>, org.opendaylight.yangtools.yang.binding.KeyAware<MonitoredRouterKey>

This class represents the following YANG schema fragment defined in module odl-bmp-monitor-config

 list monitored-router {
   leaf address {
     type inet:ip-address-no-zone;
   }
   key address;
   leaf active {
     type boolean;
   }
   leaf port {
     when "../active = 'true'";
     type inet:port-number;
   }
   leaf password {
     type rfc2385:rfc2385-key;
   }
 }
 

To create instances of this class use MonitoredRouterBuilder.

See Also:

• MonitoredRouterBuilder
• MonitoredRouterKey

Field Summary

Fields

Modifier and Type	Field	Description
static final @NonNull org.opendaylight.yangtools.yang.common.QName	QNAME	YANG identifier of the statement represented by this class.

Method Summary

Modifier and Type	Method	Description
static boolean	bindingEquals(@NonNull MonitoredRouter thisObj, Object obj)	Default implementation of Object.equals(Object) contract for this interface.
static int	bindingHashCode(@NonNull MonitoredRouter obj)	Default implementation of Object.hashCode() contract for this interface.
static String	bindingToString(@NonNull MonitoredRouter obj)	Default implementation of Object.toString() contract for this interface.
Boolean	getActive()	Return active, or null if it is not present.
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone	getAddress()	Return address, or null if it is not present.
Rfc2385Key	getPassword()	Return password, or null if it is not present.
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber	getPort()	Return port, or null if it is not present.
default Class<MonitoredRouter>	implementedInterface()
MonitoredRouterKey	key()
default @NonNull Boolean	requireActive()	Return active, guaranteed to be non-null.
default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone	requireAddress()	Return address, guaranteed to be non-null.
default @NonNull Rfc2385Key	requirePassword()	Return password, guaranteed to be non-null.
default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber	requirePort()	Return port, guaranteed to be non-null.

Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

augmentation, augmentationOrElseThrow, augmentationOrElseThrow, augmentations

Field Details

QNAME

static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME

YANG identifier of the statement represented by this class.

Method Details

implementedInterface

default Class<MonitoredRouter> implementedInterface()

Specified by:

implementedInterface in interface org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>

Specified by:

implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

bindingHashCode

static int bindingHashCode(@NonNull MonitoredRouter obj)

Default implementation of Object.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 - if obj is null

bindingEquals

static boolean bindingEquals(@NonNull MonitoredRouter thisObj,
 Object obj)

Default implementation of Object.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 invocation

obj - Object acting as argument to equals invocation

Returns:

True if thisObj and obj are considered equal

Throws:

NullPointerException - if thisObj is null

bindingToString

static String bindingToString(@NonNull MonitoredRouter obj)

Default implementation of Object.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 - if obj is null

key

MonitoredRouterKey key()

Specified by:

key in interface org.opendaylight.yangtools.yang.binding.KeyAware<MonitoredRouterKey>

getAddress

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone getAddress()

Return address, or null if it is not present.

Returns:

IpAddressNoZone address, or null if it is not present.

requireAddress

default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddressNoZone requireAddress()

Return address, guaranteed to be non-null.

Returns:

IpAddressNoZone address, guaranteed to be non-null.

Throws:

NoSuchElementException - if address is not present

getActive

Boolean getActive()

Return active, or null if it is not present.

Returns:

Boolean active, or null if it is not present.

requireActive

default @NonNull Boolean requireActive()

Return active, guaranteed to be non-null.

Returns:

Boolean active, guaranteed to be non-null.

Throws:

NoSuchElementException - if active is not present

getPort

org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber getPort()

Return port, or null if it is not present.

Returns:

PortNumber port, or null if it is not present.

requirePort

default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.PortNumber requirePort()

Return port, guaranteed to be non-null.

Returns:

PortNumber port, guaranteed to be non-null.

Throws:

NoSuchElementException - if port is not present

getPassword

Rfc2385Key getPassword()

Return password, or null if it is not present.

     
         RFC2385 shared secret
     
 

Returns:

Rfc2385Key password, or null if it is not present.

requirePassword

default @NonNull Rfc2385Key requirePassword()

Return password, guaranteed to be non-null.

     
         RFC2385 shared secret
     
 

Returns:

Rfc2385Key password, guaranteed to be non-null.

Throws:

NoSuchElementException - if password is not present