Class RpsBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.pcntf.message.pcntf.message.notifications.RpsBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Rps>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Rps,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class RpsBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Rps>
Class that buildsRpsBuilder
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:
RpsBuilder createTarget(int fooXyzzy, int barBaz) { return new RpsBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of RpsBuilder, 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:
RpsBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description RpsBuilder()
RpsBuilder(Rps base)
RpsBuilder(RpObject arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RpsBuilder
addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Rps>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Rps> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Rps>>
E$$augmentation(Class<E$$> augmentationType)
Rps
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.Rp
getRp()
RpsBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Rps>> augmentationType)
RpsBuilder
setRp(Rp value)
-
-
-
Method Detail
-
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:- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.types.rev181109.RpObject
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types
-
getRp
public Rp getRp()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Rps>> E$$ augmentation(Class<E$$> augmentationType)
-
setRp
public RpsBuilder setRp(Rp value)
-
addAugmentation
public RpsBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Rps>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Rps> augmentationValue)
-
removeAugmentation
public RpsBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Rps>> augmentationType)
-
build
public Rps build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Rps>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Rps,IllegalArgumentException>
-
-