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