Class LocalBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp._default.policy.rev200120.originator.id.set.originator.id.set.LocalBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Local>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Local,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class LocalBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Local>
Class that buildsLocalBuilder
instances. Overall design of the class is that of a fluent interface, where method chaining is used.In general, this class is supposed to be used like this template:
LocalBuilder createTarget(int fooXyzzy, int barBaz) { return new LocalBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of LocalBuilder, as instances can be freely passed around without worrying about synchronization issues.
As a side note: method chaining results in:
- very efficient Java bytecode, as the method invocation result, in this case the Builder reference, is
on the stack, so further method invocations just need to fill method arguments for the next method
invocation, which is terminated by
build()
, which is then returned from the method - better understanding by humans, as the scope of mutable state (the builder) is kept to a minimum and is very localized
- better optimization oportunities, as the object scope is minimized in terms of invocation (rather than method) stack, making escape analysis a lot easier. Given enough compiler (JIT/AOT) prowess, the cost of th builder object can be completely eliminated
- See Also:
LocalBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description LocalBuilder()
LocalBuilder(Local base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LocalBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Local>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Local> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Local>>
E$$augmentation(Class<E$$> augmentationType)
Local
build()
LocalBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Local>> augmentationType)
-
-
-
Constructor Detail
-
LocalBuilder
public LocalBuilder()
-
LocalBuilder
public LocalBuilder(Local base)
-
-
Method Detail
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Local>> E$$ augmentation(Class<E$$> augmentationType)
-
addAugmentation
public LocalBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Local>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Local> augmentationValue)
-
removeAugmentation
public LocalBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Local>> augmentationType)
-
build
public Local build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Local>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Local,IllegalArgumentException>
-
-