01 /*
02 * Copyright 2005 Sun Microsystems, Inc. All Rights Reserved.
03 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04 *
05 * This code is free software; you can redistribute it and/or modify it
06 * under the terms of the GNU General Public License version 2 only, as
07 * published by the Free Software Foundation. Sun designates this
08 * particular file as subject to the "Classpath" exception as provided
09 * by Sun in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25 package javax.swing.table;
26
27 /**
28 * TableStringConverter is used to convert objects from the model into
29 * strings. This is useful in filtering and searching when the model returns
30 * objects that do not have meaningful <code>toString</code> implementations.
31 *
32 * @version 1.8 05/05/07
33 * @since 1.6
34 */
35 public abstract class TableStringConverter {
36 /**
37 * Returns the string representation of the value at the specified
38 * location.
39 *
40 * @param model the <code>TableModel</code> to fetch the value from
41 * @param row the row the string is being requested for
42 * @param column the column the string is being requested for
43 * @return the string representation. This should never return null.
44 * @throws NullPointerException if <code>model</code> is null
45 * @throws IndexOutOfBoundsException if the arguments are outside the
46 * bounds of the model
47 */
48 public abstract String toString(TableModel model, int row,
49 int column);
50 }
|