org.netbeans.modules.j2ee.deployment.plugins.api
Interface OldJSPDebug.JspSourceMapper

Enclosing interface:
OldJSPDebug

public static interface OldJSPDebug.JspSourceMapper

Provides common interface for JSP <----> Java mappings


Nested Class Summary
static interface OldJSPDebug.JspSourceMapper.NameConverter
          Converts the JSP file name (from the string int the servlet comments into the Forte4J resource name)
 
Method Summary
 Map getFileNames()
           
 String getJavaLineType(int line, int col)
          Returns the type of the generated Servlet line/column
 String getJspFileName(int line, int col)
          Returns the JSP file name for the given line/column in the generated Servlet
 String getPrimaryJspFileName()
          Get the value of primaryJspFileName.
 boolean hasIncludeFiles()
          Returns whether the primary JSP page has included files (HTML, JSP etc)
 boolean isEmpty()
          Returns whether the JSP page is empty
 boolean isJavaCodeInJspPage(int line, int col)
          Returns whether the giver Servlet line/column is a part of dynamic (Java) code in the JSP page
 boolean isProperJspFileName(String name)
          Returns whether the given name is a proper JSP file name
 int mangle(int line)
          Returns Java Servlet line number for the given line number of the primary (not "included") JSP file
 int mangle(int line, int col)
          Returns Java Servlet line number for the given line/column number of the primary (not "included") JSP file
 int mangle(String jspFile, int line)
          Returns Java Servlet line number for the given line number of the given JSP
 int mangle(String jspFileName, int line, int col)
          Returns Java Servlet line/column number for the given line number of the given JSP
 void setPrimaryJspFileName(String v)
          Set the value of primaryJspFileName.
 int size()
          Returns the number of entries in this source mapper.
 int unmangle(int line)
          Returns primary (not "included") JSP file line number for the given line number in the generated Java Servlet
 int unmangle(int line, int col)
          Returns primary (not "included") JSP file line/column number for the given line number in the generated Java Servlet
 int unmangle(String jspFileName, int line, int col)
          Returns JSP file line/column number for the given line number in the generated Java Servlet
 

Method Detail

getPrimaryJspFileName

String getPrimaryJspFileName()
Get the value of primaryJspFileName.

Returns:
Value of primaryJspFileName.

setPrimaryJspFileName

void setPrimaryJspFileName(String v)
Set the value of primaryJspFileName.

Parameters:
v - Value to assign to primaryJspFileName.

size

int size()
Returns the number of entries in this source mapper. This number is 0, if no entries were made.

Returns:
The number of entries in this source mapper. This number is 0, if no entries were made.

isEmpty

boolean isEmpty()
Returns whether the JSP page is empty

Returns:
Whether the JSP page is empty

mangle

int mangle(int line)
Returns Java Servlet line number for the given line number of the primary (not "included") JSP file

Parameters:
line - unmangled (JSP) line number
Returns:
The mangled (Servlet) line number

mangle

int mangle(int line,
           int col)
Returns Java Servlet line number for the given line/column number of the primary (not "included") JSP file

Parameters:
line - unmangled (JSP) line number
col - unmangled (JSP) column number
Returns:
The mangled (Servlet) line number

mangle

int mangle(String jspFile,
           int line)
Returns Java Servlet line number for the given line number of the given JSP

Parameters:
jspFile -

mangle

int mangle(String jspFileName,
           int line,
           int col)
Returns Java Servlet line/column number for the given line number of the given JSP

Parameters:
jspFileName - Name of the JSP file to map
line - unmangled (JSP) line number
col - unmangled (JSP) column number
Returns:
The mangled (Servlet) line number

unmangle

int unmangle(int line)
Returns primary (not "included") JSP file line number for the given line number in the generated Java Servlet

Parameters:
line - mangled (Servlet) line number
Returns:
The unmangled (JSP) line number

unmangle

int unmangle(int line,
             int col)
Returns primary (not "included") JSP file line/column number for the given line number in the generated Java Servlet

Parameters:
line - mangled (Servlet) line number
col - mangled (Servlet) column number
Returns:
The unmangled (JSP) line number

unmangle

int unmangle(String jspFileName,
             int line,
             int col)
Returns JSP file line/column number for the given line number in the generated Java Servlet

Parameters:
jspFileName - JSP file name
line - mangled (Servlet) line number
col - mangled (Servlet) column number
Returns:
The unmangled (JSP) line number

getJavaLineType

String getJavaLineType(int line,
                       int col)
Returns the type of the generated Servlet line/column

Parameters:
line - mangled (Servlet) line number
col - mangled (Servlet) column number
Returns:
The type of the generated Servlet line/column

getJspFileName

String getJspFileName(int line,
                      int col)
                      throws IOException
Returns the JSP file name for the given line/column in the generated Servlet

Parameters:
line - mangled (Servlet) line number
col - mangled (Servlet) column number
Returns:
The JSP file name for the given line/column in the generated Servlet
Throws:
IOException

isJavaCodeInJspPage

boolean isJavaCodeInJspPage(int line,
                            int col)
Returns whether the giver Servlet line/column is a part of dynamic (Java) code in the JSP page

Parameters:
line - mangled (Servlet) line number
col - mangled (Servlet) column number
Returns:
Whether the giver Servlet line/column is a part of dynamic (Java) code in the JSP page

getFileNames

Map getFileNames()
Returns:
a Map of all JSP file names comprising the generated Java servlet

hasIncludeFiles

boolean hasIncludeFiles()
Returns whether the primary JSP page has included files (HTML, JSP etc)

Returns:
Whether the primary JSP page has included files (HTML, JSP etc)

isProperJspFileName

boolean isProperJspFileName(String name)
Returns whether the given name is a proper JSP file name

Parameters:
name - given name
Returns:
whether the given name is a proper JSP file name

 

Built on March 27 2006.  |  Portions Copyright 1997-2005 Sun Microsystems, Inc. All rights reserved.