Class MatchBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.grouping.MatchBuilder
-
@Generated("mdsal-binding-generator") public class MatchBuilder extends Object
Class that buildsMatch
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:
Match createMatch(int fooXyzzy, int barBaz) { return new MatchBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Match, 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:
Match
- 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 MatchBuilder()
Construct an empty builder.MatchBuilder(Match base)
Construct a builder initialized with state from specifiedMatch
.MatchBuilder(MatchEntriesGrouping arg)
Construct a new builder initialized from specifiedMatchEntriesGrouping
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MatchBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Match> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Match>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull Match
build()
A newMatch
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.List<MatchEntry>
getMatchEntry()
Return current value associated with the property corresponding toMatchEntriesGrouping.getMatchEntry()
.Class<? extends MatchTypeBase>
getType()
Return current value associated with the property corresponding toMatch.getType()
.MatchBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Match>> augmentationType)
Remove an augmentation from this builder's product.MatchBuilder
setMatchEntry(List<MatchEntry> values)
Set the property corresponding toMatchEntriesGrouping.getMatchEntry()
to the specified value.MatchBuilder
setType(Class<? extends MatchTypeBase> value)
Set the property corresponding toMatch.getType()
to the specified value.
-
-
-
Constructor Detail
-
MatchBuilder
public MatchBuilder()
Construct an empty builder.
-
MatchBuilder
public MatchBuilder(MatchEntriesGrouping arg)
Construct a new builder initialized from specifiedMatchEntriesGrouping
.- Parameters:
arg
- MatchEntriesGrouping 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
-
getMatchEntry
public List<MatchEntry> getMatchEntry()
Return current value associated with the property corresponding toMatchEntriesGrouping.getMatchEntry()
.- Returns:
- current value
-
getType
public Class<? extends MatchTypeBase> getType()
Return current value associated with the property corresponding toMatch.getType()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Match>> 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
-
setMatchEntry
public MatchBuilder setMatchEntry(List<MatchEntry> values)
Set the property corresponding toMatchEntriesGrouping.getMatchEntry()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
setType
public MatchBuilder setType(Class<? extends MatchTypeBase> value)
Set the property corresponding toMatch.getType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public MatchBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Match> 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 MatchBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Match>> 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
-
-