com.helger.web.fileupload.parse

Class FileItemStream

java.lang.Object

com.helger.web.fileupload.parse.FileItemStream

All Implemented Interfaces:

IFileItemHeadersSupport, IFileItemStream, Closeable, AutoCloseable

@NotThreadSafe
public class FileItemStream
extends Object
implements IFileItemStream, Closeable

Default implementation of IFileItemStream.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the file item.
String	getContentType() Returns the items content type, or null.
String	getFieldName() Returns the items field name.
IFileItemHeaders	getHeaders() Returns the collection of headers defined locally within this item.
String	getName() Returns the original filename in the client's filesystem, as provided by the browser (or other client software).
String	getNameSecure() Returns the original filename in the client's filesystem, as provided by the browser (or other client software).
String	getNameUnchecked() Returns the original filename in the client's filesystem, as provided by the browser (or other client software).
boolean	isFormField() Returns, whether this is a form field.
InputStream	openStream() Returns an input stream, which may be used to read the items contents.
void	setHeaders(IFileItemHeaders aHeaders) Sets the headers read from within an item.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

close

public void close()
           throws IOException

Closes the file item.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException - An I/O error occurred.

getContentType

@Nullable
public String getContentType()

Returns the items content type, or null.

Specified by:

getContentType in interface IFileItemStream

Returns:

Content type, if known, or null.

getFieldName

public String getFieldName()

Returns the items field name.

Specified by:

getFieldName in interface IFileItemStream

Returns:

Field name.

getName

@Nullable
public String getName()

Description copied from interface: IFileItemStream

Returns the original filename in the client's filesystem, as provided by the browser (or other client software). In most cases, this will be the base file name, without path information. However, some clients, such as the Opera browser, do include path information.

Specified by:

getName in interface IFileItemStream

Returns:

The original filename in the client's filesystem.

getNameSecure

@Nullable
public String getNameSecure()

Description copied from interface: IFileItemStream

Returns the original filename in the client's filesystem, as provided by the browser (or other client software). In most cases, this will be the base file name, without path information. However, some clients, such as the Opera browser, do include path information. Compared to IFileItemStream.getName() this method automatically removes everything and including a NUL byte and therefore does not throw an InvalidFileNameException.

Specified by:

getNameSecure in interface IFileItemStream

Returns:

The original filename in the client's filesystem.

getNameUnchecked

@Nullable
public String getNameUnchecked()

Description copied from interface: IFileItemStream

Returns the original filename in the client's filesystem, as provided by the browser (or other client software). In most cases, this will be the base file name, without path information. However, some clients, such as the Opera browser, do include path information.

Specified by:

getNameUnchecked in interface IFileItemStream

Returns:

The original filename in the client's filesystem.

isFormField

public boolean isFormField()

Returns, whether this is a form field.

Specified by:

isFormField in interface IFileItemStream

Returns:

True, if the item is a form field, otherwise false.

openStream

@Nonnull
public InputStream openStream()
                                 throws IOException

Returns an input stream, which may be used to read the items contents.

Specified by:

openStream in interface IFileItemStream

Returns:

Opened input stream.

Throws:

IOException - An I/O error occurred.

getHeaders

@Nullable
public IFileItemHeaders getHeaders()

Description copied from interface: IFileItemHeadersSupport

Returns the collection of headers defined locally within this item.

Specified by:

getHeaders in interface IFileItemHeadersSupport

Returns:

the IFileItemHeaders present for this item.

setHeaders

public void setHeaders(@Nullable
                       IFileItemHeaders aHeaders)

Description copied from interface: IFileItemHeadersSupport

Sets the headers read from within an item. Implementations of IFileItem or IFileItemStream should implement this interface to be able to get the raw headers found within the item header block.

Specified by:

setHeaders in interface IFileItemHeadersSupport

Parameters:

aHeaders - the instance that holds onto the headers for this instance.