|
Mirror API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Filer
This interface supports the creation of new files by an annotation processor. Files created in this way will be known to the annotation processing tool implementing this interface, better enabling the tool to manage them. Four kinds of files are distinguished: source files, class files, other text files, and other binary files. The latter two are collectively referred to as auxiliary files.
There are two distinguished locations (subtrees within the file system) where newly created files are placed: one for new source files, and one for new class files. (These might be specified on a tool's command line, for example, using flags such as -s and -d.) Auxiliary files may be created in either location.
During each run of an annotation processing tool, a file with a given pathname may be created only once. If that file already exists before the first attempt to create it, the old contents will be deleted. Any subsequent attempt to create the same file during a run will fail.
Nested Class Summary | |
---|---|
static class |
Filer.Location
Locations (subtrees within the file system) where new files are created. |
Method Summary | |
---|---|
OutputStream |
createBinaryFile(Filer.Location loc,
String pkg,
File relPath)
Creates a new binary file, and returns a stream for writing to it. |
OutputStream |
createClassFile(String name)
Creates a new class file, and returns a stream for writing to it. |
PrintWriter |
createSourceFile(String name)
Creates a new source file and returns a writer for it. |
PrintWriter |
createTextFile(Filer.Location loc,
String pkg,
File relPath,
String charsetName)
Creates a new text file, and returns a writer for it. |
Method Detail |
---|
PrintWriter createSourceFile(String name) throws IOException
The charset used to encode the file is determined by the implementation. An annotation processing tool may have an -encoding flag or the like for specifying this. It will typically use the platform's default encoding if none is specified.
name
- canonical (fully qualified) name of the principal type
being declared in this file
IOException
- if the file cannot be createdOutputStream createClassFile(String name) throws IOException
name
- canonical (fully qualified) name of the type being written
IOException
- if the file cannot be createdPrintWriter createTextFile(Filer.Location loc, String pkg, File relPath, String charsetName) throws IOException
A charset for
encoding the file may be provided. If none is given, the
charset used to encode source files
(see createSourceFile(String)
) will be used.
loc
- location of the new filepkg
- package relative to which the file should be named,
or the empty string if nonerelPath
- final pathname components of the filecharsetName
- the name of the charset to use, or null if none
is being explicitly specified
IOException
- if the file cannot be createdOutputStream createBinaryFile(Filer.Location loc, String pkg, File relPath) throws IOException
loc
- location of the new filepkg
- package relative to which the file should be named,
or the empty string if nonerelPath
- final pathname components of the file
IOException
- if the file cannot be created
|
Mirror API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |