Class ProcTimeBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.proc.time.object.ProcTimeBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<ProcTime>
,org.opendaylight.yangtools.concepts.CheckedBuilder<ProcTime,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class ProcTimeBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<ProcTime>
Class that buildsProcTimeBuilder
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:
ProcTimeBuilder createTarget(int fooXyzzy, int barBaz) { return new ProcTimeBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ProcTimeBuilder, 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:
ProcTimeBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description ProcTimeBuilder()
ProcTimeBuilder(Object arg)
ProcTimeBuilder(ObjectHeader arg)
ProcTimeBuilder(ProcTime base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description ProcTimeBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ProcTime>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<ProcTime> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.ProcTimeBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ProcTime> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ProcTime>>
E$$augmentation(Class<E$$> augmentationType)
ProcTime
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint32
getAverageProcTime()
org.opendaylight.yangtools.yang.common.Uint32
getCurrentProcTime()
org.opendaylight.yangtools.yang.common.Uint32
getMaxProcTime()
org.opendaylight.yangtools.yang.common.Uint32
getMinProcTime()
org.opendaylight.yangtools.yang.common.Uint32
getVarianceProcTime()
Boolean
isEstimated()
Boolean
isIgnore()
Boolean
isProcessingRule()
ProcTimeBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ProcTime>> augmentationType)
Remove an augmentation from this builder's product.ProcTimeBuilder
setAverageProcTime(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetAverageProcTime(Uint32)
instead.ProcTimeBuilder
setAverageProcTime(org.opendaylight.yangtools.yang.common.Uint32 value)
ProcTimeBuilder
setCurrentProcTime(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetCurrentProcTime(Uint32)
instead.ProcTimeBuilder
setCurrentProcTime(org.opendaylight.yangtools.yang.common.Uint32 value)
ProcTimeBuilder
setEstimated(Boolean value)
ProcTimeBuilder
setIgnore(Boolean value)
ProcTimeBuilder
setMaxProcTime(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMaxProcTime(Uint32)
instead.ProcTimeBuilder
setMaxProcTime(org.opendaylight.yangtools.yang.common.Uint32 value)
ProcTimeBuilder
setMinProcTime(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMinProcTime(Uint32)
instead.ProcTimeBuilder
setMinProcTime(org.opendaylight.yangtools.yang.common.Uint32 value)
ProcTimeBuilder
setProcessingRule(Boolean value)
ProcTimeBuilder
setVarianceProcTime(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetVarianceProcTime(Uint32)
instead.ProcTimeBuilder
setVarianceProcTime(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
ProcTimeBuilder
public ProcTimeBuilder()
-
ProcTimeBuilder
public ProcTimeBuilder(Object arg)
-
ProcTimeBuilder
public ProcTimeBuilder(ObjectHeader arg)
-
ProcTimeBuilder
public ProcTimeBuilder(ProcTime 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.ObjectHeader
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Object
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getAverageProcTime
public org.opendaylight.yangtools.yang.common.Uint32 getAverageProcTime()
-
getCurrentProcTime
public org.opendaylight.yangtools.yang.common.Uint32 getCurrentProcTime()
-
getMaxProcTime
public org.opendaylight.yangtools.yang.common.Uint32 getMaxProcTime()
-
getMinProcTime
public org.opendaylight.yangtools.yang.common.Uint32 getMinProcTime()
-
getVarianceProcTime
public org.opendaylight.yangtools.yang.common.Uint32 getVarianceProcTime()
-
isEstimated
public Boolean isEstimated()
-
isIgnore
public Boolean isIgnore()
-
isProcessingRule
public Boolean isProcessingRule()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ProcTime>> E$$ augmentation(Class<E$$> augmentationType)
-
setAverageProcTime
public ProcTimeBuilder setAverageProcTime(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setAverageProcTime
@Deprecated(forRemoval=true) public ProcTimeBuilder setAverageProcTime(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetAverageProcTime(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setCurrentProcTime
public ProcTimeBuilder setCurrentProcTime(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setCurrentProcTime
@Deprecated(forRemoval=true) public ProcTimeBuilder setCurrentProcTime(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetCurrentProcTime(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setMaxProcTime
public ProcTimeBuilder setMaxProcTime(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setMaxProcTime
@Deprecated(forRemoval=true) public ProcTimeBuilder setMaxProcTime(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMaxProcTime(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setMinProcTime
public ProcTimeBuilder setMinProcTime(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setMinProcTime
@Deprecated(forRemoval=true) public ProcTimeBuilder setMinProcTime(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMinProcTime(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setVarianceProcTime
public ProcTimeBuilder setVarianceProcTime(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setVarianceProcTime
@Deprecated(forRemoval=true) public ProcTimeBuilder setVarianceProcTime(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetVarianceProcTime(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setEstimated
public ProcTimeBuilder setEstimated(Boolean value)
-
setIgnore
public ProcTimeBuilder setIgnore(Boolean value)
-
setProcessingRule
public ProcTimeBuilder setProcessingRule(Boolean value)
-
addAugmentation
public ProcTimeBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ProcTime> 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 ProcTimeBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ProcTime>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<ProcTime> 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 ProcTimeBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ProcTime>> 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 ProcTime build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<ProcTime>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<ProcTime,IllegalArgumentException>
-
-