org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731

Class QueuePropContainerBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.QueuePropContainerBuilder

All Implemented Interfaces:

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

public class QueuePropContainerBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<QueuePropContainer>

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

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

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

QueuePropContainerBuilder, Builder

Constructor Summary

Constructors

Constructor and Description
QueuePropContainerBuilder()
QueuePropContainerBuilder(QueuePropContainer base)
QueuePropContainerBuilder(QueuePropertyHeader arg)

Method Summary

Modifier and Type	Method and Description
QueuePropContainerBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<QueuePropContainer>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<QueuePropContainer> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<QueuePropContainer>> E$$	augmentation(Class<E$$> augmentationType)
QueuePropContainer	build()
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.
List<QueueProperty>	getQueueProperty()
QueuePropContainerBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<QueuePropContainer>> augmentationType)
QueuePropContainerBuilder	setQueueProperty(List<QueueProperty> values)

Methods inherited from class java.lang.Object

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

Constructor Detail

QueuePropContainerBuilder

public QueuePropContainerBuilder()

QueuePropContainerBuilder

public QueuePropContainerBuilder(QueuePropertyHeader arg)

QueuePropContainerBuilder

public QueuePropContainerBuilder(QueuePropContainer 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.openflow.protocol.rev130731.QueuePropertyHeader

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types

getQueueProperty

public List<QueueProperty> getQueueProperty()

augmentation

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

setQueueProperty

public QueuePropContainerBuilder setQueueProperty(List<QueueProperty> values)

addAugmentation

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

removeAugmentation

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

build

public QueuePropContainer build()

Specified by:

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