com.exonum.binding.common.message

Class Message.Builder

java.lang.Object

com.exonum.binding.common.message.Message.Builder

Enclosing interface:

Message

public static class Message.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
Message	build() Returns a newly-created Message based on the contents of the Builder.
Message	buildPartial() Returns a newly-created partial Message for use in unit tests.
BinaryMessage	buildRaw()
Message.Builder	clear() Resets the state of this builder.
static Message.Builder	from(Message value) Creates a new builder using value as a template.
java.nio.ByteBuffer	getBody() Returns the value that will be returned by Message.getBody().
short	getMessageType() Returns the value that will be returned by Message.getMessageType().
byte	getNetworkId() Returns the value that will be returned by Message.getNetworkId().
short	getServiceId() Returns the value that will be returned by Message.getServiceId().
byte[]	getSignature() Returns the value that will be returned by Message.getSignature().
byte	getVersion() Returns the value that will be returned by Message.getVersion().
Message.Builder	mergeFrom(Message.Builder template) Copies values from the given Builder.
Message.Builder	mergeFrom(Message value) Sets all property values using the given Message as a template.
Message.Builder	setBody(byte[] body) Sets the message body.
Message.Builder	setBody(java.nio.ByteBuffer body) Sets the value to be returned by Message.getBody().
Message.Builder	setMessageType(short messageType) Sets the value to be returned by Message.getMessageType().
Message.Builder	setNetworkId(byte networkId) Sets the value to be returned by Message.getNetworkId().
Message.Builder	setServiceId(short serviceId) Sets the value to be returned by Message.getServiceId().
Message.Builder	setSignature(byte[] signature) Sets the value to be returned by Message.getSignature().
Message.Builder	setVersion(byte version) Sets the value to be returned by Message.getVersion().

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

setBody

public Message.Builder setBody(byte[] body)

Sets the message body.

Returns:

this Builder object

Throws:

java.lang.NullPointerException - if body is null

setBody

public Message.Builder setBody(java.nio.ByteBuffer body)

Sets the value to be returned by Message.getBody().

Returns:

this Builder object

setSignature

public Message.Builder setSignature(byte[] signature)

Sets the value to be returned by Message.getSignature().

Returns:

this Builder object

buildRaw

public BinaryMessage buildRaw()

from

public static Message.Builder from(Message value)

Creates a new builder using value as a template.

setNetworkId

public Message.Builder setNetworkId(byte networkId)

Sets the value to be returned by Message.getNetworkId().

Returns:

this Builder object

getNetworkId

public byte getNetworkId()

Returns the value that will be returned by Message.getNetworkId().

Throws:

java.lang.IllegalStateException - if the field has not been set

setVersion

public Message.Builder setVersion(byte version)

Sets the value to be returned by Message.getVersion().

Returns:

this Builder object

getVersion

public byte getVersion()

Returns the value that will be returned by Message.getVersion().

Throws:

java.lang.IllegalStateException - if the field has not been set

setServiceId

public Message.Builder setServiceId(short serviceId)

Sets the value to be returned by Message.getServiceId().

Returns:

this Builder object

getServiceId

public short getServiceId()

Returns the value that will be returned by Message.getServiceId().

Throws:

java.lang.IllegalStateException - if the field has not been set

setMessageType

public Message.Builder setMessageType(short messageType)

Sets the value to be returned by Message.getMessageType().

Returns:

this Builder object

getMessageType

public short getMessageType()

Returns the value that will be returned by Message.getMessageType().

Throws:

java.lang.IllegalStateException - if the field has not been set

getBody

public java.nio.ByteBuffer getBody()

Returns the value that will be returned by Message.getBody().

Throws:

java.lang.IllegalStateException - if the field has not been set

getSignature

public byte[] getSignature()

Returns the value that will be returned by Message.getSignature().

Throws:

java.lang.IllegalStateException - if the field has not been set

mergeFrom

public Message.Builder mergeFrom(Message value)

Sets all property values using the given Message as a template.

mergeFrom

public Message.Builder mergeFrom(Message.Builder template)

Copies values from the given Builder. Does not affect any properties not set on the input.

clear

public Message.Builder clear()

Resets the state of this builder.

build

public Message build()

Returns a newly-created Message based on the contents of the Builder.

Throws:

java.lang.IllegalStateException - if any field has not been set

buildPartial

public Message buildPartial()

Returns a newly-created partial Message for use in unit tests. State checking will not be performed. Unset properties will throw an UnsupportedOperationException when accessed via the partial object.

Partials should only ever be used in tests. They permit writing robust test cases that won't fail if this type gains more application-level constraints (e.g. new required fields) in future. If you require partially complete values in production code, consider using a Builder.