KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > beehive > netui > databinding > datagrid > api > sort > SortStrategy


1 /*
2  * Copyright 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  * $Header:$
17  */
18 package org.apache.beehive.netui.databinding.datagrid.api.sort;
19
20 /**
21  * <p>
22  * A SortStrategy is an implementation for the state machine which is used to cycle through sort directions.
23  * </p>
24  */
25 public abstract class SortStrategy
26     implements java.io.Serializable JavaDoc {
27
28     /**
29      * Get the default {@link SortDirection}.
30      * @return the default {@link SortDirection}
31      */
32     public abstract SortDirection getDefaultDirection();
33
34     /**
35      * Given a <code>direction</code> compute the next {@link SortDirection}. Implementations
36      * are free to use arbitrary logic to compute the next direction.
37      * @param direction the current sort direction
38      * @return the next sort direction
39      */
40     public abstract SortDirection nextDirection(SortDirection direction);
41 }
42
Popular Tags