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