Class MatchEntryBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entries.grouping.MatchEntryBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<MatchEntry>
,org.opendaylight.yangtools.concepts.CheckedBuilder<MatchEntry,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class MatchEntryBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<MatchEntry>
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
,Builder
-
-
Constructor Summary
Constructors Constructor Description MatchEntryBuilder()
MatchEntryBuilder(MatchEntry base)
MatchEntryBuilder(MatchEntryFieldsGrouping arg)
MatchEntryBuilder(MatchEntryValueGrouping arg)
-
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)
MatchEntry
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Boolean
getHasMask()
MatchEntryValue
getMatchEntryValue()
Class<? extends OxmClassBase>
getOxmClass()
Class<? extends MatchField>
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)
MatchEntryBuilder
setMatchEntryValue(MatchEntryValue value)
MatchEntryBuilder
setOxmClass(Class<? extends OxmClassBase> value)
MatchEntryBuilder
setOxmMatchField(Class<? extends MatchField> value)
-
-
-
Constructor Detail
-
MatchEntryBuilder
public MatchEntryBuilder()
-
MatchEntryBuilder
public MatchEntryBuilder(MatchEntryFieldsGrouping arg)
-
MatchEntryBuilder
public MatchEntryBuilder(MatchEntryValueGrouping arg)
-
MatchEntryBuilder
public MatchEntryBuilder(MatchEntry base)
-
-
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:- MatchEntryFieldsGrouping
- MatchEntryValueGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getHasMask
public Boolean getHasMask()
-
getMatchEntryValue
public MatchEntryValue getMatchEntryValue()
-
getOxmClass
public Class<? extends OxmClassBase> getOxmClass()
-
getOxmMatchField
public Class<? extends MatchField> getOxmMatchField()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MatchEntry>> E$$ augmentation(Class<E$$> augmentationType)
-
setHasMask
public MatchEntryBuilder setHasMask(Boolean value)
-
setMatchEntryValue
public MatchEntryBuilder setMatchEntryValue(MatchEntryValue value)
-
setOxmClass
public MatchEntryBuilder setOxmClass(Class<? extends OxmClassBase> value)
-
setOxmMatchField
public MatchEntryBuilder setOxmMatchField(Class<? extends MatchField> value)
-
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 MatchEntry build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<MatchEntry>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<MatchEntry,IllegalArgumentException>
-
-