Class DefaultFileContent

java.lang.Object

org.apache.commons.vfs2.provider.DefaultFileContent

All Implemented Interfaces:

Closeable, AutoCloseable, FileContent

public final class DefaultFileContent
extends Object
implements FileContent

The content of a file.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private final class	DefaultFileContent.FileContentInputStream	An input stream for reading content.
(package private) final class	DefaultFileContent.FileContentOutputStream	An output stream for writing content.
private final class	DefaultFileContent.FileRandomAccessContent	An input/output stream for reading/writing content on random positions
private final class	DefaultFileContent.RawFileContentInputStream	An input stream for reading content.

Field Summary

Fields

Modifier and Type	Field	Description
private Map<String,Object>	attrs
private static final Certificate[]	EMPTY_CERTIFICATE_ARRAY
private FileContentInfo	fileContentInfo
private final FileContentInfoFactory	fileContentInfoFactory
private final AbstractFileObject<?>	fileObject
private int	openStreams	Counts open streams for this file.
private boolean	resetAttributes
private Map<String,Object>	roAttrs
(package private) static final int	STATE_CLOSED
(package private) static final int	STATE_OPENED
private final ThreadLocal<FileContentThreadData>	threadLocal
private static final int	WRITE_BUFFER_SIZE	The default buffer size for write(OutputStream)

Constructor Summary

Constructors

Constructor	Description
DefaultFileContent(AbstractFileObject file, FileContentInfoFactory fileContentInfoFactory)

Method Summary

Modifier and Type	Method	Description
private InputStream	buildInputStream(int bufferSize)
private OutputStream	buildOutputStream(boolean bAppend, int bufferSize)
void	close()	Closes all resources used by the content, including all streams, readers and writers.
private void	endInput(InputStream instr)	Handles the end of input stream.
private void	endOutput()	Handles the end of output stream.
private void	endRandomAccess(RandomAccessContent rac)	Handles the end of random access.
Object	getAttribute(String attrName)	Gets the value of an attribute.
String[]	getAttributeNames()	Lists the attributes of this file.
Map<String,Object>	getAttributes()	Returns a read-only map of this file's attributes.
Certificate[]	getCertificates()	Returns the certificates used to sign this file.
FileContentInfo	getContentInfo()	Gets the FileContentInfo which describes the content-type, content-encoding
FileObject	getFile()	Returns the file that this is the content of.
private FileContentThreadData	getFileContentThreadData()
InputStream	getInputStream()	Returns an input stream for reading the content.
InputStream	getInputStream(int bufferSize)	Returns an input stream for reading the content.
long	getLastModifiedTime()	Returns the last-modified timestamp.
OutputStream	getOutputStream()	Returns an output stream for writing the content.
OutputStream	getOutputStream(boolean bAppend)	Returns an output stream for writing the content in append mode.
OutputStream	getOutputStream(boolean bAppend, int bufferSize)	Returns an output stream for writing the content in append mode.
OutputStream	getOutputStream(int bufferSize)	Returns an output stream for writing the content.
RandomAccessContent	getRandomAccessContent(RandomAccessMode mode)	Returns an input/output stream to use to read and write the content of the file in an random manner.
long	getSize()	Returns the size of the content (in bytes).
boolean	hasAttribute(String attrName)	Checks if an attribute exists.
boolean	isOpen()	Checks if a input and/or output stream is open.
boolean	isOpenGlobal()	Checks if an input or output stream is open.
void	removeAttribute(String attrName)	Removes an attribute.
void	resetAttributes()	Used internally to flag situations where the file attributes should be reretrieved.
void	setAttribute(String attrName, Object value)	Sets the value of an attribute.
void	setLastModifiedTime(long modTime)	Sets the last-modified timestamp.
(package private) void	streamClosed()
(package private) void	streamOpened()
long	write(OutputStream output)	Writes this content to an OutputStream.
long	write(OutputStream output, int bufferSize)	Writes this content to an OutputStream.
long	write(FileContent fileContent)	Writes this content to another FileContent.
long	write(FileObject file)	Writes this content to another FileObject.

Methods inherited from class Object

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

Methods inherited from interface FileContent

getByteArray, getString, getString, isEmpty

Field Details

EMPTY_CERTIFICATE_ARRAY

private static final Certificate[] EMPTY_CERTIFICATE_ARRAY

STATE_CLOSED

static final int STATE_CLOSED

See Also:

• Constant Field Values

STATE_OPENED

static final int STATE_OPENED

See Also:

• Constant Field Values

WRITE_BUFFER_SIZE

private static final int WRITE_BUFFER_SIZE

The default buffer size for write(OutputStream)

See Also:

• Constant Field Values

fileObject

private final AbstractFileObject<?> fileObject

attrs

private Map<String,Object> attrs

roAttrs

private Map<String,Object> roAttrs

fileContentInfo

private FileContentInfo fileContentInfo

fileContentInfoFactory

private final FileContentInfoFactory fileContentInfoFactory

threadLocal

private final ThreadLocal<FileContentThreadData> threadLocal

resetAttributes

private boolean resetAttributes

openStreams

private int openStreams

Counts open streams for this file.

Constructor Details

DefaultFileContent

public DefaultFileContent(AbstractFileObject file,
 FileContentInfoFactory fileContentInfoFactory)

Method Details

getFileContentThreadData

private FileContentThreadData getFileContentThreadData()

streamOpened

void streamOpened()

streamClosed

void streamClosed()

getFile

public FileObject getFile()

Returns the file that this is the content of.

Specified by:

getFile in interface FileContent

Returns:

the FileObject.

getSize

public long getSize()
             throws FileSystemException

Returns the size of the content (in bytes).

Specified by:

getSize in interface FileContent

Returns:

The size of the content (in bytes).

Throws:

FileSystemException - if an error occurs.

getLastModifiedTime

public long getLastModifiedTime()
                         throws FileSystemException

Returns the last-modified timestamp.

Specified by:

getLastModifiedTime in interface FileContent

Returns:

The last modified timestamp.

Throws:

FileSystemException - if an error occurs.

setLastModifiedTime

public void setLastModifiedTime(long modTime)
                         throws FileSystemException

Sets the last-modified timestamp.

Specified by:

setLastModifiedTime in interface FileContent

Parameters:

modTime - The last modified timestamp.

Throws:

FileSystemException - if an error occurs.

hasAttribute

public boolean hasAttribute(String attrName)
                     throws FileSystemException

Checks if an attribute exists.

Specified by:

hasAttribute in interface FileContent

Parameters:

attrName - The name of the attribute to check.

Returns:

true if the attribute is associated with the file.

Throws:

FileSystemException - if an error occurs.

Since:

2.0

getAttributes

public Map<String,Object> getAttributes()
                                 throws FileSystemException

Returns a read-only map of this file's attributes.

Specified by:

getAttributes in interface FileContent

Returns:

a Map of the file's attributes.

Throws:

FileSystemException - if an error occurs.

resetAttributes

public void resetAttributes()

Used internally to flag situations where the file attributes should be reretrieved.

Since:

2.0

getAttributeNames

public String[] getAttributeNames()
                           throws FileSystemException

Lists the attributes of this file.

Specified by:

getAttributeNames in interface FileContent

Returns:

An array of attribute names.

Throws:

FileSystemException - if an error occurs.

getAttribute

public Object getAttribute(String attrName)
                    throws FileSystemException

Gets the value of an attribute.

Specified by:

getAttribute in interface FileContent

Parameters:

attrName - The attribute name.

Returns:

The value of the attribute or null.

Throws:

FileSystemException - if an error occurs.

setAttribute

public void setAttribute(String attrName,
 Object value)
                  throws FileSystemException

Sets the value of an attribute.

Specified by:

setAttribute in interface FileContent

Parameters:

attrName - The name of the attribute to add.

value - The value of the attribute.

Throws:

FileSystemException - if an error occurs.

removeAttribute

public void removeAttribute(String attrName)
                     throws FileSystemException

Removes an attribute.

Specified by:

removeAttribute in interface FileContent

Parameters:

attrName - The name of the attribute to remove.

Throws:

FileSystemException - if an error occurs.

Since:

2.0

getCertificates

public Certificate[] getCertificates()
                              throws FileSystemException

Returns the certificates used to sign this file.

Specified by:

getCertificates in interface FileContent

Returns:

An array of Certificates.

Throws:

FileSystemException - if an error occurs.

getInputStream

public InputStream getInputStream()
                           throws FileSystemException

Returns an input stream for reading the content.

Specified by:

getInputStream in interface FileContent

Returns:

The InputStream

Throws:

FileSystemException - if an error occurs.

getInputStream

public InputStream getInputStream(int bufferSize)
                           throws FileSystemException

Returns an input stream for reading the content.

Specified by:

getInputStream in interface FileContent

Parameters:

bufferSize - The buffer size to use.

Returns:

The InputStream

Throws:

FileSystemException - if an error occurs.

Since:

2.4

getRandomAccessContent

public RandomAccessContent getRandomAccessContent(RandomAccessMode mode)
                                           throws FileSystemException

Returns an input/output stream to use to read and write the content of the file in an random manner.

Specified by:

getRandomAccessContent in interface FileContent

Parameters:

mode - The RandomAccessMode.

Returns:

A RandomAccessContent object to access the file.

Throws:

FileSystemException - if an error occurs.

getOutputStream

public OutputStream getOutputStream()
                             throws FileSystemException

Returns an output stream for writing the content.

Specified by:

getOutputStream in interface FileContent

Returns:

The OutputStream for the file.

Throws:

FileSystemException - if an error occurs.

getOutputStream

public OutputStream getOutputStream(boolean bAppend)
                             throws FileSystemException

Returns an output stream for writing the content in append mode.

Specified by:

getOutputStream in interface FileContent

Parameters:

bAppend - true if the data written should be appended.

Returns:

The OutputStream for the file.

Throws:

FileSystemException - if an error occurs.

getOutputStream

public OutputStream getOutputStream(int bufferSize)
                             throws FileSystemException

Returns an output stream for writing the content.

Specified by:

getOutputStream in interface FileContent

Parameters:

bufferSize - The buffer size to use.

Returns:

The OutputStream for the file.

Throws:

FileSystemException - if an error occurs.

Since:

2.4

getOutputStream

public OutputStream getOutputStream(boolean bAppend,
 int bufferSize)
                             throws FileSystemException

Returns an output stream for writing the content in append mode.

Specified by:

getOutputStream in interface FileContent

Parameters:

bAppend - true if the data written should be appended.

bufferSize - The buffer size to use.

Returns:

The OutputStream for the file.

Throws:

FileSystemException - if an error occurs.

Since:

2.4

close

public void close()
           throws FileSystemException

Closes all resources used by the content, including all streams, readers and writers.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface FileContent

Throws:

FileSystemException - if an error occurs.

buildInputStream

private InputStream buildInputStream(int bufferSize)
                              throws FileSystemException

Throws:

FileSystemException

buildOutputStream

private OutputStream buildOutputStream(boolean bAppend,
 int bufferSize)
                                throws FileSystemException

Throws:

FileSystemException

endInput

private void endInput(InputStream instr)

Handles the end of input stream.

endRandomAccess

private void endRandomAccess(RandomAccessContent rac)

Handles the end of random access.

endOutput

private void endOutput()
                throws Exception

Handles the end of output stream.

Throws:

Exception

isOpen

public boolean isOpen()

Checks if a input and/or output stream is open.

This checks only the scope of the current thread.

Specified by:

isOpen in interface FileContent

Returns:

true if this is the case

isOpenGlobal

public boolean isOpenGlobal()

Checks if an input or output stream is open. This checks all threads.

Returns:

true if this is the case

getContentInfo

public FileContentInfo getContentInfo()
                               throws FileSystemException

Gets the FileContentInfo which describes the content-type, content-encoding

Specified by:

getContentInfo in interface FileContent

Returns:

The FileContentInfo.

Throws:

FileSystemException - if an error occurs.

write

public long write(FileContent fileContent)
           throws IOException

Writes this content to another FileContent.

Specified by:

write in interface FileContent

Parameters:

fileContent - The target FileContent.

Returns:

the total number of bytes written

Throws:

IOException - if an error occurs writing the content.

Since:

2.1

write

public long write(FileObject file)
           throws IOException

Writes this content to another FileObject.

Specified by:

write in interface FileContent

Parameters:

file - The target FileObject.

Returns:

the total number of bytes written

Throws:

IOException - if an error occurs writing the content.

Since:

2.1

write

public long write(OutputStream output)
           throws IOException

Writes this content to an OutputStream.

Specified by:

write in interface FileContent

Parameters:

output - The target OutputStream.

Returns:

the total number of bytes written

Throws:

IOException - if an error occurs writing the content.

Since:

2.1

write

public long write(OutputStream output,
 int bufferSize)
           throws IOException

Writes this content to an OutputStream.

Specified by:

write in interface FileContent

Parameters:

output - The target OutputStream.

bufferSize - The buffer size to write data chunks.

Returns:

the total number of bytes written

Throws:

IOException - if an error occurs writing the file.

Since:

2.1