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