flash.tools.debugger.threadsafe

Class ThreadSafeSourceFile

java.lang.Object

flash.tools.debugger.threadsafe.ThreadSafeSourceFile

All Implemented Interfaces:

SourceFile

public class ThreadSafeSourceFile
extends Object
implements SourceFile

Thread-safe wrapper for flash.tools.debugger.SourceFile

Author:

Mike Morearty

Method Summary

Methods

Modifier and Type	Method and Description
String	getBasePath() Base path for this filename, without the package-name portion.
String	getFullPath() Full path and file name, if its exists, for this SourceFile.
String	getFunctionNameForLine(Session session, int lineNum) Return the function name for a given line number, or null if not known or if the line matches more than one function.
String[]	getFunctionNames(Session session) Get a list of all function names for this SourceFile
int	getId() Return a unique identifier for this SourceFile.
String	getLine(int lineNum) Obtains the textual content of the given line from within a source file.
int	getLineCount() Returns the number of source lines in the given file
int	getLineForFunctionName(Session session, String name) Return the line number for the given function name if it doesn't exists -1 is returned
String	getName() File name of this SourceFile.
int	getOffsetForLine(int lineNum) Return the offset within the SWF for a given line number.
String	getPackageName() Get the package name portion of the path for this file.
static SourceFile	getRaw(SourceFile f) Returns the raw SourceFile underlying a ThreadSafeSourceFile.
String	getRawName() Raw, unprocessed file name for this SourceFile.
Object	getSyncObject()
static Object	getSyncObject(SourceFile sf)
String	toString()
static ThreadSafeSourceFile	wrap(Object syncObj, SourceFile sourceFile) Wraps a SourceFile inside a ThreadSafeSourceFile.
static ThreadSafeSourceFile[]	wrapArray(Object syncObj, SourceFile[] sourceFiles) Wraps an array of SourceFiles inside an array of ThreadSafeSourceFiles.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

wrap

public static ThreadSafeSourceFile wrap(Object syncObj,
                        SourceFile sourceFile)

Wraps a SourceFile inside a ThreadSafeSourceFile. If the passed-in SourceFile is null, then this function returns null.

wrapArray

public static ThreadSafeSourceFile[] wrapArray(Object syncObj,
                               SourceFile[] sourceFiles)

Wraps an array of SourceFiles inside an array of ThreadSafeSourceFiles.

getRaw

public static SourceFile getRaw(SourceFile f)

Returns the raw SourceFile underlying a ThreadSafeSourceFile.

getSyncObject

public static Object getSyncObject(SourceFile sf)

getRawName

public String getRawName()

Description copied from interface: SourceFile

Raw, unprocessed file name for this SourceFile.

Specified by:

getRawName in interface SourceFile

getFunctionNameForLine

public String getFunctionNameForLine(Session session,
                            int lineNum)

Description copied from interface: SourceFile

Return the function name for a given line number, or null if not known or if the line matches more than one function.

Specified by:

getFunctionNameForLine in interface SourceFile

getFunctionNames

public String[] getFunctionNames(Session session)

Description copied from interface: SourceFile

Get a list of all function names for this SourceFile

Specified by:

getFunctionNames in interface SourceFile

getId

public int getId()

Description copied from interface: SourceFile

Return a unique identifier for this SourceFile.

Specified by:

getId in interface SourceFile

getLine

public String getLine(int lineNum)

Description copied from interface: SourceFile

Obtains the textual content of the given line from within a source file. Line numbers start at 1 and go to getLineCount().

Specified by:

getLine in interface SourceFile

Returns:

the line of source of the file. Any carriage return and/or line feed are stripped from the end of the string.

getLineCount

public int getLineCount()

Description copied from interface: SourceFile

Returns the number of source lines in the given file

Specified by:

getLineCount in interface SourceFile

Returns:

-1 indicates an error. Call getError() to obtain specific reason code.

getLineForFunctionName

public int getLineForFunctionName(Session session,
                         String name)

Description copied from interface: SourceFile

Return the line number for the given function name if it doesn't exists -1 is returned

Specified by:

getLineForFunctionName in interface SourceFile

getName

public String getName()

Description copied from interface: SourceFile

File name of this SourceFile. In the case of a disk-based SourceFile, this is the same as the filename with no path, e.g. 'myfile.as'

Specified by:

getName in interface SourceFile

Returns:

filename, or "" (never null)

getOffsetForLine

public int getOffsetForLine(int lineNum)

Description copied from interface: SourceFile

Return the offset within the SWF for a given line number.

Specified by:

getOffsetForLine in interface SourceFile

getPackageName

public String getPackageName()

Description copied from interface: SourceFile

Get the package name portion of the path for this file. For example, if class mx.controls.Button.as was in C:\flex\sdk\frameworks\mx\controls\Button.as, then getPackageName() would return "mx\controls".

Specified by:

getPackageName in interface SourceFile

Returns:

package name, or "" (never null)

getFullPath

public String getFullPath()

Description copied from interface: SourceFile

Full path and file name, if its exists, for this SourceFile. For disk-based SourceFiles, this is equivalent to getBasePath + slash + getPackageName() + slash + getName() where "slash" is a platform-specific slash character.

Specified by:

getFullPath in interface SourceFile

Returns:

path, never null

getBasePath

public String getBasePath()

Description copied from interface: SourceFile

Base path for this filename, without the package-name portion. For example, if class mx.controls.Button.as was in C:\flex\sdk\frameworks\mx\controls\Button.as, then getBasePath() would return "C:\flex\sdk\frameworks" (note that the "mx\controls" part would NOT be returned).

Specified by:

getBasePath in interface SourceFile

Returns:

base path, or null

toString

public String toString()

Overrides:

toString in class Object

getSyncObject

public final Object getSyncObject()