Class TunnelInstanceInterfaceBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.interfacemanager.meta.rev160406.tunnel.instance._interface.map.TunnelInstanceInterfaceBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<TunnelInstanceInterface>
,org.opendaylight.yangtools.concepts.CheckedBuilder<TunnelInstanceInterface,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class TunnelInstanceInterfaceBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<TunnelInstanceInterface>
Class that buildsTunnelInstanceInterfaceBuilder
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:
TunnelInstanceInterfaceBuilder createTarget(int fooXyzzy, int barBaz) { return new TunnelInstanceInterfaceBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TunnelInstanceInterfaceBuilder, 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:
TunnelInstanceInterfaceBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description TunnelInstanceInterfaceBuilder()
TunnelInstanceInterfaceBuilder(TunnelInstanceInterface base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TunnelInstanceInterfaceBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TunnelInstanceInterface>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<TunnelInstanceInterface> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TunnelInstanceInterface>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
TunnelInstanceInterface
build()
java.lang.String
getInterfaceName()
java.lang.String
getTunnelInstanceIdentifier()
TunnelInstanceInterfaceKey
key()
TunnelInstanceInterfaceBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TunnelInstanceInterface>> augmentationType)
TunnelInstanceInterfaceBuilder
setInterfaceName(java.lang.String value)
TunnelInstanceInterfaceBuilder
setTunnelInstanceIdentifier(java.lang.String value)
TunnelInstanceInterfaceBuilder
withKey(TunnelInstanceInterfaceKey key)
-
-
-
Constructor Detail
-
TunnelInstanceInterfaceBuilder
public TunnelInstanceInterfaceBuilder()
-
TunnelInstanceInterfaceBuilder
public TunnelInstanceInterfaceBuilder(TunnelInstanceInterface base)
-
-
Method Detail
-
key
public TunnelInstanceInterfaceKey key()
-
getInterfaceName
public java.lang.String getInterfaceName()
-
getTunnelInstanceIdentifier
public java.lang.String getTunnelInstanceIdentifier()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TunnelInstanceInterface>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public TunnelInstanceInterfaceBuilder withKey(TunnelInstanceInterfaceKey key)
-
setInterfaceName
public TunnelInstanceInterfaceBuilder setInterfaceName(java.lang.String value)
-
setTunnelInstanceIdentifier
public TunnelInstanceInterfaceBuilder setTunnelInstanceIdentifier(java.lang.String value)
-
addAugmentation
public TunnelInstanceInterfaceBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TunnelInstanceInterface>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<TunnelInstanceInterface> augmentationValue)
-
removeAugmentation
public TunnelInstanceInterfaceBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TunnelInstanceInterface>> augmentationType)
-
build
public TunnelInstanceInterface build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<TunnelInstanceInterface>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<TunnelInstanceInterface,java.lang.IllegalArgumentException>
-
-