-/*\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
-import java.util.List;\r
-\r
-/**\r
- * Generated Transfer Object extends {@link GeneratedType} and is designed to\r
- * represent Java Class. The Generated Transfer Object contains declarations of\r
- * member fields stored in List of Properties. The Generated Transfer Object can\r
- * be extended by exactly ONE Generated Transfer Object as Java don't allow\r
- * multiple inheritance. For retrieval of implementing Generated Types use\r
- * {@link #getImplements()} method. <br>\r
- * Every transfer object SHOULD contain equals, hashCode and toString\r
- * definitions. For this purpose retrieve definitions through\r
- * {@link #getEqualsIdentifiers ()}, {@link #getHashCodeIdentifiers()} and\r
- * {@link #getToStringIdentifiers ()}.\r
- * \r
- */\r
-public interface GeneratedTransferObject extends GeneratedType {\r
-\r
- /**\r
- * Returns the extending Generated Transfer Object or <code>null</code> if\r
- * there is no extending Generated Transfer Object.\r
- * \r
- * @return the extending Generated Transfer Object or <code>null</code> if\r
- * there is no extending Generated Transfer Object.\r
- */\r
- public GeneratedTransferObject getSuperType();\r
-\r
- /**\r
- * Returns List of Properties that are designated to define equality for\r
- * Generated Transfer Object.\r
- * \r
- * @return List of Properties that are designated to define equality for\r
- * Generated Transfer Object.\r
- */\r
- public List<GeneratedProperty> getEqualsIdentifiers();\r
-\r
- /**\r
- * Returns List of Properties that are designated to define identity for\r
- * Generated Transfer Object.\r
- * \r
- * @return List of Properties that are designated to define identity for\r
- * Generated Transfer Object.\r
- */\r
- public List<GeneratedProperty> getHashCodeIdentifiers();\r
-\r
- /**\r
- * Returns List of Properties that will be members of toString definition\r
- * for Generated Transfer Object.\r
- * \r
- * @return List of Properties that will be members of toString definition\r
- * for Generated Transfer Object.\r
- */\r
- public List<GeneratedProperty> getToStringIdentifiers();\r
-\r
- /**\r
- * Return boolean value which describe whether Generated Transfer Object\r
- * was/wasn't created from union YANG type.\r
- * \r
- * @return true value if Generated Transfer Object was created from union\r
- * YANG type.\r
- */\r
- @Deprecated\r
- public boolean isUnionType();\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;
+
+import java.util.List;
+
+/**
+ * Generated Transfer Object extends {@link GeneratedType} and is designed to
+ * represent Java Class. The Generated Transfer Object contains declarations of
+ * member fields stored in List of Properties. The Generated Transfer Object can
+ * be extended by exactly ONE Generated Transfer Object as Java don't allow
+ * multiple inheritance. For retrieval of implementing Generated Types use
+ * {@link #getImplements()} method. <br>
+ * Every transfer object SHOULD contain equals, hashCode and toString
+ * definitions. For this purpose retrieve definitions through
+ * {@link #getEqualsIdentifiers ()}, {@link #getHashCodeIdentifiers()} and
+ * {@link #getToStringIdentifiers ()}.
+ *
+ */
+public interface GeneratedTransferObject extends GeneratedType {
+
+ /**
+ * Returns the extending Generated Transfer Object or <code>null</code> if
+ * there is no extending Generated Transfer Object.
+ *
+ * @return the extending Generated Transfer Object or <code>null</code> if
+ * there is no extending Generated Transfer Object.
+ */
+ GeneratedTransferObject getSuperType();
+
+ /**
+ * Returns List of Properties that are designated to define equality for
+ * Generated Transfer Object.
+ *
+ * @return List of Properties that are designated to define equality for
+ * Generated Transfer Object.
+ */
+ List<GeneratedProperty> getEqualsIdentifiers();
+
+ /**
+ * Returns List of Properties that are designated to define identity for
+ * Generated Transfer Object.
+ *
+ * @return List of Properties that are designated to define identity for
+ * Generated Transfer Object.
+ */
+ List<GeneratedProperty> getHashCodeIdentifiers();
+
+ /**
+ * Returns List of Properties that will be members of toString definition
+ * for Generated Transfer Object.
+ *
+ * @return List of Properties that will be members of toString definition
+ * for Generated Transfer Object.
+ */
+ List<GeneratedProperty> getToStringIdentifiers();
+
+ /**
+ * Return boolean value which describe whether Generated Transfer Object
+ * was/wasn't created from union YANG type.
+ *
+ * @return true value if Generated Transfer Object was created from union
+ * YANG type.
+ */
+ @Deprecated
+ boolean isUnionType();
+}
Code Review / yangtools.git / blobdiff