org.apache.commons.vfs.provider.smb
Class SmbFileObject

java.lang.Object
  extended by org.apache.commons.vfs.provider.AbstractFileObject
      extended by org.apache.commons.vfs.provider.smb.SmbFileObject
All Implemented Interfaces:
FileObject

public class SmbFileObject
extends AbstractFileObject
implements FileObject

A file in an SMB file system.

Version:
$Revision: 659785 $ $Date: 2008-05-24 12:32:41 +0200 (Sa, 24. Mai 2008) $
Author:
Adam Murdoch

Constructor Summary
protected SmbFileObject(FileName name, SmbFileSystem fileSystem)
           
 
Method Summary
protected  void doAttach()
          Attaches this file object to its file resource.
protected  void doCreateFolder()
          Creates this file as a folder.
protected  void doDelete()
          Deletes the file.
protected  void doDetach()
          Detaches this file object from 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  java.io.OutputStream doGetOutputStream(boolean bAppend)
          Creates an output stream to write the file content to.
protected  RandomAccessContent doGetRandomAccessContent(RandomAccessMode mode)
          random access
protected  FileType doGetType()
          Determines the type of the file, returns null if the file does not exist.
protected  boolean doIsHidden()
          Determines if this file is hidden.
protected  java.lang.String[] doListChildren()
          Lists the children of the file.
protected  void doRename(FileObject newfile)
          Renames the file.
 
Methods inherited from class org.apache.commons.vfs.provider.AbstractFileObject
canRenameTo, childrenChanged, childrenChanged, close, copyFrom, createFile, createFolder, delete, delete, doCreateFileContent, doGetAttributes, doGetCertificates, doIsReadable, doIsSameFile, doIsWriteable, doListChildrenResolved, doRemoveAttribute, doSetAttribute, doSetLastModifiedTime, doSetLastModTime, endOutput, exists, finalize, findFiles, findFiles, getChild, getChildren, getContent, getFileContentInfoFactory, getFileOperations, getFileSystem, getInputStream, getName, getOutputStream, getOutputStream, getParent, getRandomAccessContent, getType, getURL, handleChanged, handleCreate, handleDelete, holdObject, injectType, isAttached, isContentOpen, isHidden, isReadable, isSameFile, isWriteable, moveTo, notifyAllStreamsClosed, onChange, onChildrenChanged, refresh, resolveFile, resolveFile, toString
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.apache.commons.vfs.FileObject
canRenameTo, close, copyFrom, createFile, createFolder, delete, delete, exists, findFiles, findFiles, getChild, getChildren, getContent, getFileOperations, getFileSystem, getName, getParent, getType, getURL, isAttached, isContentOpen, isHidden, isReadable, isWriteable, moveTo, refresh, resolveFile, resolveFile
 

Constructor Detail

SmbFileObject

protected SmbFileObject(FileName name,
                        SmbFileSystem fileSystem)
                 throws FileSystemException
Throws:
FileSystemException
Method Detail

doAttach

protected void doAttach()
                 throws java.lang.Exception
Attaches this file object to its file resource.

Overrides:
doAttach in class AbstractFileObject
Throws:
java.lang.Exception

doDetach

protected void doDetach()
                 throws java.lang.Exception
Description copied from class: AbstractFileObject
Detaches this file object from its file resource.

Called when this file is closed. Note that the file object may be reused later, so should be able to be reattached.

This implementation does nothing.

Overrides:
doDetach in class AbstractFileObject
Throws:
java.lang.Exception

doGetType

protected FileType doGetType()
                      throws java.lang.Exception
Determines the type of the file, returns null if the file does not exist.

Specified by:
doGetType in class AbstractFileObject
Throws:
java.lang.Exception

doListChildren

protected java.lang.String[] doListChildren()
                                     throws java.lang.Exception
Lists the children of the file. Is only called if doGetType() returns FileType.FOLDER.

Specified by:
doListChildren in class AbstractFileObject
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

doIsHidden

protected boolean doIsHidden()
                      throws java.lang.Exception
Determines if this file is hidden.

Overrides:
doIsHidden in class AbstractFileObject
Throws:
java.lang.Exception

doDelete

protected void doDelete()
                 throws java.lang.Exception
Deletes the file.

Overrides:
doDelete in class AbstractFileObject
Throws:
java.lang.Exception

doRename

protected void doRename(FileObject newfile)
                 throws java.lang.Exception
Description copied from class: AbstractFileObject
Renames the file. Is only called when:

This implementation throws an exception.

Overrides:
doRename in class AbstractFileObject
Throws:
java.lang.Exception

doCreateFolder

protected void doCreateFolder()
                       throws java.lang.Exception
Creates this file as a folder.

Overrides:
doCreateFolder in class AbstractFileObject
Throws:
java.lang.Exception

doGetContentSize

protected long doGetContentSize()
                         throws java.lang.Exception
Returns the size of the file content (in bytes).

Specified by:
doGetContentSize in class AbstractFileObject
Throws:
java.lang.Exception

doGetLastModifiedTime

protected long doGetLastModifiedTime()
                              throws java.lang.Exception
Returns the last modified time of this file.

Overrides:
doGetLastModifiedTime in class AbstractFileObject
Throws:
java.lang.Exception

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
Throws:
java.lang.Exception

doGetOutputStream

protected java.io.OutputStream doGetOutputStream(boolean bAppend)
                                          throws java.lang.Exception
Creates an output stream to write the file content to.

Overrides:
doGetOutputStream in class AbstractFileObject
Throws:
java.lang.Exception

doGetRandomAccessContent

protected RandomAccessContent doGetRandomAccessContent(RandomAccessMode mode)
                                                throws java.lang.Exception
random access

Overrides:
doGetRandomAccessContent in class AbstractFileObject
Throws:
java.lang.Exception


Copyright © 2002-2011 Apache Software Foundation. All Rights Reserved.