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:

java.io.Closeable, java.lang.AutoCloseable, java.lang.Comparable<FileObject>, java.lang.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().

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UrlFileObject(UrlFileSystem fs, AbstractFileName fileName)

Method Summary

Modifier and Type	Method	Description
protected java.net.URL	createURL(FileName 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 java.io.InputStream	doGetInputStream()	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 java.lang.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, doGetOutputStream, doGetRandomAccessContent, doIsExecutable, doIsHidden, doIsReadable, doIsSameFile, doIsWriteable, doListChildrenResolved, doRemoveAttribute, doRename, doSetAttribute, doSetExecutable, doSetLastModifiedTime, doSetReadable, doSetWritable, endOutput, exists, finalize, findFiles, findFiles, getAbstractFileSystem, getChild, getChildren, getContent, getFileContentInfoFactory, getFileOperations, getFileSystem, getInputStream, getName, getOutputStream, getOutputStream, getParent, getPublicURIString, getRandomAccessContent, getType, getURL, handleChanged, handleCreate, handleDelete, holdObject, injectType, isAttached, isContentOpen, isExecutable, isFile, isFolder, isHidden, isReadable, isSameFile, 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 java.lang.Iterable

forEach, spliterator

Constructor Detail

UrlFileObject

protected UrlFileObject(UrlFileSystem fs,
                        AbstractFileName fileName)

Method Detail

doAttach

protected void doAttach()
                 throws java.lang.Exception

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

Overrides:

doAttach in class AbstractFileObject<UrlFileSystem>

Throws:

java.lang.Exception - if an error occurs.

createURL

protected java.net.URL createURL(FileName name)
                          throws java.net.MalformedURLException,
                                 FileSystemException,
                                 org.apache.commons.httpclient.URIException

Throws:

java.net.MalformedURLException

FileSystemException

org.apache.commons.httpclient.URIException

doGetType

protected FileType doGetType()
                      throws java.lang.Exception

Determines the type of the file.

Specified by:

doGetType in class AbstractFileObject<UrlFileSystem>

Returns:

the type of the file.

Throws:

java.lang.Exception - if an error occurs.

doGetContentSize

protected long doGetContentSize()
                         throws java.lang.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:

java.lang.Exception - if an error occurs.

doGetLastModifiedTime

protected long doGetLastModifiedTime()
                              throws java.lang.Exception

Returns the last modified time of this file.

Overrides:

doGetLastModifiedTime in class AbstractFileObject<UrlFileSystem>

Returns:

The last modification time.

Throws:

java.lang.Exception - if an error occurs.

doListChildren

protected java.lang.String[] doListChildren()
                                     throws java.lang.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:

java.lang.Exception - if an error occurs.

doGetInputStream

protected java.io.InputStream doGetInputStream()
                                        throws java.lang.Exception

Creates an input stream to read the file content from.

Specified by:

doGetInputStream in class AbstractFileObject<UrlFileSystem>

Returns:

An InputStream to read the file content.

Throws:

java.lang.Exception - if an error occurs.