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