org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.band.type.band.type

Class DscpRemarkBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.meter.types.rev130918.band.type.band.type.DscpRemarkBuilder

All Implemented Interfaces:

org.opendaylight.yangtools.concepts.Builder<DscpRemark>, org.opendaylight.yangtools.concepts.CheckedBuilder<DscpRemark,IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

public class DscpRemarkBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<DscpRemark>

Class that builds DscpRemarkBuilder 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:

   
     DscpRemarkBuilder createTarget(int fooXyzzy, int barBaz) {
         return new DscpRemarkBuilderBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

This pattern is supported by the immutable nature of DscpRemarkBuilder, 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:

DscpRemarkBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
DscpRemarkBuilder()
DscpRemarkBuilder(DscpRemark base)

Method Summary

Modifier and Type	Method and Description
DscpRemarkBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DscpRemark>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<DscpRemark> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DscpRemark>> E$$	augmentation(Class<E$$> augmentationType)
DscpRemark	build()
Long	getDscpRemarkBurstSize()
Long	getDscpRemarkRate()
Short	getPrecLevel()
DscpRemarkBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DscpRemark>> augmentationType)
DscpRemarkBuilder	setDscpRemarkBurstSize(Long value)
DscpRemarkBuilder	setDscpRemarkRate(Long value)
DscpRemarkBuilder	setPrecLevel(Short value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DscpRemarkBuilder

public DscpRemarkBuilder()

DscpRemarkBuilder

public DscpRemarkBuilder(DscpRemark base)

Method Detail

getDscpRemarkBurstSize

public Long getDscpRemarkBurstSize()

getDscpRemarkRate

public Long getDscpRemarkRate()

getPrecLevel

public Short getPrecLevel()

augmentation

public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DscpRemark>> E$$ augmentation(Class<E$$> augmentationType)

setDscpRemarkBurstSize

public DscpRemarkBuilder setDscpRemarkBurstSize(Long value)

setDscpRemarkRate

public DscpRemarkBuilder setDscpRemarkRate(Long value)

setPrecLevel

public DscpRemarkBuilder setPrecLevel(Short value)

addAugmentation

public DscpRemarkBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DscpRemark>> augmentationType,
                                         org.opendaylight.yangtools.yang.binding.Augmentation<DscpRemark> augmentationValue)

removeAugmentation

public DscpRemarkBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DscpRemark>> augmentationType)

build

public DscpRemark build()

Specified by:

build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<DscpRemark,IllegalArgumentException>