Class AggregateBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.local.routing.rev151009.local.aggregate.top.local.aggregates.AggregateBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Aggregate>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Aggregate,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class AggregateBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Aggregate>
Class that buildsAggregate
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:
Aggregate createAggregate(int fooXyzzy, int barBaz) { return new AggregateBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Aggregate, 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:
Aggregate
,Builder
-
-
Constructor Summary
Constructors Constructor Description AggregateBuilder()
AggregateBuilder(Aggregate base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AggregateBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Aggregate> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Aggregate>>
E$$augmentation(Class<E$$> augmentationType)
Aggregate
build()
Config
getConfig()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix
getPrefix()
State
getState()
AggregateKey
key()
AggregateBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Aggregate>> augmentationType)
Remove an augmentation from this builder's product.AggregateBuilder
setConfig(Config value)
AggregateBuilder
setPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
AggregateBuilder
setState(State value)
AggregateBuilder
withKey(AggregateKey key)
-
-
-
Constructor Detail
-
AggregateBuilder
public AggregateBuilder()
-
AggregateBuilder
public AggregateBuilder(Aggregate base)
-
-
Method Detail
-
key
public AggregateKey key()
-
getConfig
public Config getConfig()
-
getPrefix
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getPrefix()
-
getState
public State getState()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Aggregate>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public AggregateBuilder withKey(AggregateKey key)
-
setConfig
public AggregateBuilder setConfig(Config value)
-
setPrefix
public AggregateBuilder setPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)
-
setState
public AggregateBuilder setState(State value)
-
addAugmentation
public AggregateBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Aggregate> 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 AggregateBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Aggregate>> 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 Aggregate build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Aggregate>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Aggregate,IllegalArgumentException>
-
-