Class SectionParser

java.lang.Object

com.ibm.dtfj.javacore.parser.j9.SectionParserGrammar

com.ibm.dtfj.javacore.parser.j9.SectionParser

All Implemented Interfaces:

ISectionParser, ICommonTypes

Direct Known Subclasses:

ClassLoaderSectionParser, EnvironmentSectionParser, MemorySectionParser, MonitorSectionParser, NativeMemorySectionParser, PlatformSectionParser, StackSectionParser, ThreadSectionParser, TitleSectionParser

public abstract class SectionParser
extends SectionParserGrammar
implements ICommonTypes

Field Summary

Fields

Modifier and Type	Field	Description
protected IImageBuilder	fImageBuilder
protected static final int	LOOKAHEAD_DEPTH	Depth of at least 3 is needed for J9 javacores, as parsing a section from the start will yield three tokens: SECTION, header information token, first TAG of section (note that NULL lines are ignored by the scanner).

Fields declared in class SectionParserGrammar

anyMatched, DEFAULT_DEPTH, fLookAheadBuffer, FORCE_THROW, fSectionName, fTagManager, fTagParser

Modifier and Type	Field	Description
protected boolean	anyMatched
protected static final int	DEFAULT_DEPTH
protected ILookAheadBuffer	fLookAheadBuffer
protected static final int	FORCE_THROW
protected String	fSectionName
protected J9TagManager	fTagManager
protected ITagParser	fTagParser

Fields declared in interface ICommonTypes

BUILD_INFO, COMMON, JIT_BUILD_VERSION, JIT_PRESENT, JRE_NAME, JRE_VERSION, NULL, POINTER_SIZE, SECTION, UNAVAILABLE_DATA, VM_VERSION

Modifier and Type	Field	Description
static final String	BUILD_INFO
static final String	COMMON
static final String	JIT_BUILD_VERSION
static final String	JIT_PRESENT
static final String	JRE_NAME
static final String	JRE_VERSION
static final String	NULL
static final String	POINTER_SIZE
static final String	SECTION
static final String	UNAVAILABLE_DATA
static final String	VM_VERSION

Constructor Summary

Constructors

Constructor	Description
SectionParser(String sectionName)

Method Summary

Modifier and Type	Method	Description
boolean	addAsProperty(Properties properties, String key, String value)
void	readIntoDTFJ(ILookAheadBuffer lookAheadBuffer, IImageBuilder imageBuilder)	Pass in a lookahead buffer that is shared amongst all section parsers, pass in the DTFJ factory to construct the DTFJ objects as tags are being parsed.
protected abstract void	sovOnlyRules(String startingTag)
protected abstract void	topLevelRule()	Must be implemented by subclass.

Methods declared in class SectionParserGrammar

anyMatched, consume, getCurrentFileLineNumber, getErrors, getLineRuleResults, getLookAheadBuffer, getSectionName, handleError, handleError, handleError, handleError, handleError, handleErrorAtLineNumber, handleRequiredMismatch, handleUnknownMismatch, isValidJavaCoreTag, isValidSectionTag, lookAhead, match, matchOptional, matchRequired, processTagLineOptional, processTagLineRequired, setLookAheadBuffer, setLookAheadBuffer, setTagManager

Modifier and Type	Method	Description
boolean	anyMatched()
protected void	consume()
int	getCurrentFileLineNumber()	Returns the current line number being parsed, or -1 if no parsing is occurring (parsing is finished, etc..).
Iterator	getErrors()
protected IAttributeValueMap	getLineRuleResults(IParserToken token)
protected ILookAheadBuffer	getLookAheadBuffer()
String	getSectionName()
protected void	handleError(Exception e)
protected void	handleError(Exception e, int behaviour)
protected void	handleError(String message)
protected void	handleError(String message, int offset, int length)
protected void	handleError(String message, Exception e)
protected void	handleErrorAtLineNumber(int fileLineNumber, String message, Exception e)
protected void	handleRequiredMismatch(String expectedType, String actualType, String actualValue)
protected void	handleUnknownMismatch(String actualType, String actualValue)
protected boolean	isValidJavaCoreTag(IParserToken token)
protected boolean	isValidSectionTag(String tag)
protected IParserToken	lookAhead(int depth)
protected boolean	match(String type, boolean required)	The match performs one additional function: if the mismatch is due to an unrecognised javacore tag, that erroneous tag can be interpreted as garbage for now, so the latter is consumed without further processing.
protected boolean	matchOptional(String type)	Match a type, but do not generate an error if mismatch occurs.
protected boolean	matchRequired(String type)	Match a type, and generate an error if a mismatch occurs.
protected IAttributeValueMap	processTagLineOptional(String tagName)
protected IAttributeValueMap	processTagLineRequired(String tagName)
protected void	setLookAheadBuffer(ILookAheadBuffer lookAheadBuffer)
protected void	setLookAheadBuffer(ILookAheadBuffer lookAheadBuffer, int depth)
protected void	setTagManager(J9TagManager tagManager)

Methods declared in class Object

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

Field Details

fImageBuilder

protected IImageBuilder fImageBuilder

LOOKAHEAD_DEPTH

protected static final int LOOKAHEAD_DEPTH

Depth of at least 3 is needed for J9 javacores, as parsing a section from the start will yield three tokens: SECTION, header information token, first TAG of section (note that NULL lines are ignored by the scanner). Adjust as necessary for deeper analysis.

See Also:

• Constant Field Values

Constructor Details

SectionParser

public SectionParser(String sectionName)

Method Details

readIntoDTFJ

public void readIntoDTFJ(ILookAheadBuffer lookAheadBuffer,
 IImageBuilder imageBuilder)
                  throws ParserException

Description copied from interface: ISectionParser

Pass in a lookahead buffer that is shared amongst all section parsers, pass in the DTFJ factory to construct the DTFJ objects as tags are being parsed.

Specified by:

readIntoDTFJ in interface ISectionParser

Parameters:

lookAheadBuffer -

imageBuilder -

lookahead - from where to read tokens

tag - information containing current tag information at the time of the parse

Throws:

NullPointerException - if a null lookaheadbuffer is passed.

ParserException

addAsProperty

public boolean addAsProperty(Properties properties,
 String key,
 String value)

Parameters:

properties -

key -

value -

topLevelRule

protected abstract void topLevelRule()
                              throws ParserException

Must be implemented by subclass.

Parameters:

lookAheadBuffer -

Throws:

ParserException

sovOnlyRules

protected abstract void sovOnlyRules(String startingTag)
                              throws ParserException

Parameters:

startingTag -

Throws:

ParserException