Class Ipv4EntryBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.fibmanager.rev150330.ipv4entries.Ipv4EntryBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Ipv4Entry>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Ipv4Entry,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class Ipv4EntryBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<Ipv4Entry>
Class that buildsIpv4EntryBuilder
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:
Ipv4EntryBuilder createTarget(int fooXyzzy, int barBaz) { return new Ipv4EntryBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Ipv4EntryBuilder, 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:
Ipv4EntryBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description Ipv4EntryBuilder()
Ipv4EntryBuilder(Ipv4Entry base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Ipv4EntryBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Entry> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Entry>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Ipv4Entry
build()
java.lang.String
getDestPrefix()
java.lang.String
getNextHopAddress()
Ipv4EntryKey
key()
Ipv4EntryBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Entry>> augmentationType)
Remove an augmentation from this builder's product.Ipv4EntryBuilder
setDestPrefix(java.lang.String value)
Ipv4EntryBuilder
setNextHopAddress(java.lang.String value)
Ipv4EntryBuilder
withKey(Ipv4EntryKey key)
-
-
-
Constructor Detail
-
Ipv4EntryBuilder
public Ipv4EntryBuilder()
-
Ipv4EntryBuilder
public Ipv4EntryBuilder(Ipv4Entry base)
-
-
Method Detail
-
key
public Ipv4EntryKey key()
-
getDestPrefix
public java.lang.String getDestPrefix()
-
getNextHopAddress
public java.lang.String getNextHopAddress()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Entry>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public Ipv4EntryBuilder withKey(Ipv4EntryKey key)
-
setDestPrefix
public Ipv4EntryBuilder setDestPrefix(java.lang.String value)
-
setNextHopAddress
public Ipv4EntryBuilder setNextHopAddress(java.lang.String value)
-
addAugmentation
public Ipv4EntryBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Entry> 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 Ipv4EntryBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Entry>> 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
-
-