dom/mdsal-dom-api/src/main/java/org/opendaylight/mdsal/dom/api/DOMNotification.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.mdsal.dom.api;
   9
  10 import org.eclipse.jdt.annotation.NonNull;
  11 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  12 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier.Absolute;
  13
  14 /**
  15  * A single YANG notification. This interface captures the data portion of a notification. Implementations may choose
  16  * to additionally implement {@link DOMEvent}, in which case {@link DOMEvent#getEventInstant()} returns the time when
  17  * this notification was generated -- and corresponds to <a href="https://tools.ietf.org/html/rfc5277#section-2.2.1">
  18  * RFC5277</a> NETCONF notification's {@code eventTime} parameter.
  19  */
  20 public interface DOMNotification {
  21     /**
  22      * Return the type of this notification.
  23      *
  24      * @return Notification type.
  25      */
  26     @NonNull Absolute getType();
  27
  28     /**
  29      * Return the body of this notification.
  30      *
  31      * @return Notification body.
  32      */
  33     @NonNull ContainerNode getBody();
  34 }