Class OriginBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.path.attributes.attributes.OriginBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Origin>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Origin,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class OriginBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Origin>
Class that buildsOrigin
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:
Origin createOrigin(int fooXyzzy, int barBaz) { return new OriginBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Origin, 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:
Origin
,Builder
-
-
Constructor Summary
Constructors Constructor Description OriginBuilder()
OriginBuilder(Origin base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OriginBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Origin> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Origin>>
E$$augmentation(Class<E$$> augmentationType)
Origin
build()
BgpOrigin
getValue()
OriginBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Origin>> augmentationType)
Remove an augmentation from this builder's product.OriginBuilder
setValue(BgpOrigin value)
-
-
-
Constructor Detail
-
OriginBuilder
public OriginBuilder()
-
OriginBuilder
public OriginBuilder(Origin base)
-
-
Method Detail
-
getValue
public BgpOrigin getValue()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Origin>> E$$ augmentation(Class<E$$> augmentationType)
-
setValue
public OriginBuilder setValue(BgpOrigin value)
-
addAugmentation
public OriginBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Origin> 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 OriginBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Origin>> 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 Origin build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Origin>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Origin,IllegalArgumentException>
-
-