org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.vs.tlv

Class VsTlvBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.vs.tlv.VsTlvBuilder

All Implemented Interfaces:

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

public class VsTlvBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<VsTlv>

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

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

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

VsTlvBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
VsTlvBuilder()
VsTlvBuilder(Tlv arg)
VsTlvBuilder(VsTlv base)

Method Summary

Modifier and Type	Method and Description
VsTlvBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VsTlv>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<VsTlv> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VsTlv>> E$$	augmentation(Class<E$$> augmentationType)
VsTlv	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()
VendorPayload	getVendorPayload()
VsTlvBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VsTlv>> augmentationType)
VsTlvBuilder	setEnterpriseNumber(org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.iana.rev130816.EnterpriseNumber value)
VsTlvBuilder	setVendorPayload(VendorPayload value)

Methods inherited from class java.lang.Object

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

Constructor Detail

VsTlvBuilder

public VsTlvBuilder()

VsTlvBuilder

public VsTlvBuilder(Tlv arg)

VsTlvBuilder

public VsTlvBuilder(VsTlv 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.Tlv

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()

getVendorPayload

public VendorPayload getVendorPayload()

augmentation

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

setEnterpriseNumber

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

setVendorPayload

public VsTlvBuilder setVendorPayload(VendorPayload value)

addAugmentation

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

removeAugmentation

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

build

public VsTlv build()

Specified by:

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