xapi.file.api

Interface FileService

All Known Implementing Classes:

FileServiceImpl, FileServiceJava7

public interface FileService

Method Summary

Modifier and Type	Method and Description
File	chmod(int chmod, File file) Performs a chmod-like operation on a file.
File	createTempDir(String prefix, boolean deleteOnExit)
void	delete(String kill, boolean recursive)
String	getFileMaybeUnzip(String file, int chmod)
String	getPath(String path) Return the canonical (fully resolved) path of the given path segment.
String	getResourceMaybeUnzip(String resource, ClassLoader cl, int chmod)
void	mkdirsTransient(File dest)
boolean	saveFile(String path, String fileName, String contents)
boolean	saveFile(String path, String fileName, String contents, String charset)
String	unzip(String resource, JarFile jarFile, int chmod)

Method Detail

getResourceMaybeUnzip

String getResourceMaybeUnzip(String resource,
                             ClassLoader cl,
                             int chmod)

getFileMaybeUnzip

String getFileMaybeUnzip(String file,
                         int chmod)

createTempDir

File createTempDir(String prefix,
                   boolean deleteOnExit)

unzip

String unzip(String resource,
             JarFile jarFile,
             int chmod)

chmod

File chmod(int chmod,
           File file)

Performs a chmod-like operation on a file. Special group permissions are ignored by java 6 and <, but owner/all permissions are settable via HEXADECIMAL integer flags. 0x755 != 755. A java 7 implementation will fully respect PosixFilePermission. A method may be provided to translate decimal input, but for now, there is an assertion guarding this method.

Parameters:

chmod - - A HEXADECIMAL value < 0x777

file - - The file to apply the setting upon

Returns:

That same file.

getPath

String getPath(String path)

Return the canonical (fully resolved) path of the given path segment.

saveFile

boolean saveFile(String path,
                 String fileName,
                 String contents)

saveFile

boolean saveFile(String path,
                 String fileName,
                 String contents,
                 String charset)

mkdirsTransient

void mkdirsTransient(File dest)

delete

void delete(String kill,
            boolean recursive)