Class Prefix1Builder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.ospf.topology.rev131021.Prefix1Builder
-
@Generated("mdsal-binding-generator") public class Prefix1Builder extends Object
Class that buildsPrefix1
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:
Prefix1 createPrefix1(int fooXyzzy, int barBaz) { return new Prefix1Builder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Prefix1, 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:
Prefix1
- 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 Prefix1Builder()
Construct an empty builder.Prefix1Builder(OspfPrefixAttributes arg)
Construct a new builder initialized from specifiedOspfPrefixAttributes
.Prefix1Builder(Prefix1 base)
Construct a builder initialized with state from specifiedPrefix1
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description @NonNull Prefix1
build()
A newPrefix1
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.OspfPrefixAttributes
getOspfPrefixAttributes()
Return current value associated with the property corresponding toOspfPrefixAttributes.getOspfPrefixAttributes()
.Prefix1Builder
setOspfPrefixAttributes(OspfPrefixAttributes value)
Set the property corresponding toOspfPrefixAttributes.getOspfPrefixAttributes()
to the specified value.
-
-
-
Constructor Detail
-
Prefix1Builder
public Prefix1Builder()
Construct an empty builder.
-
Prefix1Builder
public Prefix1Builder(OspfPrefixAttributes arg)
Construct a new builder initialized from specifiedOspfPrefixAttributes
.- Parameters:
arg
- org.opendaylight.yang.gen.v1.urn.tbd.params.xml.ns.yang.ospf.topology.rev131021.OspfPrefixAttributes 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
-
getOspfPrefixAttributes
public OspfPrefixAttributes getOspfPrefixAttributes()
Return current value associated with the property corresponding toOspfPrefixAttributes.getOspfPrefixAttributes()
.- Returns:
- current value
-
setOspfPrefixAttributes
public Prefix1Builder setOspfPrefixAttributes(OspfPrefixAttributes value)
Set the property corresponding toOspfPrefixAttributes.getOspfPrefixAttributes()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
-