1/*
2 * Copyright (c) 2005, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25package 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 * @since 1.6
33 */
34public abstract class TableStringConverter {
35    /**
36     * Returns the string representation of the value at the specified
37     * location.
38     *
39     * @param model the <code>TableModel</code> to fetch the value from
40     * @param row the row the string is being requested for
41     * @param column the column the string is being requested for
42     * @return the string representation.  This should never return null.
43     * @throws NullPointerException if <code>model</code> is null
44     * @throws IndexOutOfBoundsException if the arguments are outside the
45     *         bounds of the model
46     */
47    public abstract String toString(TableModel model, int row, int column);
48}
49