org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.snapshot.gathering.status.grouping

Class SnapshotGatheringStatusStartBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.snapshot.gathering.status.grouping.SnapshotGatheringStatusStartBuilder

All Implemented Interfaces:

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

public class SnapshotGatheringStatusStartBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<SnapshotGatheringStatusStart>

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

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

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

SnapshotGatheringStatusStartBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
SnapshotGatheringStatusStartBuilder()
SnapshotGatheringStatusStartBuilder(SnapshotGatheringStatusStart base)

Method Summary

Modifier and Type	Method and Description
SnapshotGatheringStatusStartBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SnapshotGatheringStatusStart>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<SnapshotGatheringStatusStart> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<SnapshotGatheringStatusStart>> E$$	augmentation(Class<E$$> augmentationType)
SnapshotGatheringStatusStart	build()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime	getBegin()
SnapshotGatheringStatusStartBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<SnapshotGatheringStatusStart>> augmentationType)
SnapshotGatheringStatusStartBuilder	setBegin(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime value)

Methods inherited from class java.lang.Object

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

Constructor Detail

SnapshotGatheringStatusStartBuilder

public SnapshotGatheringStatusStartBuilder()

SnapshotGatheringStatusStartBuilder

public SnapshotGatheringStatusStartBuilder(SnapshotGatheringStatusStart base)

Method Detail

getBegin

public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime getBegin()

augmentation

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

setBegin

public SnapshotGatheringStatusStartBuilder setBegin(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.DateAndTime value)

addAugmentation

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

removeAugmentation

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

build

public SnapshotGatheringStatusStart build()

Specified by:

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