Class PacketQueuesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.queue.service.rev150305.get.queue.output.PacketQueuesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<PacketQueues>
,org.opendaylight.yangtools.concepts.CheckedBuilder<PacketQueues,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class PacketQueuesBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<PacketQueues>
Class that buildsPacketQueuesBuilder
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:
PacketQueuesBuilder createTarget(int fooXyzzy, int barBaz) { return new PacketQueuesBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of PacketQueuesBuilder, 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:
PacketQueuesBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description PacketQueuesBuilder()
PacketQueuesBuilder(CommonQueue arg)
PacketQueuesBuilder(QueuePacket arg)
PacketQueuesBuilder(PacketQueues base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description PacketQueuesBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketQueues>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<PacketQueues> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketQueues>>
E$$augmentation(Class<E$$> augmentationType)
PacketQueues
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()
PacketQueuesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketQueues>> augmentationType)
PacketQueuesBuilder
setPort(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setPort(Uint32)} instead.PacketQueuesBuilder
setPort(org.opendaylight.yangtools.yang.common.Uint32 value)
PacketQueuesBuilder
setProperty(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setProperty(Uint16)} instead.PacketQueuesBuilder
setProperty(org.opendaylight.yangtools.yang.common.Uint16 value)
PacketQueuesBuilder
setQueueId(QueueId value)
-
-
-
Constructor Detail
-
PacketQueuesBuilder
public PacketQueuesBuilder()
-
PacketQueuesBuilder
public PacketQueuesBuilder(QueuePacket arg)
-
PacketQueuesBuilder
public PacketQueuesBuilder(CommonQueue arg)
-
PacketQueuesBuilder
public PacketQueuesBuilder(PacketQueues 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
-
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<PacketQueues>> E$$ augmentation(Class<E$$> augmentationType)
-
setPort
public PacketQueuesBuilder setPort(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setPort
@Deprecated(forRemoval=true) public PacketQueuesBuilder 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 PacketQueuesBuilder setProperty(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setProperty
@Deprecated(forRemoval=true) public PacketQueuesBuilder 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 PacketQueuesBuilder setQueueId(QueueId value)
-
addAugmentation
public PacketQueuesBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketQueues>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<PacketQueues> augmentationValue)
-
removeAugmentation
public PacketQueuesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<PacketQueues>> augmentationType)
-
build
public PacketQueues build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<PacketQueues>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<PacketQueues,IllegalArgumentException>
-
-