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

Class IpPrefixBuilder

java.lang.Object

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

All Implemented Interfaces:

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

public class IpPrefixBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<IpPrefix>

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

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

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

IpPrefixBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
IpPrefixBuilder()
IpPrefixBuilder(CSubobject arg)
IpPrefixBuilder(IpPrefix base)
IpPrefixBuilder(IpPrefixSubobject arg)

Method Summary

Modifier and Type	Method and Description
IpPrefixBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpPrefix>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<IpPrefix> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IpPrefix>> E$$	augmentation(Class<E$$> augmentationType)
IpPrefix	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.IpPrefix	getIpPrefix()
IpPrefixBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpPrefix>> augmentationType)
IpPrefixBuilder	setIpPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)

Methods inherited from class java.lang.Object

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

Constructor Detail

IpPrefixBuilder

public IpPrefixBuilder()

IpPrefixBuilder

public IpPrefixBuilder(IpPrefixSubobject arg)

IpPrefixBuilder

public IpPrefixBuilder(CSubobject arg)

IpPrefixBuilder

public IpPrefixBuilder(IpPrefix 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.rsvp.rev150820.IpPrefixSubobject
• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.CSubobject

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getIpPrefix

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

augmentation

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

setIpPrefix

public IpPrefixBuilder setIpPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value)

addAugmentation

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

removeAugmentation

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

build

public IpPrefix build()

Specified by:

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