org.apache.cocoon.components.language.programming.javascript
Class JavascriptLanguage

java.lang.Object
  |
  +--org.apache.avalon.framework.logger.AbstractLoggable
        |
        +--org.apache.cocoon.components.language.programming.AbstractProgrammingLanguage
              |
              +--org.apache.cocoon.components.language.programming.javascript.JavascriptLanguage
All Implemented Interfaces:
org.apache.avalon.framework.component.Component, org.apache.avalon.framework.logger.Loggable, org.apache.avalon.framework.parameters.Parameterizable, ProgrammingLanguage

public class JavascriptLanguage
extends AbstractProgrammingLanguage
implements ProgrammingLanguage

The interpreted Javascript programming language. Program in Javascript must have comment line as first line of file:

 // $Cocoon extends: org.apache.cocoon.components.language.xsp.JSGenerator$
 
The class specified will be used as a Java wrapper interpreting javascript program.

Version:
CVS $Id: JavascriptLanguage.java,v 1.9 2002/03/08 04:08:53 vgritsenko Exp $
Author:
Vadim Gritsenko

Fields inherited from class org.apache.cocoon.components.language.programming.AbstractProgrammingLanguage
codeFormatter, languageName
 
Fields inherited from interface org.apache.cocoon.components.language.programming.ProgrammingLanguage
ROLE
 
Constructor Summary
JavascriptLanguage()
           
 
Method Summary
protected  void doUnload(java.lang.Object program, java.lang.String filename, java.io.File baseDir)
          Unload a previously loaded program
 java.lang.String getSourceExtension()
          Return the language's canonical source file extension.
 Program load(java.lang.String filename, java.io.File baseDirectory, java.lang.String encoding)
          Load a program from a file
 java.lang.String quoteString(java.lang.String constant)
          Escape a String according to the programming language's string constant encoding rules.
 
Methods inherited from class org.apache.cocoon.components.language.programming.AbstractProgrammingLanguage
getCodeFormatter, getLanguageName, instantiate, parameterize, setLanguageName, unload
 
Methods inherited from class org.apache.avalon.framework.logger.AbstractLoggable
getLogger, setLogger, setupLogger, setupLogger, setupLogger
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.cocoon.components.language.programming.ProgrammingLanguage
getCodeFormatter, getLanguageName, instantiate, setLanguageName, unload
 

Constructor Detail

JavascriptLanguage

public JavascriptLanguage()
Method Detail

load

public Program load(java.lang.String filename,
                    java.io.File baseDirectory,
                    java.lang.String encoding)
             throws LanguageException
Description copied from interface: ProgrammingLanguage
Load a program from a file
Specified by:
load in interface ProgrammingLanguage
Following copied from interface: org.apache.cocoon.components.language.programming.ProgrammingLanguage
Parameters:
filename - The program base file name
baseDirectory - The directory containing the program file
encoding - The encoding expected in the source file or null if it is the platform's default encoding
Returns:
The loaded program
Throws:
LanguageException - If an error occurs during loading

doUnload

protected void doUnload(java.lang.Object program,
                        java.lang.String filename,
                        java.io.File baseDir)
                 throws LanguageException
Description copied from class: AbstractProgrammingLanguage
Unload a previously loaded program
Overrides:
doUnload in class AbstractProgrammingLanguage
Following copied from class: org.apache.cocoon.components.language.programming.AbstractProgrammingLanguage
Parameters:
program - A previously loaded object program
Throws:
LanguageException - If an error occurs during unloading

quoteString

public java.lang.String quoteString(java.lang.String constant)
Description copied from interface: ProgrammingLanguage
Escape a String according to the programming language's string constant encoding rules.
Specified by:
quoteString in interface ProgrammingLanguage
Following copied from interface: org.apache.cocoon.components.language.programming.ProgrammingLanguage
Parameters:
constant - The string to be escaped
Returns:
The escaped string

getSourceExtension

public java.lang.String getSourceExtension()
Return the language's canonical source file extension.
Specified by:
getSourceExtension in interface ProgrammingLanguage
Returns:
The source file extension


Copyright © 1999-2002 Apache Software Foundation. All Rights Reserved.