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