KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > clif > storage > api > BladeEvent


1 /*
2 * CLIF is a Load Injection Framework
3 * Copyright (C) 2004 France Telecom R&D
4 *
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
9 *
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
14 *
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 *
19 * CLIF $Name: $
20 *
21 * Contact: clif@objectweb.org
22 */

23
24 package org.objectweb.clif.storage.api;
25
26 import java.io.Serializable JavaDoc;
27
28
29 /**
30  * Common/base interface for every event generated by blades
31  * @author Bruno Dillenseger
32  */

33 public interface BladeEvent extends Comparable JavaDoc, Serializable JavaDoc
34 {
35     /**
36      * @return a label uniquely designating this class of event
37      */

38     public String JavaDoc getTypeLabel();
39
40     /**
41      * @return the date of this event
42      */

43     public long getDate();
44
45     /**
46      * @return the blade identifier concerned by this event.
47      */

48     public String JavaDoc getBladeId();
49
50     /**
51      * @param dateOrigin the origin date in milliseconds (since 1st January 1970). This value
52      * is substracted from the event date before printing, thus allowing a change of date origin.
53      * @param separator the separator string to be used to separate the event values
54      * @return a text line describing this scenario event, consisting of values separated by the
55      * given separator string. The first field shall be an integer giving the date of the event.
56      */

57     public String JavaDoc toString(long dateOrigin, String JavaDoc separator);
58 }
59
Popular Tags