Class MetadataBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.match.MetadataBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Metadata>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Metadata,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class MetadataBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Metadata>
Class that buildsMetadataBuilder
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:
MetadataBuilder createTarget(int fooXyzzy, int barBaz) { return new MetadataBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MetadataBuilder, 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:
MetadataBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description MetadataBuilder()
MetadataBuilder(Metadata base)
MetadataBuilder(OfMetadata arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description MetadataBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Metadata>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Metadata> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Metadata>>
E$$augmentation(Class<E$$> augmentationType)
Metadata
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.org.opendaylight.yangtools.yang.common.Uint64
getMetadata()
org.opendaylight.yangtools.yang.common.Uint64
getMetadataMask()
MetadataBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Metadata>> augmentationType)
MetadataBuilder
setMetadata(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setMetadata(Uint64)} instead.MetadataBuilder
setMetadata(org.opendaylight.yangtools.yang.common.Uint64 value)
MetadataBuilder
setMetadataMask(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setMetadataMask(Uint64)} instead.MetadataBuilder
setMetadataMask(org.opendaylight.yangtools.yang.common.Uint64 value)
-
-
-
Constructor Detail
-
MetadataBuilder
public MetadataBuilder()
-
MetadataBuilder
public MetadataBuilder(OfMetadata arg)
-
MetadataBuilder
public MetadataBuilder(Metadata base)
-
-
Method Detail
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument. Valid argument is instance of one of following types:- org.opendaylight.yang.gen.v1.urn.opendaylight.model.match.types.rev131026.OfMetadata
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
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<Metadata>> E$$ augmentation(Class<E$$> augmentationType)
-
setMetadata
public MetadataBuilder setMetadata(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setMetadata
@Deprecated(forRemoval=true) public MetadataBuilder setMetadata(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setMetadata(Uint64)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setMetadataMask
public MetadataBuilder setMetadataMask(org.opendaylight.yangtools.yang.common.Uint64 value)
-
setMetadataMask
@Deprecated(forRemoval=true) public MetadataBuilder setMetadataMask(BigInteger value)
Deprecated, for removal: This API element is subject to removal in a future version.Use {#link setMetadataMask(Uint64)} instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public MetadataBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Metadata>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Metadata> augmentationValue)
-
removeAugmentation
public MetadataBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Metadata>> augmentationType)
-
build
public Metadata build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Metadata>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Metadata,IllegalArgumentException>
-
-