Class Aggregation1Builder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.http.openconfig.net.yang.vlan.rev190416.Aggregation1Builder
-
@Generated("mdsal-binding-generator") public class Aggregation1Builder extends Object
Class that buildsAggregation1instances. 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:
Aggregation1 createAggregation1(int fooXyzzy, int barBaz) { return new Aggregation1Builder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }This pattern is supported by the immutable nature of Aggregation1, 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:
Aggregation1
- 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 Aggregation1Builder()Construct an empty builder.Aggregation1Builder(Aggregation1 base)Construct a builder initialized with state from specifiedAggregation1.Aggregation1Builder(VlanSwitchedTop arg)Construct a new builder initialized from specifiedVlanSwitchedTop.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description @NonNull Aggregation1build()A newAggregation1instance.voidfieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)Set fields from given grouping argument.SwitchedVlangetSwitchedVlan()Return current value associated with the property corresponding toVlanSwitchedTop.getSwitchedVlan().Aggregation1BuildersetSwitchedVlan(SwitchedVlan value)Set the property corresponding toVlanSwitchedTop.getSwitchedVlan()to the specified value.
-
-
-
Constructor Detail
-
Aggregation1Builder
public Aggregation1Builder()
Construct an empty builder.
-
Aggregation1Builder
public Aggregation1Builder(VlanSwitchedTop arg)
Construct a new builder initialized from specifiedVlanSwitchedTop.- Parameters:
arg- VlanSwitchedTop from which the builder should be initialized
-
Aggregation1Builder
public Aggregation1Builder(Aggregation1 base)
Construct a builder initialized with state from specifiedAggregation1.- Parameters:
base- Aggregation1 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
-
getSwitchedVlan
public SwitchedVlan getSwitchedVlan()
Return current value associated with the property corresponding toVlanSwitchedTop.getSwitchedVlan().- Returns:
- current value
-
setSwitchedVlan
public Aggregation1Builder setSwitchedVlan(SwitchedVlan value)
Set the property corresponding toVlanSwitchedTop.getSwitchedVlan()to the specified value.- Parameters:
value- desired value- Returns:
- this builder
-
build
public @NonNull Aggregation1 build()
A newAggregation1instance.- Returns:
- A new
Aggregation1instance.
-
-