Class WriteMetadataBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.write.metadata._case.WriteMetadataBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<WriteMetadata>
,org.opendaylight.yangtools.concepts.CheckedBuilder<WriteMetadata,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class WriteMetadataBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<WriteMetadata>
Class that buildsWriteMetadataBuilder
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:
WriteMetadataBuilder createTarget(int fooXyzzy, int barBaz) { return new WriteMetadataBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of WriteMetadataBuilder, 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:
WriteMetadataBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description WriteMetadataBuilder()
WriteMetadataBuilder(WriteMetadata base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description WriteMetadataBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<WriteMetadata> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<WriteMetadata>>
E$$augmentation(Class<E$$> augmentationType)
WriteMetadata
build()
org.opendaylight.yangtools.yang.common.Uint64
getMetadata()
org.opendaylight.yangtools.yang.common.Uint64
getMetadataMask()
WriteMetadataBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<WriteMetadata>> augmentationType)
Remove an augmentation from this builder's product.WriteMetadataBuilder
setMetadata(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMetadata(Uint64)
instead.WriteMetadataBuilder
setMetadata(org.opendaylight.yangtools.yang.common.Uint64 value)
WriteMetadataBuilder
setMetadataMask(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMetadataMask(Uint64)
instead.WriteMetadataBuilder
setMetadataMask(org.opendaylight.yangtools.yang.common.Uint64 value)
-
-
-
Constructor Detail
-
WriteMetadataBuilder
public WriteMetadataBuilder()
-
WriteMetadataBuilder
public WriteMetadataBuilder(WriteMetadata base)
-
-
Method Detail
-
getMetadata
public org.opendaylight.yangtools.yang.common.Uint64 getMetadata()
-
getMetadataMask
public org.opendaylight.yangtools.yang.common.Uint64 getMetadataMask()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<WriteMetadata>> E$$ augmentation(Class<E$$> augmentationType)
-
setMetadata
public WriteMetadataBuilder setMetadata(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setMetadata
@Deprecated(forRemoval=true) public WriteMetadataBuilder setMetadata(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMetadata(Uint64)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setMetadataMask
public WriteMetadataBuilder setMetadataMask(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setMetadataMask
@Deprecated(forRemoval=true) public WriteMetadataBuilder setMetadataMask(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMetadataMask(Uint64)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public WriteMetadataBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<WriteMetadata> 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 WriteMetadataBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<WriteMetadata>> 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 WriteMetadata build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<WriteMetadata>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<WriteMetadata,IllegalArgumentException>
-
-