Class RouterIdBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.bgp.af.vpn.instance.config.RouterIdBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<RouterId>
,org.opendaylight.yangtools.concepts.CheckedBuilder<RouterId,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class RouterIdBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<RouterId>
Class that buildsRouterIdBuilder
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:
RouterIdBuilder createTarget(int fooXyzzy, int barBaz) { return new RouterIdBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of RouterIdBuilder, 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:
RouterIdBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description RouterIdBuilder()
RouterIdBuilder(RouterId base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description RouterIdBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RouterId>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<RouterId> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.RouterIdBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RouterId> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RouterId>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
RouterId
build()
ConfigType
getConfigType()
java.lang.Boolean
isEnable()
RouterIdBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RouterId>> augmentationType)
Remove an augmentation from this builder's product.RouterIdBuilder
setConfigType(ConfigType value)
RouterIdBuilder
setEnable(java.lang.Boolean value)
-
-
-
Constructor Detail
-
RouterIdBuilder
public RouterIdBuilder()
-
RouterIdBuilder
public RouterIdBuilder(RouterId base)
-
-
Method Detail
-
getConfigType
public ConfigType getConfigType()
-
isEnable
public java.lang.Boolean isEnable()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RouterId>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setConfigType
public RouterIdBuilder setConfigType(ConfigType value)
-
setEnable
public RouterIdBuilder setEnable(java.lang.Boolean value)
-
addAugmentation
public RouterIdBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RouterId> 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 RouterIdBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RouterId>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<RouterId> 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 RouterIdBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RouterId>> 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
-
-