Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.tspec.object
Class TspecObjectBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.tspec.object.TspecObjectBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<TspecObject>
,org.opendaylight.yangtools.concepts.CheckedBuilder<TspecObject,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class TspecObjectBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<TspecObject>
Class that buildsTspecObject
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:
TspecObject createTspecObject(int fooXyzzy, int barBaz) { return new TspecObjectBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of TspecObject, 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:
TspecObject
,Builder
-
-
Constructor Summary
Constructors Constructor Description TspecObjectBuilder()
TspecObjectBuilder(RsvpTeObject arg)
TspecObjectBuilder(TspecObject base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TspecObjectBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TspecObject> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TspecObject>>
E$$augmentation(Class<E$$> augmentationType)
TspecObject
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint32
getMaximumPacketSize()
org.opendaylight.yangtools.yang.common.Uint32
getMinimumPolicedUnit()
Float32
getPeakDataRate()
Float32
getTokenBucketRate()
Float32
getTokenBucketSize()
TspecObjectBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TspecObject>> augmentationType)
Remove an augmentation from this builder's product.TspecObjectBuilder
setMaximumPacketSize(org.opendaylight.yangtools.yang.common.Uint32 value)
TspecObjectBuilder
setMinimumPolicedUnit(org.opendaylight.yangtools.yang.common.Uint32 value)
TspecObjectBuilder
setPeakDataRate(Float32 value)
TspecObjectBuilder
setTokenBucketRate(Float32 value)
TspecObjectBuilder
setTokenBucketSize(Float32 value)
-
-
-
Constructor Detail
-
TspecObjectBuilder
public TspecObjectBuilder()
-
TspecObjectBuilder
public TspecObjectBuilder(RsvpTeObject arg)
-
TspecObjectBuilder
public TspecObjectBuilder(TspecObject 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:- RsvpTeObject
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getMaximumPacketSize
public org.opendaylight.yangtools.yang.common.Uint32 getMaximumPacketSize()
-
getMinimumPolicedUnit
public org.opendaylight.yangtools.yang.common.Uint32 getMinimumPolicedUnit()
-
getPeakDataRate
public Float32 getPeakDataRate()
-
getTokenBucketRate
public Float32 getTokenBucketRate()
-
getTokenBucketSize
public Float32 getTokenBucketSize()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<TspecObject>> E$$ augmentation(Class<E$$> augmentationType)
-
setMaximumPacketSize
public TspecObjectBuilder setMaximumPacketSize(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setMinimumPolicedUnit
public TspecObjectBuilder setMinimumPolicedUnit(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setPeakDataRate
public TspecObjectBuilder setPeakDataRate(Float32 value)
-
setTokenBucketRate
public TspecObjectBuilder setTokenBucketRate(Float32 value)
-
setTokenBucketSize
public TspecObjectBuilder setTokenBucketSize(Float32 value)
-
addAugmentation
public TspecObjectBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<TspecObject> 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 TspecObjectBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<TspecObject>> 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 TspecObject build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<TspecObject>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<TspecObject,IllegalArgumentException>
-
-