GroupedTimingStatisticsFormatter.java

/* Copyright (c) 2008-2009 HomeAway, Inc.
 * All rights reserved.  http://www.perf4j.org
 *
 * 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.perf4j.helpers;

import org.perf4j.GroupedTimingStatistics;

/**
 * Can format a {@link org.perf4j.GroupedTimingStatistics} instance to a String.
 *
 * @author Alex Devine
 */
public interface GroupedTimingStatisticsFormatter {
    /**
     * Outputs the specified GroupedTimingStatistics instance as a String
     *
     * @param stats The GroupedTimingStatistics instance to format
     * @return The stringified GroupedTimingStatistics
     */
    String format(GroupedTimingStatistics stats);
}