com.jivesoftware.community.renderer
Enum RenderType

java.lang.Object
  java.lang.Enum<RenderType>
      com.jivesoftware.community.renderer.RenderType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<RenderType>

public enum RenderType
extends java.lang.Enum<RenderType>

Defines render types used for jive objects.

Enum Constant Summary

BODY
Type representing a message body.

COMMENT_BODY
Type representing a comment body.

COMMUNITY_DESCRIPTION
Type representing a community description.

DOCUMENT_BODY
Type representing a document body.

DOCUMENT_FIELD_TEXT
Type representing a document field text.

DOCUMENT_SUMMARY
Type representing a document summary.

DOCUMENT_TITLE
Type representing a document title.

DOCUMENT_VERSION_COMMENT
Type representing a document version comment.

PROPERTY
Type representing a message property.

SUBJECT
Type representing a message subject.

TAG
Type representing a content tag.

Method Summary

long	getKey() Gets the key of a RenderType object
java.lang.String	getName() Returns a string based key representing this render type.
static RenderType	getRenderType(int key) A helper method to get a specific RenderType object from its key
static RenderType	getRenderType(java.lang.String name)
java.lang.String	getValue() Gets the value of a RenderType object
static RenderType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static RenderType[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

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

Enum Constant Detail

PROPERTY

public static final RenderType PROPERTY

Type representing a message property.

SUBJECT

public static final RenderType SUBJECT

Type representing a message subject.

BODY

public static final RenderType BODY

Type representing a message body.

TAG

public static final RenderType TAG

Type representing a content tag.

COMMUNITY_DESCRIPTION

public static final RenderType COMMUNITY_DESCRIPTION

Type representing a community description.

DOCUMENT_TITLE

public static final RenderType DOCUMENT_TITLE

Type representing a document title.

DOCUMENT_BODY

public static final RenderType DOCUMENT_BODY

Type representing a document body.

DOCUMENT_FIELD_TEXT

public static final RenderType DOCUMENT_FIELD_TEXT

Type representing a document field text.

DOCUMENT_VERSION_COMMENT

public static final RenderType DOCUMENT_VERSION_COMMENT

Type representing a document version comment.

COMMENT_BODY

public static final RenderType COMMENT_BODY

Type representing a comment body.

DOCUMENT_SUMMARY

public static final RenderType DOCUMENT_SUMMARY

Type representing a document summary.

Method Detail

values

public static final RenderType[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(RenderType c : RenderType.values())
        System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they're declared

valueOf

public static RenderType valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

getKey

public long getKey()

Gets the key of a RenderType object

Returns:

the key value representing the RenderType object

getName

public java.lang.String getName()

Returns a string based key representing this render type.

Returns:

Astring based key representing this render type.

getValue

public java.lang.String getValue()

Gets the value of a RenderType object

Returns:

the String value representing the RenderType object

getRenderType

public static RenderType getRenderType(int key)

A helper method to get a specific RenderType object from its key

Parameters:

key - the key value of the RenderType object

Returns:

the RenderType object corresponding to the key value. NULL if the key is invalid.

getRenderType

public static RenderType getRenderType(java.lang.String name)