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