com.jivesoftware.community
Enum JiveInterceptor.Type

java.lang.Object
  java.lang.Enum<JiveInterceptor.Type>
      com.jivesoftware.community.JiveInterceptor.Type

All Implemented Interfaces:

Serializable, Comparable<JiveInterceptor.Type>

Enclosing interface:

JiveInterceptor

public static enum JiveInterceptor.Type
extends Enum<JiveInterceptor.Type>

Represents the different ways a JiveInterceptor may be run

Enum Constant Summary

TYPE_EDIT
Interceptor that is run when jive objects are edited - for example by calling ForumMessage.setSubject(String) or com.jivesoftware.community.ForumMessage#setBody(String).

TYPE_POST
Interceptor that is run after the jive object has been accepted into the system.

TYPE_PRE
Interceptor that is run before the jive object has been accepted into the system.

Method Summary

int	getKey()
static JiveInterceptor.Type	getType(int key) A helper method to get a specific Type object from its key
static JiveInterceptor.Type	valueOf(String name) Returns the enum constant of this type with the specified name.
static JiveInterceptor.Type[]	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

TYPE_PRE

public static final JiveInterceptor.Type TYPE_PRE

Interceptor that is run before the jive object has been accepted into the system.

TYPE_POST

public static final JiveInterceptor.Type TYPE_POST

Interceptor that is run after the jive object has been accepted into the system.

TYPE_EDIT

public static final JiveInterceptor.Type TYPE_EDIT

Interceptor that is run when jive objects are edited - for example by calling ForumMessage.setSubject(String) or com.jivesoftware.community.ForumMessage#setBody(String).

Method Detail

values

public static final JiveInterceptor.Type[] 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(JiveInterceptor.Type c : JiveInterceptor.Type.values())
        System.out.println(c);

Returns:

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

valueOf

public static JiveInterceptor.Type 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

getKey

public int getKey()

getType

public static JiveInterceptor.Type getType(int key)

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

Parameters:

key - the key value of the Type object

Returns:

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