Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.string.tlv

Class StringTlvBuilder

java.lang.Object

org.opendaylight.yangtools.binding.lib.AugmentableBuilder<StringTlv,StringTlvBuilder>

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.string.tlv.StringTlvBuilder

All Implemented Interfaces:

org.opendaylight.yangtools.concepts.Mutable

@Generated("mdsal-binding-generator")
public class StringTlvBuilder
extends org.opendaylight.yangtools.binding.lib.AugmentableBuilder<StringTlv,StringTlvBuilder>

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

   
     StringTlv createStringTlv(int fooXyzzy, int barBaz) {
         return new StringTlvBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• StringTlv

Constructor Summary

Constructors

Constructor	Description
StringTlvBuilder()	Construct an empty builder.
StringTlvBuilder(StringTlv base)	Construct a builder initialized with state from specified StringTlv.

Method Summary

Modifier and Type	Method	Description
@NonNull StringTlv	build()	Returns A new StringTlv instance.
static @NonNull StringTlv	empty()	Returns an empty StringTlv.
String	getStringInfo()	Deprecated, for removal: This API element is subject to removal in a future version. This method will not be generated in a future release
StringTlvBuilder	setStringInfo(String value)	Set the property corresponding to StringTlv.getStringInfo() to the specified value.

Methods inherited from class org.opendaylight.yangtools.binding.lib.AugmentableBuilder

addAugmentation, augmentation, augmentations, removeAugmentation

Methods inherited from class java.lang.Object

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

Constructor Details

StringTlvBuilder

public StringTlvBuilder()

Construct an empty builder.

StringTlvBuilder

public StringTlvBuilder(StringTlv base)

Construct a builder initialized with state from specified StringTlv.

Parameters:

base - StringTlv from which the builder should be initialized

Method Details

empty

public static @NonNull StringTlv empty()

Returns an empty StringTlv.

Returns:

an empty StringTlv

getStringInfo

@Deprecated(forRemoval=true)
public String getStringInfo()

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

This method will not be generated in a future release

Return current value associated with the property corresponding to StringTlv.getStringInfo().

Returns:

current value

setStringInfo

public StringTlvBuilder setStringInfo(String value)

Set the property corresponding to StringTlv.getStringInfo() to the specified value.

Parameters:

value - desired value

Returns:

this builder

build

public @NonNull StringTlv build()

Returns A new StringTlv instance.

Returns:

A new StringTlv instance