Module org.htmlunit

Package org.htmlunit.util

Class KeyDataPair

java.lang.Object

org.htmlunit.util.NameValuePair

org.htmlunit.util.KeyDataPair

All Implemented Interfaces:

Serializable

public class KeyDataPair
extends NameValuePair

INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
A holder for a key/value pair that represents a file to upload.

Author:

Brad Clarke, David D. Kilzer, Mike Bowler, Ahmed Ashour, Ronald Brill, Michael Lueck

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
KeyDataPair(String key, File file, String fileName, String mimeType, String charset)	Creates an instance.
KeyDataPair(String key, File file, String fileName, String mimeType, Charset charset)	Creates an instance.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object object)
Charset	getCharset()	Returns the charset encoding for this file upload.
byte[]	getData()	Returns the in-memory data assigned to this file value, or null if the actual file content should be used.
File	getFile()	Returns the File object if the file exists, otherwise null.
String	getFileName()	Returns the file name.
String	getMimeType()	Returns the MIME type for this file upload.
int	hashCode()
KeyDataPair	normalized()	INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK. convert null values to empty string
void	setData(byte[] data)	Sets the in-memory data for this file value.

Methods inherited from class org.htmlunit.util.NameValuePair

getName, getValue, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

KeyDataPair

public KeyDataPair(String key,
 File file,
 String fileName,
 String mimeType,
 String charset)

Creates an instance.

Parameters:

key - the key

file - the file

fileName - the name of the file

mimeType - the MIME type

charset - the charset encoding name

KeyDataPair

public KeyDataPair(String key,
 File file,
 String fileName,
 String mimeType,
 Charset charset)

Creates an instance.

Parameters:

key - the key

file - the file

fileName - the name of the file

mimeType - the MIME type

charset - the charset encoding

Method Details

equals

public boolean equals(Object object)

Overrides:

equals in class NameValuePair

hashCode

public int hashCode()

Overrides:

hashCode in class NameValuePair

getFile

public File getFile()

Returns the File object if the file exists, otherwise null.

Returns:

the file, or null if it does not exist

getFileName

public String getFileName()

Returns the file name.

Returns:

the file name

getCharset

public Charset getCharset()

Returns the charset encoding for this file upload.

Returns:

the charset

getMimeType

public String getMimeType()

Returns the MIME type for this file upload.

Returns:

the MIME type

getData

public byte[] getData()

Returns the in-memory data assigned to this file value, or null if the actual file content should be used.

Returns:

the in-memory data, or null

setData

public void setData(byte[] data)

Sets the in-memory data for this file value. If not set, the file content will be used.

Parameters:

data - the byte array with file data

normalized

public KeyDataPair normalized()

INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.
convert null values to empty string Specialization of the inherited method that copies all fields and ensures the value in the base class is not null.

Overrides:

normalized in class NameValuePair

Returns:

a normalized copy of the NameValuePair