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