Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.policy.rev151009.bgp.match.conditions
Class MatchExtCommunitySetBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.policy.rev151009.bgp.match.conditions.MatchExtCommunitySetBuilder
Class that builds
MatchExtCommunitySet
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:
MatchExtCommunitySet createMatchExtCommunitySet(int fooXyzzy, int barBaz) {
return new MatchExtCommunitySetBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of MatchExtCommunitySet, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedMatchExtCommunitySet
.Construct a new builder initialized from specifiedMatchSetOptionsGroup
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<MatchExtCommunitySet> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MatchExtCommunitySet>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull MatchExtCommunitySet
build()
A newMatchExtCommunitySet
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toMatchExtCommunitySet.getExtCommunitySet()
.Return current value associated with the property corresponding toMatchSetOptionsGroup.getMatchSetOptions()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MatchExtCommunitySet>> augmentationType) Remove an augmentation from this builder's product.setExtCommunitySet
(String value) Set the property corresponding toMatchExtCommunitySet.getExtCommunitySet()
to the specified value.Set the property corresponding toMatchSetOptionsGroup.getMatchSetOptions()
to the specified value.
-
Constructor Details
-
MatchExtCommunitySetBuilder
public MatchExtCommunitySetBuilder()Construct an empty builder. -
MatchExtCommunitySetBuilder
Construct a new builder initialized from specifiedMatchSetOptionsGroup
.- Parameters:
arg
- MatchSetOptionsGroup from which the builder should be initialized
-
MatchExtCommunitySetBuilder
Construct a builder initialized with state from specifiedMatchExtCommunitySet
.- Parameters:
base
- MatchExtCommunitySet from which the builder should be initialized
-
-
Method Details
-
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
-
getExtCommunitySet
Return current value associated with the property corresponding toMatchExtCommunitySet.getExtCommunitySet()
.- Returns:
- current value
-
getMatchSetOptions
Return current value associated with the property corresponding toMatchSetOptionsGroup.getMatchSetOptions()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MatchExtCommunitySet>> 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
-
setExtCommunitySet
Set the property corresponding toMatchExtCommunitySet.getExtCommunitySet()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMatchSetOptions
Set the property corresponding toMatchSetOptionsGroup.getMatchSetOptions()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public MatchExtCommunitySetBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MatchExtCommunitySet> 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 MatchExtCommunitySetBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MatchExtCommunitySet>> 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
A newMatchExtCommunitySet
instance.- Returns:
- A new
MatchExtCommunitySet
instance.
-