org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.record.route.subobjects.subobject.type.label._case

Class LabelBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.record.route.subobjects.subobject.type.label._case.LabelBuilder

All Implemented Interfaces:

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

public class LabelBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Label>

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

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

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

LabelBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
LabelBuilder()
LabelBuilder(CSubobject arg)
LabelBuilder(Label base)
LabelBuilder(LabelSubobject arg)

Method Summary

Modifier and Type	Method and Description
LabelBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Label>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Label> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Label>> E$$	augmentation(Class<E$$> augmentationType)
Label	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
LabelType	getLabelType()
Boolean	isGlobal()
Boolean	isUniDirectional()
LabelBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Label>> augmentationType)
LabelBuilder	setGlobal(Boolean value)
LabelBuilder	setLabelType(LabelType value)
LabelBuilder	setUniDirectional(Boolean value)

Methods inherited from class java.lang.Object

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

Constructor Detail

LabelBuilder

public LabelBuilder()

LabelBuilder

public LabelBuilder(LabelSubobject arg)

LabelBuilder

public LabelBuilder(CSubobject arg)

LabelBuilder

public LabelBuilder(Label 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.rsvp.rev150820.LabelSubobject
• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.CSubobject

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getLabelType

public LabelType getLabelType()

isGlobal

public Boolean isGlobal()

isUniDirectional

public Boolean isUniDirectional()

augmentation

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

setLabelType

public LabelBuilder setLabelType(LabelType value)

setGlobal

public LabelBuilder setGlobal(Boolean value)

setUniDirectional

public LabelBuilder setUniDirectional(Boolean value)

addAugmentation

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

removeAugmentation

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

build

public Label build()

Specified by:

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