Fixing sonar issues 2

[yangtools.git] / code-generator / binding-model-api / src / main / java / org / opendaylight / yangtools / sal / binding / model / api / Constant.java

diff --git a/code-generator/binding-model-api/src/main/java/org/opendaylight/yangtools/sal/binding/model/api/Constant.java b/code-generator/binding-model-api/src/main/java/org/opendaylight/yangtools/sal/binding/model/api/Constant.java
index 1fbf3254240167cc1795aff8c629339010127079..31d673c7028d9b292c3b16fc7e87dfd56b6e8c4c 100644 (file)
--- a/code-generator/binding-model-api/src/main/java/org/opendaylight/yangtools/sal/binding/model/api/Constant.java
+++ b/code-generator/binding-model-api/src/main/java/org/opendaylight/yangtools/sal/binding/model/api/Constant.java
@@ -1,67 +1,63 @@
-/*\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.sal.binding.model.api;\r
-\r
-/**\r
- * Interface Contact is designed to hold and model java constant. In Java\r
- * there are no constant keywords instead of the constant is defined as\r
- * static final field with assigned value. For this purpose the Constant\r
- * interface contains methods {@link #getType()} to provide wrapped return\r
- * Type of Constant, {@link #getName()} the Name of constant and the {@link\r
- * #getValue()} for providing of value assigned to Constant. To determine of\r
- * which type the constant value is it is recommended firstly to retrieve\r
- * Type from constant. The Type interface holds base information like java\r
- * package name and java type name (e.g. fully qualified name). From this\r
- * string user should be able to determine to which type can be {@link\r
- * #getValue()} type typecasted to unbox and provide value assigned to\r
- * constant.\r
- */\r
-public interface Constant {\r
-\r
-    /**\r
-     * Returns the Type that declares constant.\r
-     *\r
-     * @return the Type that declares constant.\r
-     */\r
-    public Type getDefiningType();\r
-\r
-    /**\r
-     * Returns the return Type (or just Type) of the Constant.\r
-     *\r
-     * @return the return Type (or just Type) of the Constant.\r
-     */\r
-    public Type getType();\r
-\r
-    /**\r
-     * Returns the name of constant.\r
-     * <br>\r
-     * By conventions the name SHOULD be in CAPITALS separated with\r
-     * underscores.\r
-     *\r
-     * @return the name of constant.\r
-     */\r
-    public String getName();\r
-\r
-    /**\r
-     * Returns boxed value that is assigned for context.\r
-     *\r
-     * @return boxed value that is assigned for context.\r
-     */\r
-    public Object getValue();\r
-\r
-    /**\r
-     * Returns Constant definition in formatted string.\r
-     * <br>\r
-     * <br>\r
-     * The expected string SHOULD be in format: <code>public final\r
-     * static [Type] CONSTANT_NAME = [value];</code>\r
-     *\r
-     * @return Constant definition in formatted string.\r
-     */\r
-    public String toFormattedString();\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.sal.binding.model.api;
+
+/**
+ * Interface Contact is designed to hold and model java constant. In Java there
+ * are no constant keywords instead of the constant is defined as static final
+ * field with assigned value. For this purpose the Constant interface contains
+ * methods {@link #getType()} to provide wrapped return Type of Constant,
+ * {@link #getName()} the Name of constant and the {@link #getValue()} for
+ * providing of value assigned to Constant. To determine of which type the
+ * constant value is it is recommended firstly to retrieve Type from constant.
+ * The Type interface holds base information like java package name and java
+ * type name (e.g. fully qualified name). From this string user should be able
+ * to determine to which type can be {@link #getValue()} type typecasted to
+ * unbox and provide value assigned to constant.
+ */
+public interface Constant {
+
+    /**
+     * Returns the Type that declares constant.
+     * 
+     * @return the Type that declares constant.
+     */
+    Type getDefiningType();
+
+    /**
+     * Returns the return Type (or just Type) of the Constant.
+     * 
+     * @return the return Type (or just Type) of the Constant.
+     */
+    Type getType();
+
+    /**
+     * Returns the name of constant. <br>
+     * By conventions the name SHOULD be in CAPITALS separated with underscores.
+     * 
+     * @return the name of constant.
+     */
+    String getName();
+
+    /**
+     * Returns boxed value that is assigned for context.
+     * 
+     * @return boxed value that is assigned for context.
+     */
+    Object getValue();
+
+    /**
+     * Returns Constant definition in formatted string. <br>
+     * <br>
+     * The expected string SHOULD be in format: <code>public final
+     * static [Type] CONSTANT_NAME = [value];</code>
+     * 
+     * @return Constant definition in formatted string.
+     */
+    String toFormattedString();
+}