001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.net.examples.nntp;
018
019import java.io.IOException;
020import java.util.ArrayList;
021import java.util.List;
022
023import org.apache.commons.net.nntp.Article;
024import org.apache.commons.net.nntp.NNTPClient;
025
026/**
027 * Some convenience methods for NNTP example classes.
028 */
029public class NNTPUtils {
030
031    /**
032     * Given an {@link NNTPClient} instance, and an integer range of messages, return an array of {@link Article} instances.
033     *
034     * @param client            the client to use
035     * @param lowArticleNumber  low number
036     * @param highArticleNumber high number
037     * @return Article[] An array of Article
038     * @throws IOException on error
039     */
040    public static List<Article> getArticleInfo(final NNTPClient client, final long lowArticleNumber, final long highArticleNumber) throws IOException {
041        final List<Article> articles = new ArrayList<>();
042        final Iterable<Article> arts = client.iterateArticleInfo(lowArticleNumber, highArticleNumber);
043        for (final Article article : arts) {
044            articles.add(article);
045        }
046        return articles;
047    }
048}