ResourceSavingArgs

Inheritance: java.lang.Object

public class ResourceSavingArgs

This class represents set of data that related to external resource file’s saving that occurs during conversion to HTML format.

Constructors

ConstructorDescription
ResourceSavingArgs()

Methods

MethodDescription
closeStreamIfRequired()Close stream if KeepStreamOpen is false, else flush it.
getFileName()Gets the supposed file name that goes from converter to code of custom method.
getKeepStreamOpen()Gets a value indicating whether the stream will be kept open after resource saving finishes.
getStream()Gets the binary content of saved file.
getUri()Gets the resource URI.
setFileName(String value)Sets the supposed file name that goes from converter to code of custom method.
setKeepStreamOpen(boolean value)Sets a value indicating whether the stream will be kept open after resource saving finishes.
setStream(OutputStream value)Sets the binary content of saved file.
setUri(String value)Sets the resource URI.

ResourceSavingArgs()

public ResourceSavingArgs()

closeStreamIfRequired()

public final void closeStreamIfRequired()

Close stream if KeepStreamOpen is false, else flush it.

getFileName()

public final String getFileName()

Gets the supposed file name that goes from converter to code of custom method. Can be use in custom code to decide how to process or where save that file.

Returns: java.lang.String - the supposed file name that goes from converter to code of custom method.

getKeepStreamOpen()

public final boolean getKeepStreamOpen()

Gets a value indicating whether the stream will be kept open after resource saving finishes.

Returns: boolean - a value indicating whether the stream will be kept open after resource saving finishes.

getStream()

public final OutputStream getStream()

Gets the binary content of saved file.

Returns: java.io.OutputStream - the binary content of saved file.

getUri()

public final String getUri()

Gets the resource URI.

Returns: java.lang.String - the resource URI.

setFileName(String value)

public final void setFileName(String value)

Sets the supposed file name that goes from converter to code of custom method. Can be use in custom code to decide how to process or where save that file.

Parameters:

ParameterTypeDescription
valuejava.lang.Stringthe supposed file name that goes from converter to code of custom method.

setKeepStreamOpen(boolean value)

public final void setKeepStreamOpen(boolean value)

Sets a value indicating whether the stream will be kept open after resource saving finishes.

Parameters:

ParameterTypeDescription
valuebooleana value indicating whether the stream will be kept open after resource saving finishes.

setStream(OutputStream value)

public final void setStream(OutputStream value)

Sets the binary content of saved file.

Parameters:

ParameterTypeDescription
valuejava.io.OutputStreamthe binary content of saved file.

setUri(String value)

public final void setUri(String value)

Sets the resource URI.

Parameters:

ParameterTypeDescription
valuejava.lang.Stringthe resource URI.