javax.tools.FileObject — clojure-interop/javax.tools 1.0.5

File abstraction for tools. In this context, file means an abstraction of regular files and other sources of data. For example, a file object can be used to represent regular files, memory cache, or data in databases.

All methods in this interface might throw a SecurityException if a security exception occurs.

Unless explicitly allowed, all methods in this interface might throw a NullPointerException if given a null argument.

delete clj

(delete this)

Deletes this file object. In case of errors, returns false.

returns: true if and only if this file object is successfully deleted; false otherwise - boolean

get-char-content clj

(get-char-content this ignore-encoding-errors)

Gets the character content of this file object, if available. Any byte that cannot be decoded will be replaced by the default translation character. In addition, a diagnostic may be reported unless ignoreEncodingErrors is true.

ignore-encoding-errors - ignore encoding errors if true - boolean

returns: a CharSequence if available; null otherwise - java.lang.CharSequence

throws: java.lang.IllegalStateException - if this file object was opened for writing and does not support reading

get-last-modified clj

(get-last-modified this)

Gets the time this file object was last modified. The time is measured in milliseconds since the epoch (00:00:00 GMT, January 1, 1970).

returns: the time this file object was last modified; or 0 if the file object does not exist, if an I/O error occurred, or if the operation is not supported - long

get-name clj

(get-name this)

Gets a user-friendly name for this file object. The exact value returned is not specified but implementations should take care to preserve names as given by the user. For example, if the user writes the filename "BobsApp\Test.java" on the command line, this method should return "BobsApp\Test.java" whereas the toUri method might return file:///C:/Documents%20and%20Settings/UncleBob/BobsApp/Test.java.

returns: a user-friendly name - java.lang.String

open-input-stream clj

(open-input-stream this)

Gets an InputStream for this file object.

returns: an InputStream - java.io.InputStream

throws: java.lang.IllegalStateException - if this file object was opened for writing and does not support reading

open-output-stream clj

(open-output-stream this)

Gets an OutputStream for this file object.

returns: an OutputStream - java.io.OutputStream

throws: java.lang.IllegalStateException - if this file object was opened for reading and does not support writing

open-reader clj

(open-reader this ignore-encoding-errors)

Gets a reader for this object. The returned reader will replace bytes that cannot be decoded with the default translation character. In addition, the reader may report a diagnostic unless ignoreEncodingErrors is true.

ignore-encoding-errors - ignore encoding errors if true - boolean

returns: a Reader - java.io.Reader

throws: java.lang.IllegalStateException - if this file object was opened for writing and does not support reading

open-writer clj

(open-writer this)

Gets a Writer for this file object.

returns: a Writer - java.io.Writer

throws: java.lang.IllegalStateException - if this file object was opened for reading and does not support writing

to-uri clj

(to-uri this)

Returns a URI identifying this file object.

returns: a URI - java.net.URI