Package org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.router.af.configuration
Class Ipv4Builder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.router.af.configuration.Ipv4Builder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Ipv4>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Ipv4,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class Ipv4Builder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<Ipv4>
Class that buildsIpv4Builder
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:
Ipv4Builder createTarget(int fooXyzzy, int barBaz) { return new Ipv4BuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Ipv4Builder, 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:
Ipv4Builder
,Builder
-
-
Constructor Summary
Constructors Constructor Description Ipv4Builder()
Ipv4Builder(Ipv4 base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Ipv4Builder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Ipv4Builder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Ipv4
build()
Mdt
getMdt()
Multicast
getMulticast()
Mvpn
getMvpn()
Unicast
getUnicast()
Ipv4Builder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4>> augmentationType)
Remove an augmentation from this builder's product.Ipv4Builder
setMdt(Mdt value)
Ipv4Builder
setMulticast(Multicast value)
Ipv4Builder
setMvpn(Mvpn value)
Ipv4Builder
setUnicast(Unicast value)
-
-
-
Constructor Detail
-
Ipv4Builder
public Ipv4Builder()
-
Ipv4Builder
public Ipv4Builder(Ipv4 base)
-
-
Method Detail
-
getMdt
public Mdt getMdt()
-
getMulticast
public Multicast getMulticast()
-
getMvpn
public Mvpn getMvpn()
-
getUnicast
public Unicast getUnicast()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setMdt
public Ipv4Builder setMdt(Mdt value)
-
setMulticast
public Ipv4Builder setMulticast(Multicast value)
-
setMvpn
public Ipv4Builder setMvpn(Mvpn value)
-
setUnicast
public Ipv4Builder setUnicast(Unicast value)
-
addAugmentation
public Ipv4Builder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4> 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 Ipv4Builder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4> 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 Ipv4Builder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4>> 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
-
-