Class ConfigBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.rev160412._interface.phys.holdtime.top.hold.time.ConfigBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Config>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Config,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class ConfigBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Config>
Class that buildsConfigBuilder
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:
ConfigBuilder createTarget(int fooXyzzy, int barBaz) { return new ConfigBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ConfigBuilder, 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:
ConfigBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description ConfigBuilder()
ConfigBuilder(Config base)
ConfigBuilder(InterfacePhysHoldtimeConfig arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ConfigBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Config>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Config> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.ConfigBuilder
addAugmentation(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)
Config
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint32
getDown()
org.opendaylight.yangtools.yang.common.Uint32
getUp()
ConfigBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Config>> augmentationType)
Remove an augmentation from this builder's product.ConfigBuilder
setDown(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDown(Uint32)
instead.ConfigBuilder
setDown(org.opendaylight.yangtools.yang.common.Uint32 value)
ConfigBuilder
setUp(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetUp(Uint32)
instead.ConfigBuilder
setUp(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
ConfigBuilder
public ConfigBuilder()
-
ConfigBuilder
public ConfigBuilder(InterfacePhysHoldtimeConfig arg)
-
ConfigBuilder
public ConfigBuilder(Config base)
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.rev160412.InterfacePhysHoldtimeConfig
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getDown
public org.opendaylight.yangtools.yang.common.Uint32 getDown()
-
getUp
public org.opendaylight.yangtools.yang.common.Uint32 getUp()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Config>> E$$ augmentation(Class<E$$> augmentationType)
-
setDown
public ConfigBuilder setDown(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setDown
@Deprecated(forRemoval=true) public ConfigBuilder setDown(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDown(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setUp
public ConfigBuilder setUp(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setUp
@Deprecated(forRemoval=true) public ConfigBuilder setUp(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetUp(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- 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
-
addAugmentation
@Deprecated(forRemoval=true) public ConfigBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Config>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Config> 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 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
public Config build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Config>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Config,IllegalArgumentException>
-
-