KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > javax > activation > CommandObject


1 /*
2  * The contents of this file are subject to the terms
3  * of the Common Development and Distribution License
4  * (the "License"). You may not use this file except
5  * in compliance with the License.
6  *
7  * You can obtain a copy of the license at
8  * glassfish/bootstrap/legal/CDDLv1.0.txt or
9  * https://glassfish.dev.java.net/public/CDDLv1.0.html.
10  * See the License for the specific language governing
11  * permissions and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL
14  * HEADER in each file and include the License file at
15  * glassfish/bootstrap/legal/CDDLv1.0.txt. If applicable,
16  * add the following below this CDDL HEADER, with the
17  * fields enclosed by brackets "[]" replaced with your
18  * own identifying information: Portions Copyright [yyyy]
19  * [name of copyright owner]
20  */

21
22 /*
23  * @(#)CommandObject.java 1.9 05/11/16
24  *
25  * Copyright 1997-2005 Sun Microsystems, Inc. All Rights Reserved.
26  */

27
28 package javax.activation;
29
30 import java.io.IOException JavaDoc;
31
32 /**
33  * JavaBeans components that are Activation Framework aware implement
34  * this interface to find out which command verb they're being asked
35  * to perform, and to obtain the DataHandler representing the
36  * data they should operate on. JavaBeans that don't implement
37  * this interface may be used as well. Such commands may obtain
38  * the data using the Externalizable interface, or using an
39  * application-specific method.<p>
40  */

41 public interface CommandObject {
42
43     /**
44      * Initialize the Command with the verb it is requested to handle
45      * and the DataHandler that describes the data it will
46      * operate on. <b>NOTE:</b> it is acceptable for the caller
47      * to pass <i>null</i> as the value for <code>DataHandler</code>.
48      *
49      * @param verb The Command Verb this object refers to.
50      * @param dh The DataHandler.
51      */

52     public void setCommandContext(String JavaDoc verb, DataHandler JavaDoc dh)
53                         throws IOException JavaDoc;
54 }
55
Popular Tags