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>
@Generated("mdsal-binding-generator") public class ProcTimeBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<ProcTime>
Class that buildsProcTime
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:
ProcTime createProcTime(int fooXyzzy, int barBaz) { return new ProcTimeBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ProcTime, 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 opportunities, 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:
ProcTime
,Builder
-
-
Constructor Summary
Constructors Constructor Description ProcTimeBuilder()
ProcTimeBuilder(Object arg)
ProcTimeBuilder(ObjectHeader arg)
ProcTimeBuilder(ProcTime base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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()
Boolean
getEstimated()
Boolean
getIgnore()
org.opendaylight.yangtools.yang.common.Uint32
getMaxProcTime()
org.opendaylight.yangtools.yang.common.Uint32
getMinProcTime()
Boolean
getProcessingRule()
org.opendaylight.yangtools.yang.common.Uint32
getVarianceProcTime()
ProcTimeBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ProcTime>> augmentationType)
Remove an augmentation from this builder's product.ProcTimeBuilder
setAverageProcTime(org.opendaylight.yangtools.yang.common.Uint32 value)
ProcTimeBuilder
setCurrentProcTime(org.opendaylight.yangtools.yang.common.Uint32 value)
ProcTimeBuilder
setEstimated(Boolean value)
ProcTimeBuilder
setIgnore(Boolean value)
ProcTimeBuilder
setMaxProcTime(org.opendaylight.yangtools.yang.common.Uint32 value)
ProcTimeBuilder
setMinProcTime(org.opendaylight.yangtools.yang.common.Uint32 value)
ProcTimeBuilder
setProcessingRule(Boolean value)
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:- ObjectHeader
- Object
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getAverageProcTime
public org.opendaylight.yangtools.yang.common.Uint32 getAverageProcTime()
-
getCurrentProcTime
public org.opendaylight.yangtools.yang.common.Uint32 getCurrentProcTime()
-
getEstimated
public Boolean getEstimated()
-
getIgnore
public Boolean getIgnore()
-
getMaxProcTime
public org.opendaylight.yangtools.yang.common.Uint32 getMaxProcTime()
-
getMinProcTime
public org.opendaylight.yangtools.yang.common.Uint32 getMinProcTime()
-
getProcessingRule
public Boolean getProcessingRule()
-
getVarianceProcTime
public org.opendaylight.yangtools.yang.common.Uint32 getVarianceProcTime()
-
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)
-
setCurrentProcTime
public ProcTimeBuilder setCurrentProcTime(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setEstimated
public ProcTimeBuilder setEstimated(Boolean value)
-
setIgnore
public ProcTimeBuilder setIgnore(Boolean value)
-
setMaxProcTime
public ProcTimeBuilder setMaxProcTime(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setMinProcTime
public ProcTimeBuilder setMinProcTime(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setProcessingRule
public ProcTimeBuilder setProcessingRule(Boolean value)
-
setVarianceProcTime
public ProcTimeBuilder setVarianceProcTime(org.opendaylight.yangtools.yang.common.Uint32 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
-
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>
-
-