Class InternalBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.ospf.topology.rev131021.ospf.node.attributes.ospf.node.attributes.router.type.InternalBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Internal>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Internal,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class InternalBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Internal>
Class that buildsInternal
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:
Internal createInternal(int fooXyzzy, int barBaz) { return new InternalBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Internal, 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 opportunities, 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:
Internal
,Builder
-
-
Constructor Summary
Constructors Constructor Description InternalBuilder()
InternalBuilder(Internal base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description InternalBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Internal> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Internal>>
E$$augmentation(Class<E$$> augmentationType)
Internal
build()
org.opendaylight.yangtools.yang.common.Empty
getInternal()
InternalBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Internal>> augmentationType)
Remove an augmentation from this builder's product.InternalBuilder
setInternal(org.opendaylight.yangtools.yang.common.Empty value)
-
-
-
Constructor Detail
-
InternalBuilder
public InternalBuilder()
-
InternalBuilder
public InternalBuilder(Internal base)
-
-
Method Detail
-
getInternal
public org.opendaylight.yangtools.yang.common.Empty getInternal()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Internal>> E$$ augmentation(Class<E$$> augmentationType)
-
setInternal
public InternalBuilder setInternal(org.opendaylight.yangtools.yang.common.Empty value)
-
addAugmentation
public InternalBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Internal> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public InternalBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Internal>> augmentationType)
Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.- Parameters:
augmentationType
- augmentation type to be removed- Returns:
- this builder
-
build
public Internal build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Internal>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Internal,IllegalArgumentException>
-
-