content: /*
   * Copyright (C) 2010 A. Horn
   *
   * Licensed under the Apache License, Version 2.0 (the "License");
   * you may not use this file except in compliance with the License.
   * You may obtain a copy of the License at
   *
   *      http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  
  package org.mcsoxford.rss;
  
  import java.util.ArrayList;
  import java.util.Collections;
  import java.util.List;
  
  /**
   * Immutable data structure to configure the RSS parser and loader modules. On
   * large data sets, well-chosen configuration values can reduce memory
   * consumption and increase performance.
   *
   * @author Mr Horn
   */
  public final class RSSConfig {
  
    /**
     * Average number of RSS item &lt;category&gt; elements which serves as the
     * initial capacity of the List implementation.
     */
    final byte categoryAvg;
  
    /**
     * Average number of RSS item &lt;media:thumbnail&gt; elements which serves as
     * the initial capacity of the List implementation.
     */
    final byte thumbnailAvg;
  
    /**
     * List of DataParser implementations which will be queried in-order to deserialize
     * date strings.
     */
    final List<DateParser> dateParsers;
  
    /**
     * Instantiate an RSS configuration with the specified parameters.
     *
     * @param categoryAvg average number of RSS item &lt;category&gt; elements in
     *          a typical RSS feed
     * @param thumbnailAvg average number of RSS item &lt;metia:thumbnail&gt;
     *          elements in a typical RSS feed
     * @param dateParsers DateParser implementations for parsing dates found in RSS feed
     */
    public RSSConfig(byte categoryAvg, byte thumbnailAvg, List<DateParser> dateParsers) {
      this.categoryAvg = categoryAvg;
      this.thumbnailAvg = thumbnailAvg;
      this.dateParsers = Collections.unmodifiableList(new ArrayList<DateParser>(dateParsers));
    }
  
    /**
     * Instantiate an RSS configuration with default values.
     */
    public RSSConfig() {
      this.categoryAvg = 3;
      this.thumbnailAvg = 2;
      this.dateParsers = Collections.unmodifiableList(Collections.<DateParser>singletonList(new Rfc822DateParser()));
    }
  
  }
  
  