Class Category
- java.lang.Object
-
- com.atlassian.confluence.search.contentnames.Category
-
public class Category extends Object
Represents a category in which results coming back from a content name search can be put in.
-
-
Field Summary
Fields Modifier and Type Field Description static Category
ATTACHMENTS
A category for attachment results.static Category
BLOGS
A category for blog results.static Category
COMMENTS
A category for comments.static Category
CONTENT
A category for page and blog results combined.static Category
CUSTOM
A category for custom content.static Category
PAGES
A category for page results.static Category
PEOPLE
A category for people results.static Category
PERSONAL_SPACE
A category for personal spaces.static Category
SPACES
A category for space results.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object o)
static Set<Category>
getCategories(String contentType)
Returns a Set of Categories the content of specific type belongs to.static Category
getCategory(String type)
Return a Category for the supplied type.String
getName()
int
hashCode()
String
toString()
-
-
-
Field Detail
-
PAGES
public static final Category PAGES
A category for page results.
-
BLOGS
public static final Category BLOGS
A category for blog results.
-
CONTENT
public static final Category CONTENT
A category for page and blog results combined.
-
ATTACHMENTS
public static final Category ATTACHMENTS
A category for attachment results.
-
PEOPLE
public static final Category PEOPLE
A category for people results.
-
SPACES
public static final Category SPACES
A category for space results.
-
COMMENTS
public static final Category COMMENTS
A category for comments.
-
PERSONAL_SPACE
public static final Category PERSONAL_SPACE
A category for personal spaces.
-
CUSTOM
public static final Category CUSTOM
A category for custom content.
-
-
Constructor Detail
-
Category
public Category(String name)
-
-
Method Detail
-
getCategory
public static Category getCategory(String type)
Return a Category for the supplied type. If the type supplied matches one of the standard category types then that existing Category will be returned. Otherwise a new category will be created and returned.- Parameters:
type
- must not be null- Returns:
- the matching category or a newly created one if there is no standard category for the type
-
getCategories
public static Set<Category> getCategories(String contentType)
Returns a Set of Categories the content of specific type belongs to. Most of the content types belong to a one corresponding category, for example: "attachment" belongs to Category Attachment. But the content type "page" belongs to Categories Page and Content and similarly the content type "blogpost" belongs to Categories BlogPost and Content.
-
getName
public String getName()
-
-