com.atlassian.confluence.search.v2.query

Class FileExtensionQuery

java.lang.Object

com.atlassian.confluence.search.v2.query.FileExtensionQuery

All Implemented Interfaces:

Expandable<SearchQuery>, SearchQuery

public class FileExtensionQuery
extends Object
implements SearchQuery

Search for content with a particular file extension. Normally only attachments will match this query, but for safety if you only want attachments you should AND with a ContentTypeQuery in case something else in the future has file extensions.

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY

Constructor Summary

Constructors

Constructor and Description
FileExtensionQuery(String fileExtension) Construct a new query for a given file extension

Method Summary

Modifier and Type	Method and Description
SearchQuery	expand() Expands this query into a composite query (that composes other queries).
String	getFileExtension()
String	getKey()
List	getParameters() List of parameters as Strings or SearchQuerys.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.confluence.search.v2.SearchQuery

getBoost

Field Detail

KEY

public static final String KEY

See Also:

Constant Field Values

Constructor Detail

FileExtensionQuery

public FileExtensionQuery(String fileExtension)

Construct a new query for a given file extension

Parameters:

fileExtension - the extension (without a period)

Method Detail

getKey

public String getKey()

Specified by:

getKey in interface SearchQuery

Returns:

the plugin key

getParameters

public List getParameters()

Description copied from interface: SearchQuery

List of parameters as Strings or SearchQuerys.

Specified by:

getParameters in interface SearchQuery

Returns:

Strings or SearchQuerys.

getFileExtension

public String getFileExtension()

expand

public SearchQuery expand()

Description copied from interface: SearchQuery

Expands this query into a composite query (that composes other queries). By overriding this method, one can specify a new query that is composition of the behaviour of the composed queries.

Specified by:

expand in interface Expandable<SearchQuery>

Specified by:

expand in interface SearchQuery

Returns:

a query