View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *   http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.commons.net.nntp;
19  
20  import java.util.Iterator;
21  
22  /**
23   * Class which wraps an {@code Iterable<String>} of raw article information to generate an {@code Iterable<Article>} of the parsed information.
24   *
25   * @since 3.0
26   */
27  class ArticleIterator implements Iterator<Article>, Iterable<Article> {
28  
29      private final Iterator<String> stringIterator;
30  
31      public ArticleIterator(final Iterable<String> iterableString) {
32          stringIterator = iterableString.iterator();
33      }
34  
35      @Override
36      public boolean hasNext() {
37          return stringIterator.hasNext();
38      }
39  
40      @Override
41      public Iterator<Article> iterator() {
42          return this;
43      }
44  
45      /**
46       * Get the next Article
47       *
48       * @return the next {@link Article}, never {@code null}, if unparseable then isDummy() will be true, and the subject will contain the raw info.
49       */
50      @Override
51      public Article next() {
52          final String line = stringIterator.next();
53          return NNTPClient.parseArticleEntry(line);
54      }
55  
56      @Override
57      public void remove() {
58          stringIterator.remove();
59      }
60  }