Ignore:
Timestamp:
07/05/11 15:18:56 (13 years ago)
Author:
sherbold
Message:
  • code documentation
File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/EventBenchCore/src/de/ugoe/cs/eventbench/IReplayDecorator.java

    r97 r106  
    33import java.io.Serializable; 
    44 
     5/** 
     6 * <p> 
     7 * This interface defines the structure of decorators used when writing replay 
     8 * files. 
     9 * </p> 
     10 *  
     11 * @author Steffen Herbold 
     12 * @version 1.0 
     13 */ 
    514public interface IReplayDecorator extends Serializable { 
    6          
     15 
     16        /** 
     17         * <p> 
     18         * Header of the file. Called at the beginning of the writing. 
     19         * </p> 
     20         *  
     21         * @return file header 
     22         */ 
    723        String getHeader(); 
    8          
     24 
     25        /** 
     26         * <p> 
     27         * Footer of the file. Called at the end of the writing. 
     28         * </p> 
     29         *  
     30         * @return file footer 
     31         */ 
    932        String getFooter(); 
    10          
     33 
     34        /** 
     35         * <p> 
     36         * Session Header. Called before each session. 
     37         * </p> 
     38         *  
     39         * @param sessionId 
     40         *            id of the session 
     41         * @return session header 
     42         */ 
    1143        String getSessionHeader(int sessionId); 
    12          
     44 
     45        /** 
     46         * <p> 
     47         * Session Footer. Called after each session. 
     48         * </p> 
     49         *  
     50         * @param sessionId 
     51         *            id of the session 
     52         * @return session footer 
     53         */ 
    1354        String getSessionFooter(int sessionId); 
    1455} 
Note: See TracChangeset for help on using the changeset viewer.