BUG-6533: add immutable implementations of yang.model.api

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

diff --git a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/UnionTypeDefinition.java b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/UnionTypeDefinition.java
index 98f5eac4a8255c21bcd8aa2e0889cab601aa79d7..c08cc7602dd439ff28477bf394874bea2ccd82bf 100644 (file)
--- a/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/UnionTypeDefinition.java
+++ b/yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/type/UnionTypeDefinition.java
@@ -8,11 +8,19 @@
 package org.opendaylight.yangtools.yang.model.api.type;
 
 import java.util.List;
-
 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
 
-public interface UnionTypeDefinition extends
-        TypeDefinition<UnionTypeDefinition> {
+/**
+ * Contains the method which access union item in the union type.
+ */
+public interface UnionTypeDefinition extends TypeDefinition<UnionTypeDefinition> {
 
-    public List<TypeDefinition<?>> getTypes();
+    /**
+     * Returns type definitions which represent the values of the arguments for
+     * all YANG <code>type</code> substatement in the main <code>union</code>
+     * statement.
+     *
+     * @return list of the type definition which contains the union items.
+     */
+    List<TypeDefinition<?>> getTypes();
 }