com.arsdigita.util.parameter
Class FileParameter

java.lang.Object
  com.arsdigita.util.parameter.AbstractParameter
      com.arsdigita.util.parameter.FileParameter

All Implemented Interfaces:

Parameter

public class FileParameter

extends AbstractParameter

A Parameter representing a File

Author:

bche

See Also:

Parameter, File

Field Summary

Fields inherited from class com.arsdigita.util.parameter.AbstractParameter

versionId

Fields inherited from interface com.arsdigita.util.parameter.Parameter

OPTIONAL, REQUIRED

Constructor Summary

FileParameter(String name)

Method Summary

void	doValidate(Object value, ErrorList errors) Validates value, placing any validation errors in errors.
String	marshal(Object value) Converts value to a representative String, which is returned.
Object	unmarshal(String value, ErrorList errors) Converts a literal String value, value, to a Java object, which is returned.

Methods inherited from class com.arsdigita.util.parameter.AbstractParameter

doRead, doWrite, getDefaultValue, getInfo, getName, isRequired, read, setInfo, toString, validate, write

Methods inherited from class java.lang.Object

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

Constructor Detail

FileParameter

public FileParameter(String name)

Method Detail

unmarshal

public Object unmarshal(String value,
                        ErrorList errors)

Description copied from class: AbstractParameter

Converts a literal String value, value, to a Java object, which is returned.

Overrides:

unmarshal in class AbstractParameter

Parameters:

value - The String value to convert from; it cannot be null

errors - An ErrorList that holds any errors encountered during unmarshaling; it cannot be null

marshal

public String marshal(Object value)

Description copied from class: AbstractParameter

Converts value to a representative String, which is returned.

Overrides:

marshal in class AbstractParameter

Parameters:

value - The value to marshal; it may be null

Returns:

The String literal representation of value; it may be null

doValidate

public void doValidate(Object value,
                       ErrorList errors)

Description copied from class: AbstractParameter

Validates value, placing any validation errors in errors. This particular implementation does nothing. Subclasses are expected to add specific validation behaviors.

Overrides:

doValidate in class AbstractParameter

Parameters:

value - The value to validate; it cannot be null

errors - The ErrorList that traps validation errors; it cannot be null