Class ProcTimeBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.proc.time.object.ProcTimeBuilder
-
@Generated("mdsal-binding-generator") public class ProcTimeBuilder extends Object
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
- 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
-
-
Constructor Summary
Constructors Constructor Description ProcTimeBuilder()
Construct an empty builder.ProcTimeBuilder(Object arg)
Construct a new builder initialized from specifiedObject
.ProcTimeBuilder(ObjectHeader arg)
Construct a new builder initialized from specifiedObjectHeader
.ProcTimeBuilder(ProcTime base)
Construct a builder initialized with state from specifiedProcTime
.
-
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)
Return the specified augmentation, if it is present in this builder.@NonNull ProcTime
build()
A newProcTime
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint32
getAverageProcTime()
Return current value associated with the property corresponding toProcTime.getAverageProcTime()
.org.opendaylight.yangtools.yang.common.Uint32
getCurrentProcTime()
Return current value associated with the property corresponding toProcTime.getCurrentProcTime()
.Boolean
getEstimated()
Return current value associated with the property corresponding toProcTime.getEstimated()
.Boolean
getIgnore()
Return current value associated with the property corresponding toObjectHeader.getIgnore()
.org.opendaylight.yangtools.yang.common.Uint32
getMaxProcTime()
Return current value associated with the property corresponding toProcTime.getMaxProcTime()
.org.opendaylight.yangtools.yang.common.Uint32
getMinProcTime()
Return current value associated with the property corresponding toProcTime.getMinProcTime()
.Boolean
getProcessingRule()
Return current value associated with the property corresponding toObjectHeader.getProcessingRule()
.org.opendaylight.yangtools.yang.common.Uint32
getVarianceProcTime()
Return current value associated with the property corresponding toProcTime.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)
Set the property corresponding toProcTime.getAverageProcTime()
to the specified value.ProcTimeBuilder
setCurrentProcTime(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toProcTime.getCurrentProcTime()
to the specified value.ProcTimeBuilder
setEstimated(Boolean value)
Set the property corresponding toProcTime.getEstimated()
to the specified value.ProcTimeBuilder
setIgnore(Boolean value)
Set the property corresponding toObjectHeader.getIgnore()
to the specified value.ProcTimeBuilder
setMaxProcTime(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toProcTime.getMaxProcTime()
to the specified value.ProcTimeBuilder
setMinProcTime(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toProcTime.getMinProcTime()
to the specified value.ProcTimeBuilder
setProcessingRule(Boolean value)
Set the property corresponding toObjectHeader.getProcessingRule()
to the specified value.ProcTimeBuilder
setVarianceProcTime(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toProcTime.getVarianceProcTime()
to the specified value.
-
-
-
Constructor Detail
-
ProcTimeBuilder
public ProcTimeBuilder()
Construct an empty builder.
-
ProcTimeBuilder
public ProcTimeBuilder(Object arg)
Construct a new builder initialized from specifiedObject
.- Parameters:
arg
- Object from which the builder should be initialized
-
ProcTimeBuilder
public ProcTimeBuilder(ObjectHeader arg)
Construct a new builder initialized from specifiedObjectHeader
.- Parameters:
arg
- ObjectHeader from which the builder should be initialized
-
-
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:- 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()
Return current value associated with the property corresponding toProcTime.getAverageProcTime()
.- Returns:
- current value
-
getCurrentProcTime
public org.opendaylight.yangtools.yang.common.Uint32 getCurrentProcTime()
Return current value associated with the property corresponding toProcTime.getCurrentProcTime()
.- Returns:
- current value
-
getEstimated
public Boolean getEstimated()
Return current value associated with the property corresponding toProcTime.getEstimated()
.- Returns:
- current value
-
getIgnore
public Boolean getIgnore()
Return current value associated with the property corresponding toObjectHeader.getIgnore()
.- Returns:
- current value
-
getMaxProcTime
public org.opendaylight.yangtools.yang.common.Uint32 getMaxProcTime()
Return current value associated with the property corresponding toProcTime.getMaxProcTime()
.- Returns:
- current value
-
getMinProcTime
public org.opendaylight.yangtools.yang.common.Uint32 getMinProcTime()
Return current value associated with the property corresponding toProcTime.getMinProcTime()
.- Returns:
- current value
-
getProcessingRule
public Boolean getProcessingRule()
Return current value associated with the property corresponding toObjectHeader.getProcessingRule()
.- Returns:
- current value
-
getVarianceProcTime
public org.opendaylight.yangtools.yang.common.Uint32 getVarianceProcTime()
Return current value associated with the property corresponding toProcTime.getVarianceProcTime()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ProcTime>> E$$ augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setAverageProcTime
public ProcTimeBuilder setAverageProcTime(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toProcTime.getAverageProcTime()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setCurrentProcTime
public ProcTimeBuilder setCurrentProcTime(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toProcTime.getCurrentProcTime()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setEstimated
public ProcTimeBuilder setEstimated(Boolean value)
Set the property corresponding toProcTime.getEstimated()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIgnore
public ProcTimeBuilder setIgnore(Boolean value)
Set the property corresponding toObjectHeader.getIgnore()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMaxProcTime
public ProcTimeBuilder setMaxProcTime(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toProcTime.getMaxProcTime()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMinProcTime
public ProcTimeBuilder setMinProcTime(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toProcTime.getMinProcTime()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setProcessingRule
public ProcTimeBuilder setProcessingRule(Boolean value)
Set the property corresponding toObjectHeader.getProcessingRule()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setVarianceProcTime
public ProcTimeBuilder setVarianceProcTime(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toProcTime.getVarianceProcTime()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
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
-
-