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

Class IgpLinkAttributes1Builder

java.lang.Object

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

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

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

   
     IgpLinkAttributes1 createIgpLinkAttributes1(int fooXyzzy, int barBaz) {
         return new IgpLinkAttributes1Builder()
             .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
             .setBar(new BarBuilder().setBaz(barBaz).build())
             .build();
     }
   
 

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

IgpLinkAttributes1

Constructor Summary

Constructors

Constructor	Description
IgpLinkAttributes1Builder()	Construct an empty builder.
IgpLinkAttributes1Builder(IgpLinkAttributes1 base)	Construct a builder initialized with state from specified IgpLinkAttributes1.
IgpLinkAttributes1Builder(OspfLinkAttributes arg)	Construct a new builder initialized from specified OspfLinkAttributes.

Method Summary

Modifier and Type	Method	Description
@NonNull IgpLinkAttributes1	build()	A new IgpLinkAttributes1 instance.
void	fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)	Set fields from given grouping argument.
OspfLinkAttributes	getOspfLinkAttributes()	Return current value associated with the property corresponding to OspfLinkAttributes.getOspfLinkAttributes().
IgpLinkAttributes1Builder	setOspfLinkAttributes(OspfLinkAttributes value)	Set the property corresponding to OspfLinkAttributes.getOspfLinkAttributes() to the specified value.

Methods inherited from class java.lang.Object

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

Constructor Detail

IgpLinkAttributes1Builder

public IgpLinkAttributes1Builder()

Construct an empty builder.

IgpLinkAttributes1Builder

public IgpLinkAttributes1Builder(OspfLinkAttributes arg)

Construct a new builder initialized from specified OspfLinkAttributes.

Parameters:

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

IgpLinkAttributes1Builder

public IgpLinkAttributes1Builder(IgpLinkAttributes1 base)

Construct a builder initialized with state from specified IgpLinkAttributes1.

Parameters:

base - IgpLinkAttributes1 from which the builder should be initialized

Method Detail

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:

• OspfLinkAttributes

Parameters:

arg - grouping object

Throws:

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

getOspfLinkAttributes

public OspfLinkAttributes getOspfLinkAttributes()

Return current value associated with the property corresponding to OspfLinkAttributes.getOspfLinkAttributes().

Returns:

current value

setOspfLinkAttributes

public IgpLinkAttributes1Builder setOspfLinkAttributes(OspfLinkAttributes value)

Set the property corresponding to OspfLinkAttributes.getOspfLinkAttributes() to the specified value.

Parameters:

value - desired value

Returns:

this builder

build

public @NonNull IgpLinkAttributes1 build()

A new IgpLinkAttributes1 instance.

Returns:

A new IgpLinkAttributes1 instance.