Class ImageDefaultOutputBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.sonic.gnoi.yang.rev210614.ImageDefaultOutputBuilder
Class that builds
ImageDefaultOutput 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:
ImageDefaultOutput createImageDefaultOutput(int fooXyzzy, int barBaz) {
return new ImageDefaultOutputBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of ImageDefaultOutput, 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
ConstructorsConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedImageDefaultOutput. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ImageDefaultOutput> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ImageDefaultOutput>>
E$$augmentation(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull ImageDefaultOutputbuild()A newImageDefaultOutputinstance.Return current value associated with the property corresponding toImageDefaultOutput.getImageDefaultResponse().removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ImageDefaultOutput>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toImageDefaultOutput.getImageDefaultResponse()to the specified value.
-
Constructor Details
-
ImageDefaultOutputBuilder
public ImageDefaultOutputBuilder()Construct an empty builder. -
ImageDefaultOutputBuilder
Construct a builder initialized with state from specifiedImageDefaultOutput.- Parameters:
base- ImageDefaultOutput from which the builder should be initialized
-
-
Method Details
-
getImageDefaultResponse
Return current value associated with the property corresponding toImageDefaultOutput.getImageDefaultResponse().- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ImageDefaultOutput>> 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
nullif not present - Throws:
NullPointerException- ifaugmentTypeisnull
-
setImageDefaultResponse
Set the property corresponding toImageDefaultOutput.getImageDefaultResponse()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
addAugmentation
public ImageDefaultOutputBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<ImageDefaultOutput> augmentation) Add an augmentation to this builder's product.- Parameters:
augmentation- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException- ifaugmentationis null
-
removeAugmentation
public ImageDefaultOutputBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ImageDefaultOutput>> 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 newImageDefaultOutputinstance.- Returns:
- A new
ImageDefaultOutputinstance.
-