Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.monitor.rev200120.routers

Class RouterBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.monitor.rev200120.routers.RouterBuilder

All Implemented Interfaces:

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

public class RouterBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Router>

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

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

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

RouterBuilder, Builder

Constructor Summary

Constructors

Constructor	Description
RouterBuilder()
RouterBuilder(Peers arg)
RouterBuilder(Router base)

Method Summary

Modifier and Type	Method	Description
RouterBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Router>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Router> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Router>> E$$	augmentation(Class<E$$> augmentationType)
Router	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)	Set fields from given grouping argument.
String	getDescription()
String	getInfo()
String	getName()
List<Peer>	getPeer()
RouterId	getRouterId()
Status	getStatus()
RouterKey	key()
RouterBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Router>> augmentationType)
RouterBuilder	setDescription(String value)
RouterBuilder	setInfo(String value)
RouterBuilder	setName(String value)
RouterBuilder	setPeer(List<Peer> values)
RouterBuilder	setRouterId(RouterId value)
RouterBuilder	setStatus(Status value)
RouterBuilder	withKey(RouterKey key)

Methods inherited from class java.lang.Object

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

Constructor Detail

RouterBuilder

public RouterBuilder()

RouterBuilder

public RouterBuilder(Peers arg)

RouterBuilder

public RouterBuilder(Router 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.bmp.monitor.rev200120.Peers

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

key

public RouterKey key()

getDescription

public String getDescription()

getInfo

public String getInfo()

getName

public String getName()

getPeer

public List<Peer> getPeer()

getRouterId

public RouterId getRouterId()

getStatus

public Status getStatus()

augmentation

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

withKey

public RouterBuilder withKey(RouterKey key)

setDescription

public RouterBuilder setDescription(String value)

setInfo

public RouterBuilder setInfo(String value)

setName

public RouterBuilder setName(String value)

setPeer

public RouterBuilder setPeer(List<Peer> values)

setRouterId

public RouterBuilder setRouterId(RouterId value)

setStatus

public RouterBuilder setStatus(Status value)

addAugmentation

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

removeAugmentation

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

build

public Router build()

Specified by:

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

Specified by:

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