Class ControlMessageBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.sb.rev150904.ctrl.msg.stats.ControlMessageBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<ControlMessage>
,org.opendaylight.yangtools.concepts.CheckedBuilder<ControlMessage,java.lang.IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
public class ControlMessageBuilder extends java.lang.Object implements org.opendaylight.yangtools.concepts.Builder<ControlMessage>
Class that buildsControlMessageBuilder
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:
ControlMessageBuilder createTarget(int fooXyzzy, int barBaz) { return new ControlMessageBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of ControlMessageBuilder, 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:
ControlMessageBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description ControlMessageBuilder()
ControlMessageBuilder(ControlMessage base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ControlMessageBuilder
addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ControlMessage>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<ControlMessage> augmentationValue)
<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ControlMessage>>
E$$augmentation(java.lang.Class<E$$> augmentationType)
ControlMessage
build()
MessageType
getMsgType()
java.lang.Long
getRxCount()
java.lang.Long
getTxCount()
ControlMessageBuilder
removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ControlMessage>> augmentationType)
ControlMessageBuilder
setMsgType(MessageType value)
ControlMessageBuilder
setRxCount(java.lang.Long value)
ControlMessageBuilder
setTxCount(java.lang.Long value)
-
-
-
Constructor Detail
-
ControlMessageBuilder
public ControlMessageBuilder()
-
ControlMessageBuilder
public ControlMessageBuilder(ControlMessage base)
-
-
Method Detail
-
getMsgType
public MessageType getMsgType()
-
getRxCount
public java.lang.Long getRxCount()
-
getTxCount
public java.lang.Long getTxCount()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<ControlMessage>> E$$ augmentation(java.lang.Class<E$$> augmentationType)
-
setMsgType
public ControlMessageBuilder setMsgType(MessageType value)
-
setRxCount
public ControlMessageBuilder setRxCount(java.lang.Long value)
-
setTxCount
public ControlMessageBuilder setTxCount(java.lang.Long value)
-
addAugmentation
public ControlMessageBuilder addAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ControlMessage>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<ControlMessage> augmentationValue)
-
removeAugmentation
public ControlMessageBuilder removeAugmentation(java.lang.Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<ControlMessage>> augmentationType)
-
build
public ControlMessage build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<ControlMessage>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<ControlMessage,java.lang.IllegalArgumentException>
-
-