Class SourceTreeJoinBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.mvpn.rev200120.mvpn.mvpn.choice.source.tree.join._case.SourceTreeJoinBuilder
-
@Generated("mdsal-binding-generator") public class SourceTreeJoinBuilder extends Object
Class that buildsSourceTreeJoin
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:
SourceTreeJoin createSourceTreeJoin(int fooXyzzy, int barBaz) { return new SourceTreeJoinBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SourceTreeJoin, 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:
SourceTreeJoin
- 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 SourceTreeJoinBuilder()
Construct an empty builder.SourceTreeJoinBuilder(CMulticastGrouping arg)
Construct a new builder initialized from specifiedCMulticastGrouping
.SourceTreeJoinBuilder(SourceTreeJoin base)
Construct a builder initialized with state from specifiedSourceTreeJoin
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SourceTreeJoinBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SourceTreeJoin> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SourceTreeJoin>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull SourceTreeJoin
build()
A newSourceTreeJoin
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.CMulticast
getCMulticast()
Return current value associated with the property corresponding toCMulticastGrouping.getCMulticast()
.SourceTreeJoinBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SourceTreeJoin>> augmentationType)
Remove an augmentation from this builder's product.SourceTreeJoinBuilder
setCMulticast(CMulticast value)
Set the property corresponding toCMulticastGrouping.getCMulticast()
to the specified value.
-
-
-
Constructor Detail
-
SourceTreeJoinBuilder
public SourceTreeJoinBuilder()
Construct an empty builder.
-
SourceTreeJoinBuilder
public SourceTreeJoinBuilder(CMulticastGrouping arg)
Construct a new builder initialized from specifiedCMulticastGrouping
.- Parameters:
arg
- CMulticastGrouping from which the builder should be initialized
-
SourceTreeJoinBuilder
public SourceTreeJoinBuilder(SourceTreeJoin base)
Construct a builder initialized with state from specifiedSourceTreeJoin
.- Parameters:
base
- SourceTreeJoin 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
-
getCMulticast
public CMulticast getCMulticast()
Return current value associated with the property corresponding toCMulticastGrouping.getCMulticast()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SourceTreeJoin>> 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
-
setCMulticast
public SourceTreeJoinBuilder setCMulticast(CMulticast value)
Set the property corresponding toCMulticastGrouping.getCMulticast()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public SourceTreeJoinBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SourceTreeJoin> 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 SourceTreeJoinBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SourceTreeJoin>> 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 SourceTreeJoin build()
A newSourceTreeJoin
instance.- Returns:
- A new
SourceTreeJoin
instance.
-
-