Class IpAddressBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.prefix.lists.prefix.list.prefixes.prefix.prefix.filter.ip.address.group.IpAddressBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<IpAddress>
,org.opendaylight.yangtools.concepts.CheckedBuilder<IpAddress,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class IpAddressBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<IpAddress>
Class that buildsIpAddressBuilder
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:
IpAddressBuilder createTarget(int fooXyzzy, int barBaz) { return new IpAddressBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of IpAddressBuilder, 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:
IpAddressBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description IpAddressBuilder()
IpAddressBuilder(IpAddress base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IpAddressBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IpAddress> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IpAddress>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
IpAddress
build()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
getIpAddress()
IpAddressBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpAddress>> augmentationType)
Remove an augmentation from this builder's product.IpAddressBuilder
setIpAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
-
-
-
Constructor Detail
-
IpAddressBuilder
public IpAddressBuilder()
-
IpAddressBuilder
public IpAddressBuilder(IpAddress base)
-
-
Method Detail
-
getIpAddress
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getIpAddress()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IpAddress>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setIpAddress
public IpAddressBuilder setIpAddress(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress value)
-
addAugmentation
public IpAddressBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IpAddress> 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 IpAddressBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpAddress>> 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
-
-