Class ConfigBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.rev160412.interfaces.top.interfaces._interface.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(InterfaceCommonConfig arg)
ConfigBuilder(InterfacePhysConfig arg)
ConfigBuilder(Config base)
-
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)
<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.String
getDescription()
org.opendaylight.yangtools.yang.common.Uint16
getMtu()
String
getName()
Class<? extends org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfaceType>
getType()
Boolean
isEnabled()
ConfigBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Config>> augmentationType)
ConfigBuilder
setDescription(String value)
ConfigBuilder
setEnabled(Boolean value)
ConfigBuilder
setMtu(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setMtu(Uint16)} instead.ConfigBuilder
setMtu(org.opendaylight.yangtools.yang.common.Uint16 value)
ConfigBuilder
setName(String value)
ConfigBuilder
setType(Class<? extends org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfaceType> value)
-
-
-
Constructor Detail
-
ConfigBuilder
public ConfigBuilder()
-
ConfigBuilder
public ConfigBuilder(InterfacePhysConfig arg)
-
ConfigBuilder
public ConfigBuilder(InterfaceCommonConfig 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.InterfaceCommonConfig
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.interfaces.rev160412.InterfacePhysConfig
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getDescription
public String getDescription()
-
getMtu
public org.opendaylight.yangtools.yang.common.Uint16 getMtu()
-
getName
public String getName()
-
getType
public Class<? extends org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfaceType> getType()
-
isEnabled
public Boolean isEnabled()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Config>> E$$ augmentation(Class<E$$> augmentationType)
-
setDescription
public ConfigBuilder setDescription(String value)
-
setMtu
public ConfigBuilder setMtu(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setMtu
@Deprecated(forRemoval=true) public ConfigBuilder setMtu(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setMtu(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setName
public ConfigBuilder setName(String value)
-
setType
public ConfigBuilder setType(Class<? extends org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.InterfaceType> value)
-
setEnabled
public ConfigBuilder setEnabled(Boolean value)
-
addAugmentation
public ConfigBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Config>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Config> augmentationValue)
-
removeAugmentation
public ConfigBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Config>> augmentationType)
-
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>
-
-