Package org.sikuli.basics

Class FileManager

java.lang.Object

org.sikuli.basics.FileManager

public class FileManager
extends Object

INTERNAL USE: Support for accessing files and other ressources

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FileManager.FileFilter

Constructor Summary

Constructors

Constructor	Description
FileManager()

Method Summary

Modifier and Type	Method	Description
static boolean	buildJar(String targetJar, String[] jars, String[] files, String[] prefixs, org.sikuli.basics.FileManager.JarFileFilter filter)
static boolean	checkJarContent(String jarPath, String jarContent)
static String	convertStreamToString(InputStream is)
static File	createTempDir()
static File	createTempDir(String path)
static File	createTempFile(String suffix)
static File	createTempFile(String suffix, String path)
static boolean	deleteFileOrFolder(File fPath)
static boolean	deleteFileOrFolder(File fPath, FileManager.FileFilter filter)
static boolean	deleteFileOrFolder(String fpPath)
static boolean	deleteFileOrFolder(String fpPath, FileManager.FileFilter filter)
static void	deleteNotUsedImages(String bundle, Set<String> usedImages)
static void	deleteTempDir(String path)
static String	downloadURL(String url, String localPath)	download a file at the given url to a local folder
static String	downloadURL(String url, String localPath, JFrame progress)
static String	downloadURL(URL url, String localPath)	download a file at the given url to a local folder
static String	downloadURLtoString(String src)
static String	downloadURLtoString(URL uSrc)
static String	downloadURLtoString(URL uSrc, boolean silent)
static boolean	exists(String path)
static String	getAddress(String arg)
static String	getAltFilename(String filename)
static String	getJarName(Class cname)
static String	getJarPath(Class cname)
static String	getName(String filename)
static int	getPort(String p)
static Proxy	getProxy()
static InetAddress	getProxyAddress(String arg)
static int	getProxyPort(String p)
static int	getRandomInt()
static URL	getURLForContentFromURL(URL uRes, String fName)
static boolean	isBundle(String dir)
static boolean	isFilenameDotted(String name)
static int	isUrlUseabel(String sURL)
static int	isUrlUseabel(URL aURL)
static String	makeFileList(File path, String prefix)
static URL	makeJarURL(File fJar)
static String	makeScriptjar(List<String> options)
static URL	makeURL(String fName)
static URL	makeURL(String fName, String type)
static URL	makeURL(URL path, String fName)
static void	mkdir(String path)
static String	normalize(String path)
static String	normalizeAbsolute(String filename)
static boolean	openURL(String url)	open the given url in the standard browser
static boolean	packJar(String folderName, String jarName, String prefix)
static boolean	pathEquals(String path1, String path2)
static String	readFileToString(File fPath)
static void	resetFolder(File fPath)
static File	resolveImagePath(File scriptFile)	Returns the directory that contains the images used by the ScriptRunner.
static String	saveImage(BufferedImage img, String sImage, String bundlePath)
static String	saveTimedImage(BufferedImage img)
static String	saveTimedImage(BufferedImage img, String path)
static String	saveTimedImage(BufferedImage img, String path, String name)
static String	saveTmpImage(BufferedImage img)
static String	saveTmpImage(BufferedImage img, String path)
static boolean	setProxy(String pName, String pPort)
static String	slashify(String path, Boolean isDirectory)
static File	smartCopy(String src, String dest)	Copy a file *src* to the path *dest* and check if the file name conflicts.
static void	traverseFolder(File fPath, FileManager.FileFilter filter)
static boolean	unpackJar(String jarName, String folderName, boolean del, boolean strip, org.sikuli.basics.FileManager.JarFileFilter filter)	unpack a jar file to a folder
static boolean	unzip(File fZip, File fTarget)
static boolean	unzip(String inpZip, String target)
static String	unzipSKL(String fpSkl)
static boolean	writeStringToFile(String text, File fPath)
static boolean	writeStringToFile(String text, String path)
static boolean	xcopy(File fSrc, File fDest)
static boolean	xcopy(File fSrc, File fDest, FileManager.FileFilter filter)
static void	xcopy(String src, String dest)
static void	xcopy(String src, String dest, FileManager.FileFilter filter)

Methods inherited from class java.lang.Object

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

Constructor Detail

FileManager

public FileManager()

Method Detail

isUrlUseabel

public static int isUrlUseabel(String sURL)

isUrlUseabel

public static int isUrlUseabel(URL aURL)

getProxy

public static Proxy getProxy()

getProxyAddress

public static InetAddress getProxyAddress(String arg)

getProxyPort

public static int getProxyPort(String p)

setProxy

public static boolean setProxy(String pName,
                               String pPort)

downloadURL

public static String downloadURL(URL url,
                                 String localPath)

download a file at the given url to a local folder

Parameters:

url - a valid url

localPath - the folder where the file should go (will be created if necessary)

Returns:

the absolute path to the downloaded file or null on any error

downloadURL

public static String downloadURL(String url,
                                 String localPath)

download a file at the given url to a local folder

Parameters:

url - a string representing a valid url

localPath - the folder where the file should go (will be created if necessary)

Returns:

the absolute path to the downloaded file or null on any error

downloadURL

public static String downloadURL(String url,
                                 String localPath,
                                 JFrame progress)

downloadURLtoString

public static String downloadURLtoString(String src)

downloadURLtoString

public static String downloadURLtoString(URL uSrc)

downloadURLtoString

public static String downloadURLtoString(URL uSrc,
                                         boolean silent)

openURL

public static boolean openURL(String url)

open the given url in the standard browser

Parameters:

url - string representing a valid url

Returns:

false on error, true otherwise

createTempDir

public static File createTempDir(String path)

createTempDir

public static File createTempDir()

getRandomInt

public static int getRandomInt()

deleteTempDir

public static void deleteTempDir(String path)

deleteFileOrFolder

public static boolean deleteFileOrFolder(File fPath,
                                         FileManager.FileFilter filter)

deleteFileOrFolder

public static boolean deleteFileOrFolder(File fPath)

deleteFileOrFolder

public static boolean deleteFileOrFolder(String fpPath,
                                         FileManager.FileFilter filter)

deleteFileOrFolder

public static boolean deleteFileOrFolder(String fpPath)

resetFolder

public static void resetFolder(File fPath)

traverseFolder

public static void traverseFolder(File fPath,
                                  FileManager.FileFilter filter)

createTempFile

public static File createTempFile(String suffix)

createTempFile

public static File createTempFile(String suffix,
                                  String path)

saveTmpImage

public static String saveTmpImage(BufferedImage img)

saveTmpImage

public static String saveTmpImage(BufferedImage img,
                                  String path)

saveTimedImage

public static String saveTimedImage(BufferedImage img)

saveTimedImage

public static String saveTimedImage(BufferedImage img,
                                    String path)

saveTimedImage

public static String saveTimedImage(BufferedImage img,
                                    String path,
                                    String name)

unzip

public static boolean unzip(String inpZip,
                            String target)

unzip

public static boolean unzip(File fZip,
                            File fTarget)

xcopy

public static boolean xcopy(File fSrc,
                            File fDest)

xcopy

public static boolean xcopy(File fSrc,
                            File fDest,
                            FileManager.FileFilter filter)

xcopy

public static void xcopy(String src,
                         String dest)
                  throws IOException

Throws:

IOException

xcopy

public static void xcopy(String src,
                         String dest,
                         FileManager.FileFilter filter)
                  throws IOException

Throws:

IOException

makeFileList

public static String makeFileList(File path,
                                  String prefix)

smartCopy

public static File smartCopy(String src,
                             String dest)
                      throws IOException

Copy a file *src* to the path *dest* and check if the file name conflicts. If a file with the same name exists in that path, rename *src* to an alternative name.

Parameters:

src - source file

dest - destination path

Returns:

the destination file if ok, null otherwise

Throws:

IOException - on failure

convertStreamToString

public static String convertStreamToString(InputStream is)

getAltFilename

public static String getAltFilename(String filename)

exists

public static boolean exists(String path)

mkdir

public static void mkdir(String path)

getName

public static String getName(String filename)

slashify

public static String slashify(String path,
                              Boolean isDirectory)

normalize

public static String normalize(String path)

normalizeAbsolute

public static String normalizeAbsolute(String filename)

isFilenameDotted

public static boolean isFilenameDotted(String name)

resolveImagePath

public static File resolveImagePath(File scriptFile)

Returns the directory that contains the images used by the ScriptRunner.

Parameters:

scriptFile - The file containing the script.

Returns:

The directory containing the images.

makeURL

public static URL makeURL(String fName)

makeJarURL

public static URL makeJarURL(File fJar)

makeURL

public static URL makeURL(String fName,
                          String type)

makeURL

public static URL makeURL(URL path,
                          String fName)

getURLForContentFromURL

public static URL getURLForContentFromURL(URL uRes,
                                          String fName)

checkJarContent

public static boolean checkJarContent(String jarPath,
                                      String jarContent)

getPort

public static int getPort(String p)

getAddress

public static String getAddress(String arg)

saveImage

public static String saveImage(BufferedImage img,
                               String sImage,
                               String bundlePath)

deleteNotUsedImages

public static void deleteNotUsedImages(String bundle,
                                       Set<String> usedImages)

isBundle

public static boolean isBundle(String dir)

getJarPath

public static String getJarPath(Class cname)

getJarName

public static String getJarName(Class cname)

writeStringToFile

public static boolean writeStringToFile(String text,
                                        String path)

writeStringToFile

public static boolean writeStringToFile(String text,
                                        File fPath)

readFileToString

public static String readFileToString(File fPath)

makeScriptjar

public static String makeScriptjar(List<String> options)

packJar

public static boolean packJar(String folderName,
                              String jarName,
                              String prefix)

buildJar

public static boolean buildJar(String targetJar,
                               String[] jars,
                               String[] files,
                               String[] prefixs,
                               org.sikuli.basics.FileManager.JarFileFilter filter)

unpackJar

public static boolean unpackJar(String jarName,
                                String folderName,
                                boolean del,
                                boolean strip,
                                org.sikuli.basics.FileManager.JarFileFilter filter)

unpack a jar file to a folder

Parameters:

jarName - absolute path to jar file

folderName - absolute path to the target folder

del - true if the folder should be deleted before unpack

strip - true if the path should be stripped

filter - to select specific content

Returns:

true if success, false otherwise

unzipSKL

public static String unzipSKL(String fpSkl)

pathEquals

public static boolean pathEquals(String path1,
                                 String path2)