Class ConfigBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.odl.bgp.app.peer.benchmark.config.rev161129.ConfigBuilder
Class that builds
Config
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:
Config createConfig(int fooXyzzy, int barBaz) {
return new ConfigBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Config, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.ConfigBuilder
(Config base) Construct a builder initialized with state from specifiedConfig
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<Config> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Config>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Config
build()
A newConfig
instance.static @NonNull Config
empty()
Get empty instance of Config.Return current value associated with the property corresponding toConfig.getAppPeerId()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Config>> augmentationType) Remove an augmentation from this builder's product.setAppPeerId
(String value) Set the property corresponding toConfig.getAppPeerId()
to the specified value.
-
Constructor Details
-
ConfigBuilder
public ConfigBuilder()Construct an empty builder. -
ConfigBuilder
Construct a builder initialized with state from specifiedConfig
.- Parameters:
base
- Config from which the builder should be initialized
-
-
Method Details
-
empty
Get empty instance of Config.- Returns:
- An empty
Config
-
getAppPeerId
Return current value associated with the property corresponding toConfig.getAppPeerId()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Config>> E$$ augmentation(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setAppPeerId
Set the property corresponding toConfig.getAppPeerId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public ConfigBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Config> 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 ConfigBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Config>> 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
A newConfig
instance.- Returns:
- A new
Config
instance.
-