net.caseif.jtelemetry

Class JTelemetry.Payload

java.lang.Object

net.caseif.jtelemetry.JTelemetry.Payload

Enclosing class:

JTelemetry

public class JTelemetry.Payload
extends java.lang.Object

Represents a payload containing data entries to be submitted to a server in a single request.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
void	addData(java.lang.String key, boolean data) Adds a piece of data to this JTelemetry.Payload in the form of a boolean (1-bit integer).
void	addData(java.lang.String key, byte... data) Adds raw data to this JTelemetry.Payload in the form of a byte array.
void	addData(java.lang.String key, byte data) Adds a piece of data to this JTelemetry.Payload in the form of a boolean (1-bit integer).
void	addData(java.lang.String key, double data) Adds a piece of data to this JTelemetry.Payload in the form of an IEEE double-precision floating point number.
void	addData(java.lang.String key, float data) Adds a piece of data to this JTelemetry.Payload in the form of an IEEE floating-point number.
void	addData(java.lang.String key, int data) Adds a piece of data to this JTelemetry.Payload in the form of a 32-bit signed integer.
void	addData(java.lang.String key, int[] data) Adds a piece of data to this JTelemetry.Payload in the form of a 32-bit integer array.
void	addData(java.lang.String key, long data) Adds a piece of data to this JTelemetry.Payload in the form of a long (64-bit) signed integer.
void	addData(java.lang.String key, short data) Adds a piece of data to this JTelemetry.Payload in the form of a short (16-bit) signed integer.
void	addData(java.lang.String key, java.lang.String data) Adds a piece of data to this JTelemetry.Payload in the form of a string.
void	addData(java.lang.String key, java.lang.String[] data) Adds a piece of data to this JTelemetry.Payload in the form of a string array.
JTelemetry	getParent() Returns the parent JTelemetry of this JTelemetry.Payload.
JTelemetry.HttpResponse	submit() Attempts to submit this payload to the address defined by the parent JTelemetry.

Methods inherited from class java.lang.Object

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

Method Detail

getParent

public JTelemetry getParent()

Returns the parent JTelemetry of this JTelemetry.Payload.

Returns:

The parent JTelemetry of this JTelemetry.Payload

Since:

1.0

submit

public JTelemetry.HttpResponse submit()
                               throws java.io.IOException

Attempts to submit this payload to the address defined by the parent JTelemetry.

The server will respond with a 2xx response code upon the request being accepted. Additionally, it may return a non-success response code:

• 413 - If the payload exceeds the size limit defined by the server (usually 32 KB)
• 501 - If the server does not support the protocol version specified by the client (this usually denotes an outdated server)

Returns:

The HTTP response returned by the server

Throws:

java.io.IOException - If an exception occurs while sending a request to the remote server

Since:

1.0

addData

public void addData(java.lang.String key,
                    boolean data)
             throws java.lang.IllegalArgumentException

Adds a piece of data to this JTelemetry.Payload in the form of a boolean (1-bit integer).

Parameters:

key - The key to assign to the data

data - The content of the data

Throws:

java.lang.IllegalArgumentException - If this payload already contains a data entry with the given key, or if the key is null

Since:

1.0

addData

public void addData(java.lang.String key,
                    byte data)
             throws java.lang.IllegalArgumentException

Adds a piece of data to this JTelemetry.Payload in the form of a boolean (1-bit integer).

Parameters:

key - The key to assign to the data

data - The content of the data

Throws:

java.lang.IllegalArgumentException - If this payload already contains a data entry with the given key, or if the key is null

Since:

1.0

addData

public void addData(java.lang.String key,
                    short data)
             throws java.lang.IllegalArgumentException

Adds a piece of data to this JTelemetry.Payload in the form of a short (16-bit) signed integer.

Parameters:

key - The key to assign to the data

data - The content of the data

Throws:

java.lang.IllegalArgumentException - If this payload already contains a data entry with the given key, or if the key is null

Since:

1.0

addData

public void addData(java.lang.String key,
                    int data)
             throws java.lang.IllegalArgumentException

Adds a piece of data to this JTelemetry.Payload in the form of a 32-bit signed integer.

Parameters:

key - The key to assign to the data

data - The content of the data

Throws:

java.lang.IllegalArgumentException - If this payload already contains a data entry with the given key, or if the key is null

Since:

1.0

addData

public void addData(java.lang.String key,
                    long data)
             throws java.lang.IllegalArgumentException

Adds a piece of data to this JTelemetry.Payload in the form of a long (64-bit) signed integer.

Parameters:

key - The key to assign to the data

data - The content of the data

Throws:

java.lang.IllegalArgumentException - If this payload already contains a data entry with the given key, or if the key is null

Since:

1.0

addData

public void addData(java.lang.String key,
                    float data)
             throws java.lang.IllegalArgumentException

Adds a piece of data to this JTelemetry.Payload in the form of an IEEE floating-point number.

Parameters:

key - The key to assign to the data

data - The content of the data

Throws:

java.lang.IllegalArgumentException - If this payload already contains a data entry with the given key, or if the key is null

Since:

1.0

addData

public void addData(java.lang.String key,
                    double data)
             throws java.lang.IllegalArgumentException

Adds a piece of data to this JTelemetry.Payload in the form of an IEEE double-precision floating point number.

Parameters:

key - The key to assign to the data

data - The content of the data

Throws:

java.lang.IllegalArgumentException - If this payload already contains a data entry with the given key, or if the key is null

Since:

1.0

addData

public void addData(java.lang.String key,
                    java.lang.String data)
             throws java.lang.IllegalArgumentException

Adds a piece of data to this JTelemetry.Payload in the form of a string.

Parameters:

key - The key to assign to the data

data - The content of the data

Throws:

java.lang.IllegalArgumentException - If this payload already contains a data entry with the given key, or if the key is null

Since:

1.0

addData

public void addData(java.lang.String key,
                    byte... data)
             throws java.lang.IllegalArgumentException

Adds raw data to this JTelemetry.Payload in the form of a byte array.

Parameters:

key - The key to assign to the data

data - The content of the data

Throws:

java.lang.IllegalArgumentException - If this payload already contains a data entry with the given key, or if the key or data is null

Since:

1.0

addData

public void addData(java.lang.String key,
                    int[] data)
             throws java.lang.IllegalArgumentException

Adds a piece of data to this JTelemetry.Payload in the form of a 32-bit integer array.

Parameters:

key - The key to assign to the data

data - The content of the data

Throws:

java.lang.IllegalArgumentException - If this payload already contains a data entry with the given key, or if the key or data is null

Since:

1.0

addData

public void addData(java.lang.String key,
                    java.lang.String[] data)
             throws java.lang.IllegalArgumentException

Adds a piece of data to this JTelemetry.Payload in the form of a string array.

Parameters:

key - The key to assign to the data

data - The content of the data

Throws:

java.lang.IllegalArgumentException - If this payload already contains a data entry with the given key, or if the key, data, or any element of the data array is null

Since:

1.0