Class IgpLinkEvent1Builder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.ospf.topology.rev131021.IgpLinkEvent1Builder
-
@Generated("mdsal-binding-generator") public class IgpLinkEvent1Builder extends Object
Class that buildsIgpLinkEvent1
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:
IgpLinkEvent1 createIgpLinkEvent1(int fooXyzzy, int barBaz) { return new IgpLinkEvent1Builder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of IgpLinkEvent1, 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:
IgpLinkEvent1
- 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
-
-
Constructor Summary
Constructors Constructor Description IgpLinkEvent1Builder()
Construct an empty builder.IgpLinkEvent1Builder(IgpLinkEvent1 base)
Construct a builder initialized with state from specifiedIgpLinkEvent1
.IgpLinkEvent1Builder(OspfLinkAttributes arg)
Construct a new builder initialized from specifiedOspfLinkAttributes
.IgpLinkEvent1Builder(OspfTopologyType arg)
Construct a new builder initialized from specifiedOspfTopologyType
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description @NonNull IgpLinkEvent1
build()
A newIgpLinkEvent1
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Ospf
getOspf()
Return current value associated with the property corresponding toOspfTopologyType.getOspf()
.OspfLinkAttributes
getOspfLinkAttributes()
Return current value associated with the property corresponding toOspfLinkAttributes.getOspfLinkAttributes()
.IgpLinkEvent1Builder
setOspf(Ospf value)
Set the property corresponding toOspfTopologyType.getOspf()
to the specified value.IgpLinkEvent1Builder
setOspfLinkAttributes(OspfLinkAttributes value)
Set the property corresponding toOspfLinkAttributes.getOspfLinkAttributes()
to the specified value.
-
-
-
Constructor Detail
-
IgpLinkEvent1Builder
public IgpLinkEvent1Builder()
Construct an empty builder.
-
IgpLinkEvent1Builder
public IgpLinkEvent1Builder(OspfTopologyType arg)
Construct a new builder initialized from specifiedOspfTopologyType
.- Parameters:
arg
- OspfTopologyType from which the builder should be initialized
-
IgpLinkEvent1Builder
public IgpLinkEvent1Builder(OspfLinkAttributes arg)
Construct a new builder initialized from specifiedOspfLinkAttributes
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.ospf.topology.rev131021.OspfLinkAttributes from which the builder should be initialized
-
IgpLinkEvent1Builder
public IgpLinkEvent1Builder(IgpLinkEvent1 base)
Construct a builder initialized with state from specifiedIgpLinkEvent1
.- Parameters:
base
- IgpLinkEvent1 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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getOspf
public Ospf getOspf()
Return current value associated with the property corresponding toOspfTopologyType.getOspf()
.- Returns:
- current value
-
getOspfLinkAttributes
public OspfLinkAttributes getOspfLinkAttributes()
Return current value associated with the property corresponding toOspfLinkAttributes.getOspfLinkAttributes()
.- Returns:
- current value
-
setOspf
public IgpLinkEvent1Builder setOspf(Ospf value)
Set the property corresponding toOspfTopologyType.getOspf()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOspfLinkAttributes
public IgpLinkEvent1Builder setOspfLinkAttributes(OspfLinkAttributes value)
Set the property corresponding toOspfLinkAttributes.getOspfLinkAttributes()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
build
public @NonNull IgpLinkEvent1 build()
A newIgpLinkEvent1
instance.- Returns:
- A new
IgpLinkEvent1
instance.
-
-