| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| FileItemFactory |
|
| 1.0;1 |
| 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 | * <p>A factory interface for creating {@link FileItem} instances. Factories | |
| 21 | * can provide their own custom configuration, over and above that provided | |
| 22 | * by the default file upload implementation.</p> | |
| 23 | */ | |
| 24 | public interface FileItemFactory { | |
| 25 | ||
| 26 | /** | |
| 27 | * Create a new {@link FileItem} instance from the supplied parameters and | |
| 28 | * any local factory configuration. | |
| 29 | * | |
| 30 | * @param fieldName The name of the form field. | |
| 31 | * @param contentType The content type of the form field. | |
| 32 | * @param isFormField <code>true</code> if this is a plain form field; | |
| 33 | * <code>false</code> otherwise. | |
| 34 | * @param fileName The name of the uploaded file, if any, as supplied | |
| 35 | * by the browser or other client. | |
| 36 | * | |
| 37 | * @return The newly created file item. | |
| 38 | */ | |
| 39 | FileItem createItem( | |
| 40 | String fieldName, | |
| 41 | String contentType, | |
| 42 | boolean isFormField, | |
| 43 | String fileName | |
| 44 | ); | |
| 45 | ||
| 46 | } |