Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.l2.fib.attributes
Class L2FibTableBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev170607.l2.fib.attributes.L2FibTableBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<L2FibTable>
,org.opendaylight.yangtools.concepts.CheckedBuilder<L2FibTable,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class L2FibTableBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<L2FibTable>
Class that buildsL2FibTableBuilder
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:
L2FibTableBuilder createTarget(int fooXyzzy, int barBaz) { return new L2FibTableBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of L2FibTableBuilder, 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:
L2FibTableBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description L2FibTableBuilder()
L2FibTableBuilder(L2FibTable base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description L2FibTableBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<L2FibTable>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<L2FibTable> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.L2FibTableBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<L2FibTable> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<L2FibTable>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
L2FibTable
build()
java.util.Map<L2FibEntryKey,L2FibEntry>
getL2FibEntry()
L2FibTableBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<L2FibTable>> augmentationType)
Remove an augmentation from this builder's product.L2FibTableBuilder
setL2FibEntry(java.util.List<L2FibEntry> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetL2FibEntry(Map)
instead.L2FibTableBuilder
setL2FibEntry(java.util.Map<L2FibEntryKey,L2FibEntry> values)
-
-
-
Constructor Detail
-
L2FibTableBuilder
public L2FibTableBuilder()
-
L2FibTableBuilder
public L2FibTableBuilder(L2FibTable base)
-
-
Method Detail
-
getL2FibEntry
public java.util.Map<L2FibEntryKey,L2FibEntry> getL2FibEntry()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<L2FibTable>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setL2FibEntry
public L2FibTableBuilder setL2FibEntry(java.util.Map<L2FibEntryKey,L2FibEntry> values)
-
setL2FibEntry
@Deprecated(forRemoval=true) public L2FibTableBuilder setL2FibEntry(java.util.List<L2FibEntry> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetL2FibEntry(Map)
instead.Utility migration setter. IMPORTANT NOTE: This method does not completely match previous mechanics, as the list is processed as during this method's execution. Any future modifications of the list are NOT reflected in this builder nor its products.- Parameters:
values
- Legacy List of values- Returns:
- this builder
- Throws:
java.lang.IllegalArgumentException
- if the list contains entries with the same keyjava.lang.NullPointerException
- if the list contains a null entry
-
addAugmentation
public L2FibTableBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<L2FibTable> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
java.lang.NullPointerException
- ifaugmentation
is null
-
addAugmentation
@Deprecated(forRemoval=true) public L2FibTableBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<L2FibTable>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<L2FibTable> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Add or remove an augmentation to this builder's product.- Parameters:
augmentationType
- augmentation type to be added or removedaugmentationValue
- augmentation value, null if the augmentation type should be removed- Returns:
- this builder
-
removeAugmentation
public L2FibTableBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<L2FibTable>> augmentationType)
Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.- Parameters:
augmentationType
- augmentation type to be removed- Returns:
- this builder
-
build
public L2FibTable build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<L2FibTable>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<L2FibTable,java.lang.IllegalArgumentException>
-
-