Class Ipv4PrefixBinaryBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.binary.address.types.rev160504.augmented.lisp.address.address.Ipv4PrefixBinaryBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Ipv4PrefixBinary>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Ipv4PrefixBinary,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class Ipv4PrefixBinaryBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<Ipv4PrefixBinary>
Class that buildsIpv4PrefixBinaryBuilder
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:
Ipv4PrefixBinaryBuilder createTarget(int fooXyzzy, int barBaz) { return new Ipv4PrefixBinaryBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Ipv4PrefixBinaryBuilder, 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:
Ipv4PrefixBinaryBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description Ipv4PrefixBinaryBuilder()
Ipv4PrefixBinaryBuilder(Ipv4PrefixBinary base)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Ipv4PrefixBinaryBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4PrefixBinary>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4PrefixBinary> augmentationValue)
Deprecated, for removal: This API element is subject to removal in a future version.Use eitheraddAugmentation(Augmentation)
orremoveAugmentation(Class)
instead.Ipv4PrefixBinaryBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4PrefixBinary> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4PrefixBinary>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
Ipv4PrefixBinary
build()
Ipv4AddressBinary
getIpv4AddressBinary()
org.opendaylight.yangtools.yang.common.Uint8
getIpv4MaskLength()
Ipv4PrefixBinaryBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4PrefixBinary>> augmentationType)
Remove an augmentation from this builder's product.Ipv4PrefixBinaryBuilder
setIpv4AddressBinary(Ipv4AddressBinary value)
Ipv4PrefixBinaryBuilder
setIpv4MaskLength(java.lang.Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIpv4MaskLength(Uint8)
instead.Ipv4PrefixBinaryBuilder
setIpv4MaskLength(org.opendaylight.yangtools.yang.common.Uint8 value)
-
-
-
Constructor Detail
-
Ipv4PrefixBinaryBuilder
public Ipv4PrefixBinaryBuilder()
-
Ipv4PrefixBinaryBuilder
public Ipv4PrefixBinaryBuilder(Ipv4PrefixBinary base)
-
-
Method Detail
-
getIpv4AddressBinary
public Ipv4AddressBinary getIpv4AddressBinary()
-
getIpv4MaskLength
public org.opendaylight.yangtools.yang.common.Uint8 getIpv4MaskLength()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4PrefixBinary>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setIpv4AddressBinary
public Ipv4PrefixBinaryBuilder setIpv4AddressBinary(Ipv4AddressBinary value)
-
setIpv4MaskLength
public Ipv4PrefixBinaryBuilder setIpv4MaskLength(org.opendaylight.yangtools.yang.common.Uint8 value)
-
setIpv4MaskLength
@Deprecated(forRemoval=true) public Ipv4PrefixBinaryBuilder setIpv4MaskLength(java.lang.Short value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetIpv4MaskLength(Uint8)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public Ipv4PrefixBinaryBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4PrefixBinary> 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 Ipv4PrefixBinaryBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4PrefixBinary>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4PrefixBinary> 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 Ipv4PrefixBinaryBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Ipv4PrefixBinary>> 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 Ipv4PrefixBinary build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Ipv4PrefixBinary>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Ipv4PrefixBinary,java.lang.IllegalArgumentException>
-
-