Class SetNwTtlActionBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.action.grouping.action.choice.set.nw.ttl._case.SetNwTtlActionBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<SetNwTtlAction>
,org.opendaylight.yangtools.concepts.CheckedBuilder<SetNwTtlAction,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class SetNwTtlActionBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<SetNwTtlAction>
Class that buildsSetNwTtlActionBuilder
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:
SetNwTtlActionBuilder createTarget(int fooXyzzy, int barBaz) { return new SetNwTtlActionBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of SetNwTtlActionBuilder, 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:
SetNwTtlActionBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description SetNwTtlActionBuilder()
SetNwTtlActionBuilder(SetNwTtlAction base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description SetNwTtlActionBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SetNwTtlAction> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SetNwTtlAction>>
E$$augmentation(Class<E$$> augmentationType)
SetNwTtlAction
build()
org.opendaylight.yangtools.yang.common.Uint8
getNwTtl()
SetNwTtlActionBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetNwTtlAction>> augmentationType)
Remove an augmentation from this builder's product.SetNwTtlActionBuilder
setNwTtl(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetNwTtl(Uint8)
instead.SetNwTtlActionBuilder
setNwTtl(org.opendaylight.yangtools.yang.common.Uint8 value)
-
-
-
Constructor Detail
-
SetNwTtlActionBuilder
public SetNwTtlActionBuilder()
-
SetNwTtlActionBuilder
public SetNwTtlActionBuilder(SetNwTtlAction base)
-
-
Method Detail
-
getNwTtl
public org.opendaylight.yangtools.yang.common.Uint8 getNwTtl()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SetNwTtlAction>> E$$ augmentation(Class<E$$> augmentationType)
-
setNwTtl
public SetNwTtlActionBuilder setNwTtl(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setNwTtl
@Deprecated(forRemoval=true) public SetNwTtlActionBuilder setNwTtl(Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetNwTtl(Uint8)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public SetNwTtlActionBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<SetNwTtlAction> 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 SetNwTtlActionBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SetNwTtlAction>> 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 SetNwTtlAction build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<SetNwTtlAction>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<SetNwTtlAction,IllegalArgumentException>
-
-