Package ai.djl.modality

Class Output

java.lang.Object

ai.djl.modality.Input

ai.djl.modality.Output

public class Output
extends Input

A class stores the generic inference results.

Field Summary

Fields inherited from class ai.djl.modality.Input

content, properties

Constructor Summary

Constructors

Constructor	Description
Output()	Constructs a Output instance.
Output(int code, java.lang.String message)	Constructs a Output with specified requestId, code and message.

Method Summary

Modifier and Type	Method	Description
static Output	decode(java.io.InputStream is)	Decodes the output from encode().
boolean	deepEquals(java.lang.Object o)	Checks for deep equality with another output.
byte[]	encode()	Encodes all data in the output to a binary form.
int	getCode()	Returns the status code of the output.
java.lang.String	getMessage()	Returns the status code of the output.
void	setCode(int code)	Sets the status code of the output.
void	setMessage(java.lang.String message)	Sets the status message of the output.

Methods inherited from class ai.djl.modality.Input

add, add, add, add, add, add, add, addProperty, decodeInputBase, encodeInputBase, get, get, getAsBytes, getAsBytes, getAsNDArray, getAsNDArray, getAsNDList, getAsNDList, getAsString, getAsString, getContent, getContentAsBuffers, getData, getDataAsNDList, getProperties, getProperty, setContent, setProperties, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Output

public Output()

Constructs a Output instance.

Output

public Output(int code,
              java.lang.String message)

Constructs a Output with specified requestId, code and message.

Parameters:

code - the status code of the output

message - the status message of the output

Method Detail

getCode

public int getCode()

Returns the status code of the output.

Returns:

the status code of the output

setCode

public void setCode(int code)

Sets the status code of the output.

Parameters:

code - the status code of the output

getMessage

public java.lang.String getMessage()

Returns the status code of the output.

Returns:

the status code of the output

setMessage

public void setMessage(java.lang.String message)

Sets the status message of the output.

Parameters:

message - the status message of the output

encode

public byte[] encode()
              throws java.io.IOException

Encodes all data in the output to a binary form.

Overrides:

encode in class Input

Returns:

the binary encoding

Throws:

java.io.IOException - if it fails to encode part of the data

decode

public static Output decode(java.io.InputStream is)
                     throws java.io.IOException

Decodes the output from encode().

Parameters:

is - the data to decode from

Returns:

the decoded output

Throws:

java.io.IOException - if it fails to decode part of the output

deepEquals

public boolean deepEquals(java.lang.Object o)

Checks for deep equality with another output.

Overrides:

deepEquals in class Input

Parameters:

o - the other output.

Returns:

whether they and all properties, content, and data are equal