Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.protection.object.protection.object.basic.protection.object._case

Class BasicProtectionObjectBuilder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.protection.object.protection.object.basic.protection.object._case.BasicProtectionObjectBuilder

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

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

   
     BasicProtectionObject createBasicProtectionObject(int fooXyzzy, int barBaz) {
         return new BasicProtectionObjectBuilder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• BasicProtectionObject

Constructor Summary

Constructors

Constructor	Description
BasicProtectionObjectBuilder()	Construct an empty builder.
BasicProtectionObjectBuilder(BasicProtectionObject base)	Construct a builder initialized with state from specified BasicProtectionObject.
BasicProtectionObjectBuilder(ProtectionSubobject arg)	Construct a new builder initialized from specified ProtectionSubobject.
BasicProtectionObjectBuilder(RsvpTeObject arg)	Construct a new builder initialized from specified RsvpTeObject.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

BasicProtectionObjectBuilder

public BasicProtectionObjectBuilder()

Construct an empty builder.

BasicProtectionObjectBuilder

public BasicProtectionObjectBuilder(RsvpTeObject arg)

Construct a new builder initialized from specified RsvpTeObject.

Parameters:

arg - RsvpTeObject from which the builder should be initialized

BasicProtectionObjectBuilder

public BasicProtectionObjectBuilder(ProtectionSubobject arg)

Construct a new builder initialized from specified ProtectionSubobject.

Parameters:

arg - org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.ProtectionSubobject from which the builder should be initialized

BasicProtectionObjectBuilder

public BasicProtectionObjectBuilder(BasicProtectionObject base)

Construct a builder initialized with state from specified BasicProtectionObject.

Parameters:

base - BasicProtectionObject 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:

• ProtectionSubobject
• RsvpTeObject

Parameters:

arg - grouping object

Throws:

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

empty

public static @NonNull BasicProtectionObject empty()

Get empty instance of BasicProtectionObject.

Returns:

An empty BasicProtectionObject

getProtectionSubobject

public ProtectionSubobject getProtectionSubobject()

Return current value associated with the property corresponding to ProtectionSubobject.getProtectionSubobject().

Returns:

current value

augmentation

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

setProtectionSubobject

public BasicProtectionObjectBuilder setProtectionSubobject(ProtectionSubobject value)

Set the property corresponding to ProtectionSubobject.getProtectionSubobject() to the specified value.

Parameters:

value - desired value

Returns:

this builder

addAugmentation

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

A new BasicProtectionObject instance.

Returns:

A new BasicProtectionObject instance.