001/* 002 * ==================================================================== 003 * Licensed to the Apache Software Foundation (ASF) under one 004 * or more contributor license agreements. See the NOTICE file 005 * distributed with this work for additional information 006 * regarding copyright ownership. The ASF licenses this file 007 * to you under the Apache License, Version 2.0 (the 008 * "License"); you may not use this file except in compliance 009 * with the License. You may obtain a copy of the License at 010 * 011 * http://www.apache.org/licenses/LICENSE-2.0 012 * 013 * Unless required by applicable law or agreed to in writing, 014 * software distributed under the License is distributed on an 015 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 016 * KIND, either express or implied. See the License for the 017 * specific language governing permissions and limitations 018 * under the License. 019 * ==================================================================== 020 * 021 * This software consists of voluntary contributions made by many 022 * individuals on behalf of the Apache Software Foundation. For more 023 * information on the Apache Software Foundation, please see 024 * <http://www.apache.org/>. 025 * 026 */ 027 028package org.apache.http; 029 030import java.util.Iterator; 031 032/** 033 * An iterator for {@link String} tokens. 034 * This interface is designed as a complement to 035 * {@link HeaderElementIterator}, in cases where the items 036 * are plain strings rather than full header elements. 037 * 038 * @since 4.0 039 */ 040public interface TokenIterator extends Iterator<Object> { 041 042 /** 043 * Indicates whether there is another token in this iteration. 044 * 045 * @return {@code true} if there is another token, 046 * {@code false} otherwise 047 */ 048 @Override 049 boolean hasNext(); 050 051 /** 052 * Obtains the next token from this iteration. 053 * This method should only be called while {@link #hasNext hasNext} 054 * is true. 055 * 056 * @return the next token in this iteration 057 */ 058 String nextToken(); 059 060}