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

Class GcBuilder

java.lang.Object

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

All Implemented Interfaces:

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

public class GcBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Gc>

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

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

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

GcBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
GcBuilder()
GcBuilder(Gc base)
GcBuilder(Object arg)
GcBuilder(ObjectHeader arg)

Method Summary

Modifier and Type	Method and Description
GcBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Gc>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Gc> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Gc>> E$$	augmentation(Class<E$$> augmentationType)
Gc	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
Short	getMaxHop()
Short	getMaxUtilization()
Short	getMinUtilization()
Short	getOverBookingFactor()
Tlvs	getTlvs()
Boolean	isIgnore()
Boolean	isProcessingRule()
GcBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Gc>> augmentationType)
GcBuilder	setIgnore(Boolean value)
GcBuilder	setMaxHop(Short value)
GcBuilder	setMaxUtilization(Short value)
GcBuilder	setMinUtilization(Short value)
GcBuilder	setOverBookingFactor(Short value)
GcBuilder	setProcessingRule(Boolean value)
GcBuilder	setTlvs(Tlvs value)

Methods inherited from class java.lang.Object

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

Constructor Detail

GcBuilder

public GcBuilder()

GcBuilder

public GcBuilder(Object arg)

GcBuilder

public GcBuilder(ObjectHeader arg)

GcBuilder

public GcBuilder(Gc 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.Object

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getMaxHop

public Short getMaxHop()

getMaxUtilization

public Short getMaxUtilization()

getMinUtilization

public Short getMinUtilization()

getOverBookingFactor

public Short getOverBookingFactor()

getTlvs

public Tlvs getTlvs()

isIgnore

public Boolean isIgnore()

isProcessingRule

public Boolean isProcessingRule()

augmentation

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

setMaxHop

public GcBuilder setMaxHop(Short value)

setMaxUtilization

public GcBuilder setMaxUtilization(Short value)

setMinUtilization

public GcBuilder setMinUtilization(Short value)

setOverBookingFactor

public GcBuilder setOverBookingFactor(Short value)

setTlvs

public GcBuilder setTlvs(Tlvs value)

setIgnore

public GcBuilder setIgnore(Boolean value)

setProcessingRule

public GcBuilder setProcessingRule(Boolean value)

addAugmentation

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

removeAugmentation

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

build

public Gc build()

Specified by:

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