Class IgpNodeEvent1Builder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.ospf.topology.rev131021.IgpNodeEvent1Builder
-
@Generated("mdsal-binding-generator") public class IgpNodeEvent1Builder extends Object
Class that buildsIgpNodeEvent1
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:
IgpNodeEvent1 createIgpNodeEvent1(int fooXyzzy, int barBaz) { return new IgpNodeEvent1Builder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of IgpNodeEvent1, 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:
IgpNodeEvent1
- 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 IgpNodeEvent1Builder()
Construct an empty builder.IgpNodeEvent1Builder(IgpNodeEvent1 base)
Construct a builder initialized with state from specifiedIgpNodeEvent1
.IgpNodeEvent1Builder(OspfNodeAttributes arg)
Construct a new builder initialized from specifiedOspfNodeAttributes
.IgpNodeEvent1Builder(OspfTopologyType arg)
Construct a new builder initialized from specifiedOspfTopologyType
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description @NonNull IgpNodeEvent1
build()
A newIgpNodeEvent1
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()
.OspfNodeAttributes
getOspfNodeAttributes()
Return current value associated with the property corresponding toOspfNodeAttributes.getOspfNodeAttributes()
.IgpNodeEvent1Builder
setOspf(Ospf value)
Set the property corresponding toOspfTopologyType.getOspf()
to the specified value.IgpNodeEvent1Builder
setOspfNodeAttributes(OspfNodeAttributes value)
Set the property corresponding toOspfNodeAttributes.getOspfNodeAttributes()
to the specified value.
-
-
-
Constructor Detail
-
IgpNodeEvent1Builder
public IgpNodeEvent1Builder()
Construct an empty builder.
-
IgpNodeEvent1Builder
public IgpNodeEvent1Builder(OspfTopologyType arg)
Construct a new builder initialized from specifiedOspfTopologyType
.- Parameters:
arg
- OspfTopologyType from which the builder should be initialized
-
IgpNodeEvent1Builder
public IgpNodeEvent1Builder(OspfNodeAttributes arg)
Construct a new builder initialized from specifiedOspfNodeAttributes
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.ospf.topology.rev131021.OspfNodeAttributes from which the builder should be initialized
-
IgpNodeEvent1Builder
public IgpNodeEvent1Builder(IgpNodeEvent1 base)
Construct a builder initialized with state from specifiedIgpNodeEvent1
.- Parameters:
base
- IgpNodeEvent1 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
-
getOspfNodeAttributes
public OspfNodeAttributes getOspfNodeAttributes()
Return current value associated with the property corresponding toOspfNodeAttributes.getOspfNodeAttributes()
.- Returns:
- current value
-
setOspf
public IgpNodeEvent1Builder setOspf(Ospf value)
Set the property corresponding toOspfTopologyType.getOspf()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setOspfNodeAttributes
public IgpNodeEvent1Builder setOspfNodeAttributes(OspfNodeAttributes value)
Set the property corresponding toOspfNodeAttributes.getOspfNodeAttributes()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
build
public @NonNull IgpNodeEvent1 build()
A newIgpNodeEvent1
instance.- Returns:
- A new
IgpNodeEvent1
instance.
-
-