Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.associaterouter.input
Class RouterIdsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.neutronvpn.rev150602.associaterouter.input.RouterIdsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<RouterIds>
,org.opendaylight.yangtools.concepts.CheckedBuilder<RouterIds,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class RouterIdsBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<RouterIds>
Class that buildsRouterIdsBuilder
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:
RouterIdsBuilder createTarget(int fooXyzzy, int barBaz) { return new RouterIdsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of RouterIdsBuilder, 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:
RouterIdsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description RouterIdsBuilder()
RouterIdsBuilder(RouterIds base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description RouterIdsBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RouterIds>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<RouterIds> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.RouterIdsBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RouterIds> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RouterIds>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
RouterIds
build()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid
getRouterId()
RouterIdsKey
key()
RouterIdsBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RouterIds>> augmentationType)
Remove an augmentation from this builder's product.RouterIdsBuilder
setRouterId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
RouterIdsBuilder
withKey(RouterIdsKey key)
-
-
-
Constructor Detail
-
RouterIdsBuilder
public RouterIdsBuilder()
-
RouterIdsBuilder
public RouterIdsBuilder(RouterIds base)
-
-
Method Detail
-
key
public RouterIdsKey key()
-
getRouterId
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid getRouterId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RouterIds>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public RouterIdsBuilder withKey(RouterIdsKey key)
-
setRouterId
public RouterIdsBuilder setRouterId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid value)
-
addAugmentation
public RouterIdsBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RouterIds> 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 RouterIdsBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RouterIds>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<RouterIds> 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 RouterIdsBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RouterIds>> 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
-
-