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