KickJava   Java API By Example, From Geeks To Geeks.

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


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 import javax.swing.text.Position JavaDoc;
23
24 /**
25  * Subset of functionality of CharSequence present in JDK1.4.
26  *
27  * @author Miloslav Metelka
28  * @version 1.00
29  */
30
31
32 public interface CharSeq {
33
34     /**
35      * Returns the length of this character sequence. The length is the number
36      * of 16-bit Unicode characters in the sequence. </p>
37      *
38      * @return the number of characters in this sequence
39      */
40     int length();
41
42     /**
43      * Returns the character at the specified index. An index ranges from zero
44      * to <tt>length() - 1</tt>. The first character of the sequence is at
45      * index zero, the next at index one, and so on, as for array
46      * indexing. </p>
47      *
48      * @param index the index of the character to be returned
49      *
50      * @return the specified character
51      *
52      * @throws IndexOutOfBoundsException
53      * if the <tt>index</tt> argument is negative or not less than
54      * <tt>length()</tt>
55      */
56     char charAt(int index);
57     
58 }
59
Popular Tags