Class Ipv4PrefixBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.Ipv4PrefixBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Ipv4Prefix>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Ipv4Prefix,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class Ipv4PrefixBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<Ipv4Prefix>
Class that buildsIpv4PrefixBuilder
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:
Ipv4PrefixBuilder createTarget(int fooXyzzy, int barBaz) { return new Ipv4PrefixBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Ipv4PrefixBuilder, 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:
Ipv4PrefixBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description Ipv4PrefixBuilder()
Ipv4PrefixBuilder(Ipv4Prefix base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Ipv4PrefixBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Prefix>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Prefix> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Ipv4PrefixBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Prefix> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Prefix>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Ipv4Prefix
build()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix
getIpv4Prefix()
Ipv4PrefixBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Prefix>> augmentationType)
Remove an augmentation from this builder's product.Ipv4PrefixBuilder
setIpv4Prefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix value)
-
-
-
Constructor Detail
-
Ipv4PrefixBuilder
public Ipv4PrefixBuilder()
-
Ipv4PrefixBuilder
public Ipv4PrefixBuilder(Ipv4Prefix base)
-
-
Method Detail
-
getIpv4Prefix
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix getIpv4Prefix()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Prefix>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setIpv4Prefix
public Ipv4PrefixBuilder setIpv4Prefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix value)
-
addAugmentation
public Ipv4PrefixBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Prefix> 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 Ipv4PrefixBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Prefix>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Prefix> 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 Ipv4PrefixBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4Prefix>> 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 Ipv4Prefix build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Ipv4Prefix>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Ipv4Prefix,java.lang.IllegalArgumentException>
-
-