Shift Builder<P> from toInstance() to build()
authorEd Warnicke <eaw@cisco.com>
Mon, 12 Jan 2015 00:25:53 +0000 (18:25 -0600)
committerEd Warnicke <eaw@cisco.com>
Thu, 15 Jan 2015 13:16:00 +0000 (07:16 -0600)
In order to be able to use Builder<P> as a marker
on generated Builders, it needed to shift to build()

All 'internal' uses for Builder have been changed
to use build().  For things used outside of yangtools,
a depracted toInstance() is maintained on child
interfaces/classes.

Change-Id: I43662296e328133a5b5267be54d407e2ad4b95e8
Signed-off-by: Ed Warnicke <eaw@cisco.com>
12 files changed:
code-generator/binding-data-codec/src/test/java/org/opendaylight/yangtools/binding/data/codec/test/AugmentationSubstitutionTest.java
code-generator/binding-data-codec/src/test/java/org/opendaylight/yangtools/binding/data/codec/test/CaseSubstitutionTest.java
code-generator/binding-data-codec/src/test/java/org/opendaylight/yangtools/binding/data/codec/test/EmptyLeafTest.java
code-generator/binding-data-codec/src/test/java/org/opendaylight/yangtools/binding/data/codec/test/InstanceIdentifierSerializeDeserializeTest.java
code-generator/binding-data-codec/src/test/java/org/opendaylight/yangtools/binding/data/codec/test/InstanceIdentifierTest.java
code-generator/binding-data-codec/src/test/java/org/opendaylight/yangtools/binding/data/codec/test/LeafReferenceTest.java
code-generator/binding-data-codec/src/test/java/org/opendaylight/yangtools/binding/data/codec/test/NormalizedNodeSerializeDeserializeTest.java
code-generator/maven-sal-api-gen-plugin/src/main/java/org/opendaylight/yangtools/yang/unified/doc/generator/GeneratorImpl.xtend
yang/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/InstanceIdentifier.java
yang/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/InstanceIdentifierBuilderImpl.java
yang/yang-binding/src/test/java/org/opendaylight/yangtools/yang/binding/test/InstanceIdentifierTest.java
yang/yang-binding/src/test/java/org/opendaylight/yangtools/yang/binding/util/DataObjectReadingUtilTest.java

index 62d913f8b6ad11850238e13c03048a7a949d6f16..6dc53e5f8f522614859498069a79dd5dd496f488 100644 (file)
@@ -36,7 +36,7 @@ public class AugmentationSubstitutionTest extends AbstractBindingRuntimeTest {
 
     private static final TopLevelListKey TOP_FOO_KEY = new TopLevelListKey("foo");
     private static final InstanceIdentifier<TopLevelList> BA_TOP_LEVEL_LIST = InstanceIdentifier.builder(Top.class)
-            .child(TopLevelList.class, TOP_FOO_KEY).toInstance();
+            .child(TopLevelList.class, TOP_FOO_KEY).build();
     private static final InstanceIdentifier<TreeLeafOnlyAugment> BA_TREE_LEAF_ONLY = BA_TOP_LEVEL_LIST
             .augmentation(TreeLeafOnlyAugment.class);
     private static final InstanceIdentifier<TreeComplexUsesAugment> BA_TREE_COMPLEX_USES = BA_TOP_LEVEL_LIST
index a01e12d1729701291baec3aef71d62ad8b42ccc9..c90a5a86be3066bb06c3919177a34d47aed6748a 100644 (file)
@@ -37,7 +37,7 @@ public class CaseSubstitutionTest extends AbstractBindingRuntimeTest {
 
     private static final TopLevelListKey TOP_FOO_KEY = new TopLevelListKey("foo");
     private static final InstanceIdentifier<TopLevelList> BA_TOP_LEVEL_LIST = InstanceIdentifier.builder(Top.class)
-            .child(TopLevelList.class, TOP_FOO_KEY).toInstance();
+            .child(TopLevelList.class, TOP_FOO_KEY).build();
     private static final InstanceIdentifier<TreeLeafOnlyAugment> BA_TREE_LEAF_ONLY = BA_TOP_LEVEL_LIST
             .augmentation(TreeLeafOnlyAugment.class);
     private static final InstanceIdentifier<TreeComplexUsesAugment> BA_TREE_COMPLEX_USES = BA_TOP_LEVEL_LIST
index 53258f8e116b9d30a06920447df68043f3097c5d..26d9bbba21f4ad533efc561bbdf780f0047e5d57 100644 (file)
@@ -40,7 +40,7 @@ public class EmptyLeafTest extends AbstractBindingRuntimeTest {
 
     private static final TopLevelListKey TOP_FOO_KEY = new TopLevelListKey("foo");
     private static final InstanceIdentifier<TopLevelList> BA_TOP_LEVEL_LIST = InstanceIdentifier.builder(Top.class)
-            .child(TopLevelList.class, TOP_FOO_KEY).toInstance();
+            .child(TopLevelList.class, TOP_FOO_KEY).build();
     private static final InstanceIdentifier<TreeLeafOnlyAugment> BA_TREE_LEAF_ONLY = BA_TOP_LEVEL_LIST
             .augmentation(TreeLeafOnlyAugment.class);
     private static final InstanceIdentifier<TreeComplexUsesAugment> BA_TREE_COMPLEX_USES = BA_TOP_LEVEL_LIST
index b0fca82863c6a8ca3553755be5e18135af5fd0df..b276bbd534ce608c2f5b660fc4d45f7de0f7aba3 100644 (file)
@@ -34,7 +34,7 @@ public class InstanceIdentifierSerializeDeserializeTest extends AbstractBindingR
 
     private static final TopLevelListKey TOP_FOO_KEY = new TopLevelListKey("foo");
     private static final InstanceIdentifier<TopLevelList> BA_TOP_LEVEL_LIST = InstanceIdentifier
-            .builder(Top.class).child(TopLevelList.class, TOP_FOO_KEY).toInstance();
+            .builder(Top.class).child(TopLevelList.class, TOP_FOO_KEY).build();
     private static final InstanceIdentifier<TreeLeafOnlyAugment> BA_TREE_LEAF_ONLY =
             BA_TOP_LEVEL_LIST.augmentation(TreeLeafOnlyAugment.class);
     private static final InstanceIdentifier<TreeComplexUsesAugment> BA_TREE_COMPLEX_USES =
index e011017894c3947bdaa3cf59805fe0b425927692..fa8b48a35b9744ff55ad965fe5f48633fc733beb 100644 (file)
@@ -31,7 +31,7 @@ public class InstanceIdentifierTest extends AbstractBindingRuntimeTest {
 
     private static final TopLevelListKey TOP_FOO_KEY = new TopLevelListKey("foo");
     private static final InstanceIdentifier<TopLevelList> BA_TOP_LEVEL_LIST = InstanceIdentifier.builder(Top.class)
-            .child(TopLevelList.class, TOP_FOO_KEY).toInstance();
+            .child(TopLevelList.class, TOP_FOO_KEY).build();
     private static final InstanceIdentifier<TreeLeafOnlyAugment> BA_TREE_LEAF_ONLY = BA_TOP_LEVEL_LIST
             .augmentation(TreeLeafOnlyAugment.class);
     private static final InstanceIdentifier<TreeComplexUsesAugment> BA_TREE_COMPLEX_USES = BA_TOP_LEVEL_LIST
index ba8c84cd96a8c7e0617e44ef22e3a3df32216c23..10dce65e2750d5c67fb4dc27422b68b0f17849e0 100644 (file)
@@ -32,7 +32,7 @@ public class LeafReferenceTest extends AbstractBindingRuntimeTest {
 
     private static final TopLevelListKey TOP_FOO_KEY = new TopLevelListKey("foo");
     private static final InstanceIdentifier<TreeComplexLeaves> BA_TOP_LEVEL_LIST = InstanceIdentifier.builder(Top.class)
-            .child(TopLevelList.class, TOP_FOO_KEY).augmentation(TreeComplexLeaves.class).toInstance();
+            .child(TopLevelList.class, TOP_FOO_KEY).augmentation(TreeComplexLeaves.class).build();
 
     private BindingNormalizedNodeCodecRegistry registry;
 
index 4b08fbe17f5d3283f4748adc4dd9a48af7f90fca..f223bfef285a843a9446c4aebffa34d7bc7d463f 100644 (file)
@@ -79,7 +79,7 @@ public class NormalizedNodeSerializeDeserializeTest extends AbstractBindingRunti
     private static final QName SIMPLE_VALUE_QNAME = QName.create(TreeComplexUsesAugment.QNAME, "simple-value");
 
     private static final InstanceIdentifier<TopLevelList> BA_TOP_LEVEL_LIST = InstanceIdentifier
-            .builder(Top.class).child(TopLevelList.class, TOP_LEVEL_LIST_FOO_KEY).toInstance();
+            .builder(Top.class).child(TopLevelList.class, TOP_LEVEL_LIST_FOO_KEY).build();
     private static final InstanceIdentifier<TreeLeafOnlyAugment> BA_TREE_LEAF_ONLY =
             BA_TOP_LEVEL_LIST.augmentation(TreeLeafOnlyAugment.class);
     private static final InstanceIdentifier<TreeComplexUsesAugment> BA_TREE_COMPLEX_USES =
index 672f26eb1e04f3087e3063f12e9d5b9aa12ec56c..62f628c50f5f23593d3672d948de69ad94d5a9f6 100644 (file)
@@ -754,7 +754,7 @@ class GeneratorImpl {
 
     def CharSequence tree(Module module) '''
         «strong(module.name)»
-        «module.childNodes.treeSet(YangInstanceIdentifier.builder.toInstance())»
+        «module.childNodes.treeSet(YangInstanceIdentifier.builder.build())»
     '''
 
     private def dispatch CharSequence tree(ChoiceNode node,YangInstanceIdentifier path) '''
@@ -794,7 +794,7 @@ class GeneratorImpl {
         «IF !childNodes.nullOrEmpty»
             <h2>Child nodes</h2>
 
-            «childNodes.printChildren(3,YangInstanceIdentifier.builder().toInstance())»
+            «childNodes.printChildren(3,YangInstanceIdentifier.builder().build())»
         «ENDIF»
     '''
 
index 934c90d9ae77aea68079ad3b0a91eb6489dda1bc..087a92c64b91f3de084af846306b6717ccca0bc0 100644 (file)
@@ -430,7 +430,7 @@ public class InstanceIdentifier<T extends DataObject> implements Path<InstanceId
         }
         Preconditions.checkArgument(a != null, "pathArguments may not be empty");
 
-        return trustedCreate(a, pathArguments, hashBuilder.toInstance(), wildcard);
+        return trustedCreate(a, pathArguments, hashBuilder.build(), wildcard);
     }
 
     /**
@@ -667,6 +667,12 @@ public class InstanceIdentifier<T extends DataObject> implements Path<InstanceId
          * @return
          */
         InstanceIdentifier<T> build();
+
+        /*
+         * @deprecated use #build()
+         */
+        @Deprecated
+        InstanceIdentifier<T> toInstance();
     }
 
     private void writeObject(final java.io.ObjectOutputStream out) throws IOException {
index 3ba833d2f471f4c9563d551796fb34114d9faa6f..5be717b574dbba76ea56458a0bb95fb8e7dd8bf0 100644 (file)
@@ -37,7 +37,7 @@ final class InstanceIdentifierBuilderImpl<T extends DataObject> implements Insta
 
     @Override
     public int hashCode() {
-        return hashBuilder.toInstance();
+        return hashBuilder.build();
     }
 
     @SuppressWarnings("unchecked")
@@ -96,11 +96,14 @@ final class InstanceIdentifierBuilderImpl<T extends DataObject> implements Insta
         }
 
         @SuppressWarnings("unchecked")
-        final InstanceIdentifier<T> ret = (InstanceIdentifier<T>) InstanceIdentifier.trustedCreate(arg, pathArguments, hashBuilder.toInstance(), wildcard);
+        final InstanceIdentifier<T> ret = (InstanceIdentifier<T>) InstanceIdentifier.trustedCreate(arg, pathArguments, hashBuilder.build(), wildcard);
         return ret;
     }
 
-    @Override
+    /*
+     * @deprecated Use #build() instead.
+     */
+    @Deprecated
     public InstanceIdentifier<T> toInstance() {
         return build();
     }
index e4188b470da3722e6004c114207d3954c80260aa..34e3911516cdb5ea35494ab5dfbd9ad304019f85 100644 (file)
@@ -27,13 +27,13 @@ public class InstanceIdentifierTest {
     @Test
     public void constructWithPredicates() {
 
-        InstanceIdentifier<Nodes> nodes = InstanceIdentifier.builder(Nodes.class).toInstance();
+        InstanceIdentifier<Nodes> nodes = InstanceIdentifier.builder(Nodes.class).build();
 
         assertNotNull(nodes);
         assertEquals(Nodes.class, nodes.getTargetType());
 
 
-        InstanceIdentifier<Node> node = nodes.builder().child(Node.class).toInstance();
+        InstanceIdentifier<Node> node = nodes.builder().child(Node.class).build();
 
         assertNotNull(node);
         assertEquals(Node.class, node.getTargetType());
@@ -44,8 +44,8 @@ public class InstanceIdentifierTest {
     @Test
     public void fluentConstruction() {
 
-        InstanceIdentifier<Nodes> nodes = InstanceIdentifier.builder(Nodes.class).toInstance();
-        InstanceIdentifier<Node> node = InstanceIdentifier.builder(Nodes.class).child(Node.class,new NodeKey(10)).toInstance();
+        InstanceIdentifier<Nodes> nodes = InstanceIdentifier.builder(Nodes.class).build();
+        InstanceIdentifier<Node> node = InstanceIdentifier.builder(Nodes.class).child(Node.class,new NodeKey(10)).build();
 
         assertNotNull(node);
         assertEquals(Node.class, node.getTargetType());
@@ -59,10 +59,10 @@ public class InstanceIdentifierTest {
         InstanceIdentifier<FooChild> fooChild = InstanceIdentifier.builder(Nodes.class).child(InstantiatedFoo.class).child(FooChild.class).build();
 
         InstanceIdentifier<Node> nodeTen = InstanceIdentifier.builder(Nodes.class) //
-                .child(Node.class,new NodeKey(10)).toInstance();
+                .child(Node.class,new NodeKey(10)).build();
         InstanceIdentifier<Node> nodeOne = InstanceIdentifier.builder(Nodes.class) //
-                .child(Node.class,new NodeKey(1)).toInstance();
-        InstanceIdentifier<Nodes> nodes = InstanceIdentifier.builder(Nodes.class).toInstance();
+                .child(Node.class,new NodeKey(1)).build();
+        InstanceIdentifier<Nodes> nodes = InstanceIdentifier.builder(Nodes.class).build();
 
         assertFalse(fooChild.contains(nodeTen));
         assertFalse(nodeTen.contains(nodes));
@@ -73,7 +73,7 @@ public class InstanceIdentifierTest {
 
     @Test
     public void containsWildcarded() {
-        InstanceIdentifier<Nodes> nodes = InstanceIdentifier.builder(Nodes.class).toInstance();
+        InstanceIdentifier<Nodes> nodes = InstanceIdentifier.builder(Nodes.class).build();
         InstanceIdentifier<Node> wildcarded = InstanceIdentifier.builder(Nodes.class).child(Node.class).build();
         InstanceIdentifier<NodeChild> wildcardedChildren = InstanceIdentifier.builder(Nodes.class) //
                 .child(Node.class) //
@@ -84,9 +84,9 @@ public class InstanceIdentifierTest {
 
 
         InstanceIdentifier<Node> nodeTen = InstanceIdentifier.builder(Nodes.class) //
-                .child(Node.class,new NodeKey(10)).toInstance();
+                .child(Node.class,new NodeKey(10)).build();
         InstanceIdentifier<Node> nodeOne = InstanceIdentifier.builder(Nodes.class) //
-                .child(Node.class,new NodeKey(1)).toInstance();
+                .child(Node.class,new NodeKey(1)).build();
 
         assertFalse(nodeTen.isWildcarded());
         assertFalse(nodeOne.isWildcarded());
@@ -96,14 +96,14 @@ public class InstanceIdentifierTest {
 
 
         InstanceIdentifier<NodeChild> nodeTenChildWildcarded = InstanceIdentifier.builder(Nodes.class) //
-                .child(Node.class,new NodeKey(10)).child(NodeChild.class).toInstance();
+                .child(Node.class,new NodeKey(10)).child(NodeChild.class).build();
 
         assertTrue(nodeTenChildWildcarded.isWildcarded());
 
         InstanceIdentifier<NodeChild> nodeTenChild = InstanceIdentifier.builder(Nodes.class) //
-                .child(Node.class,new NodeKey(10)).child(NodeChild.class, new NodeChildKey(10)).toInstance();
+                .child(Node.class,new NodeKey(10)).child(NodeChild.class, new NodeChildKey(10)).build();
         InstanceIdentifier<NodeChild> nodeOneChild = InstanceIdentifier.builder(Nodes.class) //
-                .child(Node.class,new NodeKey(1)).child(NodeChild.class, new NodeChildKey(1)).toInstance();
+                .child(Node.class,new NodeKey(1)).child(NodeChild.class, new NodeChildKey(1)).build();
 
 
         assertFalse(nodeTenChildWildcarded.containsWildcarded(nodeOneChild));
index e2400f9f3d5c2d30d1640ea11fc9bfe16a0bc81a..29dc602f60122400635544c92c0d462f95ff89ad 100644 (file)
@@ -33,7 +33,7 @@ public class DataObjectReadingUtilTest {
     public void setup() {
         MockitoAnnotations.initMocks(this);
 
-        path = InstanceIdentifier.builder(Nodes.class).toInstance();
+        path = InstanceIdentifier.builder(Nodes.class).build();
         ImmutableMap map = ImmutableMap.<InstanceIdentifier<? extends DataObject>,
                 DataObject>builder().put(path, mockedDataObject).build();