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

Class Ipv4CaseBuilder

java.lang.Object

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

All Implemented Interfaces:

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

public class Ipv4CaseBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Ipv4Case>

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

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

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

Ipv4CaseBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
Ipv4CaseBuilder()
Ipv4CaseBuilder(Ipv4Case base)

Method Summary

Modifier and Type	Method and Description
Ipv4CaseBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Case>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Case> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Case>> E$$	augmentation(Class<E$$> augmentationType)
Ipv4Case	build()
Ipv4	getIpv4()
Ipv4CaseBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Case>> augmentationType)
Ipv4CaseBuilder	setIpv4(Ipv4 value)

Methods inherited from class java.lang.Object

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

Constructor Detail

Ipv4CaseBuilder

public Ipv4CaseBuilder()

Ipv4CaseBuilder

public Ipv4CaseBuilder(Ipv4Case base)

Method Detail

getIpv4

public Ipv4 getIpv4()

augmentation

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

setIpv4

public Ipv4CaseBuilder setIpv4(Ipv4 value)

addAugmentation

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

removeAugmentation

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

build

public Ipv4Case build()

Specified by:

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