Class IgpLinkEvent1Builder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.isis.topology.rev131021.IgpLinkEvent1Builder
Class that builds
IgpLinkEvent1
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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.Construct a builder initialized with state from specifiedIgpLinkEvent1
.Construct a new builder initialized from specifiedIsisLinkAttributes
.Construct a new builder initialized from specifiedIsisTopologyType
. -
Method Summary
Modifier and TypeMethodDescription@NonNull IgpLinkEvent1
build()
A newIgpLinkEvent1
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.getIsis()
Return current value associated with the property corresponding toIsisTopologyType.getIsis()
.Return current value associated with the property corresponding toIsisLinkAttributes.getIsisLinkAttributes()
.Set the property corresponding toIsisTopologyType.getIsis()
to the specified value.Set the property corresponding toIsisLinkAttributes.getIsisLinkAttributes()
to the specified value.
-
Constructor Details
-
IgpLinkEvent1Builder
public IgpLinkEvent1Builder()Construct an empty builder. -
IgpLinkEvent1Builder
Construct a new builder initialized from specifiedIsisTopologyType
.- Parameters:
arg
- IsisTopologyType from which the builder should be initialized
-
IgpLinkEvent1Builder
Construct a new builder initialized from specifiedIsisLinkAttributes
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.network.isis.topology.rev131021.IsisLinkAttributes from which the builder should be initialized
-
IgpLinkEvent1Builder
Construct a builder initialized with state from specifiedIgpLinkEvent1
.- Parameters:
base
- IgpLinkEvent1 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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getIsis
Return current value associated with the property corresponding toIsisTopologyType.getIsis()
.- Returns:
- current value
-
getIsisLinkAttributes
Return current value associated with the property corresponding toIsisLinkAttributes.getIsisLinkAttributes()
.- Returns:
- current value
-
setIsis
Set the property corresponding toIsisTopologyType.getIsis()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setIsisLinkAttributes
Set the property corresponding toIsisLinkAttributes.getIsisLinkAttributes()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
build
A newIgpLinkEvent1
instance.- Returns:
- A new
IgpLinkEvent1
instance.
-