org.apache.hivemind

Interface Orderable

All Known Implementing Classes:

SymbolSourceContribution

public interface Orderable

Interface typically used by configuration items that wish to be ordered. Each item must provide a name, and lists: names of items which should precede the item, and names of items to follow.

Author:

Howard M. Lewis Ship

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getFollowingNames() Returns a comma-seperated list of the names of other items.
java.lang.String	getName() Returns the name of the item, which is used to establish sort order.
java.lang.String	getPrecedingNames() As getFollowingNames(), but the identified items will precede this item.

Method Detail

getName

java.lang.String getName()

Returns the name of the item, which is used to establish sort order.

getFollowingNames

java.lang.String getFollowingNames()

Returns a comma-seperated list of the names of other items. This item will precede all such items. The special value * indicates that the item should precede all items.

Returns:

the list, the value *, or null

getPrecedingNames

java.lang.String getPrecedingNames()

As getFollowingNames(), but the identified items will precede this item.