01 /*
02 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
03 *
04 * This code is free software; you can redistribute it and/or modify it
05 * under the terms of the GNU General Public License version 2 only, as
06 * published by the Free Software Foundation. Sun designates this
07 * particular file as subject to the "Classpath" exception as provided
08 * by Sun in the LICENSE file that accompanied this code.
09 *
10 * This code is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * version 2 for more details (a copy is included in the LICENSE file that
14 * accompanied this code).
15 *
16 * You should have received a copy of the GNU General Public License version
17 * 2 along with this work; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
19 *
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
22 * have any questions.
23 */
24
25 /*
26 * This file is available under and governed by the GNU General Public
27 * License version 2 only, as published by the Free Software Foundation.
28 * However, the following notice accompanied the original version of this
29 * file and, per its terms, should not be removed:
30 *
31 * Copyright (c) 2004 World Wide Web Consortium,
32 *
33 * (Massachusetts Institute of Technology, European Research Consortium for
34 * Informatics and Mathematics, Keio University). All Rights Reserved. This
35 * work is distributed under the W3C(r) Software License [1] in the hope that
36 * it will be useful, but WITHOUT ANY WARRANTY; without even the implied
37 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
38 *
39 * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
40 */
41
42 package org.w3c.dom.ls;
43
44 import org.w3c.dom.traversal.NodeFilter;
45
46 /**
47 * <code>LSSerializerFilter</code>s provide applications the ability to
48 * examine nodes as they are being serialized and decide what nodes should
49 * be serialized or not. The <code>LSSerializerFilter</code> interface is
50 * based on the <code>NodeFilter</code> interface defined in [<a href='http://www.w3.org/TR/2000/REC-DOM-Level-2-Traversal-Range-20001113'>DOM Level 2 Traversal and Range</a>]
51 * .
52 * <p> <code>Document</code>, <code>DocumentType</code>,
53 * <code>DocumentFragment</code>, <code>Notation</code>, <code>Entity</code>
54 * , and children of <code>Attr</code> nodes are not passed to the filter.
55 * The child nodes of an <code>EntityReference</code> node are only passed
56 * to the filter if the <code>EntityReference</code> node is skipped by the
57 * method <code>LSParserFilter.acceptNode()</code>.
58 * <p> When serializing an <code>Element</code>, the element is passed to the
59 * filter before any of its attributes are passed to the filter. Namespace
60 * declaration attributes, and default attributes (except in the case when "
61 * discard-default-content" is set to <code>false</code>), are never passed
62 * to the filter.
63 * <p> The result of any attempt to modify a node passed to a
64 * <code>LSSerializerFilter</code> is implementation dependent.
65 * <p> DOM applications must not raise exceptions in a filter. The effect of
66 * throwing exceptions from a filter is DOM implementation dependent.
67 * <p> For efficiency, a node passed to the filter may not be the same as the
68 * one that is actually in the tree. And the actual node (node object
69 * identity) may be reused during the process of filtering and serializing a
70 * document.
71 * <p>See also the <a href='http://www.w3.org/TR/2004/REC-DOM-Level-3-LS-20040407'>Document Object Model (DOM) Level 3 Load
72 and Save Specification</a>.
73 */
74 public interface LSSerializerFilter extends NodeFilter {
75 /**
76 * Tells the <code>LSSerializer</code> what types of nodes to show to the
77 * filter. If a node is not shown to the filter using this attribute, it
78 * is automatically serialized. See <code>NodeFilter</code> for
79 * definition of the constants. The constants <code>SHOW_DOCUMENT</code>
80 * , <code>SHOW_DOCUMENT_TYPE</code>, <code>SHOW_DOCUMENT_FRAGMENT</code>
81 * , <code>SHOW_NOTATION</code>, and <code>SHOW_ENTITY</code> are
82 * meaningless here, such nodes will never be passed to a
83 * <code>LSSerializerFilter</code>.
84 * <br> Unlike [<a href='http://www.w3.org/TR/2000/REC-DOM-Level-2-Traversal-Range-20001113'>DOM Level 2 Traversal and Range</a>]
85 * , the <code>SHOW_ATTRIBUTE</code> constant indicates that the
86 * <code>Attr</code> nodes are shown and passed to the filter.
87 * <br> The constants used here are defined in [<a href='http://www.w3.org/TR/2000/REC-DOM-Level-2-Traversal-Range-20001113'>DOM Level 2 Traversal and Range</a>]
88 * .
89 */
90 public int getWhatToShow();
91
92 }
|