Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
Descriptors |
|
| 1.0;1 |
1 | /* | |
2 | * Copyright 1999-2001,2004 The Apache Software Foundation. | |
3 | * | |
4 | * Licensed under the Apache License, Version 2.0 (the "License"); | |
5 | * you may not use this file except in compliance with the License. | |
6 | * You may obtain a copy of the License at | |
7 | * | |
8 | * http://www.apache.org/licenses/LICENSE-2.0 | |
9 | * | |
10 | * Unless required by applicable law or agreed to in writing, software | |
11 | * distributed under the License is distributed on an "AS IS" BASIS, | |
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
13 | * See the License for the specific language governing permissions and | |
14 | * limitations under the License. | |
15 | */ | |
16 | ||
17 | package org.apache.commons.workflow; | |
18 | ||
19 | ||
20 | /** | |
21 | * <p>Implementing <strong>Descriptors</strong> indicates that the corresponding | |
22 | * object has an associated list of <code>Descriptor</code> objects associated | |
23 | * with it, which can be manipulated through the methods defined in this | |
24 | * interface. The documentation for each implementing object will describe | |
25 | * the semantics of associated <code>Descriptor</code> object list. | |
26 | * </p> | |
27 | * | |
28 | * @version $Revision: 155475 $ $Date: 2005-02-26 13:31:11 +0000 (Sat, 26 Feb 2005) $ | |
29 | * @author Craig R. McClanahan | |
30 | */ | |
31 | ||
32 | public interface Descriptors { | |
33 | ||
34 | ||
35 | // --------------------------------------------------------- Public Methods | |
36 | ||
37 | ||
38 | /** | |
39 | * Add a new <code>Descriptor</code> to the set associated with | |
40 | * this object. | |
41 | * | |
42 | * @param descriptor The Descriptor to be added | |
43 | */ | |
44 | public void addDescriptor(Descriptor descriptor); | |
45 | ||
46 | ||
47 | /** | |
48 | * Return the set of <code>Descriptor</code> objects associated with | |
49 | * this object, in the order that they were originally added. | |
50 | */ | |
51 | public Descriptor[] findDescriptors(); | |
52 | ||
53 | ||
54 | /** | |
55 | * Remove an existing <code>Descriptor</code> from the set associated | |
56 | * with this object. | |
57 | * | |
58 | * @param descriptor The Descriptor to be removed | |
59 | */ | |
60 | public void removeDescriptor(Descriptor descriptor); | |
61 | ||
62 | ||
63 | } |