Class MultipartRequestQueueBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.request.multipart.request.body.multipart.request.queue._case.MultipartRequestQueueBuilder
Class that builds
MultipartRequestQueue
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:
MultipartRequestQueue createMultipartRequestQueue(int fooXyzzy, int barBaz) {
return new MultipartRequestQueueBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of MultipartRequestQueue, 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
ConstructorsConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedMultipartRequestQueue
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<MultipartRequestQueue> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartRequestQueue>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull MultipartRequestQueue
build()
A newMultipartRequestQueue
instance.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toMultipartRequestQueue.getPortNo()
.org.opendaylight.yangtools.yang.common.Uint32
Return current value associated with the property corresponding toMultipartRequestQueue.getQueueId()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartRequestQueue>> augmentationType) Remove an augmentation from this builder's product.setPortNo
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toMultipartRequestQueue.getPortNo()
to the specified value.setQueueId
(org.opendaylight.yangtools.yang.common.Uint32 value) Set the property corresponding toMultipartRequestQueue.getQueueId()
to the specified value.
-
Constructor Details
-
MultipartRequestQueueBuilder
public MultipartRequestQueueBuilder()Construct an empty builder. -
MultipartRequestQueueBuilder
Construct a builder initialized with state from specifiedMultipartRequestQueue
.- Parameters:
base
- MultipartRequestQueue from which the builder should be initialized
-
-
Method Details
-
getPortNo
public org.opendaylight.yangtools.yang.common.Uint32 getPortNo()Return current value associated with the property corresponding toMultipartRequestQueue.getPortNo()
.- Returns:
- current value
-
getQueueId
public org.opendaylight.yangtools.yang.common.Uint32 getQueueId()Return current value associated with the property corresponding toMultipartRequestQueue.getQueueId()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartRequestQueue>> 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
-
setPortNo
Set the property corresponding toMultipartRequestQueue.getPortNo()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setQueueId
Set the property corresponding toMultipartRequestQueue.getQueueId()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public MultipartRequestQueueBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MultipartRequestQueue> 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 MultipartRequestQueueBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartRequestQueue>> 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 newMultipartRequestQueue
instance.- Returns:
- A new
MultipartRequestQueue
instance.
-