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