org.parboiled.common.Formatter Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2009-2011 Mathias Doenitz
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.parboiled.common;

import javax.annotation.Nullable;

/**
 * The capability to transform an object of type T into a string representation.
 *
 * @param 
 */
// TODO: java.util{,.logging}.Formatter also exist
public interface Formatter
{

    /**
     * Create a string representation for the given obejct.
     *
     * @param object the object to format
     * @return a string describing the object
     */
    @Nullable // TODO! null! Again!
    String format(T object);

}