blob: bfe3473280aeef690a8dc856052c621a6ba969d3 [file] [log] [blame]
/*
* $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/TokenIterator.java $
* $Revision: 601000 $
* $Date: 2007-12-04 09:03:49 -0800 (Tue, 04 Dec 2007) $
*
* ====================================================================
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
*/
package org.apache.http;
import java.util.Iterator;
/**
* An iterator for {@link String} tokens.
* This interface is designed as a complement to
* {@link HeaderElementIterator}, in cases where the items
* are plain strings rather than full header elements.
*
* @version $Revision: 601000 $
*/
public interface TokenIterator extends Iterator {
/**
* Indicates whether there is another token in this iteration.
*
* @return <code>true</code> if there is another token,
* <code>false</code> otherwise
*/
boolean hasNext()
;
/**
* Obtains the next token from this iteration.
* This method should only be called while {@link #hasNext hasNext}
* is true.
*
* @return the next token in this iteration
*/
String nextToken()
;
}