Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib

Class RibBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.rib.rev180329.bgp.rib.RibBuilder

All Implemented Interfaces:

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

public class RibBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Rib>

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

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

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

RibBuilder, Builder

Constructor Summary

Constructors

Constructor	Description
RibBuilder()
RibBuilder(Rib base)

Method Summary

Modifier and Type	Method	Description
RibBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Rib>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Rib> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Rib>> E$$	augmentation(Class<E$$> augmentationType)
Rib	build()
RibId	getId()
LocRib	getLocRib()
List<Peer>	getPeer()
RibKey	key()
RibBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Rib>> augmentationType)
RibBuilder	setId(RibId value)
RibBuilder	setLocRib(LocRib value)
RibBuilder	setPeer(List<Peer> values)
RibBuilder	withKey(RibKey key)

Methods inherited from class java.lang.Object

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

Constructor Detail

RibBuilder

public RibBuilder()

RibBuilder

public RibBuilder(Rib base)

Method Detail

key

public RibKey key()

getId

public RibId getId()

getLocRib

public LocRib getLocRib()

getPeer

public List<Peer> getPeer()

augmentation

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

withKey

public RibBuilder withKey(RibKey key)

setId

public RibBuilder setId(RibId value)

setLocRib

public RibBuilder setLocRib(LocRib value)

setPeer

public RibBuilder setPeer(List<Peer> values)

addAugmentation

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

removeAugmentation

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

build

public Rib build()

Specified by:

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

Specified by:

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