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