View Javadoc

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