Package pw.chew.clickup4j.api.entities.customfields

Enum Class CustomFieldType

java.lang.Object

java.lang.Enum<CustomFieldType>

pw.chew.clickup4j.api.entities.customfields.CustomFieldType

All Implemented Interfaces:

Serializable, Comparable<CustomFieldType>, Constable

public enum CustomFieldType
extends Enum<CustomFieldType>

Represents a custom field.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTOMATIC_PROGRESS	Represents an automatic progress field.
CHECKBOX	Represents a checkbox field.
CURRENCY	Represents a currency field.
DATE	Represents a date field.
DROP_DOWN	Represents a drop-down field.
EMAIL	Represents an email field.
EMOJI	Represents an emoji, specifically a rating of emoji, the type config gives the emoji and amount (1-5).
LABELS	Represents a label field.
LOCATION	Represents a location field.
MANUAL_PROGRESS	Represents a manual progress field.
NUMBER	Represents a number field.
PHONE	Represents a phone field.
SHORT_TEXT	Represents a short text field.
TASKS	Represents a task field, may return a task.
TEXT	Represents a text field.
UNKNOWN	Represents a new field unknown to this library.
URL	Represents a URL field.
USERS	Represents a user field, may return a user.

Method Summary

Modifier and Type	Method	Description
Class<? extends ICustomField>	getAssociatedClass()	Returns the associated class with this custom field.
boolean	hasTypeConfig()	Returns if this field has custom type config.
static CustomFieldType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CustomFieldType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

URL

public static final CustomFieldType URL

Represents a URL field. However, the URL is not validated.

DROP_DOWN

public static final CustomFieldType DROP_DOWN

Represents a drop-down field. Type Config consists of a list of options, with a default and placeholder.

EMAIL

public static final CustomFieldType EMAIL

Represents an email field.

PHONE

public static final CustomFieldType PHONE

Represents a phone field.

DATE

public static final CustomFieldType DATE

Represents a date field. This field is actually validated and returns an OffsetDateTime if cast to a DateCustomField.

See Also:

• DateCustomField

TEXT

public static final CustomFieldType TEXT

Represents a text field.

CHECKBOX

public static final CustomFieldType CHECKBOX

Represents a checkbox field.

NUMBER

public static final CustomFieldType NUMBER

Represents a number field.

CURRENCY

public static final CustomFieldType CURRENCY

Represents a currency field. Type Config refers to the precision, type, and default of the currency.

TASKS

public static final CustomFieldType TASKS

Represents a task field, may return a task.

USERS

public static final CustomFieldType USERS

Represents a user field, may return a user.

EMOJI

public static final CustomFieldType EMOJI

Represents an emoji, specifically a rating of emoji, the type config gives the emoji and amount (1-5).

LABELS

public static final CustomFieldType LABELS

Represents a label field. Type Config is the labels.

AUTOMATIC_PROGRESS

public static final CustomFieldType AUTOMATIC_PROGRESS

Represents an automatic progress field. Type Config is the progress qualifiers.

MANUAL_PROGRESS

public static final CustomFieldType MANUAL_PROGRESS

Represents a manual progress field. Type Config is the range.

SHORT_TEXT

public static final CustomFieldType SHORT_TEXT

Represents a short text field.

LOCATION

public static final CustomFieldType LOCATION

Represents a location field.

UNKNOWN

public static final CustomFieldType UNKNOWN

Represents a new field unknown to this library.

Method Details

values

public static CustomFieldType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static CustomFieldType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

hasTypeConfig

public boolean hasTypeConfig()

Returns if this field has custom type config. It's recommended to case the ICustomField to the correct type.

Returns:

true if this field has custom type config, false otherwise.

getAssociatedClass

public Class<? extends ICustomField> getAssociatedClass()

Returns the associated class with this custom field.

Returns:

A class extending ICustomField