Class MatchTypeBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.flow.node.supported.match.types.MatchTypeBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<MatchType>
,org.opendaylight.yangtools.concepts.CheckedBuilder<MatchType,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class MatchTypeBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<MatchType>
Class that buildsMatchTypeBuilder
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:
MatchTypeBuilder createTarget(int fooXyzzy, int barBaz) { return new MatchTypeBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MatchTypeBuilder, 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 oportunities, 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:
MatchTypeBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description MatchTypeBuilder()
MatchTypeBuilder(Feature arg)
MatchTypeBuilder(MatchType base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description MatchTypeBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MatchType>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<MatchType> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.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)
MatchType
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.String
getMatch()
org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.SupportType
getSupportState()
MatchTypeKey
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)
MatchTypeBuilder
setSupportState(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.SupportType 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:- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.Feature
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
key
public MatchTypeKey key()
-
getMatch
public String getMatch()
-
getSupportState
public org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.SupportType getSupportState()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MatchType>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public MatchTypeBuilder withKey(MatchTypeKey key)
-
setMatch
public MatchTypeBuilder setMatch(String value)
-
setSupportState
public MatchTypeBuilder setSupportState(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.SupportType value)
-
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
-
addAugmentation
@Deprecated(forRemoval=true) public MatchTypeBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MatchType>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<MatchType> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
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
-
build
public MatchType build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<MatchType>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<MatchType,IllegalArgumentException>
-
-