pl.joegreen.sergeants.framework.user

Class UserConfiguration

java.lang.Object

pl.joegreen.sergeants.framework.user.UserConfiguration

public abstract class UserConfiguration
extends Object

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UserConfiguration(String userId)

Method Summary

Modifier and Type	Method and Description
abstract void	configureUsername(GeneralsApi api)
String	getUserId()
static UserConfiguration	idAndName(String id, String name) Use when you want to set the name for the given ID.
static UserConfiguration	onlyUserId(String id) Use when name for that ID is already set or you want to remain anonymous.
static UserConfiguration	random() Equal to idAndName(String, String) but creates a random ID and name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserConfiguration

protected UserConfiguration(String userId)

Method Detail

getUserId

public String getUserId()

configureUsername

public abstract void configureUsername(GeneralsApi api)

onlyUserId

public static UserConfiguration onlyUserId(String id)

Use when name for that ID is already set or you want to remain anonymous. This configuration will not try to set user name.

idAndName

public static UserConfiguration idAndName(String id,
                                          String name)

Use when you want to set the name for the given ID. [Bot] prefix will be added automatically. This configuration will try to set user name. Errors will be ignored, therefore you can keep using this configuration even if the name is already set (it will do nothing).

random

public static UserConfiguration random()

Equal to idAndName(String, String) but creates a random ID and name. If you want to know the id, call getUserId() on the return value.