net.sf.mmm.util.io.base.AbstractDetectorStreamProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mmm-util-io Show documentation
Utilities for input/output and streaming.
The newest version!
/* Copyright (c) The m-m-m Team, Licensed under the Apache License, Version 2.0
 * http://www.apache.org/licenses/LICENSE-2.0 */
package net.sf.mmm.util.io.base;

import java.io.InputStream;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;

import javax.inject.Inject;

import net.sf.mmm.util.component.base.AbstractComponent;
import net.sf.mmm.util.io.api.DetectorInputStream;
import net.sf.mmm.util.io.api.DetectorOutputStream;
import net.sf.mmm.util.io.api.DetectorStreamProvider;
import net.sf.mmm.util.io.api.spi.DetectorStreamProcessorFactory;
import net.sf.mmm.util.pool.api.ByteArrayPool;
import net.sf.mmm.util.pool.base.NoByteArrayPool;

/**
 * This is the abstract base implementation of the {@link DetectorStreamProvider}.
 *
 * @author Joerg Hohwiller (hohwille at users.sourceforge.net)
 * @since 1.1.0
 */
public abstract class AbstractDetectorStreamProvider extends AbstractComponent implements DetectorStreamProvider {

  private List processorFactoryList;

  private ByteArrayPool byteArrayPool;

  /**
   * The constructor.
   */
  public AbstractDetectorStreamProvider() {

    super();
  }

  /**
   * This method gets the {@link List} of {@link #addProcessorFactory(DetectorStreamProcessorFactory) registered}
   * {@link DetectorStreamProcessorFactory}-instances.
   *
   * @return the processorFactoryList
   */
  public List getProcessorFactoryList() {

    if (this.processorFactoryList == null) {
      this.processorFactoryList = new ArrayList<>();
    }
    return this.processorFactoryList;
  }

  /**
   * This method registers a {@link DetectorStreamProcessorFactory} to this {@link DetectorStreamProvider}.
   *
   * @see #setProcessorFactoryList(List)
   *
   * @param processorFactory is the {@link DetectorStreamProcessorFactory} to add.
   */
  public void addProcessorFactory(DetectorStreamProcessorFactory processorFactory) {

    getProcessorFactoryList().add(processorFactory);
  }

  /**
   * This method sets the complete {@link List} of {@link DetectorStreamProcessorFactory}-instances. Do NOT call this
   * method after {@link #addProcessorFactory(DetectorStreamProcessorFactory)} has been called.
   *
   * @param processorFactoryList is the complete {@link List} of {@link DetectorStreamProcessorFactory} -instances to
   *        set.
   */
  public void setProcessorFactoryList(List processorFactoryList) {

    getInitializationState().requireNotInitilized();
    this.processorFactoryList = processorFactoryList;
  }

  /**
   * This method sets the {@link ByteArrayPool} to use.
   *
   * @param byteArrayPool is the {@link ByteArrayPool} to set.
   */
  @Inject
  public void setByteArrayPool(ByteArrayPool byteArrayPool) {

    this.byteArrayPool = byteArrayPool;
  }

  /**
   * This method gets the {@link ByteArrayPool} used to {@link ByteArrayPool#borrow() borrow} byte-arrays.
   *
   * @return the {@link ByteArrayPool}.
   */
  public ByteArrayPool getByteArrayPool() {

    return this.byteArrayPool;
  }

  @Override
  protected void doInitialize() {

    super.doInitialize();
    if (getProcessorFactoryList().size() == 0) {
      throw new IllegalStateException("processorFactoryList is empty");
    }
    if (this.byteArrayPool == null) {
      this.byteArrayPool = NoByteArrayPool.INSTANCE;
    }
  }

  @Override
  public DetectorInputStream wrapInputStream(InputStream stream) {

    return wrapInputStream(stream, new HashMap());
  }

  @Override
  public DetectorOutputStream wrapOutputStream(OutputStream stream) {

    return wrapOutputStream(stream, new HashMap());
  }

}