Class RoutesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.to.extraroutes.vpn.extra.routes.RoutesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Routes>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Routes,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class RoutesBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<Routes>
Class that buildsRoutesBuilder
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:
RoutesBuilder createTarget(int fooXyzzy, int barBaz) { return new RoutesBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of RoutesBuilder, 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:
RoutesBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description RoutesBuilder()
RoutesBuilder(Routes base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description RoutesBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Routes>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Routes> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.RoutesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Routes> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Routes>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Routes
build()
java.util.List<java.lang.String>
getNexthopIpList()
java.lang.String
getPrefix()
RoutesKey
key()
RoutesBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Routes>> augmentationType)
Remove an augmentation from this builder's product.RoutesBuilder
setNexthopIpList(java.util.List<java.lang.String> values)
RoutesBuilder
setPrefix(java.lang.String value)
RoutesBuilder
withKey(RoutesKey key)
-
-
-
Constructor Detail
-
RoutesBuilder
public RoutesBuilder()
-
RoutesBuilder
public RoutesBuilder(Routes base)
-
-
Method Detail
-
key
public RoutesKey key()
-
getNexthopIpList
public java.util.List<java.lang.String> getNexthopIpList()
-
getPrefix
public java.lang.String getPrefix()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Routes>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public RoutesBuilder withKey(RoutesKey key)
-
setNexthopIpList
public RoutesBuilder setNexthopIpList(java.util.List<java.lang.String> values)
-
setPrefix
public RoutesBuilder setPrefix(java.lang.String value)
-
addAugmentation
public RoutesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Routes> 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 RoutesBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Routes>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Routes> 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 RoutesBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Routes>> 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
-
-