| org.apache.cocoon.components.language.programming.ProgrammingLanguage
All known Subclasses: org.apache.cocoon.components.language.programming.AbstractProgrammingLanguage, org.apache.cocoon.components.language.programming.python.PythonLanguage,
| ProgrammingLanguage | | public interface ProgrammingLanguage extends Component(Code) | | This interface states the functionality of a programming language processor
author:
Ricardo Rocha
version:
CVS $Id: ProgrammingLanguage.java 433543 2006-08-22 06:22:54Z crossley $ |
| getCodeFormatter | | CodeFormatter getCodeFormatter()(Code) | | Return the CodeFormatter associated with this programming
language
The code formatter object or null if none isavailable |
| getLanguageName | | String getLanguageName()(Code) | | Get Language Name
The name of the language |
| getSourceExtension | | String getSourceExtension()(Code) | | Return the programming language's source file extension
The canonical source file extension |
| load | | Program load(String filename, File baseDirectory, String encoding) throws LanguageException(Code) | | Load a program from a file
Parameters:
filename - The program base file name
Parameters:
baseDirectory - The directory containing the program file
Parameters:
encoding - The encoding expected in the source file ornull if it is the platform's default encoding The loaded program
exception:
LanguageException - If an error occurs during loading |
| preload | | Program preload(String filename, File baseDirectory, String encoding) throws LanguageException(Code) | | Preload a program from a file
Parameters:
filename - The program base file name
Parameters:
baseDirectory - The directory containing the program file
Parameters:
encoding - The encoding expected in the source file ornull if it is the platform's default encoding The loaded program
exception:
LanguageException - If an error occurs during loading |
| quoteString | | String quoteString(String constant)(Code) | | Escape a String according to the programming language's
string constant encoding rules.
Parameters:
constant - The string to be escaped The escaped string |
| setLanguageName | | void setLanguageName(String name)(Code) | | Set Language Name
Parameters:
name - The name of the language |
| unload | | void unload(Object program, String filename, File baseDirectory) throws LanguageException(Code) | | Unload from memory and invalidate a given program
Parameters:
program - The program
Parameters:
filename - The name of the file this program was loaded from
Parameters:
baseDirectory - The directory containing the program file
exception:
LanguageException - If an error occurs |
|
|