com.topcoder.shared.problem
Class CharacterValue

java.lang.Object
  |
  +--com.topcoder.shared.problem.BaseElement
        |
        +--com.topcoder.shared.problem.DataValue
              |
              +--com.topcoder.shared.problem.CharacterValue

All Implemented Interfaces:

java.lang.Cloneable, com.topcoder.shared.netCommon.CustomSerializable, Element, java.io.Serializable

public class CharacterValue

extends DataValue

Implementation of DataValue that holds a single character value. Essentially a wrapper around the java 'char' and can hold any valid character (including unicode).

See Also:

Serialized Form

Constructor Summary

CharacterValue()
Empty constructor required by custom serialization.

CharacterValue(char value)
Constructs the character value from the specified character.

Method Summary

void	customReadObject(com.topcoder.shared.netCommon.CSReader reader) Custom serialization.
void	customWriteObject(com.topcoder.shared.netCommon.CSWriter writer) Custom serialization.
java.lang.String	encode() Encode the character into a user readable string (ie adds quotes around the character and will escape back-slashes and quotes).
char	getChar() Gets the character value
java.lang.Object	getValue() Gets the character as an Object
void	parse(DataValueReader reader, DataType type) Parses the information in the DataValueReader for a character.

Methods inherited from class com.topcoder.shared.problem.DataValue

convertDataValuesToObjects, convertDataValueToObject, convertObjectsToDataValues, convertObjectToDataValue, encodeHTML, getRenderer, parseSequence, parseSequence, parseValue, parseValue, parseValues, parseValuesToObjects, parseValueToObject, setRenderer, toXML

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.topcoder.shared.problem.Element

getRenderer, setRenderer

Constructor Detail

CharacterValue

public CharacterValue()

Empty constructor required by custom serialization.

CharacterValue

public CharacterValue(char value)

Constructs the character value from the specified character.

Parameters:

value - the value to construct from.

Method Detail

parse

public void parse(DataValueReader reader,
                  DataType type)
           throws java.io.IOException,
                  DataValueParseException

Parses the information in the DataValueReader for a character.

Specified by:

parse in class DataValue

Parameters:

reader - the reader of the unparsed data.

type - unused.

Throws:

DataValueParseException - if a parsing exception occurs.

java.io.IOException - if an exception occurred during reading.

See Also:

DataType, DataValueReader

customWriteObject

public void customWriteObject(com.topcoder.shared.netCommon.CSWriter writer)
                       throws java.io.IOException

Custom serialization.

Parameters:

writer - the writer to write to.

Throws:

java.io.IOException - if an I/O error has occurred in the stream that backs the writer.

customReadObject

public void customReadObject(com.topcoder.shared.netCommon.CSReader reader)
                      throws java.io.IOException,
                             java.io.ObjectStreamException

Custom serialization.

Parameters:

reader - the reader to read from.

Throws:

java.io.ObjectStreamException - if the information that is read is inconsistent (stream corrupted or incompatibility between writers and readers)

java.io.IOException - if an I/O error has occurred in the stream that backs the reader.

encode

public java.lang.String encode()

Encode the character into a user readable string (ie adds quotes around the character and will escape back-slashes and quotes).

Specified by:

encode in class DataValue

Returns:

a user readable string representation of the character

getChar

public char getChar()

Gets the character value

Returns:

the character value

getValue

public java.lang.Object getValue()

Gets the character as an Object

Specified by:

getValue in class DataValue

Returns:

the character as an Character class