KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > editor > TextBatchProcessor


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */
19
20 package org.netbeans.editor;
21
22 /** Process the batches of the text in the document. This interface
23 * can be passed to the BaseDocument.processText() and this method
24 * then calls the processTextBatch() to process the text batches.
25 *
26 * @author Miloslav Metelka
27 * @version 1.00
28 */
29
30
31 public interface TextBatchProcessor {
32
33     /** Process one batch of the text.
34     * @doc document to work with
35     * @startPos starting position of the batch
36     * @endPos ending position of the batch
37     * @lastBatch whether this batch is the last one in the text area that
38     * is searched.
39     * @return non-negative number to stop the batch processing. The returned
40     * value is remembered and returned from BaseDocument.processText().
41     * Negative value means to continue with the next batch.
42     */
43     public int processTextBatch(BaseDocument doc, int startPos, int endPos,
44                                 boolean lastBatch);
45
46 }
47
Popular Tags