From 17a01f02d80a8e09a2d4eea2ae12f11ea63d1a77 Mon Sep 17 00:00:00 2001 From: Ed Warnicke Date: Sun, 11 Jan 2015 18:25:53 -0600 Subject: [PATCH] Shift Builder

from toInstance() to build() In order to be able to use Builder

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 --- .../test/AugmentationSubstitutionTest.java | 2 +- .../data/codec/test/CaseSubstitutionTest.java | 2 +- .../data/codec/test/EmptyLeafTest.java | 2 +- ...nceIdentifierSerializeDeserializeTest.java | 2 +- .../codec/test/InstanceIdentifierTest.java | 2 +- .../data/codec/test/LeafReferenceTest.java | 2 +- ...ormalizedNodeSerializeDeserializeTest.java | 2 +- .../unified/doc/generator/GeneratorImpl.xtend | 4 +-- .../yang/binding/InstanceIdentifier.java | 8 +++++- .../InstanceIdentifierBuilderImpl.java | 9 ++++--- .../binding/test/InstanceIdentifierTest.java | 26 +++++++++---------- .../util/DataObjectReadingUtilTest.java | 2 +- 12 files changed, 36 insertions(+), 27 deletions(-) diff --git a/code-generator/binding-data-codec/src/test/java/org/opendaylight/yangtools/binding/data/codec/test/AugmentationSubstitutionTest.java b/code-generator/binding-data-codec/src/test/java/org/opendaylight/yangtools/binding/data/codec/test/AugmentationSubstitutionTest.java index 62d913f8b6..6dc53e5f8f 100644 --- a/code-generator/binding-data-codec/src/test/java/org/opendaylight/yangtools/binding/data/codec/test/AugmentationSubstitutionTest.java +++ b/code-generator/binding-data-codec/src/test/java/org/opendaylight/yangtools/binding/data/codec/test/AugmentationSubstitutionTest.java @@ -36,7 +36,7 @@ public class AugmentationSubstitutionTest extends AbstractBindingRuntimeTest { private static final TopLevelListKey TOP_FOO_KEY = new TopLevelListKey("foo"); private static final InstanceIdentifier 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 BA_TREE_LEAF_ONLY = BA_TOP_LEVEL_LIST .augmentation(TreeLeafOnlyAugment.class); private static final InstanceIdentifier BA_TREE_COMPLEX_USES = BA_TOP_LEVEL_LIST diff --git a/code-generator/binding-data-codec/src/test/java/org/opendaylight/yangtools/binding/data/codec/test/CaseSubstitutionTest.java b/code-generator/binding-data-codec/src/test/java/org/opendaylight/yangtools/binding/data/codec/test/CaseSubstitutionTest.java index a01e12d172..c90a5a86be 100644 --- a/code-generator/binding-data-codec/src/test/java/org/opendaylight/yangtools/binding/data/codec/test/CaseSubstitutionTest.java +++ b/code-generator/binding-data-codec/src/test/java/org/opendaylight/yangtools/binding/data/codec/test/CaseSubstitutionTest.java @@ -37,7 +37,7 @@ public class CaseSubstitutionTest extends AbstractBindingRuntimeTest { private static final TopLevelListKey TOP_FOO_KEY = new TopLevelListKey("foo"); private static final InstanceIdentifier 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 BA_TREE_LEAF_ONLY = BA_TOP_LEVEL_LIST .augmentation(TreeLeafOnlyAugment.class); private static final InstanceIdentifier BA_TREE_COMPLEX_USES = BA_TOP_LEVEL_LIST diff --git a/code-generator/binding-data-codec/src/test/java/org/opendaylight/yangtools/binding/data/codec/test/EmptyLeafTest.java b/code-generator/binding-data-codec/src/test/java/org/opendaylight/yangtools/binding/data/codec/test/EmptyLeafTest.java index 53258f8e11..26d9bbba21 100644 --- a/code-generator/binding-data-codec/src/test/java/org/opendaylight/yangtools/binding/data/codec/test/EmptyLeafTest.java +++ b/code-generator/binding-data-codec/src/test/java/org/opendaylight/yangtools/binding/data/codec/test/EmptyLeafTest.java @@ -40,7 +40,7 @@ public class EmptyLeafTest extends AbstractBindingRuntimeTest { private static final TopLevelListKey TOP_FOO_KEY = new TopLevelListKey("foo"); private static final InstanceIdentifier 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 BA_TREE_LEAF_ONLY = BA_TOP_LEVEL_LIST .augmentation(TreeLeafOnlyAugment.class); private static final InstanceIdentifier BA_TREE_COMPLEX_USES = BA_TOP_LEVEL_LIST diff --git a/code-generator/binding-data-codec/src/test/java/org/opendaylight/yangtools/binding/data/codec/test/InstanceIdentifierSerializeDeserializeTest.java b/code-generator/binding-data-codec/src/test/java/org/opendaylight/yangtools/binding/data/codec/test/InstanceIdentifierSerializeDeserializeTest.java index b0fca82863..b276bbd534 100644 --- a/code-generator/binding-data-codec/src/test/java/org/opendaylight/yangtools/binding/data/codec/test/InstanceIdentifierSerializeDeserializeTest.java +++ b/code-generator/binding-data-codec/src/test/java/org/opendaylight/yangtools/binding/data/codec/test/InstanceIdentifierSerializeDeserializeTest.java @@ -34,7 +34,7 @@ public class InstanceIdentifierSerializeDeserializeTest extends AbstractBindingR private static final TopLevelListKey TOP_FOO_KEY = new TopLevelListKey("foo"); private static final InstanceIdentifier 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 BA_TREE_LEAF_ONLY = BA_TOP_LEVEL_LIST.augmentation(TreeLeafOnlyAugment.class); private static final InstanceIdentifier BA_TREE_COMPLEX_USES = diff --git a/code-generator/binding-data-codec/src/test/java/org/opendaylight/yangtools/binding/data/codec/test/InstanceIdentifierTest.java b/code-generator/binding-data-codec/src/test/java/org/opendaylight/yangtools/binding/data/codec/test/InstanceIdentifierTest.java index e011017894..fa8b48a35b 100644 --- a/code-generator/binding-data-codec/src/test/java/org/opendaylight/yangtools/binding/data/codec/test/InstanceIdentifierTest.java +++ b/code-generator/binding-data-codec/src/test/java/org/opendaylight/yangtools/binding/data/codec/test/InstanceIdentifierTest.java @@ -31,7 +31,7 @@ public class InstanceIdentifierTest extends AbstractBindingRuntimeTest { private static final TopLevelListKey TOP_FOO_KEY = new TopLevelListKey("foo"); private static final InstanceIdentifier 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 BA_TREE_LEAF_ONLY = BA_TOP_LEVEL_LIST .augmentation(TreeLeafOnlyAugment.class); private static final InstanceIdentifier BA_TREE_COMPLEX_USES = BA_TOP_LEVEL_LIST diff --git a/code-generator/binding-data-codec/src/test/java/org/opendaylight/yangtools/binding/data/codec/test/LeafReferenceTest.java b/code-generator/binding-data-codec/src/test/java/org/opendaylight/yangtools/binding/data/codec/test/LeafReferenceTest.java index ba8c84cd96..10dce65e27 100644 --- a/code-generator/binding-data-codec/src/test/java/org/opendaylight/yangtools/binding/data/codec/test/LeafReferenceTest.java +++ b/code-generator/binding-data-codec/src/test/java/org/opendaylight/yangtools/binding/data/codec/test/LeafReferenceTest.java @@ -32,7 +32,7 @@ public class LeafReferenceTest extends AbstractBindingRuntimeTest { private static final TopLevelListKey TOP_FOO_KEY = new TopLevelListKey("foo"); private static final InstanceIdentifier 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; diff --git a/code-generator/binding-data-codec/src/test/java/org/opendaylight/yangtools/binding/data/codec/test/NormalizedNodeSerializeDeserializeTest.java b/code-generator/binding-data-codec/src/test/java/org/opendaylight/yangtools/binding/data/codec/test/NormalizedNodeSerializeDeserializeTest.java index 4b08fbe17f..f223bfef28 100644 --- a/code-generator/binding-data-codec/src/test/java/org/opendaylight/yangtools/binding/data/codec/test/NormalizedNodeSerializeDeserializeTest.java +++ b/code-generator/binding-data-codec/src/test/java/org/opendaylight/yangtools/binding/data/codec/test/NormalizedNodeSerializeDeserializeTest.java @@ -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 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 BA_TREE_LEAF_ONLY = BA_TOP_LEVEL_LIST.augmentation(TreeLeafOnlyAugment.class); private static final InstanceIdentifier BA_TREE_COMPLEX_USES = diff --git a/code-generator/maven-sal-api-gen-plugin/src/main/java/org/opendaylight/yangtools/yang/unified/doc/generator/GeneratorImpl.xtend b/code-generator/maven-sal-api-gen-plugin/src/main/java/org/opendaylight/yangtools/yang/unified/doc/generator/GeneratorImpl.xtend index 672f26eb1e..62f628c50f 100644 --- a/code-generator/maven-sal-api-gen-plugin/src/main/java/org/opendaylight/yangtools/yang/unified/doc/generator/GeneratorImpl.xtend +++ b/code-generator/maven-sal-api-gen-plugin/src/main/java/org/opendaylight/yangtools/yang/unified/doc/generator/GeneratorImpl.xtend @@ -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»

Child nodes

- «childNodes.printChildren(3,YangInstanceIdentifier.builder().toInstance())» + «childNodes.printChildren(3,YangInstanceIdentifier.builder().build())» «ENDIF» ''' diff --git a/yang/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/InstanceIdentifier.java b/yang/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/InstanceIdentifier.java index 934c90d9ae..087a92c64b 100644 --- a/yang/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/InstanceIdentifier.java +++ b/yang/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/InstanceIdentifier.java @@ -430,7 +430,7 @@ public class InstanceIdentifier implements Path implements Path build(); + + /* + * @deprecated use #build() + */ + @Deprecated + InstanceIdentifier toInstance(); } private void writeObject(final java.io.ObjectOutputStream out) throws IOException { diff --git a/yang/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/InstanceIdentifierBuilderImpl.java b/yang/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/InstanceIdentifierBuilderImpl.java index 3ba833d2f4..5be717b574 100644 --- a/yang/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/InstanceIdentifierBuilderImpl.java +++ b/yang/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/InstanceIdentifierBuilderImpl.java @@ -37,7 +37,7 @@ final class InstanceIdentifierBuilderImpl implements Insta @Override public int hashCode() { - return hashBuilder.toInstance(); + return hashBuilder.build(); } @SuppressWarnings("unchecked") @@ -96,11 +96,14 @@ final class InstanceIdentifierBuilderImpl implements Insta } @SuppressWarnings("unchecked") - final InstanceIdentifier ret = (InstanceIdentifier) InstanceIdentifier.trustedCreate(arg, pathArguments, hashBuilder.toInstance(), wildcard); + final InstanceIdentifier ret = (InstanceIdentifier) InstanceIdentifier.trustedCreate(arg, pathArguments, hashBuilder.build(), wildcard); return ret; } - @Override + /* + * @deprecated Use #build() instead. + */ + @Deprecated public InstanceIdentifier toInstance() { return build(); } diff --git a/yang/yang-binding/src/test/java/org/opendaylight/yangtools/yang/binding/test/InstanceIdentifierTest.java b/yang/yang-binding/src/test/java/org/opendaylight/yangtools/yang/binding/test/InstanceIdentifierTest.java index e4188b470d..34e3911516 100644 --- a/yang/yang-binding/src/test/java/org/opendaylight/yangtools/yang/binding/test/InstanceIdentifierTest.java +++ b/yang/yang-binding/src/test/java/org/opendaylight/yangtools/yang/binding/test/InstanceIdentifierTest.java @@ -27,13 +27,13 @@ public class InstanceIdentifierTest { @Test public void constructWithPredicates() { - InstanceIdentifier nodes = InstanceIdentifier.builder(Nodes.class).toInstance(); + InstanceIdentifier nodes = InstanceIdentifier.builder(Nodes.class).build(); assertNotNull(nodes); assertEquals(Nodes.class, nodes.getTargetType()); - InstanceIdentifier node = nodes.builder().child(Node.class).toInstance(); + InstanceIdentifier 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 = InstanceIdentifier.builder(Nodes.class).toInstance(); - InstanceIdentifier node = InstanceIdentifier.builder(Nodes.class).child(Node.class,new NodeKey(10)).toInstance(); + InstanceIdentifier nodes = InstanceIdentifier.builder(Nodes.class).build(); + InstanceIdentifier 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 = InstanceIdentifier.builder(Nodes.class).child(InstantiatedFoo.class).child(FooChild.class).build(); InstanceIdentifier nodeTen = InstanceIdentifier.builder(Nodes.class) // - .child(Node.class,new NodeKey(10)).toInstance(); + .child(Node.class,new NodeKey(10)).build(); InstanceIdentifier nodeOne = InstanceIdentifier.builder(Nodes.class) // - .child(Node.class,new NodeKey(1)).toInstance(); - InstanceIdentifier nodes = InstanceIdentifier.builder(Nodes.class).toInstance(); + .child(Node.class,new NodeKey(1)).build(); + InstanceIdentifier 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 = InstanceIdentifier.builder(Nodes.class).toInstance(); + InstanceIdentifier nodes = InstanceIdentifier.builder(Nodes.class).build(); InstanceIdentifier wildcarded = InstanceIdentifier.builder(Nodes.class).child(Node.class).build(); InstanceIdentifier wildcardedChildren = InstanceIdentifier.builder(Nodes.class) // .child(Node.class) // @@ -84,9 +84,9 @@ public class InstanceIdentifierTest { InstanceIdentifier nodeTen = InstanceIdentifier.builder(Nodes.class) // - .child(Node.class,new NodeKey(10)).toInstance(); + .child(Node.class,new NodeKey(10)).build(); InstanceIdentifier 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 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 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 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)); diff --git a/yang/yang-binding/src/test/java/org/opendaylight/yangtools/yang/binding/util/DataObjectReadingUtilTest.java b/yang/yang-binding/src/test/java/org/opendaylight/yangtools/yang/binding/util/DataObjectReadingUtilTest.java index e2400f9f3d..29dc602f60 100644 --- a/yang/yang-binding/src/test/java/org/opendaylight/yangtools/yang/binding/util/DataObjectReadingUtilTest.java +++ b/yang/yang-binding/src/test/java/org/opendaylight/yangtools/yang/binding/util/DataObjectReadingUtilTest.java @@ -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., DataObject>builder().put(path, mockedDataObject).build(); -- 2.36.6