com.adobe.platform.operation.io

Class FileRef

java.lang.Object

com.adobe.platform.operation.io.FileRef

public abstract class FileRef
extends Object

This class represents a local file. It is typically used by Operation implementations which accept or return files.

When a FileRef instance is created by this SDK while referring to a temporary file location, calling any of the overloaded saveAs methods will delete the temporary file.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FileRef()

Method Summary

Modifier and Type	Method and Description
static FileRef	createFromLocalFile(String localSource) Creates a FileRef instance from a local file path where the media type can be inferred from the file extension.
static FileRef	createFromLocalFile(String localSource, String mediaType) Creates a FileRef instance from a local file path with an explicitly specified media type.
static FileRef	createFromStream(InputStream inputStream, String mediaType) Creates a FileRef instance from an input stream using the specified media type.
abstract void	saveAs(OutputStream outputStream) Writes the contents of this file to outputStream.
abstract void	saveAs(String targetLocation) Saves this file to the location specified by targetLocation.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileRef

protected FileRef()

Method Detail

createFromStream

public static FileRef createFromStream(InputStream inputStream,
                                       String mediaType)

Creates a FileRef instance from an input stream using the specified media type.

The InputStream is not read by this method but by consumers of file content such as Operation.execute(ExecutionContext).

Parameters:

inputStream - Stream representing the file

mediaType - Media type, to identify the file format

Returns:

a FileRef instance

createFromLocalFile

public static FileRef createFromLocalFile(String localSource,
                                          String mediaType)

Creates a FileRef instance from a local file path with an explicitly specified media type.

If the media type can be inferred from the file extension, consider createFromLocalFile(String).

Parameters:

localSource - Local file path, either absolute path or relative to classpath

mediaType - Media type to identify the local file format

Returns:

a FileRef instance

createFromLocalFile

public static FileRef createFromLocalFile(String localSource)

Creates a FileRef instance from a local file path where the media type can be inferred from the file extension.

To specify the media type explicitly, use createFromLocalFile(String, String).

Parameters:

localSource - Local file path, either absolute path or relative to classpath

Returns:

a FileRef instance

saveAs

public abstract void saveAs(String targetLocation)
                     throws IOException

Saves this file to the location specified by targetLocation. If this FileRef instance refers to a temporary local file created by the SDK, that temporary file is deleted.

The directory mentioned in targetLocation is created if it does not exist.

Parameters:

targetLocation - Local file path, either an absolute path or relative to classpath

Throws:

FileAlreadyExistsException - if the file already exists at the target location

IOException - if an I/O error occurs while saving the file

UnsupportedOperationException - if this FileRef instance does not represent an operation result

saveAs

public abstract void saveAs(OutputStream outputStream)
                     throws IOException

Writes the contents of this file to outputStream. If this FileRef instance refers to a temporary local file created by the SDK, that temporary file is deleted.

Note: This method does not close outputStream.

Parameters:

outputStream - the destination output stream

Throws:

IOException - if an I/O error occurs while writing to the output stream

UnsupportedOperationException - if this FileRef instance does not represent an operation result