Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.policy.rev151009.bgp.match.conditions
Class MatchCommunitySetBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.policy.rev151009.bgp.match.conditions.MatchCommunitySetBuilder
-
@Generated("mdsal-binding-generator") public class MatchCommunitySetBuilder extends Object
Class that buildsMatchCommunitySet
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:
MatchCommunitySet createMatchCommunitySet(int fooXyzzy, int barBaz) { return new MatchCommunitySetBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MatchCommunitySet, 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:
MatchCommunitySet
- 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 MatchCommunitySetBuilder()
Construct an empty builder.MatchCommunitySetBuilder(MatchCommunitySet base)
Construct a builder initialized with state from specifiedMatchCommunitySet
.MatchCommunitySetBuilder(MatchSetOptionsGroup arg)
Construct a new builder initialized from specifiedMatchSetOptionsGroup
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MatchCommunitySetBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MatchCommunitySet> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MatchCommunitySet>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull MatchCommunitySet
build()
A newMatchCommunitySet
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.String
getCommunitySet()
Return current value associated with the property corresponding toMatchCommunitySet.getCommunitySet()
.MatchSetOptionsType
getMatchSetOptions()
Return current value associated with the property corresponding toMatchSetOptionsGroup.getMatchSetOptions()
.MatchCommunitySetBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MatchCommunitySet>> augmentationType)
Remove an augmentation from this builder's product.MatchCommunitySetBuilder
setCommunitySet(String value)
Set the property corresponding toMatchCommunitySet.getCommunitySet()
to the specified value.MatchCommunitySetBuilder
setMatchSetOptions(MatchSetOptionsType value)
Set the property corresponding toMatchSetOptionsGroup.getMatchSetOptions()
to the specified value.
-
-
-
Constructor Detail
-
MatchCommunitySetBuilder
public MatchCommunitySetBuilder()
Construct an empty builder.
-
MatchCommunitySetBuilder
public MatchCommunitySetBuilder(MatchSetOptionsGroup arg)
Construct a new builder initialized from specifiedMatchSetOptionsGroup
.- Parameters:
arg
- MatchSetOptionsGroup from which the builder should be initialized
-
MatchCommunitySetBuilder
public MatchCommunitySetBuilder(MatchCommunitySet base)
Construct a builder initialized with state from specifiedMatchCommunitySet
.- Parameters:
base
- MatchCommunitySet 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
-
getCommunitySet
public String getCommunitySet()
Return current value associated with the property corresponding toMatchCommunitySet.getCommunitySet()
.- Returns:
- current value
-
getMatchSetOptions
public MatchSetOptionsType getMatchSetOptions()
Return current value associated with the property corresponding toMatchSetOptionsGroup.getMatchSetOptions()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MatchCommunitySet>> 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
-
setCommunitySet
public MatchCommunitySetBuilder setCommunitySet(String value)
Set the property corresponding toMatchCommunitySet.getCommunitySet()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMatchSetOptions
public MatchCommunitySetBuilder setMatchSetOptions(MatchSetOptionsType value)
Set the property corresponding toMatchSetOptionsGroup.getMatchSetOptions()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public MatchCommunitySetBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MatchCommunitySet> 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 MatchCommunitySetBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MatchCommunitySet>> 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 MatchCommunitySet build()
A newMatchCommunitySet
instance.- Returns:
- A new
MatchCommunitySet
instance.
-
-