ISourceBreakPoint Interface

com.bea.ide.debug
ISourceBreakPoint Interface

public interface ISourceBreakPoint

    extends IDebugBreakPoint

This is an interface on a breakpoint showing that it is paying attention to the source file it is in.


All Known Implementing Classes
SourceBreakpoint
All Superinterfaces
IDebugBreakPoint, Serializable

Nested Class Summary

 
Nested classes from interface com.bea.ide.debug.IDebugBreakPoint
IDebugBreakPoint.IBreakpointContext
 

Field Summary

public static final String
PROP_LINE_NUMBER
This property is the current line number.
   
Fields from interface com.bea.ide.debug.IDebugBreakPoint
BP_PROP_CONDITION, INVALID_ID, PROP_ERROR_MESSAGE
 

Method Summary

public void
documentLoaded()
This gets called on the Breakpoint, before it is handed to a document to be set.
public void
documentUnloaded()
This gets called on the Breakpoint, right after it is removed from a document.
public ISourceDocument
getCachedDocument()
Gets the document represented by this breakpoint.
public int
getLine()
Gets the line number for this break point.
public URI
getURI()
Gets the URI for the IDocument this breakpoint is set in.
public void
updateLine()
Re-syncs the line information with the underlying document
 
Methods from interface com.bea.ide.debug.IDebugBreakPoint
breakpointHit, clearBreakpoint, disable, getErrorMessage, getId, getProperties, getProperty, isDisabled, isValid, setErrorMessage, setId, setProperties, setProperty, supportsProperty, syncBreakpoint
   

Field Detail

PROP_LINE_NUMBER

public static final String PROP_LINE_NUMBER
This property is the current line number. If you register to get chagne requests for this property, you will get notified whenever the current line changes.

 

Method Detail

documentLoaded() Method

public void documentLoaded()
This gets called on the Breakpoint, before it is handed to a document to be set. This is where the breakpoint does any initialization work it could not do at start-up time.


documentUnloaded() Method

public void documentUnloaded()
This gets called on the Breakpoint, right after it is removed from a document. This can happen when a breakpoint is removed, or when a Document is hidden. A breakpoint can have unInit called on it, even though init might not have been called.


getCachedDocument() Method

public ISourceDocument getCachedDocument()
Gets the document represented by this breakpoint. This will return NULL if the breakpoint is not loaded, or if it does not have a reference to the document.

Returns

returns a reference to the document represented by the breakpoint if currently available.

getLine() Method

public int getLine()
Gets the line number for this break point. If a line number doesn't make sense for this breakpoint, the breakpoint should return some unique int that describes its position in the document. The document's IDebugDriver must understand the int.

Returns

a unique value describing the line the breakpoint is on

getURI() Method

public URI getURI()
Gets the URI for the IDocument this breakpoint is set in.

Returns

a URI that describes the document this breakpoint is in. You can get the IDocument for this URI via the DocumentSvc.

updateLine() Method

public void updateLine()
Re-syncs the line information with the underlying document