Class Icmpv4MatchBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.Icmpv4MatchBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Icmpv4Match>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Icmpv4Match,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class Icmpv4MatchBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Icmpv4Match>
Class that buildsIcmpv4MatchBuilder
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:
Icmpv4MatchBuilder createTarget(int fooXyzzy, int barBaz) { return new Icmpv4MatchBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Icmpv4MatchBuilder, 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:
Icmpv4MatchBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description Icmpv4MatchBuilder()
Icmpv4MatchBuilder(Icmpv4MatchFields arg)
Icmpv4MatchBuilder(Icmpv4Match base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Icmpv4MatchBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv4Match>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv4Match> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Icmpv4MatchBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv4Match> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv4Match>>
E$$augmentation(Class<E$$> augmentationType)
Icmpv4Match
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint8
getIcmpv4Code()
org.opendaylight.yangtools.yang.common.Uint8
getIcmpv4Type()
Icmpv4MatchBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv4Match>> augmentationType)
Remove an augmentation from this builder's product.Icmpv4MatchBuilder
setIcmpv4Code(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIcmpv4Code(Uint8)
instead.Icmpv4MatchBuilder
setIcmpv4Code(org.opendaylight.yangtools.yang.common.Uint8 value)
Icmpv4MatchBuilder
setIcmpv4Type(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIcmpv4Type(Uint8)
instead.Icmpv4MatchBuilder
setIcmpv4Type(org.opendaylight.yangtools.yang.common.Uint8 value)
-
-
-
Constructor Detail
-
Icmpv4MatchBuilder
public Icmpv4MatchBuilder()
-
Icmpv4MatchBuilder
public Icmpv4MatchBuilder(Icmpv4MatchFields arg)
-
Icmpv4MatchBuilder
public Icmpv4MatchBuilder(Icmpv4Match 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:- org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.Icmpv4MatchFields
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getIcmpv4Code
public org.opendaylight.yangtools.yang.common.Uint8 getIcmpv4Code()
-
getIcmpv4Type
public org.opendaylight.yangtools.yang.common.Uint8 getIcmpv4Type()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv4Match>> E$$ augmentation(Class<E$$> augmentationType)
-
setIcmpv4Code
public Icmpv4MatchBuilder setIcmpv4Code(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setIcmpv4Code
@Deprecated(forRemoval=true) public Icmpv4MatchBuilder setIcmpv4Code(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIcmpv4Code(Uint8)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setIcmpv4Type
public Icmpv4MatchBuilder setIcmpv4Type(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setIcmpv4Type
@Deprecated(forRemoval=true) public Icmpv4MatchBuilder setIcmpv4Type(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIcmpv4Type(Uint8)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public Icmpv4MatchBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv4Match> 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 Icmpv4MatchBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv4Match>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv4Match> 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 Icmpv4MatchBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Icmpv4Match>> 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 Icmpv4Match build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Icmpv4Match>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Icmpv4Match,IllegalArgumentException>
-
-