Cleanup checkstyle in yang-{data,model}-api

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

diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/TypeDefinition.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/TypeDefinition.java
index 4ff709e1e4ba06a9f28e45d627b6bedbaecb7837..53ec6ac3e11f3cb598b300275e28423bad8f52ff 100644 (file)
--- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/TypeDefinition.java
+++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/TypeDefinition.java
@@ -1,18 +1,56 @@
-/*\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
-\r
-public interface TypeDefinition<T extends TypeDefinition<?>> extends SchemaNode {\r
-\r
-    T getBaseType();\r
-\r
-    String getUnits();\r
-\r
-    Object getDefaultValue();\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;
+
+/**
+ * YANG statement <code>typedef</code> contains also substatements
+ * <ul>
+ * <li><code>default</code> - default value which is compatible with
+ * <code>type</code>,</li>
+ * <li><code>type</code> - base type from which is <code>typedef</code> derived,
+ * </li>
+ * <li><code>units</code> - textual information about units associated with this
+ * type.</li>
+ * </ul>
+ * This interface contains the methods for getting the values of the arguments
+ * of substatements mentioned above.
+ *
+ * @param <T>
+ *            type of the base type (YANG <code>type</code> substatement) which
+ *            is included in the instance of this type
+ */
+public interface TypeDefinition<T extends TypeDefinition<?>> extends SchemaNode {
+    /**
+     * Returns the base type from which this type is derived. If this is yang
+     * built-in type, returns null.
+     *
+     * @return value of <code>&lt;T&gt;</code> type which represents the base
+     *         type of instance of the <code>TypeDefinition</code> type or null,
+     *         if this is yang built-in type
+     */
+    T getBaseType();
+
+    /**
+     * Returns the unit which represents the value of the argument of the
+     * <code>units</code> substatement of the YANG <code>typedef</code>
+     * statement.
+     *
+     * @return string with units in which is type measured
+     */
+    String getUnits();
+
+    /**
+     * Returns the default value which represents the value of the argument of
+     * the <code>default</code> substatement of the YANG <code>typedef</code>
+     * statement.
+     *
+     * @return instance of <code>Object</code> type which contains default value
+     *         for <code>typedef</code>
+     */
+    Object getDefaultValue();
+}