Class IpAddressesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.l3vpn.rev130911.vpn.instance.op.data.vpn.instance.op.data.entry.vpn.to.dpn.list.IpAddressesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<IpAddresses>
,org.opendaylight.yangtools.concepts.CheckedBuilder<IpAddresses,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class IpAddressesBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<IpAddresses>
Class that buildsIpAddressesBuilder
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:
IpAddressesBuilder createTarget(int fooXyzzy, int barBaz) { return new IpAddressesBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of IpAddressesBuilder, 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:
IpAddressesBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description IpAddressesBuilder()
IpAddressesBuilder(IpAddresses base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IpAddressesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IpAddresses> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IpAddresses>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
IpAddresses
build()
java.lang.String
getIpAddress()
IpAddresses.IpAddressSource
getIpAddressSource()
IpAddressesKey
key()
IpAddressesBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpAddresses>> augmentationType)
Remove an augmentation from this builder's product.IpAddressesBuilder
setIpAddress(java.lang.String value)
IpAddressesBuilder
setIpAddressSource(IpAddresses.IpAddressSource value)
IpAddressesBuilder
withKey(IpAddressesKey key)
-
-
-
Constructor Detail
-
IpAddressesBuilder
public IpAddressesBuilder()
-
IpAddressesBuilder
public IpAddressesBuilder(IpAddresses base)
-
-
Method Detail
-
key
public IpAddressesKey key()
-
getIpAddress
public java.lang.String getIpAddress()
-
getIpAddressSource
public IpAddresses.IpAddressSource getIpAddressSource()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IpAddresses>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
withKey
public IpAddressesBuilder withKey(IpAddressesKey key)
-
setIpAddress
public IpAddressesBuilder setIpAddress(java.lang.String value)
-
setIpAddressSource
public IpAddressesBuilder setIpAddressSource(IpAddresses.IpAddressSource value)
-
addAugmentation
public IpAddressesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IpAddresses> 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 IpAddressesBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpAddresses>> 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 IpAddresses build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<IpAddresses>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<IpAddresses,java.lang.IllegalArgumentException>
-
-