com.togethersoft.openapi.ide.tools
Interface IdeToolFilter

public interface IdeToolFilter

Interface IdeToolFilter describes a filter of error information. A filter is a class that provides parsing of tool's output string, giving out all messages, or error messages only.

Author:
TogetherSoft
Field Summary
 final static intMODE_ALL_MESSAGES
           
 final static intMODE_ONLY_ERRORS
           

Method Summary
 IdeErrorInfogetErrorInfo(String toolOutput)
           Parses specified output string.
 StringgetName()
           Returns the name of this filter.
 voidsetMode(int mode)
           Sets specified mode of operation that defines the type of output messages.

Field Detail

MODE_ALL_MESSAGES

public final static int MODE_ALL_MESSAGES

MODE_ONLY_ERRORS

public final static int MODE_ONLY_ERRORS
Method Detail

getErrorInfo

public IdeErrorInfo getErrorInfo(String toolOutput)
Parses specified output string.
Parameters:
toolOutput - String Output of this tool to be parsed
Returns: IdeErrorInfo object that represents the error information according to the filter type

getName

public String getName()
Returns the name of this filter.
Returns: String filter name

setMode

public void setMode(int mode)
Sets specified mode of operation that defines the type of output messages.
Parameters:
mode - int mode of output. Could be:
      MODE_ONLY_ERRORS  = 0       output only errors
      MODE_ALL_MESSAGES = 1       output all messages