net.praqma.jenkins.memorymap.parser

Class AbstractMemoryMapParser

java.lang.Object

net.praqma.jenkins.memorymap.parser.AbstractMemoryMapParser

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<AbstractMemoryMapParser>, Serializable

Direct Known Subclasses:

GccMemoryMapParser, TexasInstrumentsMemoryMapParser

public abstract class AbstractMemoryMapParser
extends Object
implements hudson.model.Describable<AbstractMemoryMapParser>, hudson.ExtensionPoint, Serializable

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	logger
protected String	mapFile
protected List<Pattern>	patterns

Constructor Summary

Constructors

Constructor and Description
AbstractMemoryMapParser()
AbstractMemoryMapParser(String parserUniqueName, String mapFile, String configurationFile, Integer wordSize, Boolean bytesOnGraph, List<MemoryMapGraphConfiguration> graphConfiguration, Pattern... pattern)

Method Summary

Modifier and Type	Method and Description
static hudson.DescriptorExtensionList<AbstractMemoryMapParser,MemoryMapParserDescriptor<AbstractMemoryMapParser>>	all()
protected CharSequence	createCharSequenceFromFile(File f)
protected CharSequence	createCharSequenceFromFile(String charset, File f)
Boolean	getBytesOnGraph()
String	getConfigurationFile()
abstract int	getDefaultWordSize()
hudson.model.Descriptor<AbstractMemoryMapParser>	getDescriptor()
static List<MemoryMapParserDescriptor<?>>	getDescriptors()
List<MemoryMapGraphConfiguration>	getGraphConfiguration()
List<MemoryMapGraphConfigurationDescriptor<?>>	getGraphOptions()
String	getMapFile()
String	getParserTitle()
String	getParserUniqueName()
String	getUniqueName() Implemented in order to get a unique name for the chosen parser
Integer	getWordSize()
abstract MemoryMapConfigMemory	parseConfigFile(File f)
abstract MemoryMapConfigMemory	parseMapFile(File f, MemoryMapConfigMemory configuration)
Object	readResolve()
void	setBytesOnGraph(Boolean bytesOnGraph)
void	setConfigurationFile(String configurationFile)
void	setGraphConfiguration(List<MemoryMapGraphConfiguration> graphConfiguration)
void	setMapFile(String mapFile)
void	setParserTitle(String parserTitle)
void	setParserUniqueName(String parserUniqueName)
void	setWordSize(Integer wordSize)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final Logger logger

patterns

protected List<Pattern> patterns

mapFile

protected String mapFile

Constructor Detail

AbstractMemoryMapParser

public AbstractMemoryMapParser()

AbstractMemoryMapParser

public AbstractMemoryMapParser(String parserUniqueName,
                               String mapFile,
                               String configurationFile,
                               Integer wordSize,
                               Boolean bytesOnGraph,
                               List<MemoryMapGraphConfiguration> graphConfiguration,
                               Pattern... pattern)

Method Detail

getDefaultWordSize

public abstract int getDefaultWordSize()

Returns:

The default word size. If the map files contains usages in decimal value of bytes (say 1 200 bytes used). Use a word size of 8. else use what your compiler prefers.

readResolve

public Object readResolve()

getUniqueName

public String getUniqueName()

Implemented in order to get a unique name for the chosen parser

Returns:

The parsers unique name

createCharSequenceFromFile

protected CharSequence createCharSequenceFromFile(File f)
                                           throws IOException

Throws:

IOException

createCharSequenceFromFile

protected CharSequence createCharSequenceFromFile(String charset,
                                                  File f)
                                           throws IOException

Throws:

IOException

parseConfigFile

public abstract MemoryMapConfigMemory parseConfigFile(File f)
                                               throws IOException

Throws:

IOException

parseMapFile

public abstract MemoryMapConfigMemory parseMapFile(File f,
                                                   MemoryMapConfigMemory configuration)
                                            throws IOException

Throws:

IOException

getMapFile

public String getMapFile()

Returns:

the includeFilePattern

setMapFile

public void setMapFile(String mapFile)

Parameters:

mapFile - the mapFile to set

getDescriptor

public hudson.model.Descriptor<AbstractMemoryMapParser> getDescriptor()

Specified by:

getDescriptor in interface hudson.model.Describable<AbstractMemoryMapParser>

all

public static hudson.DescriptorExtensionList<AbstractMemoryMapParser,MemoryMapParserDescriptor<AbstractMemoryMapParser>> all()

Returns:

All registered AbstractMemoryMapParsers.

getDescriptors

public static List<MemoryMapParserDescriptor<?>> getDescriptors()

getWordSize

public Integer getWordSize()

Returns:

the wordSize

setWordSize

public void setWordSize(Integer wordSize)

Parameters:

wordSize - the wordSize to set

getBytesOnGraph

public Boolean getBytesOnGraph()

Returns:

the bytesOnGraph

setBytesOnGraph

public void setBytesOnGraph(Boolean bytesOnGraph)

Parameters:

bytesOnGraph - the bytesOnGraph to set

getConfigurationFile

public String getConfigurationFile()

Returns:

the configurationFile

setConfigurationFile

public void setConfigurationFile(String configurationFile)

Parameters:

configurationFile - the configurationFile to set

getGraphOptions

public List<MemoryMapGraphConfigurationDescriptor<?>> getGraphOptions()

toString

public String toString()

Overrides:

toString in class Object

getParserUniqueName

public String getParserUniqueName()

Returns:

the parserUniqueName

setParserUniqueName

public void setParserUniqueName(String parserUniqueName)

Parameters:

parserUniqueName - the parserUniqueName to set

getParserTitle

public String getParserTitle()

Returns:

the parserTitle

setParserTitle

@DataBoundSetter
public void setParserTitle(String parserTitle)

Parameters:

parserTitle - the parserTitle to set

getGraphConfiguration

public List<MemoryMapGraphConfiguration> getGraphConfiguration()

Returns:

the graphConfiguration

setGraphConfiguration

public void setGraphConfiguration(List<MemoryMapGraphConfiguration> graphConfiguration)

Parameters:

graphConfiguration - the graphConfiguration to set