xyz.nickr.jitter.api

Enum RoomType

java.lang.Object

java.lang.Enum<RoomType>

xyz.nickr.jitter.api.RoomType

All Implemented Interfaces:

Serializable, Comparable<RoomType>

public enum RoomType
extends Enum<RoomType>

Represents the different types of rooms.

Author:

Nick Robson

Enum Constant Summary

Enum Constants

Enum Constant and Description
ORGANISATION A GitHub organisation.
ORGANISATION_CHANNEL A Gitter channel for an organisation.
REPOSITORY A GitHub repository.
REPOSITORY_CHANNEL A Gitter channel for a repository.
UNKNOWN An unknown room type: used as a fallback
USER A GitHub user.
USER_CHANNEL A Gitter channel for a user.

Method Summary

Modifier and Type	Method and Description
static RoomType	valueOf(String name) Returns the enum constant of this type with the specified name.
static RoomType[]	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

USER

public static final RoomType USER

A GitHub user.

REPOSITORY

public static final RoomType REPOSITORY

A GitHub repository.

ORGANISATION

public static final RoomType ORGANISATION

A GitHub organisation.

USER_CHANNEL

public static final RoomType USER_CHANNEL

A Gitter channel for a user.

REPOSITORY_CHANNEL

public static final RoomType REPOSITORY_CHANNEL

A Gitter channel for a repository.

ORGANISATION_CHANNEL

public static final RoomType ORGANISATION_CHANNEL

A Gitter channel for an organisation.

UNKNOWN

public static final RoomType UNKNOWN

An unknown room type: used as a fallback

Method Detail

values

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

Returns:

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

valueOf

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