Package nzilbb.labbcat.server.api

Class RequestParameters

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<String,Object>

nzilbb.labbcat.server.api.RequestParameters

All Implemented Interfaces:

Closeable, Serializable, AutoCloseable, Cloneable, Map<String,Object>

public class RequestParameters
extends HashMap<String,Object>
implements Closeable

A map of request parameter names to their values. Each name can correspond to multiple values, and values can be either Strings or Files.

Author:

Robert Fromont robert@fromont.net.nz

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Constructor Summary

Constructors

Constructor	Description
RequestParameters()	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	close()	Deletes all temporary files that were created while reading file parameters.
List<File>	getAllFiles()	Obtains all files in the parameters.
File	getFile(String key)	Gets the named item as a list of files.
Vector<File>	getFiles(String key)	Gets the named item as a list of files.
String	getString(String key)	Gets the named item as a string.
String[]	getStrings(String key)	Gets all parameters with the given name.

Methods inherited from class java.util.HashMap

clear, clone, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, forEach, get, getOrDefault, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

RequestParameters

public RequestParameters()

Default constructor.

Method Detail

getString

public String getString(String key)

Gets the named item as a string.

Parameters:

key - The parameter name.

Returns:

The item as a String.

getStrings

public String[] getStrings(String key)

Gets all parameters with the given name.

Parameters:

key - The parameter name.

Returns:

All parameter String values, or an empty array if there are none.

getFile

public File getFile(String key)

Gets the named item as a list of files.

Parameters:

key - The parameter name.

Returns:

A list of FileItems.

getFiles

public Vector<File> getFiles(String key)

Gets the named item as a list of files.

Parameters:

key - The parameter name.

Returns:

A list of FileItems, which may be empty.

getAllFiles

public List<File> getAllFiles()

Obtains all files in the parameters.

Returns:

All the files uploaded with the parameters.

close

public void close()

Deletes all temporary files that were created while reading file parameters.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable