com.topcoder.shared.problem
Class StringValue

java.lang.Object
  |
  +--com.topcoder.shared.problem.BaseElement
        |
        +--com.topcoder.shared.problem.DataValue
              |
              +--com.topcoder.shared.problem.StringValue
All Implemented Interfaces:
java.lang.Cloneable, com.topcoder.shared.netCommon.CustomSerializable, Element, java.io.Serializable

public class StringValue
extends DataValue

Implementation of DataValue that holds a String value.

See Also:
Serialized Form

Constructor Summary
StringValue()
          Empty constructor required by custom serialization.
StringValue(java.lang.String value)
          Constructs the DataValue from the given string.
 
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 decimal into a user readable string.
 java.lang.String getString()
          Gets the string value.
 java.lang.Object getValue()
          Gets the value as an object.
 void parse(DataValueReader reader, DataType type)
          Parses the information in the DataValueReader using the a specified DataType to parse each value.
 
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

StringValue

public StringValue()
Empty constructor required by custom serialization.


StringValue

public StringValue(java.lang.String value)
Constructs the DataValue from the given string.

Parameters:
value - the string value.
Method Detail

parse

public void parse(DataValueReader reader,
                  DataType type)
           throws java.io.IOException,
                  DataValueParseException
Parses the information in the DataValueReader using the a specified DataType to parse each value.

Specified by:
parse in class DataValue
Parameters:
reader - the reader of the unparsed data.
type - the datatype used to parse data with.
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 decimal into a user readable string. The value will be surrounded by double-quotes and any embedded backslashes and double-quotes will be escaped. Example: "Joe said \"hello\""

Specified by:
encode in class DataValue
Returns:
a user readable string representation of the decimal.

getString

public java.lang.String getString()
Gets the string value.

Returns:
the string value.

getValue

public java.lang.Object getValue()
Gets the value as an object.

Specified by:
getValue in class DataValue
Returns:
the value as an String class.