KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > hivemind > Orderable


1 // Copyright 2004, 2005 The Apache Software Foundation
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14
15 package org.apache.hivemind;
16
17 /**
18  * Interface typically used by configuration items that wish to be ordered.
19  * Each item must provide a name, and lists: names of items which should precede
20  * the item, and names of items to follow.
21  *
22  * @author Howard M. Lewis Ship
23  */
24 public interface Orderable
25 {
26     /**
27      * Returns the name of the item, which is used to establish sort order.
28      */
29     public String JavaDoc getName();
30
31     /**
32      * Returns a comma-seperated list of the names of other items. This item will precede
33      * all such items. The special
34      * value <code>*</code> indicates that the item should precede all items.
35      *
36      * @return the list, the value <code>*</code>, or null
37      */
38
39     public String JavaDoc getFollowingNames();
40
41     /**
42      * As {@link #getFollowingNames()}, but the identified items will precede this item.
43      */
44
45     public String JavaDoc getPrecedingNames();
46 }
47
Popular Tags