Class DestinationIpv4CaseBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bgp.test.rev180515.update.attributes.mp.unreach.nlri.withdrawn.routes.destination.type.DestinationIpv4CaseBuilder
Class that builds
DestinationIpv4Case
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:
DestinationIpv4Case createDestinationIpv4Case(int fooXyzzy, int barBaz) {
return new DestinationIpv4CaseBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of DestinationIpv4Case, 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.Construct a new builder initialized from specifiedIpv4Prefixes
.Construct a builder initialized with state from specifiedDestinationIpv4Case
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.yang.binding.Augmentation<DestinationIpv4Case> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationIpv4Case>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull DestinationIpv4Case
build()
A newDestinationIpv4Case
instance.void
fieldsFrom
(org.opendaylight.yangtools.yang.binding.DataObject arg) Set fields from given grouping argument.Return current value associated with the property corresponding toIpv4Prefixes.getDestinationIpv4()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationIpv4Case>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toIpv4Prefixes.getDestinationIpv4()
to the specified value.
-
Constructor Details
-
DestinationIpv4CaseBuilder
public DestinationIpv4CaseBuilder()Construct an empty builder. -
DestinationIpv4CaseBuilder
Construct a new builder initialized from specifiedIpv4Prefixes
.- Parameters:
arg
- Ipv4Prefixes from which the builder should be initialized
-
DestinationIpv4CaseBuilder
Construct a builder initialized with state from specifiedDestinationIpv4Case
.- Parameters:
base
- DestinationIpv4Case 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
-
getDestinationIpv4
Return current value associated with the property corresponding toIpv4Prefixes.getDestinationIpv4()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationIpv4Case>> 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
-
setDestinationIpv4
Set the property corresponding toIpv4Prefixes.getDestinationIpv4()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
addAugmentation
public DestinationIpv4CaseBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<DestinationIpv4Case> 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 DestinationIpv4CaseBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<DestinationIpv4Case>> 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 newDestinationIpv4Case
instance.- Returns:
- A new
DestinationIpv4Case
instance.
-