com.github.agadar.nationstates.enumerator

Enum RegionalMessageStatus

java.lang.Object

java.lang.Enum<RegionalMessageStatus>

com.github.agadar.nationstates.enumerator.RegionalMessageStatus

All Implemented Interfaces:

Serializable, Comparable<RegionalMessageStatus>

public enum RegionalMessageStatus
extends Enum<RegionalMessageStatus>

Enumerator for the different statuses a regional message can have.

Author:

Agadar (https://github.com/Agadar/)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RegionalMessageStatus.Adapter Converts an integer to a RegionalMessageStatus enum value and vice versa.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DELETED_BY_AUTHOR
SUPPRESSED_BUT_VIEWABLE
SUPPRESSED_BY_MODERATOR
VISIBLE

Method Summary

Modifier and Type	Method and Description
static RegionalMessageStatus	fromInt(int intValue) Returns the RegionalMessageStatus represented by the supplied integer.
int	toInt() Returns the integer representation of this RegionalMessageStatus.
static RegionalMessageStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static RegionalMessageStatus[]	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

VISIBLE

public static final RegionalMessageStatus VISIBLE

SUPPRESSED_BUT_VIEWABLE

public static final RegionalMessageStatus SUPPRESSED_BUT_VIEWABLE

DELETED_BY_AUTHOR

public static final RegionalMessageStatus DELETED_BY_AUTHOR

SUPPRESSED_BY_MODERATOR

public static final RegionalMessageStatus SUPPRESSED_BY_MODERATOR

Method Detail

values

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

Returns:

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

valueOf

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

toInt

public int toInt()

Returns the integer representation of this RegionalMessageStatus.

Returns:

the integer representation of this RegionalMessageStatus.

fromInt

public static RegionalMessageStatus fromInt(int intValue)

Returns the RegionalMessageStatus represented by the supplied integer.

Parameters:

intValue - the supplied integer.

Returns:

the RegionalMessageStatus represented by the supplied integer.