FileItemFactory


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  
18  
19  package org.apache.tomcat.util.http.fileupload;
20  
21  
22  /**
23   * <p>A factory interface for creating {@link FileItem} instances. Factories
24   * can provide their own custom configuration, over and above that provided
25   * by the default file upload implementation.</p>
26   *
27   * @author <a HREF="mailto:martinc@apache.org">Martin Cooper</a>
28   * 
29   * @version $Id: FileItemFactory.java 467222 2006-10-24 03:17:11Z markt $
30   */
31  public interface FileItemFactory
32  {
33  
34      /**
35       * Create a new {@link FileItem} instance from the supplied parameters and
36       * any local factory configuration.
37       *
38       * @param fieldName   The name of the form field.
39       * @param contentType The content type of the form field.
40       * @param isFormField <code>true</code> if this is a plain form field;
41       *                    <code>false</code> otherwise.
42       * @param fileName    The name of the uploaded file, if any, as supplied
43       *                    by the browser or other client.
44       *
45       * @return The newly created file item.
46       */
47      FileItem createItem(
48              String   fieldName,
49              String   contentType,
50              boolean isFormField,
51              String   fileName
52              );
53  }
54
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags