Package adams.core.io

Class SftpFileObject

java.lang.Object

adams.core.io.SftpFileObject

All Implemented Interfaces:

FileObject, Serializable, Comparable<FileObject>

public class SftpFileObject
extends Object
implements FileObject

Wrapper for remote SFTP files.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Boolean	m_Directory	whether it is a directory (if no entry).
protected com.jcraft.jsch.ChannelSftp.LsEntry	m_Entry	the underlying file.
protected String	m_Name	the file/dir (if no entry).
protected File	m_ParentDir	the parent directory.
protected com.jcraft.jsch.Session	m_Session	the session.

Constructor Summary

Constructors

Modifier	Constructor	Description
	SftpFileObject(File parentDir, com.jcraft.jsch.ChannelSftp.LsEntry entry, com.jcraft.jsch.Session session)	Initializes the wrapper.
protected	SftpFileObject(File parentDir, com.jcraft.jsch.ChannelSftp.LsEntry entry, String name, Boolean dir, com.jcraft.jsch.Session session)	Initializes the wrapper.
	SftpFileObject(File parentDir, String name, boolean dir, com.jcraft.jsch.Session session)	Initializes the wrapper.

Method Summary

Modifier and Type	Method	Description
int	compareTo(FileObject o)	Returns whether this file object is the same as the provided one.
boolean	equals(Object obj)	Checks whether this object is the same as the provided one.
File	getActualFile()	Returns the actual target (if possible) in case of a link.
File	getFile()	Returns the wrapped file.
Date	getLastModified()	Returns the date when the file was last modified.
long	getLength()	Returns the size of the file.
String	getName()	Returns the file name.
FileObject	getParent()	Returns the parent, if available.
File	getParentDir()	Returns the parent directory.
com.jcraft.jsch.Session	getSession()	Returns the session.
boolean	isDirectory()	Returns whether the file represents a directory.
boolean	isHidden()	Returns whether the file is hidden.
boolean	isLink()	Returns whether the file represents a link.
boolean	isLocal()	Returns whether the file is a local file.
String	toString()	Returns the long name.

Methods inherited from class java.lang.Object

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

Field Detail

m_Session

protected transient com.jcraft.jsch.Session m_Session

the session.

m_ParentDir

protected File m_ParentDir

the parent directory.

m_Name

protected String m_Name

the file/dir (if no entry).

m_Directory

protected Boolean m_Directory

whether it is a directory (if no entry).

m_Entry

protected transient com.jcraft.jsch.ChannelSftp.LsEntry m_Entry

the underlying file.

Constructor Detail

SftpFileObject

public SftpFileObject(File parentDir,
                      String name,
                      boolean dir,
                      com.jcraft.jsch.Session session)

Initializes the wrapper.

Parameters:

parentDir - the parent directory

name - the file/dir to wrap

dir - whether it is a directory

session - the session

SftpFileObject

public SftpFileObject(File parentDir,
                      com.jcraft.jsch.ChannelSftp.LsEntry entry,
                      com.jcraft.jsch.Session session)

Initializes the wrapper.

Parameters:

parentDir - the parent directory

entry - the file to wrap

session - the session

SftpFileObject

protected SftpFileObject(File parentDir,
                         com.jcraft.jsch.ChannelSftp.LsEntry entry,
                         String name,
                         Boolean dir,
                         com.jcraft.jsch.Session session)

Initializes the wrapper.

Parameters:

parentDir - the parent directory

entry - the file to wrap

name - the file/dir to wrap

dir - whether it is a directory

session - the session

Method Detail

getParent

public FileObject getParent()

Returns the parent, if available.

Specified by:

getParent in interface FileObject

Returns:

the parent or null if not available

getSession

public com.jcraft.jsch.Session getSession()

Returns the session.

Returns:

the session

getParentDir

public File getParentDir()

Returns the parent directory.

Returns:

the parent

getFile

public File getFile()

Returns the wrapped file.

Specified by:

getFile in interface FileObject

Returns:

the file

getActualFile

public File getActualFile()

Returns the actual target (if possible) in case of a link.

Specified by:

getActualFile in interface FileObject

Returns:

the actual file

getName

public String getName()

Returns the file name.

Specified by:

getName in interface FileObject

Returns:

the name

getLength

public long getLength()

Returns the size of the file.

Specified by:

getLength in interface FileObject

Returns:

the size

isDirectory

public boolean isDirectory()

Returns whether the file represents a directory.

Specified by:

isDirectory in interface FileObject

Returns:

true if directory

getLastModified

public Date getLastModified()

Returns the date when the file was last modified.

Specified by:

getLastModified in interface FileObject

Returns:

date when last modified

isHidden

public boolean isHidden()

Returns whether the file is hidden.

Specified by:

isHidden in interface FileObject

Returns:

true if hidden

isLink

public boolean isLink()

Returns whether the file represents a link.

Specified by:

isLink in interface FileObject

Returns:

true if link

isLocal

public boolean isLocal()

Returns whether the file is a local file.

Specified by:

isLocal in interface FileObject

Returns:

true if local

toString

public String toString()

Returns the long name.

Specified by:

toString in interface FileObject

Overrides:

toString in class Object

Returns:

the long name

compareTo

public int compareTo(FileObject o)

Returns whether this file object is the same as the provided one.

Specified by:

compareTo in interface Comparable<FileObject>

Parameters:

o - the file object to compare against

Returns:

less than zero, equal to zero, greater than zero if this file object is less than, equal to, or greater than the other file object

equals

public boolean equals(Object obj)

Checks whether this object is the same as the provided one.

Overrides:

equals in class Object

Parameters:

obj - the object to compare against

Returns:

true if the same

See Also:

compareTo(FileObject)