com.ibm.lpex.prop
Class PropertiesParser
java.lang.Object
com.ibm.lpex.core.LpexCommonParser
com.ibm.lpex.prop.PropertiesParser
- All Implemented Interfaces:
- LpexConstants, LpexParser
- public class PropertiesParser
- extends LpexCommonParser
Document parser for Java properties files.
Actions (and any assigned keys) added by this parser:
- comment (Ctrl+/) - to comment the visible selected element(s) with '#'
- comment1 - to comment the visible selected element(s) with '!'
- compareKeys - to initiate a compare of the keys only
(ignoring values, comments, and white space)
- keys (Ctrl+G) - for a selective view of the keys defined
- uncomment (Ctrl+\) - to uncomment the visible selected element(s).
Keys already defined (e.g., by the active base profile) to an action
different from nullAction are not redefined in here.
Action modified by this document parser:
- contextHome - to skip comment-defining characters when determining
the start of the text.
| Fields inherited from class com.ibm.lpex.core.LpexCommonParser |
| ATTRIBUTES_COMMENT, ATTRIBUTES_COMMENT_KEYWORD, ATTRIBUTES_COMMENT1, ATTRIBUTES_DEFAULT, ATTRIBUTES_DIRECTIVE, ATTRIBUTES_ERROR, ATTRIBUTES_KEYWORD, ATTRIBUTES_KEYWORD1, ATTRIBUTES_LIBRARY, ATTRIBUTES_NONSOURCE, ATTRIBUTES_NUMERAL, ATTRIBUTES_STRING, ATTRIBUTES_STRING1, BACKGROUND_COLOR, CLASS_MESSAGE, LANGUAGE_CCPP, LANGUAGE_CICS, LANGUAGE_CL, LANGUAGE_COBOL, LANGUAGE_DDS, LANGUAGE_FORTRAN, LANGUAGE_HLASM, LANGUAGE_HTML, LANGUAGE_JAVA, LANGUAGE_JCL, LANGUAGE_LISP, LANGUAGE_PERL, LANGUAGE_PLI, LANGUAGE_REXX, LANGUAGE_RPG, LANGUAGE_SABRETALK, LANGUAGE_SQL, LANGUAGE_XMI, LANGUAGE_XML, LANGUAGE_XSL, LEXER_RC_END, LEXER_RC_EOF, LEXER_RC_MORE, LEXER_RC_OK, POPUP_END, POPUP_FILTERVIEW, POPUP_SOURCE, POPUP_TOP, PROTOKEY_EMPTY, STYLE_MESSAGE, STYLE_NAME, view
|
| Fields inherited from interface com.ibm.lpex.core.LpexConstants |
| HELP_COMMAND_MAP, LPEX_VERSION, MSG_POPUP_ERRORS, MSG_POPUP_EXCLUDESELECTION, MSG_POPUP_FILTERVIEWMENU, MSG_POPUP_INSERTMENU, MSG_POPUP_SELECTEDMENU, MSG_POPUP_SHOWALL, MSG_POPUP_SOURCEMENU, PARSE_PENDING_CHANGE_MASK, PARSE_PENDING_NEXT_DELETED_MASK, PARSE_PENDING_NEXT_SHOW_DELETED_MASK, PARSE_PENDING_PREV_DELETED_MASK, PARSE_PENDING_PREV_SHOW_DELETED_MASK, PLATFORM_AWT, PLATFORM_SWT, PLATFORM_SWT_KEY, STATUS_FILE_ERRORREADING, STATUS_FILE_INCORRECTENCODING, STATUS_FILE_NOTFOUND, STATUS_FINDTEXT_INVALIDPATTERN, STATUS_FINDTEXT_NOTFOUND, STATUS_FINDTEXT_ONLYOCCURRENCE, STATUS_FINDTEXT_READONLY, STATUS_FINDTEXT_WRAPPED, STATUS_LOCATE_NOSEQUENCETEXT, STATUS_LOCATE_NOTFOUND, STATUS_LOCATE_WRAPPED, STATUS_SAVE_CANCELLED, STATUS_SAVE_FAILED, STATUS_TEXTLIMIT_ENFORCED
|
| Methods inherited from class com.ibm.lpex.core.LpexCommonParser |
| addMessage, addMessage, addMessage, blockMarkWord, cursorIndent, expandProtoKeyword, getInstallStyleAttributes, getLanguage, getLshToken, getPopupParserItems, getPopupViewItems, getProperty, getStyleName, getStyles, getTextIndent, getToken, getTokenLocation, indentText, indentText, indentText, isDebuggable, isTokenDelimiter, lineComment, lpexView, matchToken, newLine, openLine, parse, removeMessages, removeMessages, resetParser, setProperty, setStyle, splitLine, styleString, terminateParser, tokenBegin, tokenEnd, totalParse
|
| Methods inherited from class java.lang.Object |
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
|
PropertiesParser
public PropertiesParser(LpexView lpexView)
- Constructor for the parser.
Adds all of the parser specifics to the LPEX document view.
Initializes the view for the parser: sets up all the style
attributes, classes, etc. for the language-sensitive edit features
supported.
- Parameters:
- lpexView - the document view associated with this parser
getPopupItems
protected String getPopupItems(int popupLocation)
- Retrieve parser's contribution to the popup.
This parser contributes to the "Filter view" submenu (Keys),
and to the "Source" submenu (Comment, Uncomment, Compare keys).
- Overrides:
- getPopupItems in class LpexCommonParser
- Parameters:
- popupLocation - the location on the popup menu of the items
requested, one of:
LpexCommonParser.POPUP_TOP, LpexCommonParser.POPUP_FILTERVIEW,
LpexCommonParser.POPUP_SOURCE, LpexCommonParser.POPUP_END
- Returns:
- this parser's contribution to the popup menu, or
null if none
setStyleAttributes
protected void setStyleAttributes()
- Define this parser's style attributes.
The following style characters are set:
'_' (layout blanks)
'k' (key)
'=' (equal)
'v' (value)
'a' (ampersand in value)
'c' (comment).
getCommentStyleCharacters
public String getCommentStyleCharacters()
- Return the style character used for styling comments ("c").
This is used by compare sessions when the
compare.ignoreComments option is in effect.
- Overrides:
- getCommentStyleCharacters in class LpexCommonParser
getLanguage
public String getLanguage()
- Returns "properties", the file type supported by this parser.
- Overrides:
- getLanguage in class LpexCommonParser
- See Also:
- LpexCommonParser.getProperty(java.lang.String),
LpexCommonParser.setProperty(java.lang.String, java.lang.String),
LpexCommonParser.LANGUAGE_CCPP,
LpexCommonParser.LANGUAGE_CICS,
LpexCommonParser.LANGUAGE_CL,
LpexCommonParser.LANGUAGE_COBOL,
LpexCommonParser.LANGUAGE_DDS,
LpexCommonParser.LANGUAGE_FORTRAN,
LpexCommonParser.LANGUAGE_HLASM,
LpexCommonParser.LANGUAGE_HTML,
LpexCommonParser.LANGUAGE_JAVA,
LpexCommonParser.LANGUAGE_JCL,
LpexCommonParser.LANGUAGE_LISP,
LpexCommonParser.LANGUAGE_PERL,
LpexCommonParser.LANGUAGE_PLI,
LpexCommonParser.LANGUAGE_REXX,
LpexCommonParser.LANGUAGE_RPG,
LpexCommonParser.LANGUAGE_SABRETALK,
LpexCommonParser.LANGUAGE_SQL,
LpexCommonParser.LANGUAGE_XMI,
LpexCommonParser.LANGUAGE_XML,
LpexCommonParser.LANGUAGE_XSL
getProfile
public ResourceBundle getProfile()
- Returns the parser's properties profile resource bundle.
- Overrides:
- getProfile in class LpexCommonParser
- See Also:
- LpexCommonParser.getProperty(java.lang.String),
Parser properties
parseAll
public void parseAll()
- Total parse of the entire document.
- Specified by:
- parseAll in class LpexCommonParser
- See Also:
- Total and incremental parse
parseElement
public void parseElement(int element)
- Incremental parse.
- Specified by:
- parseElement in class LpexCommonParser
- Parameters:
- element - the element whose committed change triggered the parse,
or the element that precedes or follows a deleted block.
The parser may identify other neighbouring elements that
will have to be reparsed as a unit
- See Also:
- LpexView.parsePending(int),
LpexView.elementParsed(int),
Total and incremental parse
parseOneElement
protected void parseOneElement(int element)
- Parse one element in the document.
- Parameters:
- element - one document element to parse