com.xebialabs.overthere.spi

Class BaseOverthereFile<C extends BaseOverthereConnection>

java.lang.Object

com.xebialabs.overthere.spi.BaseOverthereFile<C>

All Implemented Interfaces:

OverthereFile

Direct Known Subclasses:

ByteArrayFile, LocalFile

public abstract class BaseOverthereFile<C extends BaseOverthereConnection>
extends java.lang.Object
implements OverthereFile

A file system object (file, directory, etc.) on a remote system that is accessible through an OverthereConnection.

Field Summary

Fields

Modifier and Type	Field and Description
protected C	connection

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseOverthereFile()
protected	BaseOverthereFile(C connection)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	copyFrom(OverthereFile source)
void	copyTo(OverthereFile dest) Copies this file or directory (recursively) to the destination.
void	deleteRecursively() Deletes this file or directory.
C	getConnection() Return the connection through which this file is accessible.
OverthereFile	getFile(java.lang.String child) Returns a reference to a named child of this file or null if this file is not a directory.
protected void	localCopyFrom(OverthereFile source) Copies this file or directory (recursively) to a (new) destination in the same connection.
abstract java.lang.String	toString() Subclasses MUST implement toString properly.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.xebialabs.overthere.OverthereFile

canExecute, canRead, canWrite, delete, exists, getInputStream, getName, getOutputStream, getParentFile, getPath, isDirectory, isFile, isHidden, lastModified, length, listFiles, mkdir, mkdirs, renameTo, setExecutable

Field Detail

connection

protected C extends BaseOverthereConnection connection

Constructor Detail

BaseOverthereFile

protected BaseOverthereFile()

BaseOverthereFile

protected BaseOverthereFile(C connection)

Method Detail

getConnection

public C getConnection()

Description copied from interface: OverthereFile

Return the connection through which this file is accessible. If the connection is closed, this file may no longer be accessible.

Specified by:

getConnection in interface OverthereFile

Returns:

the connection through which this file is accessible.

getFile

public OverthereFile getFile(java.lang.String child)

Description copied from interface: OverthereFile

Returns a reference to a named child of this file or null if this file is not a directory. The child file returned may or may not exist.

Specified by:

getFile in interface OverthereFile

Parameters:

child - the name of the child relative to this file. May not contain path separators.

Returns:

the child of this file or null if this file is not a directory.

deleteRecursively

public void deleteRecursively()
                       throws RuntimeIOException

Description copied from interface: OverthereFile

Deletes this file or directory. If this file is a directory, its contents are deleted first.

Specified by:

deleteRecursively in interface OverthereFile

Throws:

RuntimeIOException

copyTo

public final void copyTo(OverthereFile dest)

Description copied from interface: OverthereFile

Copies this file or directory (recursively) to the destination. Contrary to the semantics of OverthereFile.renameTo(OverthereFile), a file can be copied accross connections and across file systems withtin a connection.

Specified by:

copyTo in interface OverthereFile

Parameters:

dest - the file to copy to.

copyFrom

protected void copyFrom(OverthereFile source)

localCopyFrom

protected void localCopyFrom(OverthereFile source)

Copies this file or directory (recursively) to a (new) destination in the same connection.

Parameters:

source - The source file or directory

toString

public abstract java.lang.String toString()

Subclasses MUST implement toString properly.

Overrides:

toString in class java.lang.Object