BinaryResult (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.extensions.restapi.BinaryResult

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable
```
public abstract class BinaryResult
extends java.lang.Object
implements java.io.Closeable
```
Wrapper around a non-JSON result from a RestView.
Views may return this type to signal they want the server glue to write raw data to the client, instead of attempting automatic conversion to JSON. The create form is overloaded to handle plain text from a String, or binary data from a byte[] or InputSteam.

Constructor Summary

Constructors
Constructor and Description

BinaryResult()

Constructors
Constructor and Description
`BinaryResult()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`asString()` Return a copy of the result as a String.
`BinaryResult`	`base64()` Wrap the binary data in base64 encoding.
`boolean`	`canGzip()`
`void`	`close()` Close the result and release any resources it holds.
`static BinaryResult`	`create(byte[] data)` Produce an `application/octet-stream` result from a byte array.
`static BinaryResult`	`create(java.io.InputStream data)` Produce an `application/octet-stream` of unknown length by copying the InputStream until EOF.
`static BinaryResult`	`create(java.lang.String data)` Produce a UTF-8 encoded result from a string.
`BinaryResult`	`disableGzip()` Disable gzip compression for already compressed responses.
`java.lang.String`	`getAttachmentName()` Get the attachment file name; null if not set.
`java.nio.charset.Charset`	`getCharacterEncoding()` Get the character encoding; null if not known.
`long`	`getContentLength()`
`java.lang.String`	`getContentType()`
`boolean`	`isBase64()`
`BinaryResult`	`setAttachmentName(java.lang.String attachmentName)` Set the attachment file name and return `this`.
`BinaryResult`	`setCharacterEncoding(java.nio.charset.Charset encoding)` Set the character set used to encode text data and return `this`.
`BinaryResult`	`setContentLength(long len)` Set the content length of the result; -1 if not known.
`BinaryResult`	`setContentType(java.lang.String contentType)` Set the MIME type of the result, and return `this`.
`java.lang.String`	`toString()`
`abstract void`	`writeTo(java.io.OutputStream os)` Write or copy the result onto the specified output stream.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BinaryResult
```
public BinaryResult()
```
- Method Detail
  - create
```
public static BinaryResult create(java.lang.String data)
```
    Produce a UTF-8 encoded result from a string.
  - create
```
public static BinaryResult create(byte[] data)
```
    Produce an application/octet-stream result from a byte array.
  - create
```
public static BinaryResult create(java.io.InputStream data)
```
    Produce an application/octet-stream of unknown length by copying the InputStream until EOF. The server glue will automatically close this stream when copying is complete.
  - getContentType
```
public java.lang.String getContentType()
```
    Returns:
    
    the MIME type of the result, for HTTP clients.
  - setContentType
```
public BinaryResult setContentType(java.lang.String contentType)
```
    Set the MIME type of the result, and return this.
  - getCharacterEncoding
```
public java.nio.charset.Charset getCharacterEncoding()
```
    Get the character encoding; null if not known.
  - setCharacterEncoding
```
public BinaryResult setCharacterEncoding(java.nio.charset.Charset encoding)
```
    Set the character set used to encode text data and return this.
  - getAttachmentName
```
public java.lang.String getAttachmentName()
```
    Get the attachment file name; null if not set.
  - setAttachmentName
```
public BinaryResult setAttachmentName(java.lang.String attachmentName)
```
    Set the attachment file name and return this.
  - getContentLength
```
public long getContentLength()
```
    Returns:
    
    length in bytes of the result; -1 if not known.
  - setContentLength
```
public BinaryResult setContentLength(long len)
```
    Set the content length of the result; -1 if not known.
  - canGzip
```
public boolean canGzip()
```
    Returns:
    
    true if this result can be gzip compressed to clients.
  - disableGzip
```
public BinaryResult disableGzip()
```
    Disable gzip compression for already compressed responses.
  - isBase64
```
public boolean isBase64()
```
    Returns:
    
    true if the result must be base64 encoded.
  - base64
```
public BinaryResult base64()
```
    Wrap the binary data in base64 encoding.
  - writeTo
```
public abstract void writeTo(java.io.OutputStream os)
                      throws java.io.IOException
```
    Write or copy the result onto the specified output stream.
    
    Parameters:
    
    os - stream to write result data onto. This stream will be closed by the caller after this method returns.
    
    Throws:
    
    java.io.IOException - if the data cannot be produced, or the OutputStream os throws any IOException during a write or flush call.
  - asString
```
public java.lang.String asString()
                          throws java.io.IOException
```
    Return a copy of the result as a String.
    The default version of this method copies the result into a temporary byte array and then tries to decode it using the configured encoding.
    
    Returns:
    
    string version of the result.
    
    Throws:
    
    java.io.IOException - if the data cannot be produced or could not be decoded to a String.
  - close
```
public void close()
           throws java.io.IOException
```
    Close the result and release any resources it holds.
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Throws:
    
    java.io.IOException
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class BinaryResult

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BinaryResult

Method Detail

create

create

create

getContentType

setContentType

getCharacterEncoding

setCharacterEncoding

getAttachmentName

setAttachmentName

getContentLength

setContentLength

canGzip

disableGzip

isBase64

base64

writeTo

asString

close

toString