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 * A type-safe iterator for {@link HeaderElement} objects.
34 *
35 * @since 4.0
36 */
37 public interface HeaderElementIterator extends Iterator<Object> {
38
39 /**
40 * Indicates whether there is another header element in this
41 * iteration.
42 *
43 * @return {@code true} if there is another header element,
44 * {@code false} otherwise
45 */
46 @Override
47 boolean hasNext();
48
49 /**
50 * Obtains the next header element from this iteration.
51 * This method should only be called while {@link #hasNext hasNext}
52 * is true.
53 *
54 * @return the next header element in this iteration
55 */
56 HeaderElement nextElement();
57
58 }