Package org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.monitor.params
Class MonitorConfigBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.rev160406.monitor.params.MonitorConfigBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<MonitorConfig>
,org.opendaylight.yangtools.concepts.CheckedBuilder<MonitorConfig,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class MonitorConfigBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<MonitorConfig>
Class that buildsMonitorConfigBuilder
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:
MonitorConfigBuilder createTarget(int fooXyzzy, int barBaz) { return new MonitorConfigBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MonitorConfigBuilder, 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 oportunities, 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:
MonitorConfigBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description MonitorConfigBuilder()
MonitorConfigBuilder(MonitorConfig base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description MonitorConfigBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MonitorConfig>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<MonitorConfig> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.MonitorConfigBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MonitorConfig> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MonitorConfig>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
MonitorConfig
build()
java.lang.String
getMonitorConfigKey()
java.lang.String
getMonitorConfigValue()
MonitorConfigKey
key()
MonitorConfigBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MonitorConfig>> augmentationType)
Remove an augmentation from this builder's product.MonitorConfigBuilder
setMonitorConfigKey(java.lang.String value)
MonitorConfigBuilder
setMonitorConfigValue(java.lang.String value)
MonitorConfigBuilder
withKey(MonitorConfigKey key)
-
-
-
Constructor Detail
-
MonitorConfigBuilder
public MonitorConfigBuilder()
-
MonitorConfigBuilder
public MonitorConfigBuilder(MonitorConfig base)
-
-
Method Detail
-
key
public MonitorConfigKey key()
-
getMonitorConfigKey
public java.lang.String getMonitorConfigKey()
-
getMonitorConfigValue
public java.lang.String getMonitorConfigValue()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MonitorConfig>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public MonitorConfigBuilder withKey(MonitorConfigKey key)
-
setMonitorConfigKey
public MonitorConfigBuilder setMonitorConfigKey(java.lang.String value)
-
setMonitorConfigValue
public MonitorConfigBuilder setMonitorConfigValue(java.lang.String value)
-
addAugmentation
public MonitorConfigBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MonitorConfig> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
java.lang.NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public MonitorConfigBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MonitorConfig>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<MonitorConfig> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public MonitorConfigBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MonitorConfig>> 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 MonitorConfig build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<MonitorConfig>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<MonitorConfig,java.lang.IllegalArgumentException>
-
-