yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/NotificationDefinition.java

   1 /*
   2  * Copyright (c) 2013 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.yangtools.yang.model.api;
   9
  10 import javax.annotation.Nullable;
  11
  12 /**
  13  * Interface describing YANG 'notification' statement. The notification
  14  * statement is used to define a NETCONF notification.
  15  */
  16 public interface NotificationDefinition extends SchemaNode, DataNodeContainer, AugmentationTarget, CopyableNode {
  17
  18     /**
  19      * All implementations should override this method.
  20      * The default definition of this method is used only in YANG 1.0 (RFC6020) implementation of
  21      * NotificationDefinition which does not support any constraints.
  22      * YANG notification statement has been changed in YANG 1.1 (RFC7950) and now allows must constraints.
  23      *
  24      * @return the constraints associated with this NotificationDefinition
  25      */
  26      // FIXME: version 2.0.0: make this method non-default
  27     @Nullable default ConstraintDefinition getConstraints() {
  28         return null;
  29     }
  30 }