com.networknt.colfer

Class ColferRpc

java.lang.Object

com.networknt.colfer.ColferRpc

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Account

@Generated(value="colf(1)",
           comments="Colfer from schema file colferRpc.colf")
public class ColferRpc
extends Object
implements Serializable

Data bean with built-in serialization support. RPC Service

Author:

generated by colf(1)

See Also:

Colfer's home, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ColferRpc.Unmarshaller Reusable deserialization of Colfer streams.

Field Summary

Fields

Modifier and Type	Field and Description
String	action
static int	colferSizeMax The upper limit for serial byte sizes.
String	host
String	service
String	version

Constructor Summary

Constructors

Constructor and Description
ColferRpc() Default constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(ColferRpc o)
boolean	equals(Object o)
String	getAction() Gets Colfer.colferRpc.action.
String	getHost() Gets Colfer.colferRpc.host.
String	getService() Gets Colfer.colferRpc.service.
String	getVersion() Gets Colfer.colferRpc.version.
int	hashCode()
int	marshal(byte[] buf, int offset) Serializes the object.
byte[]	marshal(OutputStream out, byte[] buf) Serializes the object.
void	setAction(String value) Sets Colfer.colferRpc.action.
void	setHost(String value) Sets Colfer.colferRpc.host.
void	setService(String value) Sets Colfer.colferRpc.service.
void	setVersion(String value) Sets Colfer.colferRpc.version.
int	unmarshal(byte[] buf, int offset) Deserializes the object.
int	unmarshal(byte[] buf, int offset, int end) Deserializes the object.

Methods inherited from class java.lang.Object

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

Field Detail

colferSizeMax

public static int colferSizeMax

The upper limit for serial byte sizes.

host

public String host

service

public String service

action

public String action

version

public String version

Constructor Detail

ColferRpc

public ColferRpc()

Default constructor

Method Detail

marshal

public byte[] marshal(OutputStream out,
                      byte[] buf)
               throws IOException

Serializes the object.

Parameters:

out - the data destination.

buf - the initial buffer or null.

Returns:

the final buffer. When the serial fits into buf then the return is buf. Otherwise the return is a new buffer, large enough to hold the whole serial.

Throws:

IOException - from out.

IllegalStateException - on an upper limit breach defined by colferSizeMax.

marshal

public int marshal(byte[] buf,
                   int offset)

Serializes the object.

Parameters:

buf - the data destination.

offset - the initial index for buf, inclusive.

Returns:

the final index for buf, exclusive.

Throws:

BufferOverflowException - when buf is too small.

IllegalStateException - on an upper limit breach defined by colferSizeMax.

unmarshal

public int unmarshal(byte[] buf,
                     int offset)

Deserializes the object.

Parameters:

buf - the data source.

offset - the initial index for buf, inclusive.

Returns:

the final index for buf, exclusive.

Throws:

BufferUnderflowException - when buf is incomplete. (EOF)

SecurityException - on an upper limit breach defined by colferSizeMax.

InputMismatchException - when the data does not match this object's schema.

unmarshal

public int unmarshal(byte[] buf,
                     int offset,
                     int end)

Deserializes the object.

Parameters:

buf - the data source.

offset - the initial index for buf, inclusive.

end - the index limit for buf, exclusive.

Returns:

the final index for buf, exclusive.

Throws:

BufferUnderflowException - when buf is incomplete. (EOF)

SecurityException - on an upper limit breach defined by colferSizeMax.

InputMismatchException - when the data does not match this object's schema.

getHost

public String getHost()

Gets Colfer.colferRpc.host.

Returns:

the value.

setHost

public void setHost(String value)

Sets Colfer.colferRpc.host.

Parameters:

value - the replacement.

getService

public String getService()

Gets Colfer.colferRpc.service.

Returns:

the value.

setService

public void setService(String value)

Sets Colfer.colferRpc.service.

Parameters:

value - the replacement.

getAction

public String getAction()

Gets Colfer.colferRpc.action.

Returns:

the value.

setAction

public void setAction(String value)

Sets Colfer.colferRpc.action.

Parameters:

value - the replacement.

getVersion

public String getVersion()

Gets Colfer.colferRpc.version.

Returns:

the value.

setVersion

public void setVersion(String value)

Sets Colfer.colferRpc.version.

Parameters:

value - the replacement.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

equals

public final boolean equals(ColferRpc o)