Class TunnelAggregationBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.genius.itm.config.rev160406.itm.config.TunnelAggregationBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<TunnelAggregation>
,org.opendaylight.yangtools.concepts.CheckedBuilder<TunnelAggregation,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class TunnelAggregationBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<TunnelAggregation>
Class that buildsTunnelAggregationBuilder
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:
TunnelAggregationBuilder createTarget(int fooXyzzy, int barBaz) { return new TunnelAggregationBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TunnelAggregationBuilder, 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:
TunnelAggregationBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description TunnelAggregationBuilder()
TunnelAggregationBuilder(TunnelAggregation base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description TunnelAggregationBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TunnelAggregation> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TunnelAggregation>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
TunnelAggregation
build()
java.lang.Boolean
getEnabled()
java.lang.String
getTunnelType()
java.lang.Boolean
isEnabled()
Deprecated, for removal: This API element is subject to removal in a future version.TunnelAggregationKey
key()
TunnelAggregationBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TunnelAggregation>> augmentationType)
Remove an augmentation from this builder's product.TunnelAggregationBuilder
setEnabled(java.lang.Boolean value)
TunnelAggregationBuilder
setTunnelType(java.lang.String value)
TunnelAggregationBuilder
withKey(TunnelAggregationKey key)
-
-
-
Constructor Detail
-
TunnelAggregationBuilder
public TunnelAggregationBuilder()
-
TunnelAggregationBuilder
public TunnelAggregationBuilder(TunnelAggregation base)
-
-
Method Detail
-
key
public TunnelAggregationKey key()
-
getEnabled
public java.lang.Boolean getEnabled()
-
isEnabled
@Deprecated(forRemoval=true) public final java.lang.Boolean isEnabled()
Deprecated, for removal: This API element is subject to removal in a future version.
-
getTunnelType
public java.lang.String getTunnelType()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TunnelAggregation>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public TunnelAggregationBuilder withKey(TunnelAggregationKey key)
-
setEnabled
public TunnelAggregationBuilder setEnabled(java.lang.Boolean value)
-
setTunnelType
public TunnelAggregationBuilder setTunnelType(java.lang.String value)
-
addAugmentation
public TunnelAggregationBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TunnelAggregation> 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 TunnelAggregationBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TunnelAggregation>> 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 TunnelAggregation build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<TunnelAggregation>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<TunnelAggregation,java.lang.IllegalArgumentException>
-
-