Package org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventaggregator.rev141202

Interface TopicNotification

All Superinterfaces:

Augmentable<TopicNotification>, BaseNotification, BindingObject, DataContainer, DataObject, Notification

public interface TopicNotification
extends DataObject, Augmentable<TopicNotification>, Notification

Notification of an event occuring on a particular node. This notification acts as an encapsulation for the event being delivered.

This class represents the following YANG schema fragment defined in module UnqualifiedQName{localName=event-aggregator}

 notification topic-notification {
   leaf topic-id {
     type topic-id;
   }
   leaf node-id {
     type string;
   }
   anyxml payload {
   }
 }
 

The schema path to identify an instance is event-aggregator/topic-notification

To create instances of this class use TopicNotificationBuilder.

See Also:

TopicNotificationBuilder

Field Summary

Fields

Modifier and Type	Field	Description
static @NonNull QName	QNAME

Method Summary

Modifier and Type	Method	Description
static boolean	bindingEquals(@NonNull TopicNotification thisObj, Object obj)	Default implementation of Object.equals(Object) contract for this interface.
static int	bindingHashCode(@NonNull TopicNotification obj)	Default implementation of Object.hashCode() contract for this interface.
static String	bindingToString(@NonNull TopicNotification obj)	Default implementation of Object.toString() contract for this interface.
@Nullable String	getNodeId()	Return nodeId, or null if it is not present..
@Nullable Payload	getPayload()	Return payload, or null if it is not present..
@Nullable TopicId	getTopicId()	Return topicId, or null if it is not present..
default Class<TopicNotification>	implementedInterface()

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

augmentation, augmentations

Field Detail

QNAME

static final @NonNull QName QNAME

Method Detail

implementedInterface

default Class<TopicNotification> implementedInterface()

Specified by:

implementedInterface in interface DataContainer

Specified by:

implementedInterface in interface DataObject

bindingHashCode

static int bindingHashCode(@NonNull TopicNotification 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 TopicNotification 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 TopicNotification 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

getTopicId

@Nullable TopicId getTopicId()

Return topicId, or null if it is not present..

     
         Topic to which this event is being delivered.
     
 

Returns:

org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventaggregator.rev141202.TopicId topicId, or null if it is not present.

getNodeId

@Nullable String getNodeId()

Return nodeId, or null if it is not present..

     
         Node ID of the node which generated the event.
     
 

Returns:

java.lang.String nodeId, or null if it is not present.

getPayload

@Nullable Payload getPayload()

Return payload, or null if it is not present..

     
         Encapsulated notification. The format is the XML representation of a
         notification according to RFC6020 section 7.14.2.
     
 

Returns:

org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.messagebus.eventaggregator.rev141202.topic.notification.Payload payload, or null if it is not present.