Class VrfTablesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.fibentries.VrfTablesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<VrfTables>
,org.opendaylight.yangtools.concepts.CheckedBuilder<VrfTables,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class VrfTablesBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<VrfTables>
Class that buildsVrfTablesBuilder
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:
VrfTablesBuilder createTarget(int fooXyzzy, int barBaz) { return new VrfTablesBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of VrfTablesBuilder, 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:
VrfTablesBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description VrfTablesBuilder()
VrfTablesBuilder(VrfTables base)
VrfTablesBuilder(MacVrfEntries arg)
VrfTablesBuilder(VrfEntries arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description VrfTablesBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VrfTables>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<VrfTables> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.VrfTablesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VrfTables> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VrfTables>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
VrfTables
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.java.util.Map<MacVrfEntryKey,MacVrfEntry>
getMacVrfEntry()
java.lang.String
getRouteDistinguisher()
java.util.Map<VrfEntryKey,VrfEntry>
getVrfEntry()
VrfTablesKey
key()
VrfTablesBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VrfTables>> augmentationType)
Remove an augmentation from this builder's product.VrfTablesBuilder
setMacVrfEntry(java.util.List<MacVrfEntry> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMacVrfEntry(Map)
instead.VrfTablesBuilder
setMacVrfEntry(java.util.Map<MacVrfEntryKey,MacVrfEntry> values)
VrfTablesBuilder
setRouteDistinguisher(java.lang.String value)
VrfTablesBuilder
setVrfEntry(java.util.List<VrfEntry> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetVrfEntry(Map)
instead.VrfTablesBuilder
setVrfEntry(java.util.Map<VrfEntryKey,VrfEntry> values)
VrfTablesBuilder
withKey(VrfTablesKey key)
-
-
-
Constructor Detail
-
VrfTablesBuilder
public VrfTablesBuilder()
-
VrfTablesBuilder
public VrfTablesBuilder(VrfEntries arg)
-
VrfTablesBuilder
public VrfTablesBuilder(MacVrfEntries arg)
-
VrfTablesBuilder
public VrfTablesBuilder(VrfTables 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.netvirt.fibmanager.rev150330.MacVrfEntries
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.VrfEntries
- Parameters:
arg
- grouping object- Throws:
java.lang.IllegalArgumentException
- if given argument is none of valid types
-
key
public VrfTablesKey key()
-
getMacVrfEntry
public java.util.Map<MacVrfEntryKey,MacVrfEntry> getMacVrfEntry()
-
getRouteDistinguisher
public java.lang.String getRouteDistinguisher()
-
getVrfEntry
public java.util.Map<VrfEntryKey,VrfEntry> getVrfEntry()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<VrfTables>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public VrfTablesBuilder withKey(VrfTablesKey key)
-
setMacVrfEntry
public VrfTablesBuilder setMacVrfEntry(java.util.Map<MacVrfEntryKey,MacVrfEntry> values)
-
setMacVrfEntry
@Deprecated(forRemoval=true) public VrfTablesBuilder setMacVrfEntry(java.util.List<MacVrfEntry> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetMacVrfEntry(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
-
setRouteDistinguisher
public VrfTablesBuilder setRouteDistinguisher(java.lang.String value)
-
setVrfEntry
public VrfTablesBuilder setVrfEntry(java.util.Map<VrfEntryKey,VrfEntry> values)
-
setVrfEntry
@Deprecated(forRemoval=true) public VrfTablesBuilder setVrfEntry(java.util.List<VrfEntry> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetVrfEntry(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 VrfTablesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<VrfTables> 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 VrfTablesBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VrfTables>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<VrfTables> 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 VrfTablesBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<VrfTables>> 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
-
-