Package org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906

Class GetMappingWithXtrIdOutputBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.GetMappingWithXtrIdOutputBuilder

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

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

   
     GetMappingWithXtrIdOutput createGetMappingWithXtrIdOutput(int fooXyzzy, int barBaz) {
         return new GetMappingWithXtrIdOutputBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• GetMappingWithXtrIdOutput

Constructor Summary

Constructors

Constructor	Description
GetMappingWithXtrIdOutputBuilder()	Construct an empty builder.
GetMappingWithXtrIdOutputBuilder(MappingRecordContainer arg)	Construct a new builder initialized from specified MappingRecordContainer.
GetMappingWithXtrIdOutputBuilder(GetMappingWithXtrIdOutput base)	Construct a builder initialized with state from specified GetMappingWithXtrIdOutput.

Method Summary

Modifier and Type	Method	Description
GetMappingWithXtrIdOutputBuilder	addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<GetMappingWithXtrIdOutput> augmentation)	Add an augmentation to this builder's product.
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GetMappingWithXtrIdOutput>> E$$	augmentation(Class<E$$> augmentationType)	Return the specified augmentation, if it is present in this builder.
@NonNull GetMappingWithXtrIdOutput	build()	A new GetMappingWithXtrIdOutput instance.
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)	Set fields from given grouping argument.
MappingRecord	getMappingRecord()	Return current value associated with the property corresponding to MappingRecordContainer.getMappingRecord().
GetMappingWithXtrIdOutputBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<GetMappingWithXtrIdOutput>> augmentationType)	Remove an augmentation from this builder's product.
GetMappingWithXtrIdOutputBuilder	setMappingRecord(MappingRecord value)	Set the property corresponding to MappingRecordContainer.getMappingRecord() to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Details

GetMappingWithXtrIdOutputBuilder

public GetMappingWithXtrIdOutputBuilder()

Construct an empty builder.

GetMappingWithXtrIdOutputBuilder

public GetMappingWithXtrIdOutputBuilder(MappingRecordContainer arg)

Construct a new builder initialized from specified MappingRecordContainer.

Parameters:

arg - MappingRecordContainer from which the builder should be initialized

GetMappingWithXtrIdOutputBuilder

public GetMappingWithXtrIdOutputBuilder(GetMappingWithXtrIdOutput base)

Construct a builder initialized with state from specified GetMappingWithXtrIdOutput.

Parameters:

base - GetMappingWithXtrIdOutput from which the builder should be initialized

Method Details

fieldsFrom

public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)

Set fields from given grouping argument. Valid argument is instance of one of following types:

• MappingRecordContainer

Parameters:

arg - grouping object

Throws:

IllegalArgumentException - if given argument is none of valid types or has property with incompatible value

getMappingRecord

public MappingRecord getMappingRecord()

Return current value associated with the property corresponding to MappingRecordContainer.getMappingRecord().

Returns:

current value

augmentation

public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<GetMappingWithXtrIdOutput>>
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

setMappingRecord

public GetMappingWithXtrIdOutputBuilder setMappingRecord(MappingRecord value)

Set the property corresponding to MappingRecordContainer.getMappingRecord() to the specified value.

Parameters:

value - desired value

Returns:

this builder

addAugmentation

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

A new GetMappingWithXtrIdOutput instance.

Returns:

A new GetMappingWithXtrIdOutput instance.