01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: *
17: * $Header:$
18: */
19: package org.apache.beehive.netui.databinding.datagrid.api.sort;
20:
21: /**
22: * <p>
23: * A SortStrategy is an implementation for the state machine which is used to cycle through sort directions.
24: * </p>
25: */
26: public abstract class SortStrategy implements java.io.Serializable {
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: }
|