Class WriteMetadataCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.WriteMetadataCaseBuilder
-
@Generated("mdsal-binding-generator") public class WriteMetadataCaseBuilder extends Object
Class that buildsWriteMetadataCase
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:
WriteMetadataCase createWriteMetadataCase(int fooXyzzy, int barBaz) { return new WriteMetadataCaseBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of WriteMetadataCase, 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:
WriteMetadataCase
- 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
-
-
Constructor Summary
Constructors Constructor Description WriteMetadataCaseBuilder()
Construct an empty builder.WriteMetadataCaseBuilder(WriteMetadataCase base)
Construct a builder initialized with state from specifiedWriteMetadataCase
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description WriteMetadataCaseBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<WriteMetadataCase> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<WriteMetadataCase>>
E$$augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.@NonNull WriteMetadataCase
build()
A newWriteMetadataCase
instance.WriteMetadata
getWriteMetadata()
Return current value associated with the property corresponding toWriteMetadataCase.getWriteMetadata()
.WriteMetadataCaseBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<WriteMetadataCase>> augmentationType)
Remove an augmentation from this builder's product.WriteMetadataCaseBuilder
setWriteMetadata(WriteMetadata value)
Set the property corresponding toWriteMetadataCase.getWriteMetadata()
to the specified value.
-
-
-
Constructor Detail
-
WriteMetadataCaseBuilder
public WriteMetadataCaseBuilder()
Construct an empty builder.
-
WriteMetadataCaseBuilder
public WriteMetadataCaseBuilder(WriteMetadataCase base)
Construct a builder initialized with state from specifiedWriteMetadataCase
.- Parameters:
base
- WriteMetadataCase from which the builder should be initialized
-
-
Method Detail
-
getWriteMetadata
public WriteMetadata getWriteMetadata()
Return current value associated with the property corresponding toWriteMetadataCase.getWriteMetadata()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<WriteMetadataCase>> 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
-
setWriteMetadata
public WriteMetadataCaseBuilder setWriteMetadata(WriteMetadata value)
Set the property corresponding toWriteMetadataCase.getWriteMetadata()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public WriteMetadataCaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<WriteMetadataCase> 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 WriteMetadataCaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<WriteMetadataCase>> 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
public @NonNull WriteMetadataCase build()
A newWriteMetadataCase
instance.- Returns:
- A new
WriteMetadataCase
instance.
-
-