Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.queue.get.config.reply
Class QueuesBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.queue.get.config.reply.QueuesBuilder
Class that builds
Queues
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:
Queues createQueues(int fooXyzzy, int barBaz) {
return new QueuesBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Queues, 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 opportunities, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.QueuesBuilder
(PacketQueue arg) Construct a new builder initialized from specifiedPacketQueue
.QueuesBuilder
(Queues base) Construct a builder initialized with state from specifiedQueues
.Construct a new builder initialized from specifiedQueuePropertyHeader
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<Queues> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Queues>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Queues
build()
A newQueues
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.getPort()
Return current value associated with the property corresponding toPacketQueue.getPort()
.Return current value associated with the property corresponding toPacketQueue.getQueueId()
.Return current value associated with the property corresponding toQueuePropertyHeader.getQueueProperty()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Queues>> augmentationType) Remove an augmentation from this builder's product.setPort
(PortNumber value) Set the property corresponding toPacketQueue.getPort()
to the specified value.setQueueId
(QueueId value) Set the property corresponding toPacketQueue.getQueueId()
to the specified value.setQueueProperty
(List<QueueProperty> values) Set the property corresponding toQueuePropertyHeader.getQueueProperty()
to the specified value.
-
Constructor Details
-
QueuesBuilder
public QueuesBuilder()Construct an empty builder. -
QueuesBuilder
Construct a new builder initialized from specifiedPacketQueue
.- Parameters:
arg
- PacketQueue from which the builder should be initialized
-
QueuesBuilder
Construct a new builder initialized from specifiedQueuePropertyHeader
.- Parameters:
arg
- QueuePropertyHeader from which the builder should be initialized
-
QueuesBuilder
Construct a builder initialized with state from specifiedQueues
.- Parameters:
base
- Queues from which the builder should be initialized
-
-
Method Details
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getPort
Return current value associated with the property corresponding toPacketQueue.getPort()
.- Returns:
- current value
-
getQueueId
Return current value associated with the property corresponding toPacketQueue.getQueueId()
.- Returns:
- current value
-
getQueueProperty
Return current value associated with the property corresponding toQueuePropertyHeader.getQueueProperty()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Queues>> E$$ augmentation(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setPort
Set the property corresponding toPacketQueue.getPort()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setQueueId
Set the property corresponding toPacketQueue.getQueueId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setQueueProperty
Set the property corresponding toQueuePropertyHeader.getQueueProperty()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public QueuesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Queues> augmentation) Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public QueuesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Queues>> augmentationType) Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.- Parameters:
augmentationType
- augmentation type to be removed- Returns:
- this builder
-
build
A newQueues
instance.- Returns:
- A new
Queues
instance.
-