RSSConfig.java

/*
 * 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;

/**
 * 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 <category> elements which serves as the
   * initial capacity of the List implementation.
   */
  final byte categoryAvg;

  /**
   * Average number of RSS item <media:thumbnail> elements which serves as
   * the initial capacity of the List implementation.
   */
  final byte thumbnailAvg;

  /**
   * Instantiate an RSS configuration with the specified parameters.
   * 
   * @param categoryAvg average number of RSS item <category> elements in
   *          a typical RSS feed
   * @param thumbnailAvg average number of RSS item <metia:thumbnail>
   *          elements in a typical RSS feed
   */
  public RSSConfig(byte categoryAvg, byte thumbnailAvg) {
    this.categoryAvg = categoryAvg;
    this.thumbnailAvg = thumbnailAvg;
  }

  /**
   * Instantiate an RSS configuration with default values.
   */
  public RSSConfig() {
    this.categoryAvg = 3;
    this.thumbnailAvg = 2;
  }

}