Endpoint

java.lang.Object
- java.lang.Enum<Endpoint>
- - starvationevasion.server.model.Endpoint

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Endpoint>
```
public enum Endpoint
extends java.lang.Enum<Endpoint>
```
Author:

Javier Chavez (javierc@cs.unm.edu) All the endpoints to the api

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AVAILABLE_REGIONS` Get a list of all the available regions Handled by `DataHandler` Required Payload: none
`CHAT` Send a chat, card or both Handled by `ChatHandler` Required Payload: to, card, text
`DELETE_CARD` Delete a card Handled by `VoteHandler` Required Payload: card
`DRAFT_CARD` Draft a card Handled by `VoteHandler` Required Payload: card
`DRAW_CARD` Draw a card Handled by `VoteHandler` Required Payload: none
`GAME_STATE` Get the game state Handled by `DataHandler` Required Payload: none
`HAND_CREATE` Create current user hand Handled by `CardHandler` Required Payload: none
`HAND_READ` Get current user hand Handled by `CardHandler` Required Payload: none
`KILL` Turn off the server Handled by `AdminTaskHandler` Required Payload: none
`LOGIN` Login to the server Handled by `LoginHandler` Required Payload: username, password
`READY` Tell the server that current user is ready to play game Required Payload: none
`SERVER_UPTIME` Get the uptime of the server Handled by `DataHandler` Required Payload: none
`USER_CREATE` Create a User Handled by `UserHandler` Required Payload: username, password, region
`USER_READ` Get more information about a user Handled by `UserHandler` Required Payload: username or region
`USER_UPDATE` Update current user "profile" Handled by `UserHandler` Required Payload: username, password, region
`USERS` Get a list of ALL the users Handled by `UserHandler` Required Payload: none
`USERS_LOGGED_IN` Get a list of all the logged in users Handled by `UserHandler` Required Payload: none
`USERS_READY` Get a list of all the users ready to play the game Handled by `UserHandler` Required Payload: none
`VOTE_DOWN` Vote down on a card Handled by `VoteHandler` Required Payload: card
`VOTE_UP` Vote up on a card Handled by `VoteHandler` Required Payload: card

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getUrl()`
`static Endpoint`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static Endpoint[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - USER_CREATE
```
public static final Endpoint USER_CREATE
```
    Create a User Handled by UserHandler Required Payload: username, password, region
  - USER_READ
```
public static final Endpoint USER_READ
```
    Get more information about a user Handled by UserHandler Required Payload: username or region
  - USER_UPDATE
```
public static final Endpoint USER_UPDATE
```
    Update current user "profile" Handled by UserHandler Required Payload: username, password, region
  - USERS
```
public static final Endpoint USERS
```
    Get a list of ALL the users Handled by UserHandler Required Payload: none
  - USERS_LOGGED_IN
```
public static final Endpoint USERS_LOGGED_IN
```
    Get a list of all the logged in users Handled by UserHandler Required Payload: none
  - USERS_READY
```
public static final Endpoint USERS_READY
```
    Get a list of all the users ready to play the game Handled by UserHandler Required Payload: none
  - LOGIN
```
public static final Endpoint LOGIN
```
    Login to the server Handled by LoginHandler Required Payload: username, password
  - HAND_READ
```
public static final Endpoint HAND_READ
```
    Get current user hand Handled by CardHandler Required Payload: none
  - HAND_CREATE
```
public static final Endpoint HAND_CREATE
```
    Create current user hand Handled by CardHandler Required Payload: none
  - VOTE_UP
```
public static final Endpoint VOTE_UP
```
    Vote up on a card Handled by VoteHandler Required Payload: card
  - VOTE_DOWN
```
public static final Endpoint VOTE_DOWN
```
    Vote down on a card Handled by VoteHandler Required Payload: card
  - DRAFT_CARD
```
public static final Endpoint DRAFT_CARD
```
    Draft a card Handled by VoteHandler Required Payload: card
  - DRAW_CARD
```
public static final Endpoint DRAW_CARD
```
    Draw a card Handled by VoteHandler Required Payload: none
  - DELETE_CARD
```
public static final Endpoint DELETE_CARD
```
    Delete a card Handled by VoteHandler Required Payload: card
  - CHAT
```
public static final Endpoint CHAT
```
    Send a chat, card or both Handled by ChatHandler Required Payload: to, card, text
  - GAME_STATE
```
public static final Endpoint GAME_STATE
```
    Get the game state Handled by DataHandler Required Payload: none
  - SERVER_UPTIME
```
public static final Endpoint SERVER_UPTIME
```
    Get the uptime of the server Handled by DataHandler Required Payload: none
  - AVAILABLE_REGIONS
```
public static final Endpoint AVAILABLE_REGIONS
```
    Get a list of all the available regions Handled by DataHandler Required Payload: none
  - READY
```
public static final Endpoint READY
```
    Tell the server that current user is ready to play game Required Payload: none
  - KILL
```
public static final Endpoint KILL
```
    Turn off the server Handled by AdminTaskHandler Required Payload: none
- Method Detail
  - values
```
public static Endpoint[] 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 (Endpoint c : Endpoint.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Endpoint 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
    
    java.lang.NullPointerException - if the argument is null
  - getUrl
```
public java.lang.String getUrl()
```

Enum Endpoint

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

USER_CREATE

USER_READ

USER_UPDATE

USERS

USERS_LOGGED_IN

USERS_READY

LOGIN

HAND_READ

HAND_CREATE

VOTE_UP

VOTE_DOWN

DRAFT_CARD

DRAW_CARD

DELETE_CARD

CHAT

GAME_STATE

SERVER_UPTIME

AVAILABLE_REGIONS

READY

KILL

Method Detail

values

valueOf

getUrl