org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.stats.rev171113.pcep.session.state

Class PeerCapabilitiesBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.stats.rev171113.pcep.session.state.PeerCapabilitiesBuilder

All Implemented Interfaces:

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

public class PeerCapabilitiesBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<PeerCapabilities>

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

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

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

PeerCapabilitiesBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
PeerCapabilitiesBuilder()
PeerCapabilitiesBuilder(PeerCapabilities base)

Method Summary

Modifier and Type	Method and Description
PeerCapabilitiesBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerCapabilities>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<PeerCapabilities> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerCapabilities>> E$$	augmentation(Class<E$$> augmentationType)
PeerCapabilities	build()
PeerCapabilitiesBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PeerCapabilities>> augmentationType)

Methods inherited from class java.lang.Object

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

Constructor Detail

PeerCapabilitiesBuilder

public PeerCapabilitiesBuilder()

PeerCapabilitiesBuilder

public PeerCapabilitiesBuilder(PeerCapabilities base)

Method Detail

augmentation

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

addAugmentation

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

removeAugmentation

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

build

public PeerCapabilities build()

Specified by:

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