com.atlassian.confluence.search.v2.query
Class ContentTypeQuery

java.lang.Object
  extended by com.atlassian.confluence.search.v2.query.ContentTypeQuery
All Implemented Interfaces:
SearchQuery

public class ContentTypeQuery
extends Object
implements SearchQuery

Search for content of a particular type. The string representation of a content's type is that returned by the ContentTypeAware.getType() method.


Constructor Summary
ContentTypeQuery(Collection<ContentTypeEnum> contentTypes)
          Search for content that is one of the provided types
ContentTypeQuery(ContentTypeEnum contentType)
          Search for a particular type of content
 
Method Summary
 boolean equals(Object obj)
           
 Set<ContentTypeEnum> getContentTypes()
          Get the content types being searched for, as strings.
 String getKey()
           
 List<String> getParameters()
          List of parameters as Strings or SearchQuerys.
 int hashCode()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ContentTypeQuery

public ContentTypeQuery(ContentTypeEnum contentType)
Search for a particular type of content

Parameters:
contentType - the type string for the content to be searched for

ContentTypeQuery

public ContentTypeQuery(Collection<ContentTypeEnum> contentTypes)
Search for content that is one of the provided types

Parameters:
contentTypes - a list of content types to search for
Method Detail

getKey

public String getKey()
Specified by:
getKey in interface SearchQuery
Returns:
the plugin key

getParameters

public List<String> getParameters()
Description copied from interface: SearchQuery
List of parameters as Strings or SearchQuerys.

Specified by:
getParameters in interface SearchQuery
Returns:
Strings or SearchQuerys.

getContentTypes

public Set<ContentTypeEnum> getContentTypes()
Get the content types being searched for, as strings. Really does the same as getParameters() but has a more apt name.

Returns:
a list of the content types being searched for, as strings

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object


Copyright © 2003-2011 Atlassian. All Rights Reserved.