Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.overlay.rev150105.supported.tunnels
Class SupportedTunnelEntryBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.overlay.rev150105.supported.tunnels.SupportedTunnelEntryBuilder
-
@Generated("mdsal-binding-generator") public class SupportedTunnelEntryBuilder extends Object
Class that buildsSupportedTunnelEntry
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:
SupportedTunnelEntry createSupportedTunnelEntry(int fooXyzzy, int barBaz) { return new SupportedTunnelEntryBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SupportedTunnelEntry, 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 opportunities, 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:
SupportedTunnelEntry
- 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
-
-
Constructor Summary
Constructors Constructor Description SupportedTunnelEntryBuilder()
Construct an empty builder.SupportedTunnelEntryBuilder(SupportedTunnelEntry base)
Construct a builder initialized with state from specifiedSupportedTunnelEntry
.SupportedTunnelEntryBuilder(TunnelTypeAttributes arg)
Construct a new builder initialized from specifiedTunnelTypeAttributes
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SupportedTunnelEntryBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SupportedTunnelEntry> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SupportedTunnelEntry>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull SupportedTunnelEntry
build()
A newSupportedTunnelEntry
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Class<? extends TunnelTypeBase>
getTunnelType()
Return current value associated with the property corresponding toTunnelTypeAttributes.getTunnelType()
.SupportedTunnelEntryBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SupportedTunnelEntry>> augmentationType)
Remove an augmentation from this builder's product.SupportedTunnelEntryBuilder
setTunnelType(Class<? extends TunnelTypeBase> value)
Set the property corresponding toTunnelTypeAttributes.getTunnelType()
to the specified value.
-
-
-
Constructor Detail
-
SupportedTunnelEntryBuilder
public SupportedTunnelEntryBuilder()
Construct an empty builder.
-
SupportedTunnelEntryBuilder
public SupportedTunnelEntryBuilder(TunnelTypeAttributes arg)
Construct a new builder initialized from specifiedTunnelTypeAttributes
.- Parameters:
arg
- TunnelTypeAttributes from which the builder should be initialized
-
SupportedTunnelEntryBuilder
public SupportedTunnelEntryBuilder(SupportedTunnelEntry base)
Construct a builder initialized with state from specifiedSupportedTunnelEntry
.- Parameters:
base
- SupportedTunnelEntry from which the builder should be initialized
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getTunnelType
public Class<? extends TunnelTypeBase> getTunnelType()
Return current value associated with the property corresponding toTunnelTypeAttributes.getTunnelType()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SupportedTunnelEntry>> E$$ augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setTunnelType
public SupportedTunnelEntryBuilder setTunnelType(Class<? extends TunnelTypeBase> value)
Set the property corresponding toTunnelTypeAttributes.getTunnelType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public SupportedTunnelEntryBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SupportedTunnelEntry> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public SupportedTunnelEntryBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SupportedTunnelEntry>> 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 @NonNull SupportedTunnelEntry build()
A newSupportedTunnelEntry
instance.- Returns:
- A new
SupportedTunnelEntry
instance.
-
-