com.jivesoftware.community
Enum ProfileField.Type

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ProfileField.Type>

Enclosing class:

ProfileField

public static enum ProfileField.Type
extends java.lang.Enum<ProfileField.Type>

A typesafe enum class for ProfileField types.

Enum Constant Summary

BOOLEAN
Type representing a boolean type.

DATETIME
Type representing a date/time type.

DECIMAL
Type representing a decimal type.

EMAIL
Type representing a email type.

LARGETEXT
Type representing a textarea type.

MULTILIST
Type representing a multiselect type.

NUMBER
Type representing a number type.

PHONE_NUMBER
Type representing a phone number type.

SINGLELIST
Type representing a select type.

TEXT
Type representing a textfield type.

URL
Type representing a url type.

ZIP_CODE
Type representing a zip code type.

Method Summary

java.lang.String	getDescription() Gets the description of this type.
java.lang.String	getDisplayName() Gets the displayName of this type.
ProfileFieldFormatter	getFormatter() Gets the profile field formatter for this type
int	getID() Gets the id representing this type.
DocumentFieldValidator	getValidator() Gets the profile field validator for this type
static ProfileField.Type	valueOf(int ID) Gets an Type object from an typeID
static ProfileField.Type	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ProfileField.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

BOOLEAN

public static final ProfileField.Type BOOLEAN

Type representing a boolean type.

DATETIME

public static final ProfileField.Type DATETIME

Type representing a date/time type.

DECIMAL

public static final ProfileField.Type DECIMAL

Type representing a decimal type.

EMAIL

public static final ProfileField.Type EMAIL

Type representing a email type.

NUMBER

public static final ProfileField.Type NUMBER

Type representing a number type.

LARGETEXT

public static final ProfileField.Type LARGETEXT

Type representing a textarea type.

MULTILIST

public static final ProfileField.Type MULTILIST

Type representing a multiselect type.

SINGLELIST

public static final ProfileField.Type SINGLELIST

Type representing a select type.

TEXT

public static final ProfileField.Type TEXT

Type representing a textfield type.

URL

public static final ProfileField.Type URL

Type representing a url type.

PHONE_NUMBER

public static final ProfileField.Type PHONE_NUMBER

Type representing a phone number type.

ZIP_CODE

public static final ProfileField.Type ZIP_CODE

Type representing a zip code type.

Method Detail

values

public static final ProfileField.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(ProfileField.Type c : ProfileField.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 ProfileField.Type 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

getID

public int getID()

Gets the id representing this type.

Returns:

tthe id representing this type

getDisplayName

public java.lang.String getDisplayName()

Gets the displayName of this type.

Returns:

the description of this type

getDescription

public java.lang.String getDescription()

Gets the description of this type.

Returns:

the description of this type

getValidator

public DocumentFieldValidator getValidator()

Gets the profile field validator for this type

Returns:

the profile field validator for this type

getFormatter

public ProfileFieldFormatter getFormatter()

Gets the profile field formatter for this type

Returns:

the profile field formatter for this type

valueOf

public static ProfileField.Type valueOf(int ID)

Gets an Type object from an typeID

Parameters:

ID - the ID of the type

Returns:

the Type object of the specified ID