001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *  
010 *    http://www.apache.org/licenses/LICENSE-2.0
011 *  
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License. 
018 *  
019 */
020package org.apache.directory.api.ldap.model.cursor;
021
022
023/**
024 * A table key/value String renderer for the display or logging of
025 * human readable potentially binary data.
026 * 
027 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
028 */
029public interface TupleRenderer
030{
031    /**
032     * Gets the key Object rendered as a String.
033     *
034     * @param key the key Object
035     * @return the String representation of the key Object
036     */
037    String getKeyString( Object key );
038
039
040    /**
041     * Gets the value Object rendered as a String.
042     *
043     * @param value the value Object
044     * @return the String representation of the value Object
045     */
046    String getValueString( Object value );
047}