Class LoggingOptionsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009.bgp.neighbor.group.LoggingOptionsBuilder
-
@Generated("mdsal-binding-generator") public class LoggingOptionsBuilder extends Object
Class that buildsLoggingOptions
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:
LoggingOptions createLoggingOptions(int fooXyzzy, int barBaz) { return new LoggingOptionsBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of LoggingOptions, 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:
LoggingOptions
- 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
-
-
Constructor Summary
Constructors Constructor Description LoggingOptionsBuilder()
Construct an empty builder.LoggingOptionsBuilder(LoggingOptions base)
Construct a builder initialized with state from specifiedLoggingOptions
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LoggingOptionsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LoggingOptions> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LoggingOptions>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull LoggingOptions
build()
A newLoggingOptions
instance.Config
getConfig()
Return current value associated with the property corresponding toLoggingOptions.getConfig()
.State
getState()
Return current value associated with the property corresponding toLoggingOptions.getState()
.LoggingOptionsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LoggingOptions>> augmentationType)
Remove an augmentation from this builder's product.LoggingOptionsBuilder
setConfig(Config value)
Set the property corresponding toLoggingOptions.getConfig()
to the specified value.LoggingOptionsBuilder
setState(State value)
Set the property corresponding toLoggingOptions.getState()
to the specified value.
-
-
-
Constructor Detail
-
LoggingOptionsBuilder
public LoggingOptionsBuilder()
Construct an empty builder.
-
LoggingOptionsBuilder
public LoggingOptionsBuilder(LoggingOptions base)
Construct a builder initialized with state from specifiedLoggingOptions
.- Parameters:
base
- LoggingOptions from which the builder should be initialized
-
-
Method Detail
-
getConfig
public Config getConfig()
Return current value associated with the property corresponding toLoggingOptions.getConfig()
.- Returns:
- current value
-
getState
public State getState()
Return current value associated with the property corresponding toLoggingOptions.getState()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LoggingOptions>> 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
-
setConfig
public LoggingOptionsBuilder setConfig(Config value)
Set the property corresponding toLoggingOptions.getConfig()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setState
public LoggingOptionsBuilder setState(State value)
Set the property corresponding toLoggingOptions.getState()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public LoggingOptionsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<LoggingOptions> 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 LoggingOptionsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LoggingOptions>> 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 @NonNull LoggingOptions build()
A newLoggingOptions
instance.- Returns:
- A new
LoggingOptions
instance.
-
-