Class SetFieldMatchBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.table.types.rev131026.set.field.match.SetFieldMatchBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<SetFieldMatch>
,org.opendaylight.yangtools.concepts.CheckedBuilder<SetFieldMatch,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class SetFieldMatchBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<SetFieldMatch>
Class that buildsSetFieldMatchBuilder
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:
SetFieldMatchBuilder createTarget(int fooXyzzy, int barBaz) { return new SetFieldMatchBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SetFieldMatchBuilder, 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:
SetFieldMatchBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description SetFieldMatchBuilder()
SetFieldMatchBuilder(SetFieldMatch base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description SetFieldMatchBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetFieldMatch>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<SetFieldMatch> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.SetFieldMatchBuilder
addAugmentation(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)
SetFieldMatch
build()
Class<? extends MatchField>
getMatchType()
Boolean
isHasMask()
SetFieldMatchKey
key()
SetFieldMatchBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetFieldMatch>> augmentationType)
Remove an augmentation from this builder's product.SetFieldMatchBuilder
setHasMask(Boolean value)
SetFieldMatchBuilder
setMatchType(Class<? extends MatchField> value)
SetFieldMatchBuilder
withKey(SetFieldMatchKey key)
-
-
-
Constructor Detail
-
SetFieldMatchBuilder
public SetFieldMatchBuilder()
-
SetFieldMatchBuilder
public SetFieldMatchBuilder(SetFieldMatch base)
-
-
Method Detail
-
key
public SetFieldMatchKey key()
-
getMatchType
public Class<? extends MatchField> getMatchType()
-
isHasMask
public Boolean isHasMask()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SetFieldMatch>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public SetFieldMatchBuilder withKey(SetFieldMatchKey key)
-
setMatchType
public SetFieldMatchBuilder setMatchType(Class<? extends MatchField> value)
-
setHasMask
public SetFieldMatchBuilder setHasMask(Boolean value)
-
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
-
addAugmentation
@Deprecated(forRemoval=true) public SetFieldMatchBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetFieldMatch>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<SetFieldMatch> 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 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
public SetFieldMatch build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<SetFieldMatch>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<SetFieldMatch,IllegalArgumentException>
-
-