1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * 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 package org.apache.commons.scxml2.model;
18
19 import java.util.Comparator;
20
21 /**
22 * DocumentOrder is implemented by {@link EnterableState} and {@link Transition} elements in the SCXML document
23 * representing their document order,
24 * <p>
25 * They are ordered with ancestor states before their descendant states,
26 * and the transitions within a state in document order before any descendant states.
27 * </p>
28 * <p>Note: it is assumed there will be no more than Integer.MAX_VALUE of such elements in a single SCXML document</p>
29 */
30 public interface DocumentOrder {
31
32 Comparator<DocumentOrder> documentOrderComparator = new Comparator<DocumentOrder>() {
33 @Override
34 public int compare(final DocumentOrder o1, final DocumentOrder o2) {
35 return o1.getOrder() - o2.getOrder();
36 }
37 };
38
39 Comparator<DocumentOrder> reverseDocumentOrderComparator = new Comparator<DocumentOrder>() {
40 @Override
41 public int compare(final DocumentOrder o1, final DocumentOrder o2) {
42 return o2.getOrder() - o1.getOrder();
43 }
44 };
45
46 /**
47 * @return the relative document order within the SCXML document of this element
48 */
49 int getOrder();
50 }