net.scharlie.lj4l.core.io.remote.sftp

Class SftpFileAttributes

java.lang.Object

net.scharlie.lj4l.core.io.remote.sftp.SftpFileAttributes

All Implemented Interfaces:

ConnectedTestable

public final class SftpFileAttributes
extends Object
implements ConnectedTestable

This class encapsulates the attributes of a SFTP file.

Instances of this class are not safe for use by multiple threads.

Constructor Summary

Constructors

Constructor and Description
SftpFileAttributes(SftpChannel channel, String path) Create a new SFTP file attributes object.

Method Summary

Modifier and Type	Method and Description
boolean	fileExists() Answer whether the file exists.
String	getPath() Get the file path.
boolean	isConnected() Answer whether this object is currently connected.
boolean	isFile() Answer whether the file is a normal (regular) file and not a directory, link or any other.
boolean	isValid() Answer whether this object contains valid values.
long	lastModifiedInMillis() Get the time stamp of the last file modification in milliseconds since 1.1.1970.
long	lengthInBytes() Get the current length of the file in bytes.
void	refresh() Refresh the content of this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

SftpFileAttributes

public SftpFileAttributes(SftpChannel channel,
                          String path)

Create a new SFTP file attributes object.

Parameters:

channel - The SFTP channel

path - The file path

Throws:

IllegalArgumentException - if the SFTP channel is null

IllegalArgumentException - if the path is null or blank

Method Detail

getPath

public final String getPath()

Get the file path. Never null.

Returns:

file path

refresh

public final void refresh()

Refresh the content of this object.

isConnected

public final boolean isConnected()

Description copied from interface: ConnectedTestable

Answer whether this object is currently connected.

Specified by:

isConnected in interface ConnectedTestable

Returns:

answer

isValid

public final boolean isValid()

Answer whether this object contains valid values.

Returns:

answer

fileExists

public final boolean fileExists()

Answer whether the file exists.

Returns:

answer

lengthInBytes

public final long lengthInBytes()

Get the current length of the file in bytes.

Returns:

length in bytes

lastModifiedInMillis

public final long lastModifiedInMillis()

Get the time stamp of the last file modification in milliseconds since 1.1.1970.

Returns:

time stamp in milliseconds

isFile

public final boolean isFile()

Answer whether the file is a normal (regular) file and not a directory, link or any other.

Returns:

answer