com.atlassian.bonnie.search
Interface SearchableAttachment

All Superinterfaces:

Searchable

public interface SearchableAttachment
extends Searchable

An object representing some searchable file.

Method Summary

java.lang.String	getComment() Return any comment associated with this attachment
java.io.InputStream	getContentsAsStream() Return the contents of the attachment as an InputStream
java.lang.String	getContentType() Gets the MIME content-type of this attachment.
java.lang.String	getDownloadPath()
java.lang.String	getFileName() Gets the filename of this attachment.
java.lang.String	getNiceFileSize()
java.lang.String	getNiceType()

Methods inherited from interface com.atlassian.bonnie.Searchable

getId, getSearchableDependants, isIndexable

Method Detail

getContentType

java.lang.String getContentType()

Gets the MIME content-type of this attachment. If there is no content-type, return "application/x-unknown". Should never return null.

Returns:

the MIME content-type of the attachment, or "application/x-unknown" if the MIME type is unknown

getFileName

java.lang.String getFileName()

Gets the filename of this attachment. If there is no filename, return the empty string. This method should never return null.

Returns:

the filename of this attachment, or the empty string if there is no filename

getContentsAsStream

java.io.InputStream getContentsAsStream()
                                        throws java.io.IOException

Return the contents of the attachment as an InputStream

Returns:

an InputStream set at the start of the attachment's contents.

Throws:

java.io.IOException

getComment

java.lang.String getComment()

Return any comment associated with this attachment

getNiceType

java.lang.String getNiceType()

getNiceFileSize

java.lang.String getNiceFileSize()

getDownloadPath

java.lang.String getDownloadPath()