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     */
017    package org.apache.commons.fileupload;
018    
019    
020    /**
021     * <p>A factory interface for creating {@link FileItem} instances. Factories
022     * can provide their own custom configuration, over and above that provided
023     * by the default file upload implementation.</p>
024     *
025     * @author <a href="mailto:martinc@apache.org">Martin Cooper</a>
026     *
027     * @version $Id: FileItemFactory.java 479262 2006-11-26 03:09:24Z niallp $
028     */
029    public interface FileItemFactory {
030    
031        /**
032         * Create a new {@link FileItem} instance from the supplied parameters and
033         * any local factory configuration.
034         *
035         * @param fieldName   The name of the form field.
036         * @param contentType The content type of the form field.
037         * @param isFormField <code>true</code> if this is a plain form field;
038         *                    <code>false</code> otherwise.
039         * @param fileName    The name of the uploaded file, if any, as supplied
040         *                    by the browser or other client.
041         *
042         * @return The newly created file item.
043         */
044        FileItem createItem(
045                String fieldName,
046                String contentType,
047                boolean isFormField,
048                String fileName
049                );
050    }