Improve {Action,Notification}NodeContainerCompat safety

[yangtools.git] / yang / yang-model-api / src / main / java / org / opendaylight / yangtools / yang / model / api / ConstraintMetaDefinition.java

diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ConstraintMetaDefinition.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ConstraintMetaDefinition.java
index 060fe2b089110997fced678874091fda917e802a..a02851319bf14c0fc573db29631dbe496e588304 100644 (file)
--- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ConstraintMetaDefinition.java
+++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/ConstraintMetaDefinition.java
@@ -1,19 +1,31 @@
-/*\r
- * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.\r
- *\r
- * This program and the accompanying materials are made available under the\r
- * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
- * and is available at http://www.eclipse.org/legal/epl-v10.html\r
- */\r
-package org.opendaylight.yangtools.yang.model.api;\r
-\r
-public interface ConstraintMetaDefinition {\r
-\r
-    String getDescription();\r
-\r
-    String getErrorAppTag();\r
-\r
-    String getErrorMessage();\r
-\r
-    String getReference();\r
-}\r
+/*
+ * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.yangtools.yang.model.api;
+
+import java.util.Optional;
+
+/**
+ * Contains methods which retrieve values for description, error message, error app tag and reference (to some external
+ * definition, resource or similar).
+ */
+public interface ConstraintMetaDefinition extends DocumentedNode {
+
+    /**
+     * Returns the value of the argument of YANG <code>error-app-tag</code> keyword.
+     *
+     * @return string with the application tag, or empty if it was not provided.
+     */
+    Optional<String> getErrorAppTag();
+
+    /**
+     * Returns the value of the argument of YANG <code>error-message</code> keyword.
+     *
+     * @return string with the error message, or empty if it was not provided.
+     */
+    Optional<String> getErrorMessage();
+}