/[aagtl_public1]/src/net/htmlparser/jericho/OutputSegment.java
aagtl

Contents of /src/net/htmlparser/jericho/OutputSegment.java

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2 - (show annotations) (download)
Sun Aug 5 13:48:36 2012 UTC (11 years, 7 months ago) by zoffadmin
File size: 4285 byte(s)
initial import of aagtl source code
1 // Jericho HTML Parser - Java based library for analysing and manipulating HTML
2 // Version 3.2
3 // Copyright (C) 2004-2009 Martin Jericho
4 // http://jericho.htmlparser.net/
5 //
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of either one of the following licences:
8 //
9 // 1. The Eclipse Public License (EPL) version 1.0,
10 // included in this distribution in the file licence-epl-1.0.html
11 // or available at http://www.eclipse.org/legal/epl-v10.html
12 //
13 // 2. The GNU Lesser General Public License (LGPL) version 2.1 or later,
14 // included in this distribution in the file licence-lgpl-2.1.txt
15 // or available at http://www.gnu.org/licenses/lgpl.txt
16 //
17 // This library is distributed on an "AS IS" basis,
18 // WITHOUT WARRANTY OF ANY KIND, either express or implied.
19 // See the individual licence texts for more details.
20
21 package net.htmlparser.jericho;
22
23 import java.io.*;
24 import java.util.*;
25
26 /**
27 * Defines the interface for an output segment, which is used in an {@link OutputDocument} to
28 * replace segments of the source document with other text.
29 * <p>
30 * All text in the <code>OutputDocument</code> between the character positions defined by {@link #getBegin()} and {@link #getEnd()}
31 * is replaced by the content of this output segment.
32 * If the begin and end character positions are the same, the content is simply
33 * inserted at this position without replacing any text.
34 *
35 * @see OutputDocument#register(OutputSegment)
36 */
37 public interface OutputSegment extends CharStreamSource {
38
39 /**
40 * The comparator used to sort output segments in the {@link OutputDocument} before output.
41 * <p>
42 * The following rules are applied in order compare two output segments:
43 * <ol>
44 * <li>The output segment that {@linkplain #getBegin() begins} earlier in the document comes first.
45 * <li>If both output segments begin at the same position, the one that has zero length comes first.
46 * If neither or both have zero length then neither is guaranteed to come before the other.
47 * </ol>
48 * <p>
49 * Note: this comparator has a natural ordering that may be inconsistent with the <code>equals</code>
50 * method of classes implementing this interface.
51 * This means that the comparator may treat two output segments as equal where calling the
52 * <code>equals(Object)</code> method with the same two output segments returns <code>false</code>.
53 */
54 public static final Comparator<OutputSegment> COMPARATOR=new OutputSegmentComparator();
55
56 /**
57 * Returns the character position in the {@linkplain OutputDocument#getSourceText() source text of the output document} where this segment begins.
58 * @return the character position in the {@linkplain OutputDocument#getSourceText() source text of the output document} where this segment begins.
59 */
60 public int getBegin();
61
62 /**
63 * Returns the character position in the {@linkplain OutputDocument#getSourceText() source text of the output document} where this segment ends.
64 * @return the character position in the {@linkplain OutputDocument#getSourceText() source text of the output document} where this segment ends.
65 */
66 public int getEnd();
67
68 /**
69 * Writes the content of this output segment to the specified <code>Writer</code>.
70 * @param writer the destination <code>java.io.Writer</code> for the output.
71 * @throws IOException if an I/O exception occurs.
72 */
73 public void writeTo(Writer writer) throws IOException;
74
75 /**
76 * Appends the content of this output segment to the specified <code>Appendable</code> object.
77 * @param appendable the destination <code>java.lang.Appendable</code> object for the output.
78 * @throws IOException if an I/O exception occurs.
79 */
80 public void appendTo(Appendable appendable) throws IOException;
81
82 /**
83 * Returns the content of this output segment as a <code>String</code>.
84 * @return the content of this output segment as a <code>String</code>, guaranteed not <code>null</code>.
85 * @see #writeTo(Writer)
86 */
87 public String toString();
88
89 /**
90 * Returns a string representation of this object useful for debugging purposes.
91 * @return a string representation of this object useful for debugging purposes.
92 */
93 public String getDebugInfo();
94 }

   
Visit the aagtl Website