Class PlrBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.rsvp.rev150820.detour.object.detour.object.ipv4.detour.object.PlrBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Plr>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Plr,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class PlrBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Plr>
Class that buildsPlr
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:
Plr createPlr(int fooXyzzy, int barBaz) { return new PlrBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Plr, 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:
Plr
,Builder
-
-
Constructor Summary
Constructors Constructor Description PlrBuilder()
PlrBuilder(Plr base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PlrBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Plr> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Plr>>
E$$augmentation(Class<E$$> augmentationType)
Plr
build()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone
getAvoidNode()
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone
getPlrId()
PlrBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Plr>> augmentationType)
Remove an augmentation from this builder's product.PlrBuilder
setAvoidNode(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
PlrBuilder
setPlrId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
-
-
-
Constructor Detail
-
PlrBuilder
public PlrBuilder()
-
PlrBuilder
public PlrBuilder(Plr base)
-
-
Method Detail
-
getAvoidNode
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone getAvoidNode()
-
getPlrId
public org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone getPlrId()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Plr>> E$$ augmentation(Class<E$$> augmentationType)
-
setAvoidNode
public PlrBuilder setAvoidNode(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
-
setPlrId
public PlrBuilder setPlrId(org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone value)
-
addAugmentation
public PlrBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Plr> 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 PlrBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Plr>> 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
public Plr build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Plr>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Plr,IllegalArgumentException>
-
-