01: /*
02: * Copyright 2004-2007 the original author or authors.
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
10: * Unless required by applicable law or agreed to in writing, software
11: * distributed under the License is distributed on an "AS IS" BASIS,
12: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13: * See the License for the specific language governing permissions and
14: * limitations under the License.
15: */
16: package org.springframework.binding.format;
17:
18: /**
19: * A lightweight interface for formatting a value and parsing a value from its
20: * formatted form.
21: *
22: * @author Keith Donald
23: */
24: public interface Formatter {
25:
26: /**
27: * Format the value.
28: * @param value the value to format
29: * @return the formatted string, fit for display in a UI
30: * @throws IllegalArgumentException the value could not be formatted
31: */
32: public String formatValue(Object value)
33: throws IllegalArgumentException;
34:
35: /**
36: * Parse the formatted string representation of a value, restoring the
37: * value.
38: * @param formattedString the formatted string representation
39: * @param targetClass the target class to convert the formatted value to
40: * @return the parsed value
41: * @throws InvalidFormatException the string was in an invalid form
42: */
43: public Object parseValue(String formattedString, Class targetClass)
44: throws InvalidFormatException;
45:
46: }
|