1 package org.e2etrace.formatter;
2
3 /*
4 * Copyright 2006 Gunther Popp
5 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 */
18
19 import java.io.IOException;
20 import java.io.Writer;
21
22 import org.e2etrace.trace.ITraceSession;
23
24
25 /**
26 * Formatters traverse a tree of trace steps and generate formatted output.
27 * <p>
28 *
29 * @author Gunther Popp
30 */
31 public interface ITraceFormatter {
32
33 /**
34 * Generate a formatted output for the supplied trace session.
35 * <p>
36 *
37 * @param session trace session
38 * @param toWriter Writer to send the output to
39 * @throws IOException A problem occured sending the output to toWriter
40 */
41 void format(ITraceSession session, Writer toWriter) throws IOException;
42
43 }