Package org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes

Class RoutersBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.neutron.l3.rev150712.routers.attributes.RoutersBuilder

All Implemented Interfaces:

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

public class RoutersBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Routers>

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

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

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

RoutersBuilder, Builder

Constructor Summary

Constructors

Constructor	Description
RoutersBuilder()
RoutersBuilder(Routers base)

Method Summary

Modifier and Type	Method	Description
RoutersBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Routers>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Routers> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Routers>> E$$	augmentation(Class<E$$> augmentationType)
Routers	build()
List<Router>	getRouter()
RoutersBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Routers>> augmentationType)
RoutersBuilder	setRouter(List<Router> values)

Methods inherited from class java.lang.Object

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

Constructor Detail

RoutersBuilder

public RoutersBuilder()

RoutersBuilder

public RoutersBuilder(Routers base)

Method Detail

getRouter

public List<Router> getRouter()

augmentation

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

setRouter

public RoutersBuilder setRouter(List<Router> values)

addAugmentation

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

removeAugmentation

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

build

public Routers build()

Specified by:

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

Specified by:

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