1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.fileupload;
18
19
20 /**
21 * <p>A factory interface for creating {@link FileItem} instances. Factories
22 * can provide their own custom configuration, over and above that provided
23 * by the default file upload implementation.</p>
24 *
25 * @author <a href="mailto:martinc@apache.org">Martin Cooper</a>
26 *
27 * @version $Id: FileItemFactory.java 479262 2006-11-26 03:09:24Z niallp $
28 */
29 public interface FileItemFactory {
30
31 /**
32 * Create a new {@link FileItem} instance from the supplied parameters and
33 * any local factory configuration.
34 *
35 * @param fieldName The name of the form field.
36 * @param contentType The content type of the form field.
37 * @param isFormField <code>true</code> if this is a plain form field;
38 * <code>false</code> otherwise.
39 * @param fileName The name of the uploaded file, if any, as supplied
40 * by the browser or other client.
41 *
42 * @return The newly created file item.
43 */
44 FileItem createItem(
45 String fieldName,
46 String contentType,
47 boolean isFormField,
48 String fileName
49 );
50 }