org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.overload.duration.tlv

Class OverloadDurationBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.overload.duration.tlv.OverloadDurationBuilder

All Implemented Interfaces:

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

public class OverloadDurationBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<OverloadDuration>

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

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

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

OverloadDurationBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
OverloadDurationBuilder()
OverloadDurationBuilder(OverloadDuration base)
OverloadDurationBuilder(Tlv arg)

Method Summary

Modifier and Type	Method and Description
OverloadDurationBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OverloadDuration>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<OverloadDuration> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<OverloadDuration>> E$$	augmentation(Class<E$$> augmentationType)
OverloadDuration	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
Long	getDuration()
OverloadDurationBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<OverloadDuration>> augmentationType)
OverloadDurationBuilder	setDuration(Long value)

Methods inherited from class java.lang.Object

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

Constructor Detail

OverloadDurationBuilder

public OverloadDurationBuilder()

OverloadDurationBuilder

public OverloadDurationBuilder(Tlv arg)

OverloadDurationBuilder

public OverloadDurationBuilder(OverloadDuration 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.types.rev181109.Tlv

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getDuration

public Long getDuration()

augmentation

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

setDuration

public OverloadDurationBuilder setDuration(Long value)

addAugmentation

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

removeAugmentation

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

build

public OverloadDuration build()

Specified by:

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