Class IgpLinkEvent1Builder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.ospf.topology.rev131021.IgpLinkEvent1Builder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<IgpLinkEvent1>
,org.opendaylight.yangtools.concepts.CheckedBuilder<IgpLinkEvent1,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class IgpLinkEvent1Builder extends Object implements org.opendaylight.yangtools.concepts.Builder<IgpLinkEvent1>
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
,Builder
-
-
Constructor Summary
Constructors Constructor Description IgpLinkEvent1Builder()
IgpLinkEvent1Builder(IgpLinkEvent1 base)
IgpLinkEvent1Builder(OspfLinkAttributes arg)
IgpLinkEvent1Builder(OspfTopologyType arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IgpLinkEvent1
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Ospf
getOspf()
OspfLinkAttributes
getOspfLinkAttributes()
IgpLinkEvent1Builder
setOspf(Ospf value)
IgpLinkEvent1Builder
setOspfLinkAttributes(OspfLinkAttributes value)
-
-
-
Constructor Detail
-
IgpLinkEvent1Builder
public IgpLinkEvent1Builder()
-
IgpLinkEvent1Builder
public IgpLinkEvent1Builder(OspfTopologyType arg)
-
IgpLinkEvent1Builder
public IgpLinkEvent1Builder(OspfLinkAttributes arg)
-
IgpLinkEvent1Builder
public IgpLinkEvent1Builder(IgpLinkEvent1 base)
-
-
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:- org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.ospf.topology.rev131021.OspfLinkAttributes
- OspfTopologyType
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getOspf
public Ospf getOspf()
-
getOspfLinkAttributes
public OspfLinkAttributes getOspfLinkAttributes()
-
setOspf
public IgpLinkEvent1Builder setOspf(Ospf value)
-
setOspfLinkAttributes
public IgpLinkEvent1Builder setOspfLinkAttributes(OspfLinkAttributes value)
-
build
public IgpLinkEvent1 build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<IgpLinkEvent1>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<IgpLinkEvent1,IllegalArgumentException>
-
-