org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.vendor.information.objects

Class VendorInformationObjectBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.vendor.information.objects.VendorInformationObjectBuilder

All Implemented Interfaces:

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

public class VendorInformationObjectBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<VendorInformationObject>

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

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

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

VendorInformationObjectBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
VendorInformationObjectBuilder()
VendorInformationObjectBuilder(Object arg)
VendorInformationObjectBuilder(ObjectHeader arg)
VendorInformationObjectBuilder(VendorInformation arg)
VendorInformationObjectBuilder(VendorInformationObject base)

Method Summary

Modifier and Type	Method and Description
VendorInformationObjectBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VendorInformationObject>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<VendorInformationObject> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VendorInformationObject>> E$$	augmentation(Class<E$$> augmentationType)
VendorInformationObject	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.iana.rev130816.EnterpriseNumber	getEnterpriseNumber()
EnterpriseSpecificInformation	getEnterpriseSpecificInformation()
Boolean	isIgnore()
Boolean	isProcessingRule()
VendorInformationObjectBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VendorInformationObject>> augmentationType)
VendorInformationObjectBuilder	setEnterpriseNumber(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.iana.rev130816.EnterpriseNumber value)
VendorInformationObjectBuilder	setEnterpriseSpecificInformation(EnterpriseSpecificInformation value)
VendorInformationObjectBuilder	setIgnore(Boolean value)
VendorInformationObjectBuilder	setProcessingRule(Boolean value)

Methods inherited from class java.lang.Object

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

Constructor Detail

VendorInformationObjectBuilder

public VendorInformationObjectBuilder()

VendorInformationObjectBuilder

public VendorInformationObjectBuilder(Object arg)

VendorInformationObjectBuilder

public VendorInformationObjectBuilder(ObjectHeader arg)

VendorInformationObjectBuilder

public VendorInformationObjectBuilder(VendorInformation arg)

VendorInformationObjectBuilder

public VendorInformationObjectBuilder(VendorInformationObject 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.VendorInformation
• 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

getEnterpriseNumber

public org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.iana.rev130816.EnterpriseNumber getEnterpriseNumber()

getEnterpriseSpecificInformation

public EnterpriseSpecificInformation getEnterpriseSpecificInformation()

isIgnore

public Boolean isIgnore()

isProcessingRule

public Boolean isProcessingRule()

augmentation

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

setEnterpriseNumber

public VendorInformationObjectBuilder setEnterpriseNumber(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.iana.rev130816.EnterpriseNumber value)

setEnterpriseSpecificInformation

public VendorInformationObjectBuilder setEnterpriseSpecificInformation(EnterpriseSpecificInformation value)

setIgnore

public VendorInformationObjectBuilder setIgnore(Boolean value)

setProcessingRule

public VendorInformationObjectBuilder setProcessingRule(Boolean value)

addAugmentation

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

removeAugmentation

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

build

public VendorInformationObject build()

Specified by:

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