Package org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.multipart.reply.multipart.reply.body

Class MultipartReplyPortDescBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925.multipart.reply.multipart.reply.body.MultipartReplyPortDescBuilder

@Generated("mdsal-binding-generator")
public class MultipartReplyPortDescBuilder
extends Object

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

   
     MultipartReplyPortDesc createMultipartReplyPortDesc(int fooXyzzy, int barBaz) {
         return new MultipartReplyPortDescBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• MultipartReplyPortDesc

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
MultipartReplyPortDescBuilder	addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyPortDesc> augmentation)	Add an augmentation to this builder's product.
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyPortDesc>> E$$	augmentation(Class<E$$> augmentationType)	Return the specified augmentation, if it is present in this builder.
@NonNull MultipartReplyPortDesc	build()	A new MultipartReplyPortDesc instance.
List<Ports>	getPorts()	Return current value associated with the property corresponding to MultipartReplyPortDesc.getPorts().
MultipartReplyPortDescBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyPortDesc>> augmentationType)	Remove an augmentation from this builder's product.
MultipartReplyPortDescBuilder	setPorts(List<Ports> values)	Set the property corresponding to MultipartReplyPortDesc.getPorts() to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Details

MultipartReplyPortDescBuilder

public MultipartReplyPortDescBuilder()

Construct an empty builder.

MultipartReplyPortDescBuilder

public MultipartReplyPortDescBuilder(MultipartReplyPortDesc base)

Construct a builder initialized with state from specified MultipartReplyPortDesc.

Parameters:

base - MultipartReplyPortDesc from which the builder should be initialized

Method Details

getPorts

public List<Ports> getPorts()

Return current value associated with the property corresponding to MultipartReplyPortDesc.getPorts().

Returns:

current value

augmentation

public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyPortDesc>>
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 - if augmentType is null

setPorts

public MultipartReplyPortDescBuilder setPorts(List<Ports> values)

Set the property corresponding to MultipartReplyPortDesc.getPorts() to the specified value.

Parameters:

values - desired value

Returns:

this builder

addAugmentation

public MultipartReplyPortDescBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyPortDesc> 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 MultipartReplyPortDescBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<MultipartReplyPortDesc>> 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 MultipartReplyPortDesc build()

A new MultipartReplyPortDesc instance.

Returns:

A new MultipartReplyPortDesc instance.