Class WriteMetadataCaseBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.rev131026.instruction.instruction.WriteMetadataCaseBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<WriteMetadataCase>
,org.opendaylight.yangtools.concepts.CheckedBuilder<WriteMetadataCase,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class WriteMetadataCaseBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<WriteMetadataCase>
Class that buildsWriteMetadataCaseBuilder
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:
WriteMetadataCaseBuilder createTarget(int fooXyzzy, int barBaz) { return new WriteMetadataCaseBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of WriteMetadataCaseBuilder, 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:
WriteMetadataCaseBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description WriteMetadataCaseBuilder()
WriteMetadataCaseBuilder(WriteMetadataCase base)
-
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)
WriteMetadataCase
build()
WriteMetadata
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)
-
-
-
Constructor Detail
-
WriteMetadataCaseBuilder
public WriteMetadataCaseBuilder()
-
WriteMetadataCaseBuilder
public WriteMetadataCaseBuilder(WriteMetadataCase base)
-
-
Method Detail
-
getWriteMetadata
public WriteMetadata getWriteMetadata()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<WriteMetadataCase>> E$$ augmentation(Class<E$$> augmentationType)
-
setWriteMetadata
public WriteMetadataCaseBuilder setWriteMetadata(WriteMetadata value)
-
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 WriteMetadataCase build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<WriteMetadataCase>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<WriteMetadataCase,IllegalArgumentException>
-
-