1 /*
2 * Copyright 2001-2010 Stephen Colebourne
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.joda.primitives.listiterator;
17
18 import org.joda.primitives.iterator.CharIterator;
19
20 /**
21 * Defines a list iterator over primitive <code>char</code> values.
22 *
23 * @author Stephen Colebourne
24 * @author Jason Tiscione
25 * @version CODE GENERATED
26 * @since 1.0
27 */
28 public interface CharListIterator extends CharIterator, PrimitiveListIterator<Character> {
29 // This file is CODE GENERATED. Do not change manually.
30
31 // Mandatory operations
32 //-----------------------------------------------------------------------
33 /**
34 * Gets the previous value from the iterator.
35 *
36 * @return the previous available value
37 * @throws NoSuchElementException if there are no more values available
38 */
39 char previousChar();
40
41 // Optional operations
42 //-----------------------------------------------------------------------
43 /**
44 * Adds the specified value to the list underlying the iterator at the
45 * current iteration index (optional operation).
46 *
47 * @param value the value to add
48 * @throws IllegalStateException if the iterator cannot be added to at present
49 * @throws UnsupportedOperationException if not supported by this collection
50 */
51 void add(char value);
52
53 /**
54 * Sets the last retrieved value from the iterator (optional operation).
55 *
56 * @param value the value to set
57 * @throws IllegalStateException if the iterator cannot be set to at present
58 * @throws UnsupportedOperationException if not supported by this collection
59 */
60 void set(char value);
61
62 }