Class TunnelInterfaceBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vbridge.topology.rev160129.network.topology.topology.node.termination.point._interface.type.TunnelInterfaceBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<TunnelInterface>
,org.opendaylight.yangtools.concepts.CheckedBuilder<TunnelInterface,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class TunnelInterfaceBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<TunnelInterface>
Class that buildsTunnelInterfaceBuilder
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:
TunnelInterfaceBuilder createTarget(int fooXyzzy, int barBaz) { return new TunnelInterfaceBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TunnelInterfaceBuilder, 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:
TunnelInterfaceBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description TunnelInterfaceBuilder()
TunnelInterfaceBuilder(TunnelInterface base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TunnelInterfaceBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TunnelInterface>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<TunnelInterface> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TunnelInterface>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
TunnelInterface
build()
ExternalReference
getTunnelInterface()
TunnelInterfaceBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TunnelInterface>> augmentationType)
TunnelInterfaceBuilder
setTunnelInterface(ExternalReference value)
-
-
-
Constructor Detail
-
TunnelInterfaceBuilder
public TunnelInterfaceBuilder()
-
TunnelInterfaceBuilder
public TunnelInterfaceBuilder(TunnelInterface base)
-
-
Method Detail
-
getTunnelInterface
public ExternalReference getTunnelInterface()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TunnelInterface>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setTunnelInterface
public TunnelInterfaceBuilder setTunnelInterface(ExternalReference value)
-
addAugmentation
public TunnelInterfaceBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TunnelInterface>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<TunnelInterface> augmentationValue)
-
removeAugmentation
public TunnelInterfaceBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TunnelInterface>> augmentationType)
-
build
public TunnelInterface build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<TunnelInterface>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<TunnelInterface,java.lang.IllegalArgumentException>
-
-