org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.bandwidth.object

Class BandwidthBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.bandwidth.object.BandwidthBuilder

All Implemented Interfaces:

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

public class BandwidthBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Bandwidth>

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

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

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

BandwidthBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
BandwidthBuilder()
BandwidthBuilder(Bandwidth arg)
BandwidthBuilder(Bandwidth base)
BandwidthBuilder(Object arg)
BandwidthBuilder(ObjectHeader arg)

Method Summary

Modifier and Type	Method and Description
BandwidthBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Bandwidth>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Bandwidth> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Bandwidth>> E$$	augmentation(Class<E$$> augmentationType)
Bandwidth	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.concepts.rev131125.Bandwidth	getBandwidth()
Boolean	isIgnore()
Boolean	isProcessingRule()
BandwidthBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Bandwidth>> augmentationType)
BandwidthBuilder	setBandwidth(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.concepts.rev131125.Bandwidth value)
BandwidthBuilder	setIgnore(Boolean value)
BandwidthBuilder	setProcessingRule(Boolean value)

Methods inherited from class java.lang.Object

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

Constructor Detail

BandwidthBuilder

public BandwidthBuilder()

BandwidthBuilder

public BandwidthBuilder(Object arg)

BandwidthBuilder

public BandwidthBuilder(ObjectHeader arg)

BandwidthBuilder

public BandwidthBuilder(Bandwidth arg)

BandwidthBuilder

public BandwidthBuilder(Bandwidth 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:

• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.ObjectHeader
• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Bandwidth
• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.Object

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getBandwidth

public org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.concepts.rev131125.Bandwidth getBandwidth()

isIgnore

public Boolean isIgnore()

isProcessingRule

public Boolean isProcessingRule()

augmentation

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

setBandwidth

public BandwidthBuilder setBandwidth(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.network.concepts.rev131125.Bandwidth value)

setIgnore

public BandwidthBuilder setIgnore(Boolean value)

setProcessingRule

public BandwidthBuilder setProcessingRule(Boolean value)

addAugmentation

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

removeAugmentation

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

build

public Bandwidth build()

Specified by:

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