Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.mvpn.rev200120.mvpn.routes

Class MvpnRouteBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.mvpn.rev200120.mvpn.routes.MvpnRouteBuilder

All Implemented Interfaces:

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

public class MvpnRouteBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<MvpnRoute>

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

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

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

MvpnRouteBuilder, Builder

Constructor Summary

Constructors

Constructor	Description
MvpnRouteBuilder()
MvpnRouteBuilder(PathAttributes arg)
MvpnRouteBuilder(PathIdGrouping arg)
MvpnRouteBuilder(BgpRibRoute arg)
MvpnRouteBuilder(Mvpn arg)
MvpnRouteBuilder(MvpnRoute base)
MvpnRouteBuilder(MvpnBgpRibRoute arg)
MvpnRouteBuilder(Route arg)
MvpnRouteBuilder(BgpRibRoute arg)

Method Summary

Modifier and Type	Method	Description
MvpnRouteBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MvpnRoute>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<MvpnRoute> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MvpnRoute>> E$$	augmentation(Class<E$$> augmentationType)
MvpnRoute	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)	Set fields from given grouping argument.
Attributes	getAttributes()
MvpnChoice	getMvpnChoice()
PathId	getPathId()
String	getRouteKey()
MvpnRouteKey	key()
MvpnRouteBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MvpnRoute>> augmentationType)
MvpnRouteBuilder	setAttributes(Attributes value)
MvpnRouteBuilder	setMvpnChoice(MvpnChoice value)
MvpnRouteBuilder	setPathId(PathId value)
MvpnRouteBuilder	setRouteKey(String value)
MvpnRouteBuilder	withKey(MvpnRouteKey key)

Methods inherited from class java.lang.Object

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

Constructor Detail

MvpnRouteBuilder

public MvpnRouteBuilder()

MvpnRouteBuilder

public MvpnRouteBuilder(MvpnBgpRibRoute arg)

MvpnRouteBuilder

public MvpnRouteBuilder(Mvpn arg)

MvpnRouteBuilder

public MvpnRouteBuilder(BgpRibRoute arg)

MvpnRouteBuilder

public MvpnRouteBuilder(BgpRibRoute arg)

MvpnRouteBuilder

public MvpnRouteBuilder(Route arg)

MvpnRouteBuilder

public MvpnRouteBuilder(PathIdGrouping arg)

MvpnRouteBuilder

public MvpnRouteBuilder(PathAttributes arg)

MvpnRouteBuilder

public MvpnRouteBuilder(MvpnRoute 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.bgp.message.rev200120.PathAttributes
• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.mvpn.rev200120.Mvpn
• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.message.rev200120.PathIdGrouping
• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.Route
• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pmsi.tunnel.rev200120.BgpRibRoute
• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.mvpn.rev200120.MvpnBgpRibRoute
• org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.mvpn.rev200120.BgpRibRoute

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

key

public MvpnRouteKey key()

getAttributes

public Attributes getAttributes()

getMvpnChoice

public MvpnChoice getMvpnChoice()

getPathId

public PathId getPathId()

getRouteKey

public String getRouteKey()

augmentation

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

withKey

public MvpnRouteBuilder withKey(MvpnRouteKey key)

setAttributes

public MvpnRouteBuilder setAttributes(Attributes value)

setMvpnChoice

public MvpnRouteBuilder setMvpnChoice(MvpnChoice value)

setPathId

public MvpnRouteBuilder setPathId(PathId value)

setRouteKey

public MvpnRouteBuilder setRouteKey(String value)

addAugmentation

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

removeAugmentation

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

build

public MvpnRoute build()

Specified by:

build in interface org.opendaylight.yangtools.concepts.Builder<MvpnRoute>

Specified by:

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