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

Class ClassTypeBuilder

java.lang.Object

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

All Implemented Interfaces:

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

public class ClassTypeBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<ClassType>

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

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

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

ClassTypeBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
ClassTypeBuilder()
ClassTypeBuilder(ClassType base)
ClassTypeBuilder(Object arg)
ClassTypeBuilder(ObjectHeader arg)

Method Summary

Modifier and Type	Method and Description
ClassTypeBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ClassType>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<ClassType> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ClassType>> E$$	augmentation(Class<E$$> augmentationType)
ClassType	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
ClassType	getClassType()
Boolean	isIgnore()
Boolean	isProcessingRule()
ClassTypeBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ClassType>> augmentationType)
ClassTypeBuilder	setClassType(ClassType value)
ClassTypeBuilder	setIgnore(Boolean value)
ClassTypeBuilder	setProcessingRule(Boolean value)

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassTypeBuilder

public ClassTypeBuilder()

ClassTypeBuilder

public ClassTypeBuilder(Object arg)

ClassTypeBuilder

public ClassTypeBuilder(ObjectHeader arg)

ClassTypeBuilder

public ClassTypeBuilder(ClassType 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

getClassType

public ClassType getClassType()

isIgnore

public Boolean isIgnore()

isProcessingRule

public Boolean isProcessingRule()

augmentation

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

setClassType

public ClassTypeBuilder setClassType(ClassType value)

setIgnore

public ClassTypeBuilder setIgnore(Boolean value)

setProcessingRule

public ClassTypeBuilder setProcessingRule(Boolean value)

addAugmentation

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

removeAugmentation

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

build

public ClassType build()

Specified by:

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