Class ExternalTunnelBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.external.tunnel.list.ExternalTunnelBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<ExternalTunnel>
,org.opendaylight.yangtools.concepts.CheckedBuilder<ExternalTunnel,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class ExternalTunnelBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<ExternalTunnel>
Class that buildsExternalTunnelBuilder
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:
ExternalTunnelBuilder createTarget(int fooXyzzy, int barBaz) { return new ExternalTunnelBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ExternalTunnelBuilder, 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:
ExternalTunnelBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description ExternalTunnelBuilder()
ExternalTunnelBuilder(ExternalTunnel base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ExternalTunnelBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ExternalTunnel> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ExternalTunnel>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
ExternalTunnel
build()
java.lang.String
getDestinationDevice()
java.lang.String
getSourceDevice()
java.lang.Class<? extends TunnelTypeBase>
getTransportType()
java.lang.String
getTunnelInterfaceName()
ExternalTunnelKey
key()
ExternalTunnelBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ExternalTunnel>> augmentationType)
Remove an augmentation from this builder's product.ExternalTunnelBuilder
setDestinationDevice(java.lang.String value)
ExternalTunnelBuilder
setSourceDevice(java.lang.String value)
ExternalTunnelBuilder
setTransportType(java.lang.Class<? extends TunnelTypeBase> value)
ExternalTunnelBuilder
setTunnelInterfaceName(java.lang.String value)
ExternalTunnelBuilder
withKey(ExternalTunnelKey key)
-
-
-
Constructor Detail
-
ExternalTunnelBuilder
public ExternalTunnelBuilder()
-
ExternalTunnelBuilder
public ExternalTunnelBuilder(ExternalTunnel base)
-
-
Method Detail
-
key
public ExternalTunnelKey key()
-
getDestinationDevice
public java.lang.String getDestinationDevice()
-
getSourceDevice
public java.lang.String getSourceDevice()
-
getTransportType
public java.lang.Class<? extends TunnelTypeBase> getTransportType()
-
getTunnelInterfaceName
public java.lang.String getTunnelInterfaceName()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ExternalTunnel>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public ExternalTunnelBuilder withKey(ExternalTunnelKey key)
-
setDestinationDevice
public ExternalTunnelBuilder setDestinationDevice(java.lang.String value)
-
setSourceDevice
public ExternalTunnelBuilder setSourceDevice(java.lang.String value)
-
setTransportType
public ExternalTunnelBuilder setTransportType(java.lang.Class<? extends TunnelTypeBase> value)
-
setTunnelInterfaceName
public ExternalTunnelBuilder setTunnelInterfaceName(java.lang.String value)
-
addAugmentation
public ExternalTunnelBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ExternalTunnel> 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 ExternalTunnelBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ExternalTunnel>> 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 ExternalTunnel build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<ExternalTunnel>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<ExternalTunnel,java.lang.IllegalArgumentException>
-
-