Class MetadataValuesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.match.rev140421.ofj.oxm.of.metadata.grouping.MetadataValuesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<MetadataValues>
,org.opendaylight.yangtools.concepts.CheckedBuilder<MetadataValues,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class MetadataValuesBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<MetadataValues>
Class that buildsMetadataValues
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:
MetadataValues createMetadataValues(int fooXyzzy, int barBaz) { return new MetadataValuesBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MetadataValues, 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:
MetadataValues
,Builder
-
-
Constructor Summary
Constructors Constructor Description MetadataValuesBuilder()
MetadataValuesBuilder(MetadataValues base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description MetadataValuesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MetadataValues> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MetadataValues>>
E$$augmentation(Class<E$$> augmentationType)
MetadataValues
build()
org.opendaylight.yangtools.yang.common.Uint32
getMetadata()
MetadataValuesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MetadataValues>> augmentationType)
Remove an augmentation from this builder's product.MetadataValuesBuilder
setMetadata(org.opendaylight.yangtools.yang.common.Uint32 value)
-
-
-
Constructor Detail
-
MetadataValuesBuilder
public MetadataValuesBuilder()
-
MetadataValuesBuilder
public MetadataValuesBuilder(MetadataValues base)
-
-
Method Detail
-
getMetadata
public org.opendaylight.yangtools.yang.common.Uint32 getMetadata()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MetadataValues>> E$$ augmentation(Class<E$$> augmentationType)
-
setMetadata
public MetadataValuesBuilder setMetadata(org.opendaylight.yangtools.yang.common.Uint32 value)
-
addAugmentation
public MetadataValuesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MetadataValues> 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 MetadataValuesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MetadataValues>> 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 MetadataValues build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<MetadataValues>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<MetadataValues,IllegalArgumentException>
-
-