1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements.  See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License.  You may obtain a copy of the License at
8  *
9  *      http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 /* $Id$ */
19 
20 package org.apache.fop.fo;
21 
22 import java.util.NoSuchElementException;
23 
24 /**
25  * Class providing an (FO flavored) char iterator for a string.
26  */
27 public class StringCharIterator extends CharIterator {
28 
29     private int index;
30     private String str;
31 
32     /**
33      * Constructor
34      * @param s the character that this iterator should iterate.
35      */
StringCharIterator(String s)36     public StringCharIterator(String s) {
37         this.index = -1;
38         this.str = s;
39     }
40 
41     /**
42      * @return true if there is another element in the collection over which to
43      * iterate (since this iterator only handles one character, this will return
44      * false if it is past that character).
45      */
hasNext()46     public boolean hasNext() {
47         return (index + 1) < str.length();
48     }
49 
50     /**
51      * @return the next character, if there is one (since there is only one
52      * character over which to iterate, it must be the first character).
53      * @throws NoSuchElementException if past the first character
54      */
nextChar()55     public char nextChar() throws NoSuchElementException {
56         if ((index + 1) < str.length()) {
57             return str.charAt(++index);
58         } else {
59             throw new NoSuchElementException();
60         }
61     }
62 
63 }
64 
65