Class InternalTunnelBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.op.rev160406.tunnel.list.InternalTunnelBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<InternalTunnel>
,org.opendaylight.yangtools.concepts.CheckedBuilder<InternalTunnel,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class InternalTunnelBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<InternalTunnel>
Class that buildsInternalTunnelBuilder
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:
InternalTunnelBuilder createTarget(int fooXyzzy, int barBaz) { return new InternalTunnelBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of InternalTunnelBuilder, 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:
InternalTunnelBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description InternalTunnelBuilder()
InternalTunnelBuilder(InternalTunnel base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description InternalTunnelBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<InternalTunnel> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<InternalTunnel>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
InternalTunnel
build()
org.opendaylight.yangtools.yang.common.Uint64
getDestinationDPN()
org.opendaylight.yangtools.yang.common.Uint64
getSourceDPN()
java.lang.Class<? extends TunnelTypeBase>
getTransportType()
java.util.List<java.lang.String>
getTunnelInterfaceNames()
InternalTunnelKey
key()
InternalTunnelBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InternalTunnel>> augmentationType)
Remove an augmentation from this builder's product.InternalTunnelBuilder
setDestinationDPN(java.math.BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDestinationDPN(Uint64)
instead.InternalTunnelBuilder
setDestinationDPN(org.opendaylight.yangtools.yang.common.Uint64 value)
InternalTunnelBuilder
setSourceDPN(java.math.BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSourceDPN(Uint64)
instead.InternalTunnelBuilder
setSourceDPN(org.opendaylight.yangtools.yang.common.Uint64 value)
InternalTunnelBuilder
setTransportType(java.lang.Class<? extends TunnelTypeBase> value)
InternalTunnelBuilder
setTunnelInterfaceNames(java.util.List<java.lang.String> values)
InternalTunnelBuilder
withKey(InternalTunnelKey key)
-
-
-
Constructor Detail
-
InternalTunnelBuilder
public InternalTunnelBuilder()
-
InternalTunnelBuilder
public InternalTunnelBuilder(InternalTunnel base)
-
-
Method Detail
-
key
public InternalTunnelKey key()
-
getDestinationDPN
public org.opendaylight.yangtools.yang.common.Uint64 getDestinationDPN()
-
getSourceDPN
public org.opendaylight.yangtools.yang.common.Uint64 getSourceDPN()
-
getTransportType
public java.lang.Class<? extends TunnelTypeBase> getTransportType()
-
getTunnelInterfaceNames
public java.util.List<java.lang.String> getTunnelInterfaceNames()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<InternalTunnel>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public InternalTunnelBuilder withKey(InternalTunnelKey key)
-
setDestinationDPN
public InternalTunnelBuilder setDestinationDPN(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setDestinationDPN
@Deprecated(forRemoval=true) public InternalTunnelBuilder setDestinationDPN(java.math.BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDestinationDPN(Uint64)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setSourceDPN
public InternalTunnelBuilder setSourceDPN(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setSourceDPN
@Deprecated(forRemoval=true) public InternalTunnelBuilder setSourceDPN(java.math.BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSourceDPN(Uint64)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setTransportType
public InternalTunnelBuilder setTransportType(java.lang.Class<? extends TunnelTypeBase> value)
-
setTunnelInterfaceNames
public InternalTunnelBuilder setTunnelInterfaceNames(java.util.List<java.lang.String> values)
-
addAugmentation
public InternalTunnelBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<InternalTunnel> 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 InternalTunnelBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<InternalTunnel>> 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 InternalTunnel build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<InternalTunnel>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<InternalTunnel,java.lang.IllegalArgumentException>
-
-