Class MatchEntryBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entries.grouping.MatchEntryBuilder
-
@Generated("mdsal-binding-generator") public class MatchEntryBuilder extends Object
Class that buildsMatchEntry
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:
MatchEntry createMatchEntry(int fooXyzzy, int barBaz) { return new MatchEntryBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MatchEntry, 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:
MatchEntry
- 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 MatchEntryBuilder()
Construct an empty builder.MatchEntryBuilder(MatchEntry base)
Construct a builder initialized with state from specifiedMatchEntry
.MatchEntryBuilder(MatchEntryFieldsGrouping arg)
Construct a new builder initialized from specifiedMatchEntryFieldsGrouping
.MatchEntryBuilder(MatchEntryValueGrouping arg)
Construct a new builder initialized from specifiedMatchEntryValueGrouping
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MatchEntryBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MatchEntry> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MatchEntry>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull MatchEntry
build()
A newMatchEntry
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getHasMask()
Return current value associated with the property corresponding toMatchEntryFieldsGrouping.getHasMask()
.MatchEntryValue
getMatchEntryValue()
Return current value associated with the property corresponding toMatchEntryValueGrouping.getMatchEntryValue()
.Class<? extends OxmClassBase>
getOxmClass()
Return current value associated with the property corresponding toMatchEntryFieldsGrouping.getOxmClass()
.Class<? extends MatchField>
getOxmMatchField()
Return current value associated with the property corresponding toMatchEntryFieldsGrouping.getOxmMatchField()
.MatchEntryBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MatchEntry>> augmentationType)
Remove an augmentation from this builder's product.MatchEntryBuilder
setHasMask(Boolean value)
Set the property corresponding toMatchEntryFieldsGrouping.getHasMask()
to the specified value.MatchEntryBuilder
setMatchEntryValue(MatchEntryValue value)
Set the property corresponding toMatchEntryValueGrouping.getMatchEntryValue()
to the specified value.MatchEntryBuilder
setOxmClass(Class<? extends OxmClassBase> value)
Set the property corresponding toMatchEntryFieldsGrouping.getOxmClass()
to the specified value.MatchEntryBuilder
setOxmMatchField(Class<? extends MatchField> value)
Set the property corresponding toMatchEntryFieldsGrouping.getOxmMatchField()
to the specified value.
-
-
-
Constructor Detail
-
MatchEntryBuilder
public MatchEntryBuilder()
Construct an empty builder.
-
MatchEntryBuilder
public MatchEntryBuilder(MatchEntryFieldsGrouping arg)
Construct a new builder initialized from specifiedMatchEntryFieldsGrouping
.- Parameters:
arg
- MatchEntryFieldsGrouping from which the builder should be initialized
-
MatchEntryBuilder
public MatchEntryBuilder(MatchEntryValueGrouping arg)
Construct a new builder initialized from specifiedMatchEntryValueGrouping
.- Parameters:
arg
- MatchEntryValueGrouping from which the builder should be initialized
-
MatchEntryBuilder
public MatchEntryBuilder(MatchEntry base)
Construct a builder initialized with state from specifiedMatchEntry
.- Parameters:
base
- MatchEntry 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
-
getHasMask
public Boolean getHasMask()
Return current value associated with the property corresponding toMatchEntryFieldsGrouping.getHasMask()
.- Returns:
- current value
-
getMatchEntryValue
public MatchEntryValue getMatchEntryValue()
Return current value associated with the property corresponding toMatchEntryValueGrouping.getMatchEntryValue()
.- Returns:
- current value
-
getOxmClass
public Class<? extends OxmClassBase> getOxmClass()
Return current value associated with the property corresponding toMatchEntryFieldsGrouping.getOxmClass()
.- Returns:
- current value
-
getOxmMatchField
public Class<? extends MatchField> getOxmMatchField()
Return current value associated with the property corresponding toMatchEntryFieldsGrouping.getOxmMatchField()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MatchEntry>> 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
-
setHasMask
public MatchEntryBuilder setHasMask(Boolean value)
Set the property corresponding toMatchEntryFieldsGrouping.getHasMask()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMatchEntryValue
public MatchEntryBuilder setMatchEntryValue(MatchEntryValue value)
Set the property corresponding toMatchEntryValueGrouping.getMatchEntryValue()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOxmClass
public MatchEntryBuilder setOxmClass(Class<? extends OxmClassBase> value)
Set the property corresponding toMatchEntryFieldsGrouping.getOxmClass()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOxmMatchField
public MatchEntryBuilder setOxmMatchField(Class<? extends MatchField> value)
Set the property corresponding toMatchEntryFieldsGrouping.getOxmMatchField()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public MatchEntryBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MatchEntry> 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 MatchEntryBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MatchEntry>> 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 MatchEntry build()
A newMatchEntry
instance.- Returns:
- A new
MatchEntry
instance.
-
-