1/*
2 * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/TokenIterator.java $
3 * $Revision: 601000 $
4 * $Date: 2007-12-04 09:03:49 -0800 (Tue, 04 Dec 2007) $
5 *
6 * ====================================================================
7 * Licensed to the Apache Software Foundation (ASF) under one
8 * or more contributor license agreements.  See the NOTICE file
9 * distributed with this work for additional information
10 * regarding copyright ownership.  The ASF licenses this file
11 * to you under the Apache License, Version 2.0 (the
12 * "License"); you may not use this file except in compliance
13 * with the License.  You may obtain a copy of the License at
14 *
15 *   http://www.apache.org/licenses/LICENSE-2.0
16 *
17 * Unless required by applicable law or agreed to in writing,
18 * software distributed under the License is distributed on an
19 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
20 * KIND, either express or implied.  See the License for the
21 * specific language governing permissions and limitations
22 * under the License.
23 * ====================================================================
24 *
25 * This software consists of voluntary contributions made by many
26 * individuals on behalf of the Apache Software Foundation.  For more
27 * information on the Apache Software Foundation, please see
28 * <http://www.apache.org/>.
29 *
30 */
31
32package org.apache.http;
33
34
35import java.util.Iterator;
36
37
38/**
39 * An iterator for {@link String} tokens.
40 * This interface is designed as a complement to
41 * {@link HeaderElementIterator}, in cases where the items
42 * are plain strings rather than full header elements.
43 *
44 * @version $Revision: 601000 $
45 */
46public interface TokenIterator extends Iterator {
47
48    /**
49     * Indicates whether there is another token in this iteration.
50     *
51     * @return  <code>true</code> if there is another token,
52     *          <code>false</code> otherwise
53     */
54    boolean hasNext()
55        ;
56
57
58    /**
59     * Obtains the next token from this iteration.
60     * This method should only be called while {@link #hasNext hasNext}
61     * is true.
62     *
63     * @return  the next token in this iteration
64     */
65    String nextToken()
66        ;
67}
68