Package io.github.alextmjugador.khron.tiemporeal

Class TextoHora

java.lang.Object

io.github.alextmjugador.khron.libconfig.ParametroConfiguracion<String,String>

io.github.alextmjugador.khron.tiemporeal.TextoHora

final class TextoHora
extends ParametroConfiguracion<String,String>

Modela un parámetro de configuración que contiene el texto a mostrar cuando un jugador empuñe un reloj, para que vea la hora.

Author:

AlexTMjugador

Field Summary

Fields

Modifier and Type	Field	Description
private int	CARACTERES_MAX	El número máximo de caracteres que este valor puede tomar.
private static String	ID_CONFIG	El identificador de este parámetro de configuración en el código y en el comando asociado para cambiarlo.
static String	PALABRA_CLAVE_TEXTO_HORA	La palabra clave que debe de contener el texto de la hora en el reloj para ser válido.
private static String	PERMISO_CONFIG	El permiso necesario para ejecutar un comando que cambie el valor de este parámetro de configuración.
static String	REGEX_CLAVE_TEXTO_HORA	La cadena de texto PALABRA_CLAVE_TEXTO_HORA, pero construida de manera que puede ser interpretada con seguridad como una expresión regular.
private static String	RUTA_CONFIG	La ruta en el fichero de configuración hacia este parámetro de configuración.
private String	valorSinProcesar	La cadena de texto, sin los cambios aplicados por procesarValor(java.lang.String).

Constructor Summary

Constructors

Constructor	Description
TextoHora()

Method Summary

Modifier and Type	Method	Description
String	getValorYaml()	Obtiene el valor tal y como se debe de guardar en un fichero de configuración YAML.
protected String	procesarValor(String nuevoValor)	Procesa el valor que se le pasa como parámetro, dejándolo listo para ser el valor guardado en las estructuras de datos internas del plugin.
boolean	valorValido(String otroValor)	Obtiene si el valor especificado de este parámetro de configuración sería válido.

Methods inherited from class io.github.alextmjugador.khron.libconfig.ParametroConfiguracion

getId, getPermiso, getPlugin, getRutaConfiguracion, getValor, leer, puedeCambiarlo, recargarConfiguracion, setValor, setValor, setValor, valorValido

Methods inherited from class java.lang.Object

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

Field Detail

PALABRA_CLAVE_TEXTO_HORA

public static final String PALABRA_CLAVE_TEXTO_HORA

La palabra clave que debe de contener el texto de la hora en el reloj para ser válido. Se sustituirá por la hora del mundo en el que el jugador esté.

See Also:

Constant Field Values

REGEX_CLAVE_TEXTO_HORA

public static final String REGEX_CLAVE_TEXTO_HORA

La cadena de texto PALABRA_CLAVE_TEXTO_HORA, pero construida de manera que puede ser interpretada con seguridad como una expresión regular.

See Also:

Constant Field Values

RUTA_CONFIG

private static final String RUTA_CONFIG

La ruta en el fichero de configuración hacia este parámetro de configuración.

See Also:

Constant Field Values

ID_CONFIG

private static final String ID_CONFIG

El identificador de este parámetro de configuración en el código y en el comando asociado para cambiarlo.

See Also:

Constant Field Values

PERMISO_CONFIG

private static final String PERMISO_CONFIG

El permiso necesario para ejecutar un comando que cambie el valor de este parámetro de configuración.

See Also:

Constant Field Values

valorSinProcesar

private String valorSinProcesar

La cadena de texto, sin los cambios aplicados por procesarValor(java.lang.String).

CARACTERES_MAX

private final int CARACTERES_MAX

El número máximo de caracteres que este valor puede tomar.

See Also:

Constant Field Values

Constructor Detail

TextoHora

public TextoHora()
          throws IllegalArgumentException

Throws:

IllegalArgumentException

Method Detail

procesarValor

protected String procesarValor(String nuevoValor)

Description copied from class: ParametroConfiguracion

Procesa el valor que se le pasa como parámetro, dejándolo listo para ser el valor guardado en las estructuras de datos internas del plugin. Este método solo debe de ser llamado internamente desde su clase, no desde otras (las sobreescrituras de las subclases pueden asumir tal condición). Entonces, cuando es invocado, se ha garantizado que nuevoValor es válido y diferente al actual, y el valor devuelto será asignado como nuevo valor del parámetro de configuración.

Overrides:

procesarValor in class ParametroConfiguracion<String,String>

Parameters:

nuevoValor - El valor a procesar.

Returns:

El susodicho valor, procesado.

getValorYaml

public String getValorYaml()

Description copied from class: ParametroConfiguracion

Obtiene el valor tal y como se debe de guardar en un fichero de configuración YAML.

Overrides:

getValorYaml in class ParametroConfiguracion<String,String>

Returns:

El susodicho valor. La implementación predeterminada de este método asume que la clase del objeto a guardar en el fichero de configuración YAML es la misma o una superclase de la clase del valor en memoria.

valorValido

public boolean valorValido(String otroValor)

Obtiene si el valor especificado de este parámetro de configuración sería válido. Debe de contener una sola vez la cadena de texto determinada por el atributo estático PALABRA_CLAVE_TEXTO_HORA, que el plugin reemplazará por la hora actual. Tampoco debe de ser mayor de CARACTERES_MAX caracteres.

Overrides:

valorValido in class ParametroConfiguracion<String,String>

Parameters:

otroValor - El valor a comprobar.

Returns:

Verdadero si el susodicho parámetro sería válido, falso en caso contrario.