Class Ipv4TableBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.fibentries.Ipv4TableBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Ipv4Table>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Ipv4Table,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class Ipv4TableBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<Ipv4Table>
Class that buildsIpv4TableBuilder
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:
Ipv4TableBuilder createTarget(int fooXyzzy, int barBaz) { return new Ipv4TableBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Ipv4TableBuilder, 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:
Ipv4TableBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description Ipv4TableBuilder()
Ipv4TableBuilder(Ipv4Table base)
Ipv4TableBuilder(Ipv4Entries arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Ipv4TableBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Table> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Table>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Ipv4Table
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.java.util.Map<Ipv4EntryKey,Ipv4Entry>
getIpv4Entry()
Ipv4TableBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Table>> augmentationType)
Remove an augmentation from this builder's product.Ipv4TableBuilder
setIpv4Entry(java.util.List<Ipv4Entry> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIpv4Entry(Map)
instead.Ipv4TableBuilder
setIpv4Entry(java.util.Map<Ipv4EntryKey,Ipv4Entry> values)
-
-
-
Constructor Detail
-
Ipv4TableBuilder
public Ipv4TableBuilder()
-
Ipv4TableBuilder
public Ipv4TableBuilder(Ipv4Entries arg)
-
Ipv4TableBuilder
public Ipv4TableBuilder(Ipv4Table 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.Ipv4Entries
- Parameters:
arg
- grouping object- Throws:
java.lang.IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getIpv4Entry
public java.util.Map<Ipv4EntryKey,Ipv4Entry> getIpv4Entry()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Table>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setIpv4Entry
public Ipv4TableBuilder setIpv4Entry(java.util.Map<Ipv4EntryKey,Ipv4Entry> values)
-
setIpv4Entry
@Deprecated(forRemoval=true) public Ipv4TableBuilder setIpv4Entry(java.util.List<Ipv4Entry> values)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIpv4Entry(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 Ipv4TableBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Table> 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
-
removeAugmentation
public Ipv4TableBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Table>> 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
-
-