Package org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.dpn.routers.dpn.routers.list
Class RoutersListBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.dpn.routers.dpn.routers.list.RoutersListBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<RoutersList>
,org.opendaylight.yangtools.concepts.CheckedBuilder<RoutersList,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class RoutersListBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<RoutersList>
Class that buildsRoutersListBuilder
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:
RoutersListBuilder createTarget(int fooXyzzy, int barBaz) { return new RoutersListBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of RoutersListBuilder, 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:
RoutersListBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description RoutersListBuilder()
RoutersListBuilder(RoutersList base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RoutersListBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RoutersList> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RoutersList>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
RoutersList
build()
java.lang.String
getRouter()
RoutersListKey
key()
RoutersListBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RoutersList>> augmentationType)
Remove an augmentation from this builder's product.RoutersListBuilder
setRouter(java.lang.String value)
RoutersListBuilder
withKey(RoutersListKey key)
-
-
-
Constructor Detail
-
RoutersListBuilder
public RoutersListBuilder()
-
RoutersListBuilder
public RoutersListBuilder(RoutersList base)
-
-
Method Detail
-
key
public RoutersListKey key()
-
getRouter
public java.lang.String getRouter()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<RoutersList>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public RoutersListBuilder withKey(RoutersListKey key)
-
setRouter
public RoutersListBuilder setRouter(java.lang.String value)
-
addAugmentation
public RoutersListBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<RoutersList> 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
-
removeAugmentation
public RoutersListBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<RoutersList>> 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 RoutersList build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<RoutersList>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<RoutersList,java.lang.IllegalArgumentException>
-
-