File (JanosRuntime JavaDOC)

java.lang.Object
- java.io.File

```
public class File
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`pathSeparator` The system-dependent path-separator character, represented as a string for convenience.
`static char`	`pathSeparatorChar` The system-dependent path-separator character.
`static String`	`separator` The system-dependent default name-separator character, represented as a string for convenience.
`static char`	`separatorChar` The system-dependent default name-separator character.

Constructor Summary

Constructors
Constructor and Description
`File(File parent, String child)` Creates a new File instance from a parent pathname string and a child pathname string.
`File(String pathname)` Creates a new File instance by converting the given pathname string into an abstract pathname.
`File(String parent, String child)` Creates a new File instance from a parent pathname string and a child pathname string.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`available(Object obj)` Returns an estimate of the number of remaining bytes that can be read (or skipped over) from this stream.
`boolean`	`canRead()` Tests whether the application can read the file denoted by this abstract pathname.
`boolean`	`canWrite()` Tests whether the application can modify the file denoted by this abstract pathname.
`boolean`	`delete()` Deletes the file.
`boolean`	`equals(Object obj)` Compares two Objects for equality.
`boolean`	`exists()`
`String`	`getAbsolutePath()`
`String`	`getCanonicalPath()`
`String`	`getName()`
`String`	`getParent()`
`String`	`getPath()`
`int`	`hashCode()` Returns a hash code value for the object.
`boolean`	`isAbsolute()`
`boolean`	`isDirectory()`
`boolean`	`isFile()`
`long`	`lastModified()`
`long`	`length()`
`String[]`	`list()`
`String[]`	`list(FilenameFilter filenamefilter)`
`boolean`	`mkdir()`
`boolean`	`mkdirs()`
`boolean`	`renameTo(File file)`
`void`	`setLastModified(long newTime)` Sets the Last Modified timestamp for the file.
`void`	`setLength(Object obj, long newLength)`
`String`	`toString()` Returns a string representation of the object.

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

- Field Detail
  - separator
```
public static final String separator
```
    The system-dependent default name-separator character, represented as a string for convenience. This string contains a single character, namely separatorChar.
    
    See Also:
    
    Constant Field Values
  - separatorChar
```
public static final char separatorChar
```
    The system-dependent default name-separator character. This field is initialized to contain the first character of the value of the system property file.separator. On UNIX systems the value of this field is '/'; on Win32 systems it is '\'. JANOS will follow the UNIX standard and use '/'.
  - pathSeparator
```
public static final String pathSeparator
```
    The system-dependent path-separator character, represented as a string for convenience. This string contains a single character, namely pathSeparatorChar.
    
    See Also:
    
    Constant Field Values
  - pathSeparatorChar
```
public static final char pathSeparatorChar
```
    The system-dependent path-separator character. This field is initialized to contain the first character of the value of the system property path.separator. This character is used to separate filenames in a sequence of files given as a path list. On UNIX systems, this character is ':'; on Win32 systems it is ';'. JANOS will use the Win32 standard ';' as this seems more prevalent in our opinion.
- Constructor Detail
  - File
```
public File(String pathname)
```
    Creates a new File instance by converting the given pathname string into an abstract pathname. If the given string is the empty string, then the result is the empty abstract pathname. If not specified from the root the relative path will be taken from the current working directory.
    
    Parameters:
    
    pathname - the file path
    
    Throws:
    
    NullPointerException - if path is null
  - File
```
public File(String parent,
            String child)
```
    Creates a new File instance from a parent pathname string and a child pathname string. If parent is null then the new File instance is created as if by invoking the single-argument File constructor on the given child pathname string. Otherwise the parent pathname string is taken to denote a directory, and the child pathname string is taken to denote either a directory or a file. If the child pathname string is absolute then the parent directory is ignored. If parent is the empty string then the new File instance is created by converting child into an abstract pathname and resolving the result against the current working directory. Otherwise a path is created with the child defining a file or subfolder within the parent directory. If the result is not specified from the root the relative path will be taken from the current working directory.
    
    Parameters:
    
    parent - parent folder
    
    child - child subfolder or file
    
    Throws:
    
    NullPointerException - if child is null
  - File
```
public File(File parent,
            String child)
```
    Creates a new File instance from a parent pathname string and a child pathname string. If parent is null then the new File instance is created as if by invoking the single-argument File constructor on the given child pathname string. Otherwise the parent pathname string is taken to denote a directory, and the child pathname string is taken to denote either a directory or a file. If the child pathname string is absolute then the parent directory is ignored. If parent is the empty string then the new File instance is created by converting child into an abstract pathname and resolving the result against the current working directory. Otherwise a path is created with the child defining a file or subfolder within the parent directory. If the result is not specified from the root the relative path will be taken from the current working directory.
    
    Parameters:
    
    parent - parent folder
    
    child - child subfolder or file
    
    Throws:
    
    NullPointerException - if child is null
- Method Detail
  - available
```
public static int available(Object obj)
```
    Returns an estimate of the number of remaining bytes that can be read (or skipped over) from this stream.
    
    Parameters:
    
    obj - handle?
    
    Returns:
    
    remaining bytes
  - canRead
```
public boolean canRead()
```
    Tests whether the application can read the file denoted by this abstract pathname.
    
    Returns:
    
    true if and only if the file specified by this abstract pathname exists and can be read by the application; false otherwise
  - canWrite
```
public boolean canWrite()
```
    Tests whether the application can modify the file denoted by this abstract pathname.
    
    Returns:
    
    true if and only if the file system actually contains a file denoted by this abstract pathname and the application is allowed to write to the file; false otherwise.
  - delete
```
public boolean delete()
```
    Deletes the file.
    
    Returns:
    
    true if successful
  - equals
```
public boolean equals(Object obj)
```
    Description copied from class: Object
    Compares two Objects for equality.
    The equals method implements an equivalence relation:
    - It is reflexive: for any reference value x, x.equals(x) should return true.
    - It is symmetric: for any reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
    - It is transitive: for any reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
    - It is consistent: for any reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false.
    - For any reference value x, x.equals(null) should return false.
    The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any reference values x and y, this method returns true if and only if x and y refer to the same object (x==y has the value true).
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - the reference object with which to compare.
    
    Returns:
    
    true if this object is the same as the obj argument; false otherwise.
    
    See Also:
    
    Boolean.hashCode(), Hashtable
  - exists
```
public boolean exists()
```
    Returns:
    
    ?
  - getAbsolutePath
```
public String getAbsolutePath()
```
    Returns:
    
    ?
  - getCanonicalPath
```
public String getCanonicalPath()
                        throws IOException
```
    Returns:
    
    ?
    
    Throws:
    
    IOException - ?
  - setLength
```
public void setLength(Object obj,
                      long newLength)
               throws IOException
```
    Parameters:
    
    obj - ?
    
    newLength - ?
    
    Throws:
    
    IOException - ?
  - setLastModified
```
public void setLastModified(long newTime)
```
    Sets the Last Modified timestamp for the file.
    
    Parameters:
    
    newTime - time
  - getName
```
public String getName()
```
    Returns:
    
    ?
  - getParent
```
public String getParent()
```
    Returns:
    
    ?
  - getPath
```
public String getPath()
```
    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. 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 method, then calling the hashCode method on each of the two objects must produce the same integer result.
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    a hash code value for this object.
    
    See Also:
    
    Object.equals(java.lang.Object), Hashtable
  - isAbsolute
```
public boolean isAbsolute()
```
    Returns:
    
    ?
  - isDirectory
```
public boolean isDirectory()
```
    Returns:
    
    ?
  - isFile
```
public boolean isFile()
```
    Returns:
    
    ?
  - lastModified
```
public long lastModified()
```
    Returns:
    
    ?
  - length
```
public long length()
```
    Returns:
    
    ?
  - list
```
public String[] list()
```
    Returns:
    
    ?
  - list
```
public String[] list(FilenameFilter filenamefilter)
```
    Parameters:
    
    filenamefilter - ?
    
    Returns:
    
    ?
  - mkdir
```
public boolean mkdir()
```
    Returns:
    
    ?
  - mkdirs
```
public boolean mkdirs()
```
    Returns:
    
    ?
  - renameTo
```
public boolean renameTo(File file)
```
    Parameters:
    
    file - ?
    
    Returns:
    
    ?
  - 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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the object.

Class File

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

separator

separatorChar

pathSeparator

pathSeparatorChar

Constructor Detail

File

File

File

Method Detail

available

canRead

canWrite

delete

equals

exists

getAbsolutePath

getCanonicalPath

setLength

setLastModified

getName

getParent

getPath

hashCode

isAbsolute

isDirectory

isFile

lastModified

length

list

list

mkdir

mkdirs

renameTo

toString