summaryrefslogtreecommitdiffstats
path: root/parser/html/java/htmlparser/src/nu/validator/saxtree/package.html
blob: 0c34dad819f33c425bd30e4827a0711d20144999 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<html>
<head><title>Package Overview</title>
<!--
 Copyright (c) 2007 Henri Sivonen

 Permission is hereby granted, free of charge, to any person obtaining a 
 copy of this software and associated documentation files (the "Software"), 
 to deal in the Software without restriction, including without limitation 
 the rights to use, copy, modify, merge, publish, distribute, sublicense, 
 and/or sell copies of the Software, and to permit persons to whom the 
 Software is furnished to do so, subject to the following conditions:

 The above copyright notice and this permission notice shall be included in 
 all copies or substantial portions of the Software.

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 
 THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 
 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
 DEALINGS IN THE SOFTWARE.
-->
</head>
<body bgcolor="white">
<p>This package provides SAX Tree: a tree model optimized for creation from SAX 
events and replay as SAX events.</p>
<h2>Design Principles</h2>
<ol>
<li>Preserve information exposed through <code>ContentHandler</code>, 
<code>LexicalHandler</code> <em>and</em> <code>Locator</code>.
<li>Creation from SAX events or as part of the parse of a conforming 
HTML5 document should be <em>fast</em>.</li>
<li>Emitting SAX events based on the tree should be <em>fast</em>.</li>
<li>Mutations should be <em>possible</em> but should not make the above 
"fast" cases slower.</li>
<li>Concurrent reads should work without locking when there are no 
concurrent mutations.</li>
<li>The user of the API has the responsibility of using the API properly: 
for the sake of performance, the model does not check if it is being 
used properly. Improper use may, therefore, put the model in and 
inconsistent state.</li>
</ol>
</body>
</html>