Class MultipartReplyDescBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.desc._case.MultipartReplyDescBuilder
Class that builds
MultipartReplyDesc
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:
MultipartReplyDesc createMultipartReplyDesc(int fooXyzzy, int barBaz) {
return new MultipartReplyDescBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of MultipartReplyDesc, 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.Construct a builder initialized with state from specifiedMultipartReplyDesc
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyDesc> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyDesc>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull MultipartReplyDesc
build()
A newMultipartReplyDesc
instance.static @NonNull MultipartReplyDesc
empty()
Get empty instance of MultipartReplyDesc.Return current value associated with the property corresponding toMultipartReplyDesc.getDpDesc()
.Return current value associated with the property corresponding toMultipartReplyDesc.getHwDesc()
.Return current value associated with the property corresponding toMultipartReplyDesc.getMfrDesc()
.Return current value associated with the property corresponding toMultipartReplyDesc.getSerialNum()
.Return current value associated with the property corresponding toMultipartReplyDesc.getSwDesc()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyDesc>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toMultipartReplyDesc.getDpDesc()
to the specified value.Set the property corresponding toMultipartReplyDesc.getHwDesc()
to the specified value.setMfrDesc
(String value) Set the property corresponding toMultipartReplyDesc.getMfrDesc()
to the specified value.setSerialNum
(String value) Set the property corresponding toMultipartReplyDesc.getSerialNum()
to the specified value.Set the property corresponding toMultipartReplyDesc.getSwDesc()
to the specified value.
-
Constructor Details
-
MultipartReplyDescBuilder
public MultipartReplyDescBuilder()Construct an empty builder. -
MultipartReplyDescBuilder
Construct a builder initialized with state from specifiedMultipartReplyDesc
.- Parameters:
base
- MultipartReplyDesc from which the builder should be initialized
-
-
Method Details
-
empty
Get empty instance of MultipartReplyDesc.- Returns:
- An empty
MultipartReplyDesc
-
getDpDesc
Return current value associated with the property corresponding toMultipartReplyDesc.getDpDesc()
.- Returns:
- current value
-
getHwDesc
Return current value associated with the property corresponding toMultipartReplyDesc.getHwDesc()
.- Returns:
- current value
-
getMfrDesc
Return current value associated with the property corresponding toMultipartReplyDesc.getMfrDesc()
.- Returns:
- current value
-
getSerialNum
Return current value associated with the property corresponding toMultipartReplyDesc.getSerialNum()
.- Returns:
- current value
-
getSwDesc
Return current value associated with the property corresponding toMultipartReplyDesc.getSwDesc()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyDesc>> 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
-
setDpDesc
Set the property corresponding toMultipartReplyDesc.getDpDesc()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setHwDesc
Set the property corresponding toMultipartReplyDesc.getHwDesc()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setMfrDesc
Set the property corresponding toMultipartReplyDesc.getMfrDesc()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSerialNum
Set the property corresponding toMultipartReplyDesc.getSerialNum()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSwDesc
Set the property corresponding toMultipartReplyDesc.getSwDesc()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public MultipartReplyDescBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyDesc> 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 MultipartReplyDescBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyDesc>> 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 newMultipartReplyDesc
instance.- Returns:
- A new
MultipartReplyDesc
instance.
-