Class MetadataBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.metadata._case.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)
-
Method Summary
All Methods Instance Methods Concrete 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()
byte[]
getMask()
byte[]
getMetadata()
MetadataBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Metadata>> augmentationType)
MetadataBuilder
setMask(byte[] value)
MetadataBuilder
setMetadata(byte[] value)
-
-
-
Constructor Detail
-
MetadataBuilder
public MetadataBuilder()
-
MetadataBuilder
public MetadataBuilder(Metadata base)
-
-
Method Detail
-
getMask
public byte[] getMask()
-
getMetadata
public byte[] getMetadata()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Metadata>> E$$ augmentation(Class<E$$> augmentationType)
-
setMask
public MetadataBuilder setMask(byte[] value)
-
setMetadata
public MetadataBuilder setMetadata(byte[] value)
-
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>
-
-