Class QueueBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.queues.QueueBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Queue>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Queue,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class QueueBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Queue>
Class that buildsQueueBuilder
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:
QueueBuilder createTarget(int fooXyzzy, int barBaz) { return new QueueBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of QueueBuilder, 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:
QueueBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description QueueBuilder()
QueueBuilder(Queue base)
QueueBuilder(CommonQueue arg)
QueueBuilder(QueuePacket arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description QueueBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Queue>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Queue> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Queue>>
E$$augmentation(Class<E$$> augmentationType)
Queue
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint32
getPort()
org.opendaylight.yangtools.yang.common.Uint16
getProperty()
QueueId
getQueueId()
QueueKey
key()
QueueBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Queue>> augmentationType)
QueueBuilder
setPort(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setPort(Uint32)} instead.QueueBuilder
setPort(org.opendaylight.yangtools.yang.common.Uint32 value)
QueueBuilder
setProperty(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setProperty(Uint16)} instead.QueueBuilder
setProperty(org.opendaylight.yangtools.yang.common.Uint16 value)
QueueBuilder
setQueueId(QueueId value)
QueueBuilder
withKey(QueueKey key)
-
-
-
Constructor Detail
-
QueueBuilder
public QueueBuilder()
-
QueueBuilder
public QueueBuilder(QueuePacket arg)
-
QueueBuilder
public QueueBuilder(CommonQueue arg)
-
QueueBuilder
public QueueBuilder(Queue 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.flow.types.queue.rev130925.QueuePacket
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.queue.rev130925.CommonQueue
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
key
public QueueKey key()
-
getPort
public org.opendaylight.yangtools.yang.common.Uint32 getPort()
-
getProperty
public org.opendaylight.yangtools.yang.common.Uint16 getProperty()
-
getQueueId
public QueueId getQueueId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Queue>> E$$ augmentation(Class<E$$> augmentationType)
-
withKey
public QueueBuilder withKey(QueueKey key)
-
setPort
public QueueBuilder setPort(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setPort
@Deprecated(forRemoval=true) public QueueBuilder setPort(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setPort(Uint32)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setProperty
public QueueBuilder setProperty(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setProperty
@Deprecated(forRemoval=true) public QueueBuilder setProperty(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setProperty(Uint16)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setQueueId
public QueueBuilder setQueueId(QueueId value)
-
addAugmentation
public QueueBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Queue>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Queue> augmentationValue)
-
removeAugmentation
public QueueBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Queue>> augmentationType)
-
build
public Queue build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Queue>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Queue,IllegalArgumentException>
-
-