1/*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the  "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 *     http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 */
18/*
19 * $Id: DOMOrder.java 468655 2006-10-28 07:12:06Z minchau $
20 */
21package org.apache.xml.utils;
22
23/**
24 * @deprecated Since the introduction of the DTM, this class will be removed.
25 * Nodes that implement this index can return a document order index.
26 * Eventually, this will be replaced by DOM 3 methods.
27 * (compareDocumentOrder and/or compareTreePosition.)
28 */
29public interface DOMOrder
30{
31
32  /**
33   * Get the UID (document order index).
34   *
35   * @return integer whose relative value corresponds to document order
36   * -- that is, if node1.getUid()<node2.getUid(), node1 comes before
37   * node2, and if they're equal node1 and node2 are the same node. No
38   * promises are made beyond that.
39   */
40  public int getUid();
41}
42