SftpFile (J2SSH Maverick 1.5.0 API)

java.lang.Object
- com.sshtools.sftp.SftpFile

```
public class SftpFile
extends Object
```
Represents an SFTP file object.

Author:

Lee David Painter

Constructor Summary

Constructors
Constructor and Description

SftpFile(String path, SftpFileAttributes attrs)
Creates a new SftpFile object.

Constructors
Constructor and Description
`SftpFile(String path, SftpFileAttributes attrs)` Creates a new SftpFile object.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`canRead()` Determine whether the user has read access to the file.
`boolean`	`canWrite()` Determine whether the user has write access to the file.
`void`	`close()` Close the file.
`void`	`delete()` Delete this file/directory from the remote server.
`boolean`	`equals(Object obj)` Compares the Object to this instance and returns true if they point to the same file.
`String`	`getAbsolutePath()` Get the absolute path
`SftpFileAttributes`	`getAttributes()` Get the files attributes.
`String`	`getFilename()` Get the filename.
`byte[]`	`getHandle()` Get the open file handle
`String`	`getLongname()`
`SftpFile`	`getParent()` Get the parent of the current file.
`SftpSubsystemChannel`	`getSFTPChannel()` Get the SFTP subsystem channel that created this file object.
`int`	`hashCode()`
`boolean`	`isBlock()` Determine whether the file is pointing to a block special file.
`boolean`	`isCharacter()` Determine whether the file is pointing to a character mode device.
`boolean`	`isDirectory()` Determine whether the file object is pointing to a directory.
`boolean`	`isFifo()` Determine whether the file is pointing to a pipe.
`boolean`	`isFile()` Determine whether the file object is pointing to a file.
`boolean`	`isLink()` Determine whether the file object is a symbolic link.
`boolean`	`isOpen()` Determine whether the file is open.
`boolean`	`isSocket()` Determine whether the file is pointing to a socket.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SftpFile
```
public SftpFile(String path,
        SftpFileAttributes attrs)
```
    Creates a new SftpFile object.
    
    Parameters:
    path -
    attrs -
- Method Detail
  - getParent
```
public SftpFile getParent()
                   throws SshException,
                          SftpStatusException
```
    Get the parent of the current file. This method determines the correct path of the parent file; if no parent exists (i.e. the current file is the root of the filesystem) then this method returns a null value.
    
    Returns:
    SftpFile
    
    Throws:
    
    SshException
    
    SftpStatusException
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getLongname
```
public String getLongname()
```
  - equals
```
public boolean equals(Object obj)
```
    Compares the Object to this instance and returns true if they point to the same file. If they point to the same file but have open file handles, the handles are also used to determine the equality. Therefore two separate instances both pointing to the same file will return true, unless one or both have an open file handle in which case it will only return true if the file handles also match.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    obj -
    
    Returns:
    boolean
  - delete
```
public void delete()
            throws SftpStatusException,
                   SshException
```
    Delete this file/directory from the remote server.
    
    Throws:
    
    SshException
    
    SftpStatusException
  - canWrite
```
public boolean canWrite()
                 throws SftpStatusException,
                        SshException
```
    Determine whether the user has write access to the file. This checks the S_IWUSR flag is set in permissions.
    
    Returns:
    boolean
    
    Throws:
    
    SftpStatusException
    
    SshException
  - canRead
```
public boolean canRead()
                throws SftpStatusException,
                       SshException
```
    Determine whether the user has read access to the file. This checks the S_IRUSR flag is set in permissions.
    
    Returns:
    boolean
    
    Throws:
    
    SftpStatusException
    
    SshException
  - isOpen
```
public boolean isOpen()
```
    Determine whether the file is open.
    
    Returns:
    boolean
  - getHandle
```
public byte[] getHandle()
```
    Get the open file handle
    
    Returns:
    byte[]
  - getSFTPChannel
```
public SftpSubsystemChannel getSFTPChannel()
```
    Get the SFTP subsystem channel that created this file object.
    
    Returns:
    SftpSubsystemChannel
  - getFilename
```
public String getFilename()
```
    Get the filename.
    
    Returns:
    String
  - getAttributes
```
public SftpFileAttributes getAttributes()
                                 throws SftpStatusException,
                                        SshException
```
    Get the files attributes.
    
    Returns:
    SftpFileAttributes
    
    Throws:
    
    SshException
    
    SftpStatusException
  - getAbsolutePath
```
public String getAbsolutePath()
```
    Get the absolute path
    
    Returns:
    String
  - close
```
public void close()
           throws SftpStatusException,
                  SshException
```
    Close the file.
    
    Throws:
    
    SshException
    
    SftpStatusException
  - isDirectory
```
public boolean isDirectory()
                    throws SftpStatusException,
                           SshException
```
    Determine whether the file object is pointing to a directory. Note, if the file is a symbolic link pointing to a directory then false will be returned. Use SftpClient.isDirectoryOrLinkedDirectory(SftpFile) instead if you wish to follow links.
    
    Returns:
    boolean
    
    Throws:
    
    SshException
    
    SftpStatusException
  - isFile
```
public boolean isFile()
               throws SftpStatusException,
                      SshException
```
    Determine whether the file object is pointing to a file.
    
    Returns:
    boolean
    
    Throws:
    
    SshException
    
    SftpStatusException
  - isLink
```
public boolean isLink()
               throws SftpStatusException,
                      SshException
```
    Determine whether the file object is a symbolic link.
    
    Returns:
    boolean
    
    Throws:
    
    SshException
    
    SftpStatusException
  - isFifo
```
public boolean isFifo()
               throws SftpStatusException,
                      SshException
```
    Determine whether the file is pointing to a pipe.
    
    Returns:
    boolean
    
    Throws:
    
    SshException
    
    SftpStatusException
  - isBlock
```
public boolean isBlock()
                throws SftpStatusException,
                       SshException
```
    Determine whether the file is pointing to a block special file.
    
    Returns:
    boolean
    
    Throws:
    
    SshException
    
    SftpStatusException
  - isCharacter
```
public boolean isCharacter()
                    throws SftpStatusException,
                           SshException
```
    Determine whether the file is pointing to a character mode device.
    
    Returns:
    boolean
    
    Throws:
    
    SshException
    
    SftpStatusException
  - isSocket
```
public boolean isSocket()
                 throws SftpStatusException,
                        SshException
```
    Determine whether the file is pointing to a socket.
    
    Returns:
    boolean
    
    Throws:
    
    SshException
    
    SftpStatusException

Class SftpFile

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SftpFile

Method Detail

getParent

toString

hashCode

getLongname

equals

delete

canWrite

canRead

isOpen

getHandle

getSFTPChannel

getFilename

getAttributes

getAbsolutePath

close

isDirectory

isFile

isLink

isFifo

isBlock

isCharacter

isSocket