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

Class LocalPrefBuilder

java.lang.Object

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

All Implemented Interfaces:

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

public class LocalPrefBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<LocalPref>

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

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

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

LocalPrefBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
LocalPrefBuilder()
LocalPrefBuilder(LocalPref base)
LocalPrefBuilder(Preferences arg)

Method Summary

Modifier and Type	Method and Description
LocalPrefBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LocalPref>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<LocalPref> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<LocalPref>> E$$	augmentation(Class<E$$> augmentationType)
LocalPref	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
Short	getDeadtimer()
String	getIpAddress()
Short	getKeepalive()
Integer	getSessionId()
LocalPrefBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<LocalPref>> augmentationType)
LocalPrefBuilder	setDeadtimer(Short value)
LocalPrefBuilder	setIpAddress(String value)
LocalPrefBuilder	setKeepalive(Short value)
LocalPrefBuilder	setSessionId(Integer value)

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalPrefBuilder

public LocalPrefBuilder()

LocalPrefBuilder

public LocalPrefBuilder(Preferences arg)

LocalPrefBuilder

public LocalPrefBuilder(LocalPref 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.pcep.stats.rev171113.Preferences

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getDeadtimer

public Short getDeadtimer()

getIpAddress

public String getIpAddress()

getKeepalive

public Short getKeepalive()

getSessionId

public Integer getSessionId()

augmentation

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

setDeadtimer

public LocalPrefBuilder setDeadtimer(Short value)

setIpAddress

public LocalPrefBuilder setIpAddress(String value)

setKeepalive

public LocalPrefBuilder setKeepalive(Short value)

setSessionId

public LocalPrefBuilder setSessionId(Integer value)

addAugmentation

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

removeAugmentation

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

build

public LocalPref build()

Specified by:

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