Package net.rubygrapefruit.platform.internal

Class DefaultPosixFiles

java.lang.Object

net.rubygrapefruit.platform.internal.AbstractFiles

net.rubygrapefruit.platform.internal.DefaultPosixFiles

All Implemented Interfaces:

Files, NativeIntegration, PosixFiles

public class DefaultPosixFiles
extends AbstractFiles
implements PosixFiles

Constructor Summary

Constructors

Constructor	Description
DefaultPosixFiles()

Method Summary

Modifier and Type	Method	Description
int	getMode(java.io.File file)	Gets the mode for the given file.
java.util.List<DirEntry>	listDir(java.io.File dir)	Lists the entries of the given directory.
java.util.List<DirEntry>	listDir(java.io.File dir, boolean linkTarget)	Lists the entries of the given directory.
java.lang.String	readLink(java.io.File link)	Reads the contents of a symbolic link.
void	setMode(java.io.File file, int perms)	Sets the mode for the given file.
PosixFileInfo	stat(java.io.File file)	Returns basic information about the given file.
PosixFileInfo	stat(java.io.File file, boolean linkTarget)	Returns basic information about the given file.
void	symlink(java.io.File link, java.lang.String contents)	Creates a symbolic link with given contents.

Methods inherited from class net.rubygrapefruit.platform.internal.AbstractFiles

listDirFailure

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPosixFiles

public DefaultPosixFiles()

Method Detail

stat

public PosixFileInfo stat(java.io.File file)
                   throws NativeException

Description copied from interface: PosixFiles

Returns basic information about the given file. Returns whatever file details can be efficiently calculated in a single system call, which is more efficient that querying these details separately.

When the file references a symlink, details about the symlink is returned, not the target of the symlink.

Specified by:

stat in interface Files

Specified by:

stat in interface PosixFiles

Parameters:

file - The path of the file to get details of. Follows symlinks to the parent directory of this file.

Returns:

Details of the file. Returns details with type FileInfo.Type.Missing for a file that does not exist.

Throws:

NativeException - On failure to query the file information.

FilePermissionException - When the user has insufficient permissions to query the file information

stat

public PosixFileInfo stat(java.io.File file,
                          boolean linkTarget)
                   throws NativeException

Description copied from interface: PosixFiles

Returns basic information about the given file. Returns whatever file details can be efficiently calculated in a single system call, which is more efficient that querying these details separately.

Specified by:

stat in interface Files

Specified by:

stat in interface PosixFiles

Parameters:

file - The path of the file to get details of. Follows symlinks to the parent directory of this file.

linkTarget - When true and the file is a symlink, return details of the target of the symlink instead of details of the symlink itself.

Returns:

Details of the file. Returns details with type FileInfo.Type.Missing for a file that does not exist.

Throws:

NativeException - On failure to query the file information.

FilePermissionException - When the user has insufficient permissions to query the file information

listDir

public java.util.List<DirEntry> listDir(java.io.File dir)
                                 throws NativeException

Description copied from interface: Files

Lists the entries of the given directory.

When a directory entry is a symlink, details about the symlink is returned, not the target of the symlink.

Specified by:

listDir in interface Files

Parameters:

dir - The path of the directory to list. Follows symlinks to this directory.

Throws:

NativeException - On failure.

NoSuchFileException - When the specified directory does not exist.

NotADirectoryException - When the specified file is not a directory.

FilePermissionException - When the user has insufficient permissions to list the entries

listDir

public java.util.List<DirEntry> listDir(java.io.File dir,
                                        boolean linkTarget)
                                 throws NativeException

Description copied from interface: Files

Lists the entries of the given directory.

Specified by:

listDir in interface Files

Parameters:

dir - The path of the directory to list. Follows symlinks to this directory.

linkTarget - When true and a directory entry is a symlink, return details of the target of the symlink instead of details of the symlink itself.

Throws:

NativeException - On failure.

NoSuchFileException - When the specified directory does not exist.

NotADirectoryException - When the specified file is not a directory.

FilePermissionException - When the user has insufficient permissions to list the entries

setMode

public void setMode(java.io.File file,
                    int perms)

Description copied from interface: PosixFiles

Sets the mode for the given file.

Specified by:

setMode in interface PosixFiles

getMode

public int getMode(java.io.File file)

Description copied from interface: PosixFiles

Gets the mode for the given file.

Specified by:

getMode in interface PosixFiles

readLink

public java.lang.String readLink(java.io.File link)
                          throws NativeException

Description copied from interface: PosixFiles

Reads the contents of a symbolic link.

Specified by:

readLink in interface PosixFiles

Throws:

NativeException - On failure.

symlink

public void symlink(java.io.File link,
                    java.lang.String contents)
             throws NativeException

Description copied from interface: PosixFiles

Creates a symbolic link with given contents.

Specified by:

symlink in interface PosixFiles

Throws:

NativeException - On failure.