com.aspose.page.plugins

Interface IOperationResult

All Known Implementing Classes:

ByteArrayResult, FileResult, StreamResult, StringResult

public interface IOperationResult

General operation result interface that defines common methods that concrete plugin operation result should implement.

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 an output stream.
boolean	isString() Indicates whether the result is a text string.
String	toFile() Tries to convert the result to the file.
OutputStream	toStream() Tries to convert the result to a stream object.

Method Detail

isFile

boolean isFile()

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

Returns:

true if the result is a file; otherwise false.

isStream

boolean isStream()

Indicates whether the result is an output stream.

Returns:

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

isString

boolean isString()

Indicates whether the result is a text string.

Returns:

true if the result is a string; otherwise false.

isByteArray

boolean isByteArray()

Indicates whether the result is a bytes array.

Returns:

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

getData

Object getData()

Gets raw data.

Returns:

An object representing output data.

toFile

String toFile()

Tries to convert the result to the file.

Returns:

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

toStream

OutputStream toStream()

Tries to convert the result to a stream object.

Returns:

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