com.aspose.page.plugins

Class StreamResult

java.lang.Object

com.aspose.page.plugins.StreamResult

All Implemented Interfaces:

IOperationResult

public final class StreamResult
extends Object
implements IOperationResult

Represents operation result in the form of Stream.

Constructor Summary

Constructors

Constructor and Description
StreamResult(OutputStream stream) Initializes a new instance with the specified stream object.

Method Summary

Modifier and Type	Method and Description
Object	getData() Gets raw data.
boolean	isByteArray() Indicates whether the result is a bytes array.
boolean	isFile() Indicates whether the result is a path to an output file.
boolean	isStream() Indicates whether the result is a path to an output file.
boolean	isString() Indicates whether the result is a string.
String	toFile() Tries to convert the result to a file.
OutputStream	toStream() Tries to convert the result to a stream object.

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamResult

public StreamResult(OutputStream stream)

Initializes a new instance with the specified stream object.

Parameters:

stream - Stream object

Method Detail

isFile

public final boolean isFile()

Indicates whether the result is a path to an output file.

Specified by:

isFile in interface IOperationResult

Returns:

true if the result is a file; otherwise false.

isStream

public final boolean isStream()

Indicates whether the result is a path to an output file.

Specified by:

isStream in interface IOperationResult

Returns:

true if the result is a stream object; otherwise false.

isString

public final boolean isString()

Indicates whether the result is a string.

Specified by:

isString in interface IOperationResult

Returns:

true if the result is a string; otherwise false.

isByteArray

public final boolean isByteArray()

Indicates whether the result is a bytes array.

Specified by:

isByteArray in interface IOperationResult

Returns:

true if the result is a bytes array; otherwise false.

getData

public final Object getData()

Gets raw data.

Specified by:

getData in interface IOperationResult

Returns:

An object representing output data.

toFile

public final String toFile()

Tries to convert the result to a file.

Specified by:

toFile in interface IOperationResult

Returns:

A string representing the path to the output file if the result is file; otherwise null.

toStream

public final OutputStream toStream()

Tries to convert the result to a stream object.

Specified by:

toStream in interface IOperationResult

Returns:

A stream object representing the output data if the result is stream; otherwise null.