/*
 * Copyright 2002-2016 the original author or authors.
 *
 * 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
 *
 *      https://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 org.springframework.web.multipart;

import java.util.Iterator;
import java.util.List;
import java.util.Map;

import org.springframework.lang.Nullable;
import org.springframework.util.MultiValueMap;

This interface defines the multipart request access operations that are exposed for actual multipart requests. It is extended by MultipartHttpServletRequest. 
Author:
Juergen Hoeller, Arjen Poutsma
Since:
2.5.2/**
 * This interface defines the multipart request access operations that are exposed
 * for actual multipart requests. It is extended by {@link MultipartHttpServletRequest}.
 *
 * @author Juergen Hoeller
 * @author Arjen Poutsma
 * @since 2.5.2
 */
public interface MultipartRequest {

	
Return an Iterator of String objects containing the parameter names of the multipart files contained in this request. These are the field names of the form (like with normal parameters), not the original file names. 
Returns:
the names of the files/**
	 * Return an {@link java.util.Iterator} of String objects containing the
	 * parameter names of the multipart files contained in this request. These
	 * are the field names of the form (like with normal parameters), not the
	 * original file names.
	 * @return the names of the files
	 */
	Iterator<String> getFileNames();

	
Return the contents plus description of an uploaded file in this request, or null if it does not exist. 
Params:
name – a String specifying the parameter name of the multipart file
Returns:
the uploaded content in the form of a MultipartFile object/**
	 * Return the contents plus description of an uploaded file in this request,
	 * or {@code null} if it does not exist.
	 * @param name a String specifying the parameter name of the multipart file
	 * @return the uploaded content in the form of a {@link MultipartFile} object
	 */
	@Nullable
	MultipartFile getFile(String name);

	
Return the contents plus description of uploaded files in this request,
or an empty list if it does not exist.
Params:
name – a String specifying the parameter name of the multipart file
Returns:
the uploaded content in the form of a MultipartFile list
Since:
3.0/**
	 * Return the contents plus description of uploaded files in this request,
	 * or an empty list if it does not exist.
	 * @param name a String specifying the parameter name of the multipart file
	 * @return the uploaded content in the form of a {@link MultipartFile} list
	 * @since 3.0
	 */
	List<MultipartFile> getFiles(String name);

	
Return a Map of the multipart files contained in this request. 
Returns:
a map containing the parameter names as keys, and the MultipartFile objects as values/**
	 * Return a {@link java.util.Map} of the multipart files contained in this request.
	 * @return a map containing the parameter names as keys, and the
	 * {@link MultipartFile} objects as values
	 */
	Map<String, MultipartFile> getFileMap();

	
Return a MultiValueMap of the multipart files contained in this request. 
Returns:
a map containing the parameter names as keys, and a list of MultipartFile objects as values
Since:
3.0/**
	 * Return a {@link MultiValueMap} of the multipart files contained in this request.
	 * @return a map containing the parameter names as keys, and a list of
	 * {@link MultipartFile} objects as values
	 * @since 3.0
	 */
	MultiValueMap<String, MultipartFile> getMultiFileMap();

	
Determine the content type of the specified request part.
Params:
paramOrFileName – the name of the part
Returns:
the associated content type, or null if not defined
Since:
3.1/**
	 * Determine the content type of the specified request part.
	 * @param paramOrFileName the name of the part
	 * @return the associated content type, or {@code null} if not defined
	 * @since 3.1
	 */
	@Nullable
	String getMultipartContentType(String paramOrFileName);

}