KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > sape > carbon > core > component > proxy > test > TestComponent


1 /*
2  * The contents of this file are subject to the Sapient Public License
3  * Version 1.0 (the "License"); you may not use this file except in compliance
4  * with the License. You may obtain a copy of the License at
5  * http://carbon.sf.net/License.html.
6  *
7  * Software distributed under the License is distributed on an "AS IS" basis,
8  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
9  * the specific language governing rights and limitations under the License.
10  *
11  * The Original Code is The Carbon Component Framework.
12  *
13  * The Initial Developer of the Original Code is Sapient Corporation
14  *
15  * Copyright (C) 2003 Sapient Corporation. All Rights Reserved.
16  */
17
18 package org.sape.carbon.core.component.proxy.test;
19
20 import org.sape.carbon.core.component.FunctionalInterface;
21
22 /**
23  * Describes the methods that the TestComponent's Functional Implementation
24  * must provide.
25  *
26  * Copyright 2002 Sapient
27  * @since carbon 1.0
28  * @author Chris Herron, Febuary 2002
29  * @version $Revision: 1.6 $($Author: ghinkl $ / $Date: 2003/10/10 14:55:33 $)
30  */
31 public interface TestComponent extends FunctionalInterface {
32     /**
33      * Method that calls back to the Test class to confirm
34      * that it was called
35      * @param callBackId A token to pass when confirming the call
36      */
37     void doSomeWork(String JavaDoc callBackId);
38
39     /**
40      * Method that is meant to do very little so that the
41      * overhead of a component call can be measured.
42      */
43     void doNothing();
44
45     /**
46      * Throws an Exception.
47      */
48     void intentionalException() throws Exception JavaDoc;
49
50     /**
51      * Returns a TestReturnType Object.
52      * @return TestReturnType instance
53      */
54     TestReturnType returnTestReturnType();
55
56     /**
57      * Sleeps for a period of time before returning.
58      * @return true always
59      */
60     boolean reentrantMethod();
61 }
62
63
Popular Tags