com.topcoder.shared.problem
Class Value

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

All Implemented Interfaces:

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

public class Value

extends com.topcoder.shared.problem.BaseElement

implements Element

A class to represent a value (held in a string field).

Author:

mitalub

See Also:

Serialized Form

Constructor Summary

Value(java.lang.String value)
Constructs the value from the given value.

Method Summary

void	customReadObject(com.topcoder.shared.netCommon.CSReader reader) Custom serialization
void	customWriteObject(com.topcoder.shared.netCommon.CSWriter writer) Custom serialization
static java.lang.String	encodeHTML(java.lang.String text) Utility function for encoding HTML entities in text.
ElementRenderer	getRenderer() Returns this elements renderer.
java.lang.String	getValue() Returns the value.
void	setRenderer(ElementRenderer renderer) Sets the renderer for this element.
java.lang.String	toXML() Returns the value as XML.

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

Value

public Value(java.lang.String value)

Constructs the value from the given value.

Parameters:

value - the value.

Method Detail

getValue

public java.lang.String getValue()

Returns the value.

Returns:

the value.

customWriteObject

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

Custom serialization

Specified by:

customWriteObject in interface Element

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

Specified by:

customReadObject in interface Element

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.

toXML

public java.lang.String toXML()

Returns the value as XML. Formatted as <value value='encoded value'></value>.

Specified by:

toXML in interface Element

Returns:

the XML representation of the value.

See Also:

BaseElement.encodeHTML(String)

setRenderer

public void setRenderer(ElementRenderer renderer)

Sets the renderer for this element.

Specified by:

setRenderer in interface Element

Parameters:

renderer - the element renderer.

See Also:

ElementRenderer

getRenderer

public ElementRenderer getRenderer()

Returns this elements renderer.

Specified by:

getRenderer in interface Element

Returns:

this elements renderer.

See Also:

ElementRenderer

encodeHTML

public static java.lang.String encodeHTML(java.lang.String text)

Utility function for encoding HTML entities in text. All occurrences of the <, >, and & characters are converted to &lt;, &gt;, and &amp;, respectively.

Parameters:

text - the text to encode.

Returns:

the encoded text.