1 /**
2 * Licensed under the Artistic License; you may not use this file
3 * except in compliance with the License.
4 * You may obtain a copy of the License at
5 *
6 * http://displaytag.sourceforge.net/license.html
7 *
8 * THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
9 * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
10 * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
11 */
12 package org.displaytag.decorator;
13
14 import org.displaytag.exception.DecoratorException;
15
16
17 /**
18 * <p>
19 * Interface for simple column decorators.
20 * </p>
21 * <p>
22 * A column decorator is called after the object has been retrieved and it can "transform" the object before the
23 * rendering. A column decorator is simply an object formatter, and it is only aware of the value to format.
24 * </p>
25 * @author epesh
26 * @author Fabrizio Giustina
27 * @version $Revision: 1081 $ ($Author: fgiust $)
28 * @deprecated as of Displaytag 1.1 replaced by org.displaytag.decorator.DisplaytagColumnDecorator
29 */
30 public interface ColumnDecorator
31 {
32
33 /**
34 * Called after the object has been retrieved from the bean contained in the list. The decorate method is
35 * responsible for transforming the object into a string to render in the page.
36 * @param columnValue Object to decorate
37 * @return String decorated object
38 * @throws DecoratorException wrapper exception for any exception thrown during decoration
39 */
40 String decorate(Object columnValue) throws DecoratorException;
41
42 }
Save This Page