Class MatchTypeBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.flow.node.supported.match.types.MatchTypeBuilder
-
@Generated("mdsal-binding-generator") public class MatchTypeBuilder extends Object
Class that buildsMatchType
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:
MatchType createMatchType(int fooXyzzy, int barBaz) { return new MatchTypeBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MatchType, 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:
MatchType
- 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 MatchTypeBuilder()
Construct an empty builder.MatchTypeBuilder(Feature arg)
Construct a new builder initialized from specifiedFeature
.MatchTypeBuilder(MatchType base)
Construct a builder initialized with state from specifiedMatchType
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MatchTypeBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MatchType> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MatchType>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull MatchType
build()
A newMatchType
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.String
getMatch()
Return current value associated with the property corresponding toMatchType.getMatch()
.SupportType
getSupportState()
Return current value associated with the property corresponding toFeature.getSupportState()
.MatchTypeKey
key()
Return current value associated with the property corresponding toMatchType.key()
.MatchTypeBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MatchType>> augmentationType)
Remove an augmentation from this builder's product.MatchTypeBuilder
setMatch(String value)
Set the property corresponding toMatchType.getMatch()
to the specified value.MatchTypeBuilder
setSupportState(SupportType value)
Set the property corresponding toFeature.getSupportState()
to the specified value.MatchTypeBuilder
withKey(MatchTypeKey key)
-
-
-
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
-
key
public MatchTypeKey key()
Return current value associated with the property corresponding toMatchType.key()
.- Returns:
- current value
-
getMatch
public String getMatch()
Return current value associated with the property corresponding toMatchType.getMatch()
.- Returns:
- current value
-
getSupportState
public SupportType getSupportState()
Return current value associated with the property corresponding toFeature.getSupportState()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MatchType>> 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
public MatchTypeBuilder withKey(MatchTypeKey key)
-
setMatch
public MatchTypeBuilder setMatch(String value)
Set the property corresponding toMatchType.getMatch()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSupportState
public MatchTypeBuilder setSupportState(SupportType value)
Set the property corresponding toFeature.getSupportState()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public MatchTypeBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MatchType> 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 MatchTypeBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MatchType>> 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
-
-