Class GnmiParametersBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.lighty.gnmi.topology.rev210316.gnmi.connection.parameters.extensions.parameters.GnmiParametersBuilder
-
@Generated("mdsal-binding-generator") public class GnmiParametersBuilder extends Object
Class that buildsGnmiParametersinstances. 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:
GnmiParameters createGnmiParameters(int fooXyzzy, int barBaz) { return new GnmiParametersBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }This pattern is supported by the immutable nature of GnmiParameters, 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:
GnmiParameters
- 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
-
-
Constructor Summary
Constructors Constructor Description GnmiParametersBuilder()Construct an empty builder.GnmiParametersBuilder(GnmiParameters base)Construct a builder initialized with state from specifiedGnmiParameters.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GnmiParametersBuilderaddAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<GnmiParameters> augmentation)Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GnmiParameters>>
E$$augmentation(Class<E$$> augmentationType)Return the specified augmentation, if it is present in this builder.@NonNull GnmiParametersbuild()A newGnmiParametersinstance.GnmiParameters.OverwriteDataTypegetOverwriteDataType()Return current value associated with the property corresponding toGnmiParameters.getOverwriteDataType().StringgetPathTarget()Return current value associated with the property corresponding toGnmiParameters.getPathTarget().BooleangetUseModelNamePrefix()Return current value associated with the property corresponding toGnmiParameters.getUseModelNamePrefix().GnmiParametersBuilderremoveAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GnmiParameters>> augmentationType)Remove an augmentation from this builder's product.GnmiParametersBuildersetOverwriteDataType(GnmiParameters.OverwriteDataType value)Set the property corresponding toGnmiParameters.getOverwriteDataType()to the specified value.GnmiParametersBuildersetPathTarget(String value)Set the property corresponding toGnmiParameters.getPathTarget()to the specified value.GnmiParametersBuildersetUseModelNamePrefix(Boolean value)Set the property corresponding toGnmiParameters.getUseModelNamePrefix()to the specified value.
-
-
-
Constructor Detail
-
GnmiParametersBuilder
public GnmiParametersBuilder()
Construct an empty builder.
-
GnmiParametersBuilder
public GnmiParametersBuilder(GnmiParameters base)
Construct a builder initialized with state from specifiedGnmiParameters.- Parameters:
base- GnmiParameters from which the builder should be initialized
-
-
Method Detail
-
getOverwriteDataType
public GnmiParameters.OverwriteDataType getOverwriteDataType()
Return current value associated with the property corresponding toGnmiParameters.getOverwriteDataType().- Returns:
- current value
-
getPathTarget
public String getPathTarget()
Return current value associated with the property corresponding toGnmiParameters.getPathTarget().- Returns:
- current value
-
getUseModelNamePrefix
public Boolean getUseModelNamePrefix()
Return current value associated with the property corresponding toGnmiParameters.getUseModelNamePrefix().- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GnmiParameters>> 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
-
setOverwriteDataType
public GnmiParametersBuilder setOverwriteDataType(GnmiParameters.OverwriteDataType value)
Set the property corresponding toGnmiParameters.getOverwriteDataType()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setPathTarget
public GnmiParametersBuilder setPathTarget(String value)
Set the property corresponding toGnmiParameters.getPathTarget()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
setUseModelNamePrefix
public GnmiParametersBuilder setUseModelNamePrefix(Boolean value)
Set the property corresponding toGnmiParameters.getUseModelNamePrefix()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
addAugmentation
public GnmiParametersBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<GnmiParameters> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException- ifaugmentationis null
-
removeAugmentation
public GnmiParametersBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GnmiParameters>> 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 @NonNull GnmiParameters build()
A newGnmiParametersinstance.- Returns:
- A new
GnmiParametersinstance.
-
-