Class L2Builder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.interfaces._interface.L2Builder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<L2>
,org.opendaylight.yangtools.concepts.CheckedBuilder<L2,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class L2Builder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<L2>
Class that buildsL2Builder
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:
L2Builder createTarget(int fooXyzzy, int barBaz) { return new L2BuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of L2Builder, 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 oportunities, 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:
L2Builder
,Builder
-
-
Constructor Summary
Constructors Constructor Description L2Builder()
L2Builder(L2 base)
L2Builder(L2ConfigAttributes arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description L2Builder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<L2>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<L2> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<L2>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
L2
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Interconnection
getInterconnection()
L2Builder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<L2>> augmentationType)
L2Builder
setInterconnection(Interconnection value)
-
-
-
Constructor Detail
-
L2Builder
public L2Builder()
-
L2Builder
public L2Builder(L2ConfigAttributes arg)
-
L2Builder
public L2Builder(L2 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.opendaylight.params.xml.ns.yang.v3po.rev170607.L2ConfigAttributes
- Parameters:
arg
- grouping object- Throws:
java.lang.IllegalArgumentException
- if given argument is none of valid types
-
getInterconnection
public Interconnection getInterconnection()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<L2>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setInterconnection
public L2Builder setInterconnection(Interconnection value)
-
addAugmentation
public L2Builder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<L2>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<L2> augmentationValue)
-
removeAugmentation
public L2Builder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<L2>> augmentationType)
-
-