Package 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 Details

    • 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 Details

    • Category

      public Category(String name)

  • Method Details

    • 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()

    • 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