Class OverloadDurationBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.overload.duration.tlv.OverloadDurationBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<OverloadDuration>
,org.opendaylight.yangtools.concepts.CheckedBuilder<OverloadDuration,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class OverloadDurationBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<OverloadDuration>
Class that buildsOverloadDurationBuilder
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:
OverloadDurationBuilder createTarget(int fooXyzzy, int barBaz) { return new OverloadDurationBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of OverloadDurationBuilder, 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:
OverloadDurationBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description OverloadDurationBuilder()
OverloadDurationBuilder(OverloadDuration base)
OverloadDurationBuilder(Tlv arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description OverloadDurationBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<OverloadDuration> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OverloadDuration>>
E$$augmentation(Class<E$$> augmentationType)
OverloadDuration
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint32
getDuration()
OverloadDurationBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OverloadDuration>> augmentationType)
Remove an augmentation from this builder's product.OverloadDurationBuilder
setDuration(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDuration(Uint32)
instead.OverloadDurationBuilder
setDuration(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
OverloadDurationBuilder
public OverloadDurationBuilder()
-
OverloadDurationBuilder
public OverloadDurationBuilder(Tlv arg)
-
OverloadDurationBuilder
public OverloadDurationBuilder(OverloadDuration 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.params.xml.ns.yang.pcep.types.rev181109.Tlv
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getDuration
public org.opendaylight.yangtools.yang.common.Uint32 getDuration()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OverloadDuration>> E$$ augmentation(Class<E$$> augmentationType)
-
setDuration
public OverloadDurationBuilder setDuration(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setDuration
@Deprecated(forRemoval=true) public OverloadDurationBuilder setDuration(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetDuration(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public OverloadDurationBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<OverloadDuration> 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 OverloadDurationBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OverloadDuration>> 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 OverloadDuration build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<OverloadDuration>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<OverloadDuration,IllegalArgumentException>
-
-