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: DTMWSFilter.java,v 1.2.4.1 2005/09/15 08:14:55 suresh_emailid Exp $
22   */
23  package com.sun.org.apache.xml.internal.dtm;
24  
25  /**
26   * This interface is meant to be implemented by a client of the DTM, and allows
27   * stripping of whitespace nodes.
28   */
29  public interface DTMWSFilter
30  {
31    /**
32     * Do not strip whitespace child nodes of this element.
33     */
34    public static final short NOTSTRIP = 1;
35  
36    /**
37     * Strip whitespace child nodes of this element.
38     */
39    public static final short STRIP = 2;
40  
41    /**
42     * Inherit whitespace stripping behavior of the parent node.
43     */
44    public static final short INHERIT = 3;
45  
46    /**
47     * Test whether whitespace-only text nodes are visible in the logical
48     * view of <code>DTM</code>. Normally, this function
49     * will be called by the implementation of <code>DTM</code>;
50     * it is not normally called directly from
51     * user code.
52     *
53     * @param elementHandle int Handle of the element.
54     * @return one of NOTSTRIP, STRIP, or INHERIT.
55     */
56    public short getShouldStripSpace(int elementHandle, DTM dtm);
57  
58  }