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

Class OfBuilder

java.lang.Object

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

All Implemented Interfaces:

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

public class OfBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Of>

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

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

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

OfBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
OfBuilder()
OfBuilder(Object arg)
OfBuilder(ObjectHeader arg)
OfBuilder(Of base)

Method Summary

Modifier and Type	Method and Description
OfBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Of>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Of> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Of>> E$$	augmentation(Class<E$$> augmentationType)
Of	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
OfId	getCode()
Tlvs	getTlvs()
Boolean	isIgnore()
Boolean	isProcessingRule()
OfBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Of>> augmentationType)
OfBuilder	setCode(OfId value)
OfBuilder	setIgnore(Boolean value)
OfBuilder	setProcessingRule(Boolean value)
OfBuilder	setTlvs(Tlvs value)

Methods inherited from class java.lang.Object

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

Constructor Detail

OfBuilder

public OfBuilder()

OfBuilder

public OfBuilder(Object arg)

OfBuilder

public OfBuilder(ObjectHeader arg)

OfBuilder

public OfBuilder(Of 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

getCode

public OfId getCode()

getTlvs

public Tlvs getTlvs()

isIgnore

public Boolean isIgnore()

isProcessingRule

public Boolean isProcessingRule()

augmentation

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

setCode

public OfBuilder setCode(OfId value)

setTlvs

public OfBuilder setTlvs(Tlvs value)

setIgnore

public OfBuilder setIgnore(Boolean value)

setProcessingRule

public OfBuilder setProcessingRule(Boolean value)

addAugmentation

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

removeAugmentation

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

build

public Of build()

Specified by:

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