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 * A type-safe iterator for {@link Header} objects.
034 *
035 * @since 4.0
036 */
037public interface HeaderIterator extends Iterator<Object> {
038
039    /**
040     * Indicates whether there is another header in this iteration.
041     *
042     * @return  {@code true} if there is another header,
043     *          {@code false} otherwise
044     */
045    @Override
046    boolean hasNext();
047
048    /**
049     * Obtains the next header from this iteration.
050     * This method should only be called while {@link #hasNext hasNext}
051     * is true.
052     *
053     * @return  the next header in this iteration
054     */
055    Header nextHeader();
056
057}