View Javadoc

1   package org.e2etrace.trace;
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  /**
20   * Unique ID for a trace step within a trace session.
21   * <p>
22   *
23   * An example for a suitable trace step id is the fully qualified class name
24   * plus the method name.
25   * <p>
26   *
27   * @author Gunther Popp
28   *
29   */
30  public interface ITraceStepId {
31  
32    /**
33     * Returns a String representation of the trace step id.
34     * <p>
35     *
36     * In contrast to <code>toString</code> the String representation should be suitable
37     * to be used in log and configuration files. Additionally it must uniquely identify an
38     * id.<p>
39     *
40     * @return String representation of the trace step id
41     */
42    String asString();
43  }