com.arsdigita.util.parameter
Interface ParameterReader
- All Known Subinterfaces:
- ParameterLoader
- All Known Implementing Classes:
- CompoundParameterLoader, CompoundParameterReader, CSVParameterLoader, InteractiveParameterLoader, JavaPropertyLoader, JavaPropertyReader
- public interface ParameterReader
Subject to change.
Reads an encoded string value for a parameter from storage. Any
errors encountered while reading are added to an error list.
This class is counterpart to ParameterWriter
.
- Version:
- $Id: //core-platform/dev/src/com/arsdigita/util/parameter/ParameterReader.java#7 $
- Author:
- Justin Ross <jross@redhat.com>
- See Also:
Parameter.write(ParameterWriter, Object)
,
ErrorList
,
ParameterWriter
versionId
public static final String versionId
- See Also:
- Constant Field Values
read
public String read(Parameter param,
ErrorList errors)
- Reads an encoded
String
value for
param
from storage. If there are errors, they are
added to errors
.
- Parameters:
param
- The Parameter
being read; it cannot
be nullerrors
- The ErrorList
that will collect any
errors; it cannot be null
- Returns:
- The marshaled
String
value for
param
; it may be null
Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 21 2004:2337 UTC