Class MatchSetfieldBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.table.feature.prop.type.table.feature.prop.type.match.MatchSetfieldBuilder
-
@Generated("mdsal-binding-generator") public class MatchSetfieldBuilder extends Object
Class that buildsMatchSetfield
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:
MatchSetfield createMatchSetfield(int fooXyzzy, int barBaz) { return new MatchSetfieldBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MatchSetfield, 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:
MatchSetfield
- 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 MatchSetfieldBuilder()
Construct an empty builder.MatchSetfieldBuilder(SetFieldMatch arg)
Construct a new builder initialized from specifiedSetFieldMatch
.MatchSetfieldBuilder(MatchSetfield base)
Construct a builder initialized with state from specifiedMatchSetfield
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MatchSetfieldBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MatchSetfield> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MatchSetfield>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull MatchSetfield
build()
A newMatchSetfield
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Map<SetFieldMatchKey,SetFieldMatch>
getSetFieldMatch()
Return current value associated with the property corresponding toSetFieldMatch.getSetFieldMatch()
.MatchSetfieldBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MatchSetfield>> augmentationType)
Remove an augmentation from this builder's product.MatchSetfieldBuilder
setSetFieldMatch(Map<SetFieldMatchKey,SetFieldMatch> values)
Set the property corresponding toSetFieldMatch.getSetFieldMatch()
to the specified value.
-
-
-
Constructor Detail
-
MatchSetfieldBuilder
public MatchSetfieldBuilder()
Construct an empty builder.
-
MatchSetfieldBuilder
public MatchSetfieldBuilder(SetFieldMatch arg)
Construct a new builder initialized from specifiedSetFieldMatch
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.SetFieldMatch from which the builder should be initialized
-
MatchSetfieldBuilder
public MatchSetfieldBuilder(MatchSetfield base)
Construct a builder initialized with state from specifiedMatchSetfield
.- Parameters:
base
- MatchSetfield 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
-
getSetFieldMatch
public Map<SetFieldMatchKey,SetFieldMatch> getSetFieldMatch()
Return current value associated with the property corresponding toSetFieldMatch.getSetFieldMatch()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MatchSetfield>> 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
-
setSetFieldMatch
public MatchSetfieldBuilder setSetFieldMatch(Map<SetFieldMatchKey,SetFieldMatch> values)
Set the property corresponding toSetFieldMatch.getSetFieldMatch()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public MatchSetfieldBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MatchSetfield> 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 MatchSetfieldBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MatchSetfield>> 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 MatchSetfield build()
A newMatchSetfield
instance.- Returns:
- A new
MatchSetfield
instance.
-
-