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

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

diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/IdentitySchemaNode.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/IdentitySchemaNode.java
index 597b7a8acbf3b9d8fa1efee313bac77fc5c19db0..be0fbd08fdef6fdab5d1abfb1c3ef080b36d8d76 100644 (file)
--- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/IdentitySchemaNode.java
+++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/IdentitySchemaNode.java
@@ -1,36 +1,54 @@
-/*\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
-import java.util.Set;\r
-\r
-/**\r
- * Interface describing YANG 'identity' statement.\r
- * <p>\r
- * The 'identity' statement is used to define a new globally unique, abstract,\r
- * and untyped identity. Its only purpose is to denote its name, semantics, and\r
- * existence. The built-in datatype "identityref" can be used to reference\r
- * identities within a data model.\r
- * </p>\r
- */\r
-public interface IdentitySchemaNode extends SchemaNode {\r
-\r
-    /**\r
-     * @return an existing identity, from which the new identity is derived or\r
-     *         null, if the identity is defined from scratch.\r
-     */\r
-    IdentitySchemaNode getBaseIdentity();\r
-\r
-    /**\r
-     * Get identities derived from this identity.\r
-     *\r
-     * @return collection of identities derived from this identity\r
-     */\r
-    Set<IdentitySchemaNode> getDerivedIdentities();\r
-\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 com.google.common.collect.ImmutableSet;
+import java.util.Set;
+import javax.annotation.Nonnull;
+
+/**
+ * Interface describing YANG 'identity' statement.
+ *
+ * <p>
+ * The 'identity' statement is used to define a new globally unique, abstract,
+ * and untyped identity. Its only purpose is to denote its name, semantics, and
+ * existence. The built-in datatype "identityref" can be used to reference
+ * identities within a data model.
+ */
+public interface IdentitySchemaNode extends SchemaNode {
+    /**
+     * Return the base identity.
+     * @deprecated use {@link #getBaseIdentities()} instead.
+     *
+     * @return an existing identity, from which the new identity is derived or
+     *         null, if the identity is defined from scratch.
+     */
+    @Deprecated IdentitySchemaNode getBaseIdentity();
+
+    /**
+     * The YANG 1.0 (RFC6020) implementation of IdentitySchemaNode always returns an ImmutableSet containing just one
+     * base identity or an empty ImmutableSet as it does not support multiple base identities.
+     * Starting with YANG 1.1 (RFC7950), the identity can be derived from multiple base identities.
+     *
+     * @return set of existing identities from which the new identity is derived or
+     *         an empty ImmutableSet if the identity is defined from scratch.
+     */
+    // FIXME: version 2.0.0: make this method non-default
+    @Nonnull default Set<IdentitySchemaNode> getBaseIdentities() {
+        final IdentitySchemaNode base = getBaseIdentity();
+        return base == null ? ImmutableSet.of() : ImmutableSet.of(base);
+    }
+
+    /**
+     * Get identities derived from this identity.
+     *
+     * @return collection of identities derived from this identity
+     */
+    Set<IdentitySchemaNode> getDerivedIdentities();
+
+}