Class SetFieldMatchBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.set.field.match.SetFieldMatchBuilder
Class that builds
SetFieldMatch
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:
SetFieldMatch createSetFieldMatch(int fooXyzzy, int barBaz) {
return new SetFieldMatchBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of SetFieldMatch, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedSetFieldMatch
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<SetFieldMatch> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SetFieldMatch>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull SetFieldMatch
build()
A newSetFieldMatch
instance.Return current value associated with the property corresponding toSetFieldMatch.getHasMask()
.Return current value associated with the property corresponding toSetFieldMatch.getMatchType()
.key()
Return current value associated with the property corresponding toSetFieldMatch.key()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetFieldMatch>> augmentationType) Remove an augmentation from this builder's product.setHasMask
(Boolean value) Set the property corresponding toSetFieldMatch.getHasMask()
to the specified value.setMatchType
(MatchField value) Set the property corresponding toSetFieldMatch.getMatchType()
to the specified value.withKey
(SetFieldMatchKey key) Set the key value corresponding toSetFieldMatch.key()
to the specified value.
-
Constructor Details
-
SetFieldMatchBuilder
public SetFieldMatchBuilder()Construct an empty builder. -
SetFieldMatchBuilder
Construct a builder initialized with state from specifiedSetFieldMatch
.- Parameters:
base
- SetFieldMatch from which the builder should be initialized
-
-
Method Details
-
key
Return current value associated with the property corresponding toSetFieldMatch.key()
.- Returns:
- current value
-
getHasMask
Return current value associated with the property corresponding toSetFieldMatch.getHasMask()
.- Returns:
- current value
-
getMatchType
Return current value associated with the property corresponding toSetFieldMatch.getMatchType()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SetFieldMatch>> 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
-
withKey
Set the key value corresponding toSetFieldMatch.key()
to the specified value.- Parameters:
key
- desired value- Returns:
- this builder
-
setHasMask
Set the property corresponding toSetFieldMatch.getHasMask()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMatchType
Set the property corresponding toSetFieldMatch.getMatchType()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public SetFieldMatchBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SetFieldMatch> 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 SetFieldMatchBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetFieldMatch>> 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
A newSetFieldMatch
instance.- Returns:
- A new
SetFieldMatch
instance.
-