org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.record.route.subobjects.subobject.type

Class IpPrefixCaseBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.record.route.subobjects.subobject.type.IpPrefixCaseBuilder

All Implemented Interfaces:

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

public class IpPrefixCaseBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<IpPrefixCase>

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

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

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

IpPrefixCaseBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
IpPrefixCaseBuilder()
IpPrefixCaseBuilder(IpPrefixCase base)

Method Summary

Modifier and Type	Method and Description
IpPrefixCaseBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpPrefixCase>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<IpPrefixCase> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IpPrefixCase>> E$$	augmentation(Class<E$$> augmentationType)
IpPrefixCase	build()
IpPrefix	getIpPrefix()
IpPrefixCaseBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpPrefixCase>> augmentationType)
IpPrefixCaseBuilder	setIpPrefix(IpPrefix value)

Methods inherited from class java.lang.Object

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

Constructor Detail

IpPrefixCaseBuilder

public IpPrefixCaseBuilder()

IpPrefixCaseBuilder

public IpPrefixCaseBuilder(IpPrefixCase base)

Method Detail

getIpPrefix

public IpPrefix getIpPrefix()

augmentation

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

setIpPrefix

public IpPrefixCaseBuilder setIpPrefix(IpPrefix value)

addAugmentation

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

removeAugmentation

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

build

public IpPrefixCase build()

Specified by:

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