001/*
002 * Copyright (C) 2009-2011 Mathias Doenitz
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.parboiled.common;
018
019/**
020 * The capability to transform an object of type T into a string representation.
021 *
022 * @param <T> The type to transform.
023 */
024public interface Formatter<T> {
025
026    /**
027     * Create a string representation for the given object.
028     *
029     * @param object the object to format
030     * @return a string describing the object
031     */
032    String format(T object);
033
034}