Package org.apache.commons.vfs2.provider.url

Class UrlFileObject

java.lang.Object

org.apache.commons.vfs2.provider.AbstractFileObject<UrlFileSystem>

org.apache.commons.vfs2.provider.url.UrlFileObject

All Implemented Interfaces:

Closeable, AutoCloseable, Comparable<FileObject>, Iterable<FileObject>, FileObject

public class UrlFileObject
extends AbstractFileObject<UrlFileSystem>

A FileObject implementation backed by a URL.

TODO - Implement set lastModified and get/set attribute

TODO - Implement getOutputStream().

Field Summary

Fields inherited from class org.apache.commons.vfs2.provider.AbstractFileObject

DEFAULT_BUFFER_SIZE

Fields inherited from interface org.apache.commons.vfs2.FileObject

EMPTY_ARRAY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UrlFileObject(UrlFileSystem fileSystem, AbstractFileName fileName)	Constructs a new instance.

Method Summary

Modifier and Type	Method	Description
protected URL	createURL(FileName name)	Creates a URL from the given file name.
protected void	doAttach()	Attaches this file object to its file resource.
protected long	doGetContentSize()	Returns the size of the file content (in bytes).
protected InputStream	doGetInputStream(int bufferSize)	Creates an input stream to read the file content from.
protected long	doGetLastModifiedTime()	Returns the last modified time of this file.
protected FileType	doGetType()	Determines the type of the file.
protected String[]	doListChildren()	Lists the children of the file.

Methods inherited from class org.apache.commons.vfs2.provider.AbstractFileObject

canRenameTo, childrenChanged, close, compareTo, copyFrom, createFile, createFolder, delete, delete, deleteAll, doCreateFileContent, doCreateFolder, doDelete, doDetach, doGetAttributes, doGetCertificates, doGetInputStream, doGetOutputStream, doGetRandomAccessContent, doIsExecutable, doIsHidden, doIsReadable, doIsSameFile, doIsSymbolicLink, doIsWriteable, doListChildrenResolved, doRemoveAttribute, doRename, doSetAttribute, doSetExecutable, doSetLastModifiedTime, doSetReadable, doSetWritable, endOutput, exists, finalize, findFiles, findFiles, getAbstractFileSystem, getChild, getChildren, getContent, getFileContentInfoFactory, getFileOperations, getFileSystem, getInputStream, getInputStream, getName, getOutputStream, getOutputStream, getParent, getPublicURIString, getRandomAccessContent, getType, getURL, handleChanged, handleCreate, handleDelete, holdObject, injectType, isAttached, isContentOpen, isExecutable, isFile, isFolder, isHidden, isReadable, isSameFile, isSymbolicLink, isWriteable, iterator, listFiles, moveTo, notifyAllStreamsClosed, onChange, onChildrenChanged, refresh, resolveFile, resolveFile, setExecutable, setReadable, setWritable, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.commons.vfs2.FileObject

getPath, getURI

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

UrlFileObject

protected UrlFileObject(UrlFileSystem fileSystem,
 AbstractFileName fileName)

Constructs a new instance.

Parameters:

fileSystem - the file system.

fileName - the file name.

Method Details

createURL

protected URL createURL(FileName name)
                 throws IOException

Creates a URL from the given file name.

Parameters:

name - the file name.

Returns:

a new URL.

Throws:

IOException - if an I/O error occurs.

doAttach

protected void doAttach()
                 throws Exception

Attaches this file object to its file resource. This method is called before any of the doBlah() or onBlah() methods. Subclasses can use this method to perform lazy initialization.

Overrides:

doAttach in class AbstractFileObject<UrlFileSystem>

Throws:

Exception - if an error occurs.

doGetContentSize

protected long doGetContentSize()
                         throws Exception

Returns the size of the file content (in bytes).

Specified by:

doGetContentSize in class AbstractFileObject<UrlFileSystem>

Returns:

The size of the file in bytes.

Throws:

Exception - if an error occurs.

doGetInputStream

protected InputStream doGetInputStream(int bufferSize)
                                throws Exception

Creates an input stream to read the file content from.

Overrides:

doGetInputStream in class AbstractFileObject<UrlFileSystem>

Parameters:

bufferSize - Buffer size hint.

Returns:

An InputStream to read the file content.

Throws:

Exception - if an error occurs.

doGetLastModifiedTime

protected long doGetLastModifiedTime()
                              throws Exception

Returns the last modified time of this file.

Overrides:

doGetLastModifiedTime in class AbstractFileObject<UrlFileSystem>

Returns:

The last modification time.

Throws:

Exception - if an error occurs.

doGetType

protected FileType doGetType()
                      throws Exception

Determines the type of the file.

Specified by:

doGetType in class AbstractFileObject<UrlFileSystem>

Returns:

the type of the file.

Throws:

Exception - if an error occurs.

doListChildren

protected String[] doListChildren()
                           throws Exception

Lists the children of the file.

Specified by:

doListChildren in class AbstractFileObject<UrlFileSystem>

Returns:

a possible empty String array if the file is a directory or null or an exception if the file is not a directory or can't be read.

Throws:

Exception - if an error occurs.