Class Ipv4DetourObjectBuilder
java.lang.Object
org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.detour.object.detour.object.Ipv4DetourObjectBuilder
Class that builds
Ipv4DetourObject
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:
Ipv4DetourObject createIpv4DetourObject(int fooXyzzy, int barBaz) {
return new Ipv4DetourObjectBuilder()
.setFoo(new FooBuilder().setXyzzy(fooXyzzy).build())
.setBar(new BarBuilder().setBaz(barBaz).build())
.build();
}
This pattern is supported by the immutable nature of Ipv4DetourObject, 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 builder initialized with state from specifiedIpv4DetourObject
. -
Method Summary
Modifier and TypeMethodDescriptionaddAugmentation
(org.opendaylight.yangtools.binding.Augmentation<Ipv4DetourObject> augmentation) Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.binding.Augmentation<Ipv4DetourObject>>
E$$augmentation
(Class<E$$> augmentationType) Return the specified augmentation, if it is present in this builder.@NonNull Ipv4DetourObject
build()
A newIpv4DetourObject
instance.getPlr()
Return current value associated with the property corresponding toIpv4DetourObject.getPlr()
.removeAugmentation
(Class<? extends org.opendaylight.yangtools.binding.Augmentation<Ipv4DetourObject>> augmentationType) Remove an augmentation from this builder's product.Set the property corresponding toIpv4DetourObject.getPlr()
to the specified value.
-
Constructor Details
-
Ipv4DetourObjectBuilder
public Ipv4DetourObjectBuilder()Construct an empty builder. -
Ipv4DetourObjectBuilder
Construct a builder initialized with state from specifiedIpv4DetourObject
.- Parameters:
base
- Ipv4DetourObject from which the builder should be initialized
-
-
Method Details
-
getPlr
Return current value associated with the property corresponding toIpv4DetourObject.getPlr()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.binding.Augmentation<Ipv4DetourObject>> 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
-
setPlr
Set the property corresponding toIpv4DetourObject.getPlr()
to the specified value.- Parameters:
values
- desired value- Returns:
- this builder
-
addAugmentation
public Ipv4DetourObjectBuilder addAugmentation(org.opendaylight.yangtools.binding.Augmentation<Ipv4DetourObject> 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 Ipv4DetourObjectBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.binding.Augmentation<Ipv4DetourObject>> 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 newIpv4DetourObject
instance.- Returns:
- A new
Ipv4DetourObject
instance.
-