View Javadoc
1   /*
2    * reserved comment block
3    * DO NOT REMOVE OR ALTER!
4    */
5   /*
6    * Copyright 1999-2004 The Apache Software Foundation.
7    *
8    * Licensed under the Apache License, Version 2.0 (the "License");
9    * you may not use this file except in compliance with the License.
10   * You may obtain a copy of the License at
11   *
12   *     http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing, software
15   * distributed under the License is distributed on an "AS IS" BASIS,
16   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17   * See the License for the specific language governing permissions and
18   * limitations under the License.
19   */
20  
21  package com.sun.org.apache.regexp.internal;
22  
23  /**
24   * Encapsulates different types of character sources - String, InputStream, ...
25   * Defines a set of common methods
26   *
27   * @author <a href="mailto:ales.novak@netbeans.com">Ales Novak</a>
28   */
29  public interface CharacterIterator
30  {
31      /** @return a substring */
32      String substring(int beginIndex, int endIndex);
33  
34      /** @return a substring */
35      String substring(int beginIndex);
36  
37      /** @return a character at the specified position. */
38      char charAt(int pos);
39  
40      /** @return <tt>true</tt> iff if the specified index is after the end of the character stream */
41      boolean isEnd(int pos);
42  }