com.atlassian.confluence.search.contentnames

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 and 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	MAIL A category for mail.
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.

Constructor Summary

Constructors

Constructor and Description
Category(String name)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
static Category	getCategory(String type) Return a Category for the supplied type.
String	getName()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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.

MAIL

public static final Category MAIL

A category for mail.

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

getName

public String getName()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object