Class MessagesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.stats.rev171113.pcep.session.state.MessagesBuilder
-
- All Implemented Interfaces:
org.opendaylight.yangtools.concepts.Builder<Messages>
,org.opendaylight.yangtools.concepts.CheckedBuilder<Messages,IllegalArgumentException>
,org.opendaylight.yangtools.concepts.Mutable
,org.opendaylight.yangtools.concepts.MutationBehaviour<org.opendaylight.yangtools.concepts.Mutable>
@Generated("mdsal-binding-generator") public class MessagesBuilder extends Object implements org.opendaylight.yangtools.concepts.Builder<Messages>
Class that buildsMessagesBuilder
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:
MessagesBuilder createTarget(int fooXyzzy, int barBaz) { return new MessagesBuilderBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of MessagesBuilder, 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:
MessagesBuilder
,Builder
-
-
Constructor Summary
Constructors Constructor Description MessagesBuilder()
MessagesBuilder(ErrorMessagesGrouping arg)
MessagesBuilder(Messages base)
MessagesBuilder(ReplyTimeGrouping arg)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description MessagesBuilder
addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Messages> augmentation)
Add an augmentation to this builder's product.<E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Messages>>
E$$augmentation(Class<E$$> augmentationType)
Messages
build()
void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.ErrorMessages
getErrorMessages()
org.opendaylight.yangtools.yang.common.Uint32
getLastSentMsgTimestamp()
org.opendaylight.yangtools.yang.common.Uint32
getReceivedMsgCount()
ReplyTime
getReplyTime()
org.opendaylight.yangtools.yang.common.Uint32
getSentMsgCount()
org.opendaylight.yangtools.yang.common.Uint16
getUnknownMsgReceived()
MessagesBuilder
removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Messages>> augmentationType)
Remove an augmentation from this builder's product.MessagesBuilder
setErrorMessages(ErrorMessages value)
MessagesBuilder
setLastSentMsgTimestamp(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetLastSentMsgTimestamp(Uint32)
instead.MessagesBuilder
setLastSentMsgTimestamp(org.opendaylight.yangtools.yang.common.Uint32 value)
MessagesBuilder
setReceivedMsgCount(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetReceivedMsgCount(Uint32)
instead.MessagesBuilder
setReceivedMsgCount(org.opendaylight.yangtools.yang.common.Uint32 value)
MessagesBuilder
setReplyTime(ReplyTime value)
MessagesBuilder
setSentMsgCount(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSentMsgCount(Uint32)
instead.MessagesBuilder
setSentMsgCount(org.opendaylight.yangtools.yang.common.Uint32 value)
MessagesBuilder
setUnknownMsgReceived(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetUnknownMsgReceived(Uint16)
instead.MessagesBuilder
setUnknownMsgReceived(org.opendaylight.yangtools.yang.common.Uint16 value)
-
-
-
Constructor Detail
-
MessagesBuilder
public MessagesBuilder()
-
MessagesBuilder
public MessagesBuilder(ReplyTimeGrouping arg)
-
MessagesBuilder
public MessagesBuilder(ErrorMessagesGrouping arg)
-
MessagesBuilder
public MessagesBuilder(Messages 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.stats.rev171113.ReplyTimeGrouping
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.stats.rev171113.ErrorMessagesGrouping
- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getErrorMessages
public ErrorMessages getErrorMessages()
-
getLastSentMsgTimestamp
public org.opendaylight.yangtools.yang.common.Uint32 getLastSentMsgTimestamp()
-
getReceivedMsgCount
public org.opendaylight.yangtools.yang.common.Uint32 getReceivedMsgCount()
-
getReplyTime
public ReplyTime getReplyTime()
-
getSentMsgCount
public org.opendaylight.yangtools.yang.common.Uint32 getSentMsgCount()
-
getUnknownMsgReceived
public org.opendaylight.yangtools.yang.common.Uint16 getUnknownMsgReceived()
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Messages>> E$$ augmentation(Class<E$$> augmentationType)
-
setErrorMessages
public MessagesBuilder setErrorMessages(ErrorMessages value)
-
setLastSentMsgTimestamp
public MessagesBuilder setLastSentMsgTimestamp(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setLastSentMsgTimestamp
@Deprecated(forRemoval=true) public MessagesBuilder setLastSentMsgTimestamp(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetLastSentMsgTimestamp(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setReceivedMsgCount
public MessagesBuilder setReceivedMsgCount(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setReceivedMsgCount
@Deprecated(forRemoval=true) public MessagesBuilder setReceivedMsgCount(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetReceivedMsgCount(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setReplyTime
public MessagesBuilder setReplyTime(ReplyTime value)
-
setSentMsgCount
public MessagesBuilder setSentMsgCount(org.opendaylight.yangtools.yang.common.Uint32 value)
-
setSentMsgCount
@Deprecated(forRemoval=true) public MessagesBuilder setSentMsgCount(Long value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetSentMsgCount(Uint32)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
setUnknownMsgReceived
public MessagesBuilder setUnknownMsgReceived(org.opendaylight.yangtools.yang.common.Uint16 value)
-
setUnknownMsgReceived
@Deprecated(forRemoval=true) public MessagesBuilder setUnknownMsgReceived(Integer value)
Deprecated, for removal: This API element is subject to removal in a future version.UsesetUnknownMsgReceived(Uint16)
instead.Utility migration setter.- Parameters:
value
- field value in legacy type- Returns:
- this builder
-
addAugmentation
public MessagesBuilder addAugmentation(org.opendaylight.yangtools.yang.binding.Augmentation<Messages> augmentation)
Add an augmentation to this builder's product.- Parameters:
augmentation
- augmentation to be added- Returns:
- this builder
- Throws:
NullPointerException
- ifaugmentation
is null
-
removeAugmentation
public MessagesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Messages>> augmentationType)
Remove an augmentation from this builder's product. If this builder does not track such an augmentation type, this method does nothing.- Parameters:
augmentationType
- augmentation type to be removed- Returns:
- this builder
-
build
public Messages build()
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.Builder<Messages>
- Specified by:
build
in interfaceorg.opendaylight.yangtools.concepts.CheckedBuilder<Messages,IllegalArgumentException>
-
-