org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.endpoints.address.family.ipv6._case

Class Ipv6Builder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.endpoints.address.family.ipv6._case.Ipv6Builder

All Implemented Interfaces:

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

public class Ipv6Builder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Ipv6>

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

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

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

Ipv6Builder, Builder

Constructor Summary

Constructors

Constructor and Description
Ipv6Builder()
Ipv6Builder(EndpointsIpv6Source arg)
Ipv6Builder(Ipv6 base)

Method Summary

Modifier and Type	Method and Description
Ipv6Builder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6>> E$$	augmentation(Class<E$$> augmentationType)
Ipv6	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6AddressNoZone	getDestinationIpv6Address()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6AddressNoZone	getSourceIpv6Address()
Ipv6Builder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv6>> augmentationType)
Ipv6Builder	setDestinationIpv6Address(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6AddressNoZone value)
Ipv6Builder	setSourceIpv6Address(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6AddressNoZone value)

Methods inherited from class java.lang.Object

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

Constructor Detail

Ipv6Builder

public Ipv6Builder()

Ipv6Builder

public Ipv6Builder(EndpointsIpv6Source arg)

Ipv6Builder

public Ipv6Builder(Ipv6 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.EndpointsIpv6Source

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getDestinationIpv6Address

public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6AddressNoZone getDestinationIpv6Address()

getSourceIpv6Address

public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6AddressNoZone getSourceIpv6Address()

augmentation

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

setDestinationIpv6Address

public Ipv6Builder setDestinationIpv6Address(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6AddressNoZone value)

setSourceIpv6Address

public Ipv6Builder setSourceIpv6Address(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6AddressNoZone value)

addAugmentation

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

removeAugmentation

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

build

public Ipv6 build()

Specified by:

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