prefuse.data.parser
Class StringParser

java.lang.Object
  prefuse.data.parser.StringParser

All Implemented Interfaces:

DataParser

public class StringParser
extends java.lang.Object
implements DataParser

DataParser instance that "parses" a String value from a text string, this is the default fallback parser, which simply returns the string value to be parsed.

Author:

jeffrey heer

Constructor Summary

StringParser()

Method Summary

boolean	canParse(java.lang.String text) Indicates if the given text string can be successfully parsed by this parser.
java.lang.String	format(java.lang.Object value) Get a String representation for the given value.
java.lang.Class	getType() Returns String.class.
java.lang.Object	parse(java.lang.String text) Parse the given text string to a data value.
java.lang.String	parseString(java.lang.String text) Simply returns the input string.

Methods inherited from class java.lang.Object

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

Constructor Detail

StringParser

public StringParser()

Method Detail

getType

public java.lang.Class getType()

Returns String.class.

Specified by:

getType in interface DataParser

Returns:

the parsed data type for this parser as a Java Class instance

See Also:

DataParser.getType()

format

public java.lang.String format(java.lang.Object value)

Description copied from interface: DataParser

Get a String representation for the given value.

Specified by:

format in interface DataParser

Parameters:

value - the object value to format

Returns:

a formatted String representing the input value

See Also:

DataParser.format(java.lang.Object)

canParse

public boolean canParse(java.lang.String text)

Description copied from interface: DataParser

Indicates if the given text string can be successfully parsed by this parser.

Specified by:

canParse in interface DataParser

Parameters:

text - the text string to check for parsability

Returns:

true if the string can be successfully parsed into this parser's data type, false otherwise

See Also:

DataParser.canParse(java.lang.String)

parse

public java.lang.Object parse(java.lang.String text)
                       throws DataParseException

Description copied from interface: DataParser

Parse the given text string to a data value.

Specified by:

parse in interface DataParser

Parameters:

text - the text string to parse

Returns:

the parsed data value, which will be an instance of the Class returned by the DataParser.getType() method

Throws:

DataParseException - if an error occurs during parsing

See Also:

DataParser.parse(java.lang.String)

parseString

public java.lang.String parseString(java.lang.String text)
                             throws DataParseException

Simply returns the input string.

Parameters:

text - the text string to "parse"

Returns:

the input text string

Throws:

DataParseException - never actually throws an exception