Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.secondary.explicit.route.subobjects.subobject.type

Class BasicProtectionCaseBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.secondary.explicit.route.subobjects.subobject.type.BasicProtectionCaseBuilder

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

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

   
     BasicProtectionCase createBasicProtectionCase(int fooXyzzy, int barBaz) {
         return new BasicProtectionCaseBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• BasicProtectionCase

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

BasicProtectionCaseBuilder

public BasicProtectionCaseBuilder()

Construct an empty builder.

BasicProtectionCaseBuilder

public BasicProtectionCaseBuilder(BasicProtectionCase base)

Construct a builder initialized with state from specified BasicProtectionCase.

Parameters:

base - BasicProtectionCase from which the builder should be initialized

Method Details

getBasicProtection

public BasicProtection getBasicProtection()

Return current value associated with the property corresponding to BasicProtectionCase.getBasicProtection().

Returns:

current value

augmentation

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

setBasicProtection

public BasicProtectionCaseBuilder setBasicProtection(BasicProtection value)

Set the property corresponding to BasicProtectionCase.getBasicProtection() to the specified value.

Parameters:

value - desired value

Returns:

this builder

addAugmentation

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

A new BasicProtectionCase instance.

Returns:

A new BasicProtectionCase instance.