Class Bandwidth2Builder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.auto.bandwidth.rev181109.Bandwidth2Builder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Bandwidth2>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Bandwidth2,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class Bandwidth2Builder extends Object implements org.opendaylight.yangtools.concepts.Builder<Bandwidth2>
Class that buildsBandwidth2
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:
Bandwidth2 createBandwidth2(int fooXyzzy, int barBaz) { return new Bandwidth2Builder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Bandwidth2, 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:
Bandwidth2
,Builder
-
-
Constructor Summary
Constructors Constructor Description Bandwidth2Builder()
Bandwidth2Builder(Bandwidth2 base)
Bandwidth2Builder(BwSamples arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Bandwidth2
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.List<Bandwidth>
getBwSample()
Bandwidth2Builder
setBwSample(List<Bandwidth> values)
-
-
-
Constructor Detail
-
Bandwidth2Builder
public Bandwidth2Builder()
-
Bandwidth2Builder
public Bandwidth2Builder(BwSamples arg)
-
Bandwidth2Builder
public Bandwidth2Builder(Bandwidth2 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:- BwSamples
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
setBwSample
public Bandwidth2Builder setBwSample(List<Bandwidth> values)
-
build
public Bandwidth2 build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Bandwidth2>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Bandwidth2,IllegalArgumentException>
-
-