Class IpPrefixBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.basic.explicit.route.subobjects.subobject.type.ip.prefix._case.IpPrefixBuilder
Class that builds
IpPrefix
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:
IpPrefix createIpPrefix(int fooXyzzy, int barBaz) {
return new IpPrefixBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of IpPrefix, 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 opportunities, 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:
-
Constructor Summary
ConstructorDescriptionConstruct an empty builder.IpPrefixBuilder
(IpPrefix base) Construct a builder initialized with state from specifiedIpPrefix
.Construct a new builder initialized from specifiedCSubobject
.Construct a new builder initialized from specifiedIpPrefixSubobject
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<IpPrefix> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IpPrefix>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull IpPrefix
build()
A newIpPrefix
instance.static @NonNull IpPrefix
empty()
Get empty instance of IpPrefix.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix
Return current value associated with the property corresponding toIpPrefixSubobject.getIpPrefix()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpPrefix>> augmentationType) Remove an augmentation from this builder's product.setIpPrefix
(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value) Set the property corresponding toIpPrefixSubobject.getIpPrefix()
to the specified value.
-
Constructor Details
-
IpPrefixBuilder
public IpPrefixBuilder()Construct an empty builder. -
IpPrefixBuilder
Construct a new builder initialized from specifiedIpPrefixSubobject
.- Parameters:
arg
- IpPrefixSubobject from which the builder should be initialized
-
IpPrefixBuilder
Construct a new builder initialized from specifiedCSubobject
.- Parameters:
arg
- CSubobject from which the builder should be initialized
-
IpPrefixBuilder
Construct a builder initialized with state from specifiedIpPrefix
.- Parameters:
base
- IpPrefix from which the builder should be initialized
-
-
Method Details
-
fieldsFrom
public void fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument. Valid argument is instance of one of following types:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
empty
Get empty instance of IpPrefix.- Returns:
- An empty
IpPrefix
-
getIpPrefix
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix getIpPrefix()Return current value associated with the property corresponding toIpPrefixSubobject.getIpPrefix()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<IpPrefix>> E$$ augmentation(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setIpPrefix
public IpPrefixBuilder setIpPrefix(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpPrefix value) Set the property corresponding toIpPrefixSubobject.getIpPrefix()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public IpPrefixBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<IpPrefix> augmentation) Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public IpPrefixBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<IpPrefix>> 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
A newIpPrefix
instance.- Returns:
- A new
IpPrefix
instance.
-