File (Codename One API)

java.lang.Object
- com.codename1.io.File

```
public class File
extends Object
```
This class provides a similar API to java.io.File making it almost into a "drop in" replacement. It is placed in a different package because it is incompatible to java.io.File by definition. It is useful in getting some simple code to work without too many changes

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`File.FileFilter` Interface for filtering files.
`static interface`	`File.FilenameFilter` Interface to filter filenames.

Field Summary

Fields
Modifier and Type Field and Description

static String separator

static char separatorChar

Fields
Modifier and Type	Field and Description
`static String`	`separator`
`static char`	`separatorChar`

Constructor Summary

Constructors
Constructor and Description
`File(File parent, String path)` Creates a new file in the given parent directory, and subpath.
`File(String path)` Creates a new file object with given path.
`File(String dir, String file)` Creates a new file object in a given directory.
`File(URI uri)` Creates a new File object from the given URI

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`canExecute()` Checks if this file is executable.
`boolean`	`createNewFile()` Creates this file as a new blank file in the file system.
`static File`	`createTempFile(String prefix, String suffix)` Creates a temporary file.
`boolean`	`delete()` Deletes the file described by this object on the file system.
`boolean`	`equals(Object o)` Checks if the given object refers to the same file.
`boolean`	`exists()` Checks if the file described by this object exists on the file system.
`File`	`getAbsoluteFile()` Gets the absolute file - which is always itself, since `isAbsolute()` always returns true.
`String`	`getAbsolutePath()` Gets the absolute path of the file as a string,
`long`	`getFreeSpace()` Gets the free space on the root file system.
`String`	`getName()` Returns the file name.
`String`	`getParent()` Gets the parent directory path.
`File`	`getParentFile()` Returns the file object for the parent directory.
`String`	`getPath()` Gets the path to the file.
`long`	`getTotalSpace()` Returns the total space on the root file system.
`long`	`getUsableSpace()` Gets the usable space on this file system.
`int`	`hashCode()` Returns a hash code value for the object.
`boolean`	`isAbsolute()` Checks if the path is absolute.
`boolean`	`isDirectory()` Checks if this file is a directory.
`boolean`	`isFile()` Checks if this file object represents a regular file.
`boolean`	`isHidden()` Checks if this is a hidden file.
`long`	`lastModified()` Gets the last modified time as a unix timestamp in milliseconds.
`long`	`length()` Gets the file size in bytes.
`String[]`	`list()` Returns the list of child files of this directory.
`String[]`	`list(File.FilenameFilter filter)` Returns list of child files of this directory
`File[]`	`listFiles()` Gets a list of child files of this directory.
`File[]`	`listFiles(File.FileFilter ff)` Gets a list of child files of this directory, filtering them using the provided filter.
`File[]`	`listFiles(File.FilenameFilter ff)` Gets a list of child files of this directory, filtered using the provided filter.
`static File[]`	`listRoots()` List the file system roots.
`boolean`	`mkdir()` Attempts to make the directory described by this object.
`boolean`	`mkdirs()` Attempts to make the directory (and all parent directories) of this object.
`boolean`	`renameTo(File f)` Renames the file to the provided file object.
`String`	`toString()` Returns a string representation of the object.
`URI`	`toURI()` Converts this file to a URI.
`URL`	`toURL()` Converts this file to a URL.

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

- Field Detail
  - separatorChar
```
public static final char separatorChar
```
    See Also:
    
    Constant Field Values
  - separator
```
public static final String separator
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - File
```
public File(URI uri)
```
    Creates a new File object from the given URI
    
    Parameters:
    
    uri -
  - File
```
public File(String path)
```
    Creates a new file object with given path. Paths that do not begin with the "file:" prefix will automatically be prefixed with the app home path.
    
    Parameters:
    
    path - The path of the file. Relative or absolute.
  - File
```
public File(String dir,
            String file)
```
    Creates a new file object in a given directory.
    
    Parameters:
    
    dir - The parent directory path.
    
    file - The file name
  - File
```
public File(File parent,
            String path)
```
    Creates a new file in the given parent directory, and subpath.
    
    Parameters:
    
    parent - The parent directory.
    
    path - The subpath, beginning with the parent directory.
- Method Detail
  - getName
```
public String getName()
```
    Returns the file name.
    
    Returns:
    
    The file name.
  - getParent
```
public String getParent()
```
    Gets the parent directory path.
    
    Returns:
    
    The parent directory path.
  - getParentFile
```
public File getParentFile()
```
    Returns the file object for the parent directory.
    
    Returns:
  - getPath
```
public String getPath()
```
    Gets the path to the file.
    
    Returns:
  - isAbsolute
```
public boolean isAbsolute()
```
    Checks if the path is absolute. This always returns true as all File objects use absolute paths - even if they were created with relative paths. Relative paths are automatically prefixed with the app home directory path.
    
    Returns:
  - getAbsolutePath
```
public String getAbsolutePath()
```
    Gets the absolute path of the file as a string,
    
    Returns:
  - getAbsoluteFile
```
public File getAbsoluteFile()
```
    Gets the absolute file - which is always itself, since isAbsolute() always returns true.
    
    Returns:
    
    The same file object.
  - exists
```
public boolean exists()
```
    Checks if the file described by this object exists on the file system.
    
    Returns:
  - isDirectory
```
public boolean isDirectory()
```
    Checks if this file is a directory.
    
    Returns:
  - isFile
```
public boolean isFile()
```
    Checks if this file object represents a regular file.
    
    Returns:
  - isHidden
```
public boolean isHidden()
```
    Checks if this is a hidden file.
    
    Returns:
  - lastModified
```
public long lastModified()
```
    Gets the last modified time as a unix timestamp in milliseconds.
    
    Returns:
  - length
```
public long length()
```
    Gets the file size in bytes.
    
    Returns:
    
    The file size in bytes.
  - createNewFile
```
public boolean createNewFile()
                      throws IOException
```
    Creates this file as a new blank file in the file system.
    
    Returns:
    
    True if it succeeds.
    
    Throws:
    
    IOException
  - delete
```
public boolean delete()
```
    Deletes the file described by this object on the file system.
    
    Returns:
    
    True if delete succeeds.
  - list
```
public String[] list()
```
    Returns the list of child files of this directory.
    
    Returns:
  - list
```
public String[] list(File.FilenameFilter filter)
```
    Returns list of child files of this directory
    
    Parameters:
    
    filter -
    
    Returns:
  - listFiles
```
public File[] listFiles()
```
    Gets a list of child files of this directory.
    
    Returns:
  - listFiles
```
public File[] listFiles(File.FilenameFilter ff)
```
    Gets a list of child files of this directory, filtered using the provided filter.
    
    Parameters:
    
    ff - The filter to use.
    
    Returns:
  - listFiles
```
public File[] listFiles(File.FileFilter ff)
```
    Gets a list of child files of this directory, filtering them using the provided filter.
    
    Parameters:
    
    ff - The filter to use to filter output.
    
    Returns:
  - mkdir
```
public boolean mkdir()
```
    Attempts to make the directory described by this object.
    
    Returns:
    
    True on success.
  - mkdirs
```
public boolean mkdirs()
```
    Attempts to make the directory (and all parent directories) of this object.
    
    Returns:
    
    True on success.
  - renameTo
```
public boolean renameTo(File f)
```
    Renames the file to the provided file object.
    
    Parameters:
    
    f - The file object that we are renaming the file to.
    
    Returns:
    
    True on success.
  - canExecute
```
public boolean canExecute()
```
    Checks if this file is executable.
    
    Returns:
  - listRoots
```
public static File[] listRoots()
```
    List the file system roots.
    
    Returns:
  - getTotalSpace
```
public long getTotalSpace()
```
    Returns the total space on the root file system.
    
    Returns:
  - getFreeSpace
```
public long getFreeSpace()
```
    Gets the free space on the root file system.
    
    Returns:
  - getUsableSpace
```
public long getUsableSpace()
```
    Gets the usable space on this file system.
    
    Returns:
  - createTempFile
```
public static File createTempFile(String prefix,
                                  String suffix)
                           throws IOException
```
    Creates a temporary file.
    
    Parameters:
    
    prefix - The file name prefix.
    
    suffix - The file name suffix
    
    Returns:
    
    The resulting temporary file.
    
    Throws:
    
    IOException
  - equals
```
public boolean equals(Object o)
```
    Checks if the given object refers to the same file.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    o -
    
    Returns:
  - hashCode
```
public int hashCode()
```
    Description copied from class: Object
    
    Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable. The general contract of hashCode is: Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hashtables. As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)
    
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Description copied from class: Object
    
    Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method. The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of: getClass().getName() + '@' + Integer.toHexString(hashCode())
    
    Overrides:
    
    toString in class Object
  - toURL
```
public URL toURL()
          throws MalformedURLException
```
    Converts this file to a URL.
    
    Returns:
    
    Throws:
    
    MalformedURLException
  - toURI
```
public URI toURI()
          throws URISyntaxException
```
    Converts this file to a URI.
    
    Returns:
    
    Throws:
    
    URISyntaxException

Class File

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

separatorChar

separator

Constructor Detail

File

File

File

File

Method Detail

getName

getParent

getParentFile

getPath

isAbsolute

getAbsolutePath

getAbsoluteFile

exists

isDirectory

isFile

isHidden

lastModified

length

createNewFile

delete

list

list

listFiles

listFiles

listFiles

mkdir

mkdirs

renameTo

canExecute

listRoots

getTotalSpace

getFreeSpace

getUsableSpace

createTempFile

equals

hashCode

toString

toURL

toURI