com.phloc.web.fileupload.FileUpload Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2006-2015 phloc systems
 * http://www.phloc.com
 * office[at]phloc[dot]com
 *
 * 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 com.phloc.web.fileupload;

/**
 * 
 * High level API for processing file uploads.
 * 
 * 
 * This class handles multiple files per single HTML widget, sent using
 * multipart/mixed encoding type, as specified by RFC 1867.
 * 
 * 
 * How the data for individual parts is stored is determined by the factory used
 * to create them; a given part may be in memory, on disk, or somewhere else.
 * 
 * 
 * @author Rafal Krzewski
 * @author Daniel Rall
 * @author Jason van Zyl
 * @author John McNally
 * @author Martin Cooper
 * @author Sean C. Sullivan
 * @version $Id: FileUpload.java 479484 2006-11-27 01:06:53Z jochen $
 */
public class FileUpload extends AbstractFileUploadBase
{
  /**
   * The factory to use to create new form items.
   */
  private final IFileItemFactory m_aFileItemFactory;

  /**
   * Constructs an instance of this class which uses the supplied factory to
   * create FileItem instances.
   * 
   * @param fileItemFactory
   *        The factory to use for creating file items.
   */
  public FileUpload (final IFileItemFactory fileItemFactory)
  {
    super ();
    m_aFileItemFactory = fileItemFactory;
  }

  // ----------------------------------------------------- Property accessors

  /**
   * Returns the factory class used when creating file items.
   * 
   * @return The factory class for new file items.
   */
  @Override
  public IFileItemFactory getFileItemFactory ()
  {
    return m_aFileItemFactory;
  }
}