Package org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.ospf.topology.rev131021

Class IgpNodeAttributes1Builder

java.lang.Object

org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.ospf.topology.rev131021.IgpNodeAttributes1Builder

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

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

   
     IgpNodeAttributes1 createIgpNodeAttributes1(int fooXyzzy, int barBaz) {
         return new IgpNodeAttributes1Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

• IgpNodeAttributes1

Constructor Summary

Constructors

Constructor	Description
IgpNodeAttributes1Builder()	Construct an empty builder.
IgpNodeAttributes1Builder(IgpNodeAttributes1 base)	Construct a builder initialized with state from specified IgpNodeAttributes1.
IgpNodeAttributes1Builder(OspfNodeAttributes arg)	Construct a new builder initialized from specified OspfNodeAttributes.

Method Summary

Modifier and Type	Method	Description
@NonNull IgpNodeAttributes1	build()	A new IgpNodeAttributes1 instance.
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)	Set fields from given grouping argument.
OspfNodeAttributes	getOspfNodeAttributes()	Return current value associated with the property corresponding to OspfNodeAttributes.getOspfNodeAttributes().
IgpNodeAttributes1Builder	setOspfNodeAttributes(OspfNodeAttributes value)	Set the property corresponding to OspfNodeAttributes.getOspfNodeAttributes() to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Details

IgpNodeAttributes1Builder

public IgpNodeAttributes1Builder()

Construct an empty builder.

IgpNodeAttributes1Builder

public IgpNodeAttributes1Builder(OspfNodeAttributes arg)

Construct a new builder initialized from specified OspfNodeAttributes.

Parameters:

arg - org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.ospf.topology.rev131021.OspfNodeAttributes from which the builder should be initialized

IgpNodeAttributes1Builder

public IgpNodeAttributes1Builder(IgpNodeAttributes1 base)

Construct a builder initialized with state from specified IgpNodeAttributes1.

Parameters:

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

• OspfNodeAttributes

Parameters:

arg - grouping object

Throws:

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

getOspfNodeAttributes

public OspfNodeAttributes getOspfNodeAttributes()

Return current value associated with the property corresponding to OspfNodeAttributes.getOspfNodeAttributes().

Returns:

current value

setOspfNodeAttributes

public IgpNodeAttributes1Builder setOspfNodeAttributes(OspfNodeAttributes value)

Set the property corresponding to OspfNodeAttributes.getOspfNodeAttributes() to the specified value.

Parameters:

value - desired value

Returns:

this builder

build

public @NonNull IgpNodeAttributes1 build()

A new IgpNodeAttributes1 instance.

Returns:

A new IgpNodeAttributes1 instance.