Class MessagesBuilder
- java.lang.Object
-
- org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.stats.rev171113.pcep.session.state.MessagesBuilder
-
@Generated("mdsal-binding-generator") public class MessagesBuilder extends Object
Class that buildsMessages
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:
Messages createMessages(int fooXyzzy, int barBaz) { return new MessagesBuilder() .setFoo(new FooBuilder().setXyzzy(fooXyzzy).build()) .setBar(new BarBuilder().setBaz(barBaz).build()) .build(); }
This pattern is supported by the immutable nature of Messages, 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 opportunities, 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:
Messages
- 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
-
-
Constructor Summary
Constructors Constructor Description MessagesBuilder()
Construct an empty builder.MessagesBuilder(ErrorMessagesGrouping arg)
Construct a new builder initialized from specifiedErrorMessagesGrouping
.MessagesBuilder(Messages base)
Construct a builder initialized with state from specifiedMessages
.MessagesBuilder(ReplyTimeGrouping arg)
Construct a new builder initialized from specifiedReplyTimeGrouping
.
-
Method Summary
All Methods Instance Methods Concrete 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)
Return the specified augmentation, if it is present in this builder.@NonNull Messages
build()
A newMessages
instance.void
fieldsFrom(org.opendaylight.yangtools.yang.binding.DataObject arg)
Set fields from given grouping argument.ErrorMessages
getErrorMessages()
Return current value associated with the property corresponding toErrorMessagesGrouping.getErrorMessages()
.org.opendaylight.yangtools.yang.common.Uint32
getLastSentMsgTimestamp()
Return current value associated with the property corresponding toMessages.getLastSentMsgTimestamp()
.org.opendaylight.yangtools.yang.common.Uint32
getReceivedMsgCount()
Return current value associated with the property corresponding toMessages.getReceivedMsgCount()
.ReplyTime
getReplyTime()
Return current value associated with the property corresponding toReplyTimeGrouping.getReplyTime()
.org.opendaylight.yangtools.yang.common.Uint32
getSentMsgCount()
Return current value associated with the property corresponding toMessages.getSentMsgCount()
.org.opendaylight.yangtools.yang.common.Uint16
getUnknownMsgReceived()
Return current value associated with the property corresponding toMessages.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)
Set the property corresponding toErrorMessagesGrouping.getErrorMessages()
to the specified value.MessagesBuilder
setLastSentMsgTimestamp(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toMessages.getLastSentMsgTimestamp()
to the specified value.MessagesBuilder
setReceivedMsgCount(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toMessages.getReceivedMsgCount()
to the specified value.MessagesBuilder
setReplyTime(ReplyTime value)
Set the property corresponding toReplyTimeGrouping.getReplyTime()
to the specified value.MessagesBuilder
setSentMsgCount(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toMessages.getSentMsgCount()
to the specified value.MessagesBuilder
setUnknownMsgReceived(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toMessages.getUnknownMsgReceived()
to the specified value.
-
-
-
Constructor Detail
-
MessagesBuilder
public MessagesBuilder()
Construct an empty builder.
-
MessagesBuilder
public MessagesBuilder(ReplyTimeGrouping arg)
Construct a new builder initialized from specifiedReplyTimeGrouping
.- Parameters:
arg
- ReplyTimeGrouping from which the builder should be initialized
-
MessagesBuilder
public MessagesBuilder(ErrorMessagesGrouping arg)
Construct a new builder initialized from specifiedErrorMessagesGrouping
.- Parameters:
arg
- ErrorMessagesGrouping from which the builder should be initialized
-
-
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:- Parameters:
arg
- grouping object- Throws:
IllegalArgumentException
- if given argument is none of valid types or has property with incompatible value
-
getErrorMessages
public ErrorMessages getErrorMessages()
Return current value associated with the property corresponding toErrorMessagesGrouping.getErrorMessages()
.- Returns:
- current value
-
getLastSentMsgTimestamp
public org.opendaylight.yangtools.yang.common.Uint32 getLastSentMsgTimestamp()
Return current value associated with the property corresponding toMessages.getLastSentMsgTimestamp()
.- Returns:
- current value
-
getReceivedMsgCount
public org.opendaylight.yangtools.yang.common.Uint32 getReceivedMsgCount()
Return current value associated with the property corresponding toMessages.getReceivedMsgCount()
.- Returns:
- current value
-
getReplyTime
public ReplyTime getReplyTime()
Return current value associated with the property corresponding toReplyTimeGrouping.getReplyTime()
.- Returns:
- current value
-
getSentMsgCount
public org.opendaylight.yangtools.yang.common.Uint32 getSentMsgCount()
Return current value associated with the property corresponding toMessages.getSentMsgCount()
.- Returns:
- current value
-
getUnknownMsgReceived
public org.opendaylight.yangtools.yang.common.Uint16 getUnknownMsgReceived()
Return current value associated with the property corresponding toMessages.getUnknownMsgReceived()
.- Returns:
- current value
-
augmentation
public <E$$ extends org.opendaylight.yangtools.yang.binding.Augmentation<Messages>> E$$ augmentation(Class<E$$> augmentationType)
Return the specified augmentation, if it is present in this builder.- Type Parameters:
E$$
- augmentation type- Parameters:
augmentationType
- augmentation type class- Returns:
- Augmentation object from this builder, or
null
if not present - Throws:
NullPointerException
- ifaugmentType
isnull
-
setErrorMessages
public MessagesBuilder setErrorMessages(ErrorMessages value)
Set the property corresponding toErrorMessagesGrouping.getErrorMessages()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setLastSentMsgTimestamp
public MessagesBuilder setLastSentMsgTimestamp(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toMessages.getLastSentMsgTimestamp()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setReceivedMsgCount
public MessagesBuilder setReceivedMsgCount(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toMessages.getReceivedMsgCount()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setReplyTime
public MessagesBuilder setReplyTime(ReplyTime value)
Set the property corresponding toReplyTimeGrouping.getReplyTime()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setSentMsgCount
public MessagesBuilder setSentMsgCount(org.opendaylight.yangtools.yang.common.Uint32 value)
Set the property corresponding toMessages.getSentMsgCount()
to the specified value.- Parameters:
value
- desired value- Returns:
- this builder
-
setUnknownMsgReceived
public MessagesBuilder setUnknownMsgReceived(org.opendaylight.yangtools.yang.common.Uint16 value)
Set the property corresponding toMessages.getUnknownMsgReceived()
to the specified value.- Parameters:
value
- desired value- 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
-
-