View Javadoc

1   /*
2    *   Copyright 2004 The Apache Software Foundation
3    *
4    *   Licensed under the Apache License, Version 2.0 (the "License");
5    *   you may not use this file except in compliance with the License.
6    *   You may obtain a copy of the License at
7    *
8    *       http://www.apache.org/licenses/LICENSE-2.0
9    *
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   */
17  package org.apache.ldap.server.db;
18  
19  
20  /***
21   * A table key/value String renderer for the display or logging of
22   * human readable potentially binary data.
23   * 
24   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
25   * @version $Rev: 157708 $
26   */
27  public interface TupleRenderer
28  {
29      /***
30       * Gets the key Object rendered as a String.
31       *
32       * @param key the key Object
33       * @return the String representation of the key Object
34       */
35      String getKeyString( Object key );
36  
37      /***
38       * Gets the value Object rendered as a String.
39       *
40       * @param value the value Object
41       * @return the String representation of the value Object
42       */
43      String getValueString( Object value );
44  }