Package org.opendaylight.yang.gen.v1.urn.lighty.gnmi.topology.rev210316.gnmi.connection.parameters.extensions.parameters

Class GnmiParametersBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.lighty.gnmi.topology.rev210316.gnmi.connection.parameters.extensions.parameters.GnmiParametersBuilder

All Implemented Interfaces:

org.opendaylight.yangtools.concepts.Builder<GnmiParameters>, org.opendaylight.yangtools.concepts.CheckedBuilder<GnmiParameters,IllegalArgumentException>, org.opendaylight.yangtools.concepts.Mutable, org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>

@Generated("mdsal-binding-generator")
public class GnmiParametersBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<GnmiParameters>

Class that builds GnmiParametersBuilder 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:

   
     GnmiParametersBuilder createTarget(int fooXyzzy, int barBaz) {
         return new GnmiParametersBuilderBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

This pattern is supported by the immutable nature of GnmiParametersBuilder, 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:

GnmiParametersBuilder, Builder

Constructor Summary

Constructors

Constructor	Description
GnmiParametersBuilder()
GnmiParametersBuilder(GnmiParameters base)

Method Summary

Modifier and Type	Method	Description
GnmiParametersBuilder	addAugmentation(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)
GnmiParameters	build()
GnmiParameters.OverwriteDataType	getOverwriteDataType()
String	getPathTarget()
Boolean	getUseModelNamePrefix()
Boolean	isUseModelNamePrefix()	Deprecated, for removal: This API element is subject to removal in a future version.
GnmiParametersBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GnmiParameters>> augmentationType)	Remove an augmentation from this builder's product.
GnmiParametersBuilder	setOverwriteDataType(GnmiParameters.OverwriteDataType value)
GnmiParametersBuilder	setPathTarget(String value)
GnmiParametersBuilder	setUseModelNamePrefix(Boolean value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GnmiParametersBuilder

public GnmiParametersBuilder()

GnmiParametersBuilder

public GnmiParametersBuilder(GnmiParameters base)

Method Detail

getOverwriteDataType

public GnmiParameters.OverwriteDataType getOverwriteDataType()

getPathTarget

public String getPathTarget()

getUseModelNamePrefix

public Boolean getUseModelNamePrefix()

isUseModelNamePrefix

@Deprecated(forRemoval=true)
public final Boolean isUseModelNamePrefix()

Deprecated, for removal: This API element is subject to removal in a future version.

augmentation

public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GnmiParameters>> E$$ augmentation(Class<E$$> augmentationType)

setOverwriteDataType

public GnmiParametersBuilder setOverwriteDataType(GnmiParameters.OverwriteDataType value)

setPathTarget

public GnmiParametersBuilder setPathTarget(String value)

setUseModelNamePrefix

public GnmiParametersBuilder setUseModelNamePrefix(Boolean value)

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 - if augmentation is 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 GnmiParameters build()

Specified by:

build in interface org.opendaylight.yangtools.concepts.Builder<GnmiParameters>

Specified by:

build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<GnmiParameters,IllegalArgumentException>