Class PcepDispatcherConfigBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.app.config.rev160707.PcepDispatcherConfigBuilder
-
@Generated("mdsal-binding-generator") public class PcepDispatcherConfigBuilder extends Object
Class that buildsPcepDispatcherConfig
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:
PcepDispatcherConfig createPcepDispatcherConfig(int fooXyzzy, int barBaz) { return new PcepDispatcherConfigBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PcepDispatcherConfig, 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:
PcepDispatcherConfig
- 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 PcepDispatcherConfigBuilder()
Construct an empty builder.PcepDispatcherConfigBuilder(PcepDispatcherConfig base)
Construct a builder initialized with state from specifiedPcepDispatcherConfig
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PcepDispatcherConfigBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PcepDispatcherConfig> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PcepDispatcherConfig>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull PcepDispatcherConfig
build()
A newPcepDispatcherConfig
instance.org.opendaylight.yangtools.yang.common.Uint16
getMaxUnknownMessages()
Return current value associated with the property corresponding toPcepDispatcherConfig.getMaxUnknownMessages()
.Tls
getTls()
Return current value associated with the property corresponding toPcepDispatcherConfig.getTls()
.PcepDispatcherConfigBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PcepDispatcherConfig>> augmentationType)
Remove an augmentation from this builder's product.PcepDispatcherConfigBuilder
setMaxUnknownMessages(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toPcepDispatcherConfig.getMaxUnknownMessages()
to the specified value.PcepDispatcherConfigBuilder
setTls(Tls value)
Set the property corresponding toPcepDispatcherConfig.getTls()
to the specified value.
-
-
-
Constructor Detail
-
PcepDispatcherConfigBuilder
public PcepDispatcherConfigBuilder()
Construct an empty builder.
-
PcepDispatcherConfigBuilder
public PcepDispatcherConfigBuilder(PcepDispatcherConfig base)
Construct a builder initialized with state from specifiedPcepDispatcherConfig
.- Parameters:
base
- PcepDispatcherConfig from which the builder should be initialized
-
-
Method Detail
-
getMaxUnknownMessages
public org.opendaylight.yangtools.yang.common.Uint16 getMaxUnknownMessages()
Return current value associated with the property corresponding toPcepDispatcherConfig.getMaxUnknownMessages()
.- Returns:
- current value
-
getTls
public Tls getTls()
Return current value associated with the property corresponding toPcepDispatcherConfig.getTls()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PcepDispatcherConfig>> 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
-
setMaxUnknownMessages
public PcepDispatcherConfigBuilder setMaxUnknownMessages(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toPcepDispatcherConfig.getMaxUnknownMessages()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setTls
public PcepDispatcherConfigBuilder setTls(Tls value)
Set the property corresponding toPcepDispatcherConfig.getTls()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public PcepDispatcherConfigBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<PcepDispatcherConfig> 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 PcepDispatcherConfigBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PcepDispatcherConfig>> 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 PcepDispatcherConfig build()
A newPcepDispatcherConfig
instance.- Returns:
- A new
PcepDispatcherConfig
instance.
-
-