Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.renderer
Class RenderType

java.lang.Object
  extended by com.jivesoftware.forum.renderer.RenderType

public class RenderType
extends java.lang.Object

Defines render types used for jive objects.


Field Summary
static RenderType BODY
          Type representing a message body.
static RenderType PROPERTY
          Type representing a message property.
static RenderType SUBJECT
          Type representing a message subject.
static RenderType TAG
          Type representing a message tags.
 
Method Summary
 long getKey()
          Gets the key of a RenderType object
static RenderType getRenderType(int key)
          A helper method to get a specific RenderType object from its key
 java.lang.String getValue()
          Gets the value of a RenderType object
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field 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 message tags.

Method Detail

getKey

public long getKey()
Gets the key of a RenderType object

Returns:
the key value representing the RenderType object

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.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.