org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.pcep.stats.rev171113.pcep.session.state

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>

public class MessagesBuilder
extends Object
implements org.opendaylight.yangtools.concepts.Builder<Messages>

Class that builds MessagesBuilder 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 and Description
MessagesBuilder()
MessagesBuilder(ErrorMessagesGrouping arg)
MessagesBuilder(Messages base)
MessagesBuilder(ReplyTimeGrouping arg)

Method Summary

Modifier and Type	Method and Description
MessagesBuilder	addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Messages>> augmentationType, org.opendaylight.yangtools.yang.binding.Augmentation<Messages> augmentationValue)
<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()
Long	getLastSentMsgTimestamp()
Long	getReceivedMsgCount()
ReplyTime	getReplyTime()
Long	getSentMsgCount()
Integer	getUnknownMsgReceived()
MessagesBuilder	removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Messages>> augmentationType)
MessagesBuilder	setErrorMessages(ErrorMessages value)
MessagesBuilder	setLastSentMsgTimestamp(Long value)
MessagesBuilder	setReceivedMsgCount(Long value)
MessagesBuilder	setReplyTime(ReplyTime value)
MessagesBuilder	setSentMsgCount(Long value)
MessagesBuilder	setUnknownMsgReceived(Integer value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getErrorMessages

public ErrorMessages getErrorMessages()

getLastSentMsgTimestamp

public Long getLastSentMsgTimestamp()

getReceivedMsgCount

public Long getReceivedMsgCount()

getReplyTime

public ReplyTime getReplyTime()

getSentMsgCount

public Long getSentMsgCount()

getUnknownMsgReceived

public Integer 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(Long value)

setReceivedMsgCount

public MessagesBuilder setReceivedMsgCount(Long value)

setReplyTime

public MessagesBuilder setReplyTime(ReplyTime value)

setSentMsgCount

public MessagesBuilder setSentMsgCount(Long value)

setUnknownMsgReceived

public MessagesBuilder setUnknownMsgReceived(Integer value)

addAugmentation

public MessagesBuilder addAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Messages>> augmentationType,
                                       org.opendaylight.yangtools.yang.binding.Augmentation<Messages> augmentationValue)

removeAugmentation

public MessagesBuilder removeAugmentation(Class<? extends org.opendaylight.yangtools.yang.binding.Augmentation<Messages>> augmentationType)

build

public Messages build()

Specified by:

build in interface org.opendaylight.yangtools.concepts.CheckedBuilder<Messages,IllegalArgumentException>