com.atlassian.confluence.search.service
Enum ContentTypeEnum

java.lang.Object
  extended by java.lang.Enum<ContentTypeEnum>
      extended by com.atlassian.confluence.search.service.ContentTypeEnum
All Implemented Interfaces:
Serializable, Comparable<ContentTypeEnum>

public enum ContentTypeEnum
extends Enum<ContentTypeEnum>

An enum representing the different content types that may be specified in a search.


Enum Constant Summary
ATTACHMENT
           
BLOG
           
COMMENT
           
DRAFT
           
MAIL
           
PAGE
           
PERSONAL_INFORMATION
           
PERSONAL_SPACE_DESCRIPTION
           
SPACE
           
SPACE_DESCRIPTION
           
USER_STATUS
           
 
Method Summary
static ContentTypeEnum get(String representation)
          Deprecated. since 3.0. Use getByRepresentation(java.lang.String) or getByClassName(java.lang.String) instead.
static ContentTypeEnum getByClassName(String className)
           
static ContentTypeEnum getByRepresentation(String representation)
           
 String getRepresentation()
           
 Class<? extends com.atlassian.core.bean.EntityObject> getType()
           
 String getTypeClass()
          Deprecated. since 3.1 use getTypeName()
 String getTypeName()
           
 String toString()
           
static ContentTypeEnum valueOf(String name)
          Returns the enum constant of this type with the specified name.
static ContentTypeEnum[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

PAGE

public static final ContentTypeEnum PAGE

COMMENT

public static final ContentTypeEnum COMMENT

BLOG

public static final ContentTypeEnum BLOG

ATTACHMENT

public static final ContentTypeEnum ATTACHMENT

PERSONAL_INFORMATION

public static final ContentTypeEnum PERSONAL_INFORMATION

SPACE_DESCRIPTION

public static final ContentTypeEnum SPACE_DESCRIPTION

PERSONAL_SPACE_DESCRIPTION

public static final ContentTypeEnum PERSONAL_SPACE_DESCRIPTION

MAIL

public static final ContentTypeEnum MAIL

USER_STATUS

public static final ContentTypeEnum USER_STATUS

SPACE

public static final ContentTypeEnum SPACE

DRAFT

public static final ContentTypeEnum DRAFT
Method Detail

values

public static ContentTypeEnum[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (ContentTypeEnum c : ContentTypeEnum.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static ContentTypeEnum valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

getRepresentation

public String getRepresentation()

getTypeClass

public String getTypeClass()
Deprecated. since 3.1 use getTypeName()


getType

public Class<? extends com.atlassian.core.bean.EntityObject> getType()

getTypeName

public String getTypeName()

toString

public String toString()
Overrides:
toString in class Enum<ContentTypeEnum>

get

@Deprecated
public static ContentTypeEnum get(String representation)
Deprecated. since 3.0. Use getByRepresentation(java.lang.String) or getByClassName(java.lang.String) instead.


getByRepresentation

public static ContentTypeEnum getByRepresentation(String representation)
Parameters:
representation - the String representation of the enum. e.g. Page.CONTENT_TYPE
Returns:
the ContentTypeEnum for the supplied String. null is returned if the parameter does not map to a ContentTypeEnum.

getByClassName

public static ContentTypeEnum getByClassName(String className)
Parameters:
className - fully qualified class name e.g. "com.atlassian.confluence.pages.Page"
Returns:
the ContentTypeEnum for the supplied class name. null if none found.


Copyright © 2003-2011 Atlassian. All Rights Reserved.