Class MetadataBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.topology.pcep.rev220730.lsp.metadata.MetadataBuilder
Class that builds
Metadata
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:
Metadata createMetadata(int fooXyzzy, int barBaz) {
return new MetadataBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Metadata, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.MetadataBuilder
(Metadata base) Construct a builder initialized with state from specifiedMetadata
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<Metadata> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Metadata>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Metadata
build()
A newMetadata
instance.static @NonNull Metadata
empty()
Get empty instance of Metadata.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Metadata>> augmentationType) Remove an augmentation from this builder's product.
-
Constructor Details
-
MetadataBuilder
public MetadataBuilder()Construct an empty builder. -
MetadataBuilder
Construct a builder initialized with state from specifiedMetadata
.- Parameters:
base
- Metadata from which the builder should be initialized
-
-
Method Details
-
empty
Get empty instance of Metadata.- Returns:
- An empty
Metadata
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Metadata>> E$$ augmentation(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
addAugmentation
public MetadataBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Metadata> 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 MetadataBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Metadata>> 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
A newMetadata
instance.- Returns:
- A new
Metadata
instance.
-