ch.trick17.betterchecks

Enum MessageType

java.lang.Object

java.lang.Enum<MessageType>

ch.trick17.betterchecks.MessageType

All Implemented Interfaces:

Serializable, Comparable<MessageType>

@GwtCompatible
public enum MessageType
extends Enum<MessageType>

The MessageType enum defines the types of exception messages that are used in the exceptions thrown by the various checks of the Better Checks library.

So far, the only thing associated with a message type is the message format. Use getDefaultFormat() to get the default format. It can be overridden in the config file. See the documentation of Config or Check for more information about configuration of the Better Checks library and Config.getMessageFormat(MessageType, boolean) to learn more about message formats.

Author:

Michael Faes

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARG_BETWEEN
ARG_CLASS
ARG_CONTAINS
ARG_CONTAINS_ALL
ARG_CONTAINS_ANY
ARG_CONTAINS_NULL
ARG_EMPTY
ARG_ENDS
ARG_EQUAL_TO
ARG_GREATER
ARG_INDEX
ARG_INFINITE
ARG_INSTANCE_OF
ARG_INT
ARG_IS
ARG_LENGTH
ARG_LENGTH_BETWEEN
ARG_LESS
ARG_MATCHES
ARG_NAN
ARG_NEGATIVE
ARG_NULL
ARG_POSITIVE
ARG_PROTOCOL
ARG_SAME_AS
ARG_SIZE
ARG_SIZE_BETWEEN
ARG_STARTS
ARG_URL
ARG_WHITESPACE

Method Summary

Modifier and Type	Method and Description
String	getDefaultFormat() Returns the default message format for this message type.
static MessageType	valueOf(String name) Returns the enum constant of this type with the specified name.
static MessageType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ARG_NULL

public static final MessageType ARG_NULL

ARG_SAME_AS

public static final MessageType ARG_SAME_AS

ARG_EQUAL_TO

public static final MessageType ARG_EQUAL_TO

ARG_INSTANCE_OF

public static final MessageType ARG_INSTANCE_OF

ARG_CLASS

public static final MessageType ARG_CLASS

ARG_EMPTY

public static final MessageType ARG_EMPTY

ARG_WHITESPACE

public static final MessageType ARG_WHITESPACE

ARG_LENGTH

public static final MessageType ARG_LENGTH

ARG_SIZE

public static final MessageType ARG_SIZE

ARG_LENGTH_BETWEEN

public static final MessageType ARG_LENGTH_BETWEEN

ARG_SIZE_BETWEEN

public static final MessageType ARG_SIZE_BETWEEN

ARG_STARTS

public static final MessageType ARG_STARTS

ARG_ENDS

public static final MessageType ARG_ENDS

ARG_CONTAINS

public static final MessageType ARG_CONTAINS

ARG_CONTAINS_ANY

public static final MessageType ARG_CONTAINS_ANY

ARG_CONTAINS_ALL

public static final MessageType ARG_CONTAINS_ALL

ARG_CONTAINS_NULL

public static final MessageType ARG_CONTAINS_NULL

ARG_MATCHES

public static final MessageType ARG_MATCHES

ARG_URL

public static final MessageType ARG_URL

ARG_INT

public static final MessageType ARG_INT

ARG_POSITIVE

public static final MessageType ARG_POSITIVE

ARG_NEGATIVE

public static final MessageType ARG_NEGATIVE

ARG_IS

public static final MessageType ARG_IS

ARG_GREATER

public static final MessageType ARG_GREATER

ARG_LESS

public static final MessageType ARG_LESS

ARG_BETWEEN

public static final MessageType ARG_BETWEEN

ARG_INDEX

public static final MessageType ARG_INDEX

ARG_NAN

public static final MessageType ARG_NAN

ARG_INFINITE

public static final MessageType ARG_INFINITE

ARG_PROTOCOL

public static final MessageType ARG_PROTOCOL

Method Detail

values

public static MessageType[] values()

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

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

Returns:

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

valueOf

public static MessageType 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

NullPointerException - if the argument is null

getDefaultFormat

public String getDefaultFormat()

Returns the default message format for this message type. It is a custom "meta" format that encompasses both the positive and the negative (inverted) version of the format. See Config.getMessageFormat(MessageType, boolean) for more information.

Returns:

The default "meta" message format for this type of exception message