Class DscpRemarkBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.band.type.band.type.DscpRemarkBuilder
-
@Generated("mdsal-binding-generator") public class DscpRemarkBuilder extends Object
Class that buildsDscpRemark
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:
DscpRemark createDscpRemark(int fooXyzzy, int barBaz) { return new DscpRemarkBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of DscpRemark, 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:
DscpRemark
- 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 DscpRemarkBuilder()
Construct an empty builder.DscpRemarkBuilder(DscpRemark base)
Construct a builder initialized with state from specifiedDscpRemark
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DscpRemarkBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DscpRemark> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DscpRemark>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull DscpRemark
build()
A newDscpRemark
instance.org.opendaylight.yangtools.yang.common.Uint32
getDscpRemarkBurstSize()
Return current value associated with the property corresponding toDscpRemark.getDscpRemarkBurstSize()
.org.opendaylight.yangtools.yang.common.Uint32
getDscpRemarkRate()
Return current value associated with the property corresponding toDscpRemark.getDscpRemarkRate()
.org.opendaylight.yangtools.yang.common.Uint8
getPrecLevel()
Return current value associated with the property corresponding toDscpRemark.getPrecLevel()
.DscpRemarkBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DscpRemark>> augmentationType)
Remove an augmentation from this builder's product.DscpRemarkBuilder
setDscpRemarkBurstSize(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toDscpRemark.getDscpRemarkBurstSize()
to the specified value.DscpRemarkBuilder
setDscpRemarkRate(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toDscpRemark.getDscpRemarkRate()
to the specified value.DscpRemarkBuilder
setPrecLevel(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toDscpRemark.getPrecLevel()
to the specified value.
-
-
-
Constructor Detail
-
DscpRemarkBuilder
public DscpRemarkBuilder()
Construct an empty builder.
-
DscpRemarkBuilder
public DscpRemarkBuilder(DscpRemark base)
Construct a builder initialized with state from specifiedDscpRemark
.- Parameters:
base
- DscpRemark from which the builder should be initialized
-
-
Method Detail
-
getDscpRemarkBurstSize
public org.opendaylight.yangtools.yang.common.Uint32 getDscpRemarkBurstSize()
Return current value associated with the property corresponding toDscpRemark.getDscpRemarkBurstSize()
.- Returns:
- current value
-
getDscpRemarkRate
public org.opendaylight.yangtools.yang.common.Uint32 getDscpRemarkRate()
Return current value associated with the property corresponding toDscpRemark.getDscpRemarkRate()
.- Returns:
- current value
-
getPrecLevel
public org.opendaylight.yangtools.yang.common.Uint8 getPrecLevel()
Return current value associated with the property corresponding toDscpRemark.getPrecLevel()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DscpRemark>> 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
-
setDscpRemarkBurstSize
public DscpRemarkBuilder setDscpRemarkBurstSize(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toDscpRemark.getDscpRemarkBurstSize()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setDscpRemarkRate
public DscpRemarkBuilder setDscpRemarkRate(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toDscpRemark.getDscpRemarkRate()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setPrecLevel
public DscpRemarkBuilder setPrecLevel(org.opendaylight.yangtools.yang.common.Uint8 value)
Set the property corresponding toDscpRemark.getPrecLevel()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public DscpRemarkBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DscpRemark> 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 DscpRemarkBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DscpRemark>> 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 @NonNull DscpRemark build()
A newDscpRemark
instance.- Returns:
- A new
DscpRemark
instance.
-
-