Out
Response feature to HTTP requests.
close
_out.close() : Out
Description
Closes the sending of HTTP response data.
Return
( Out )
closed
_out.closed() : boolean
Description
Checks whether the response to the HTTP request has already been closed.
Return
( boolean )
The response to the HTTP request has been closed.
copy
_out.copy(in: InputStream) : Out
Description
Copies all data from an InputStream to Proteu's standard output (OutputStream), starting from the beginning of the input stream.
It is a straightforward utility method, ideal for complete transfers of binary content (such as files, images, etc.), without the need to manipulate positions or limits.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| in | InputStream | Input stream from which data will be read and transferred to the output. |
Return
( Out )
Returns the Out object itself
_out.copy(in: InputStream, skip: long) : Out
Description
Copies data from an InputStream to the current output (Proteu OutputStream), optionally skipping the first bytes specified by skip.
This method is a simplified version of the copy method with limited size, useful for transferring entire data streams, starting from a specific position.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| in | InputStream | The input stream from which data will be read. |
| skip | long | Number of bytes to skip before starting the copy. Use 0 to start from the beginning. |
Return
( Out )
Returns the Out object itself
_out.copy(in: InputStream, skip: long, size: long) : Out
Description
Copies data from an InputStream to the current output (OutputStream associated with Out), with optional support for skipping bytes and limiting the total size copied.
This method is useful for efficient transfers of binary streams, with precise control over the starting point and volume of data.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| in | InputStream | The input stream from which the data will be read. |
| skip | long | Number of bytes to skip before starting the copy (use 0 to skip none). |
| size | long | Maximum number of bytes to copy (use -1 to copy to the end of the stream). |
Return
( Out )
Returns the Out object itself
_out.copy(file: File) : Out
Description
Copies all content from a file to the response output (OutputStream).
This method is a convenience that encapsulates the creation of an InputStream from a File, and delegates the copy operation to the copy(InputStream in) method.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| file | File | The file from which the data will be copied. |
Return
( Out )
Returns the Out object itself
_out.copy(file: File, skip: long) : Out
Description
Copies data from a file to the response output (OutputStream), skipping an initial number of bytes.
This method is a convenience that abstracts the creation of an InputStream from a File and delegates the logic to the copy(InputStream in, long skip) method.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| file | File | The file from which the data will be copied. |
| skip | long | Number of bytes to be skipped at the beginning of the file. |
Return
( Out )
Returns the Out object itself
_out.copy(file: File, skip: long, size: long) : Out
Description
Copies a range of data from a file to the output (OutputStream) of the Proteu instance.
This method is a convenience that encapsulates opening the InputStream of the file and delegates the operation to the copy(InputStream, long, long) method.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| file | File | The file from which the data will be copied. |
| skip | long | Number of bytes to be skipped at the beginning of the file. |
| size | long | Number of bytes to be copied after the skip. If size is negative (< 0), all remaining content will be copied. |
Return
( Out )
Returns the Out object itself
_out.copy(storage: Storage) : Out
Description
Copies all content from a Storage resource to the current output, without skipping bytes at the beginning and without a size limit.
This method is a simplified way of calling copy(Storage storage, long skip, long size) with the skip and size parameters set to -1, indicating that there is no initial skip and all content should be copied.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| storage | Storage | The storage resource representing the file to be copied. |
Return
( Out )
Returns the Out object itself
_out.copy(storage: Storage, skip: long) : Out
Description
Copies data from a Storage resource to the current output, starting reading after skipping a specified number of bytes (skip).
This method is a convenient way to call copy(Storage storage, long skip, long size) with size set to -1, i.e., no size limit — copying all remaining content after skip.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| storage | Storage | The storage resource representing the file to be copied. |
| skip | long | Number of bytes to be skipped at the beginning of the file. |
Return
( Out )
Returns the Out object itself
_out.copy(storage: Storage, skip: long, size: long) : Out
Description
Copies the entire contents of a file to the response output (OutputStream).
This method is a convenience that encapsulates the creation of an InputStream from a file and delegates the copy operation to the copy(InputStream in) method.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| storage | Storage | The storage resource representing the file to be copied. |
| skip | long | Number of bytes to be skipped at the beginning of the file. |
| size | long | Maximum number of bytes to copy after the skip |
Return
( Out )
Returns the Out object itself
flush
_out.flush() : void
Description
Sends what is pending accumulated in the buffer.
Return
( void )
getJSONHTMLEscape
_out.getJSONHTMLEscape() : boolean
Description
Returns the current state of HTML escape configuration in the JSON response.
This method is equivalent to jsonHTMLEscape() and is present to maintain consistency with JavaBeans-based naming conventions (use of get as a prefix).
Return
( boolean )
Returns true if HTML escaping is enabled, otherwise returns false.
getJSONIdentFactor
_out.getJSONIdentFactor() : int
Description
Auxiliary method that returns the same value as jsonIdentFactor(), maintaining compatibility with JavaBeans-style naming conventions.
Return
( int )
Returns the value of the JSON indentation factor.
getMirrors
_out.getMirrors() : java.util.List
Description
Gets the output replicas.
Return
( java.util.List )
List of replicas.
init
_out.init() : Out
Description
Starts a new instance of output.
Return
( Out )
The new instance of the Output feature.
isClosed
_out.isClosed() : boolean
Return
( boolean )
isStarted
_out.isStarted() : boolean
Return
( boolean )
json
_out.json(Values: java.lang.Object) : Out
Description
Sends a response in JSON format to the client. This method sets the appropriate headers to ensure that the response is not cached and that the content is treated as valid JSON.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| Values | java.lang.Object | Object of type Values that will be converted into text and sent as JSON. |
Return
( Out )
Returns the Out object itself
_out.json(String: string) : Out
Description
Sends a response in JSON format to the client. This method sets the appropriate headers to ensure that the response is not cached and that the content is treated as valid JSON.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| String | string | Text in JSON format to be sent as a response. |
Return
( Out )
Returns the Out object itself
_out.json(Values: java.util.List) : Out
Description
Generates a formatted JSON response from an array of objects. The content is automatically structured based on a list of objects of type Values.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| Values | java.util.List | Object of type Values that will be converted into text and sent as JSON. |
Return
( Out )
Returns the Out object itself
_out.json(Values: Values | DataSchema | java.util.Map) : Out
Description
Generates a JSON response from a Map, using an instance of Values to structure the average content of the sample
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| Values | _Values | DataSchema | java.util.Map_ |
Return
( Out )
Returns the Out object itself
_out.json(Values: Values) : Out
Description
Generates a formatted JSON response from an instance of the Values class.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| Values | Values | Object containing the data that will be automatically converted to JSON. |
Return
( Out )
Returns the Out object itself
jsonHTMLEscape
_out.jsonHTMLEscape() : boolean
Description
Checks the current status of the HTML character escape configuration in the JSON response.
This configuration determines whether special HTML characters (such as <, >, &, \‘) will be converted to HTML entities when generating JSON output.
Return
( boolean )
Returns true if HTML escaping is enabled, otherwise returns false.
_out.jsonHTMLEscape(htmlEscape: boolean) : Out
Description
Defines whether special HTML characters should be escaped in the generated JSON response.
When enabled (true), characters such as < , > , & and \ will be converted to their corresponding HTML entities ('<', '>', '&bsol', etc.), ensuring greater security when displaying JSON in HTML contexts.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| htmlEscape | boolean | true to escape HTML characters in JSON content. false to disable escaping. |
Return
( Out )
Returns the Out object itself
jsonIdentFactor
_out.jsonIdentFactor() : int
Description
The current value of the indentation factor used when generating the JSON response. This value controls the number of spaces used per indentation level in JSON.
Return
( int )
Returns the value of the JSON indentation factor.
_out.jsonIdentFactor(int: int) : Out
Description
Sets the indentation factor used when generating the JSON response. This value determines how many spaces will be used to indent each level of the JSON, making the output more readable for humans.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| int | int | Number of spaces used per indentation level. |
Return
( Out )
Returns the Out object itself
mirrors
_out.mirrors() : java.util.List
Description
Gets the output replicas.
Return
( java.util.List )
List of replicas.
output
_out.output() : OutputStream
Description
Provides the original output stream.
Return
( OutputStream )
The original output stream..
print
_out.print(bool: boolean) : Out
Description
Sends the boolean result.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| bool | boolean | Boolean value that will be sent. |
Return
( Out )
Current data output.
_out.print(number: byte) : Out
Description
Sends the number.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| number | byte | Number that will be sent. |
Return
( Out )
Current data output.
_out.print(character: char) : Out
Description
Sends the character.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| character | char | Character that will be sent. |
Return
( Out )
Current data output.
_out.print(bool: double) : Out
Description
Sends the boolean result.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| bool | double | Boolean value that will be sent. |
Return
( Out )
Current data output.
_out.print(bool: float) : Out
Description
Sends the boolean result.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| bool | float | Boolean value that will be sent. |
Return
( Out )
Current data output.
_out.print(bool: int) : Out
Description
Sends the boolean result.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| bool | int | Boolean value that will be sent. |
Return
( Out )
Current data output.
_out.print(obj: java.lang.Object) : Out
Description
Converts the object to text and sends it.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| obj | java.lang.Object | Object that will be converted to text and sent. |
Return
( Out )
Current data output.
_out.print(text: string) : Out
Description
Sends the text content.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| text | string | Content that will be sent. |
Return
( Out )
Current data output.
_out.print(bool: long) : Out
Description
Sends the boolean result.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| bool | long | Boolean value that will be sent. |
Return
( Out )
Current data output.
_out.print(bool: short) : Out
Description
Sends the boolean result.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| bool | short | Boolean value that will be sent. |
Return
( Out )
Current data output.
printf
_out.printf(format: string, objects: java.lang.Object[]) : Out
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| format | string | |
| objects | java.lang.Object[] |
Return
( Out )
println
_out.println() : Out
Description
Sends a line break.
Return
( Out )
Current data output.
_out.println(bool: boolean) : Out
Description
Sends the boolean result with a line break.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| bool | boolean | Boolean value that will be sent with the line break. |
Return
( Out )
Current data output.
_out.println(number: byte) : Out
Description
Sends the number with a line break.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| number | byte | Number that will be sent with the line break. |
Return
( Out )
Current data output.
_out.println(character: char) : Out
Description
Sends the character with a line break.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| character | char | Character that will be sent with the line break. |
Return
( Out )
Current data output.
_out.println(bool: double) : Out
Description
Sends the boolean result with a line break.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| bool | double | Boolean value that will be sent with the line break. |
Return
( Out )
Current data output.
_out.println(bool: float) : Out
Description
Sends the boolean result with a line break.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| bool | float | Boolean value that will be sent with the line break. |
Return
( Out )
Current data output.
_out.println(bool: int) : Out
Description
Sends the boolean result with a line break.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| bool | int | Boolean value that will be sent with the line break. |
Return
( Out )
Current data output.
_out.println(obj: java.lang.Object) : Out
Description
Converts the object to text and sends it with a line break.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| obj | java.lang.Object | Object that will be converted to text and sent with the line break. |
Return
( Out )
Current data output.
_out.println(text: string) : Out
Description
Sends the text content with a line break.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| text | string | Content that will be sent with the line break. |
Return
( Out )
Current data output.
_out.println(bool: long) : Out
Description
Sends the boolean result with a line break.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| bool | long | Boolean value that will be sent with the line break. |
Return
( Out )
Current data output.
_out.println(bool: short) : Out
Description
Sends the boolean result with a line break.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| bool | short | Boolean value that will be sent with the line break. |
Return
( Out )
Current data output.
setJSONHTMLEscape
_out.setJSONHTMLEscape(htmlEscape: boolean) : Out
Description
Defines whether the generated JSON content should escape special HTML characters (such as <, >, &, etc.).
This method is an alias or helper method that delegates directly to jsonHTMLEscape(boolean htmlEscape), maintaining consistency with the JavaBeans naming convention (use of set as a prefix).
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| htmlEscape | boolean | true to enable HTML escaping in JSON strings; false to keep the original characters. |
Return
( Out )
Returns the Out object itself
setJSONIdentFactor
_out.setJSONIdentFactor(jsonIdentFactor: int) : Out
Description
Sets the indentation factor (spacing) used when generating pretty-printed JSON output.
This method is a shortcut that internally delegates to jsonIdentFactor(int jsonIdentFactor), maintaining consistency with JavaBeans conventions (use of set as a prefix).
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| jsonIdentFactor | int | An integer representing the number of spaces for each indentation level in formatted JSON. |
| Example: | ||
| 0 or negative values → no indentation (compact JSON) | ||
| 2 → each indentation level will have 2 spaces | ||
| 4 → more readable indentation, with 4 spaces per level |
Return
( Out )
Returns the Out object itself
start
_out.start() : void
Description
Starts the output, the HTTP header is sent.
Return
( void )
started
_out.started() : boolean
Description
Checks whether the response to the HTTP request has already started.
Return
( boolean )
The HTTP request response has started and the header has already been sent.
write
_out.write(bytes: byte[]) : Out
Description
Writes all bytes of an array directly to binary output.
The method delegates writing to the output stream associated with Proteu, ensuring that all bytes are transferred in the order of the array. It also propagates writing to mirror streams, if present.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| bytes | byte[] | Array of bytes to be written. |
Return
( Out )
Returns the Out object itself
_out.write(bytes: byte[], off: int, len: int) : Out
Description
Writes a specific sequence of bytes from an array to binary output.
This method allows you to write only a portion of the array, starting from a given index (off) and writing up to a defined length (len). The operation also propagates to mirror streams, if they exist.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| bytes | byte[] | Array of bytes from which the data will be extracted. |
| off | int | Initial position in the array. |
| len | int | Initial position in the array. |
Return
( Out )
Returns the Out object itself
_out.write(int: int) : Out
Description
Writes a single byte to the body of the HTTP response.
Internally, this method delegates the operation to the output stream managed by Proteu, which can perform status checks, start the stream if necessary, and replicate the output to additional streams (mirrors), as well as keeping track of the total number of bytes written.
It is useful for manually constructing responses byte by byte or for custom write streams.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| int | int | The byte to be written, represented as an integer value (only the least significant 8 bits are used). |
Return
( Out )
Returns the Out object itself
writeBoolean
_out.writeBoolean(boolean: boolean) : Out
Description
Writes a Boolean value to the binary output. The value true is represented as 1 (byte) and false as 0, and is written directly to the output stream.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| boolean | boolean | The value to be written to the binary output (true or false). |
Return
( Out )
Returns the Out object itself
writeByte
_out.writeByte(int: int) : Out
Description
Writes a single byte to the HTTP response stream.
This method is ideal for direct binary output, such as raw data or file contents. Internally, it delegates the call to writeByte(int b) of the Proteu instance's OutputStream, which manages the main output stream and its mirrors (if configured).
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| int | int | The value to be written as a byte. Only the least significant 8 bits are considered (equivalent to b & 0xFF). |
Return
( Out )
Returns the Out object itself
writeChar
_out.writeChar(char: char) : Out
Description
Writes a Unicode character (UTF-16) as two bytes in the binary output.
The character is divided into two 8-bit parts: the most significant byte and the least significant byte. Both are written to the output in big-endian order (most significant bits first).
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| char | char | Character to be written to the binary output. |
Return
( Out )
Returns the Out object itself
writeDouble
_out.writeDouble(double: double) : Out
Description
Writes a double value (64 bits, floating point) to the binary output. The number is converted to its 8-byte binary representation according to the IEEE 754 standard and written to the output stream in big-endian order.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| double | double | The floating point value that will be written to the binary output. |
Return
( Out )
Returns the Out object itself
writeFloat
_out.writeFloat(float: float) : Out
Description
Writes a floating point value (32 bits, floating point) to the binary output. The value is converted to its 4-byte binary representation according to the IEEE 754 standard and then written to the stream in big-endian order.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| float | float | The floating point number that will be written to the binary output. |
Return
( Out )
Returns the Out object itself
writeInt
_out.writeInt(int: int) : Out
Description
Writes an integer value (32 bits) to the HTTP response stream as four bytes in big-endian order (from the most significant byte to the least significant byte).
This method is useful for generating structured binary outputs, such as file headers, binary communication with clients, or custom protocols.
Internally, each byte of the integer is extracted with bit shifts and sent individually to the main OutputStream and its mirrors, if any.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| int | int | The entire value to be written. It will be broken into four bytes and written sequentially to the stream. |
Return
( Out )
Returns the Out object itself
writeLong
_out.writeLong(long: long) : Out
Description
Writes a long value (64 bits) to the binary output. The value is converted to a sequence of 8 bytes in big-endian format (most significant byte first), which ensures compatibility with most binary protocols and file formats.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| long | long | The numerical value that will be recorded in the binary output. |
Return
( Out )
Returns the Out object itself
writeShort
_out.writeShort(boolean: short) : Out
Description
Writes a Boolean value (true or false) to the binary output. The value is converted to a byte: 1 for true and 0 for false, following the common binary pattern.
This method is useful when you need to transmit data at the byte level, such as in binary files, network streams, or protocol buffers.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| boolean | short | The Boolean value that will be saved. |
Return
( Out )
Returns the Out object itself