org.jrebirth.af.core.resource

Class AbstractBaseParams

java.lang.Object

org.jrebirth.af.core.resource.AbstractBaseParams

All Implemented Interfaces:

ResourceParams

Direct Known Subclasses:

AbstractBaseColor, AbstractBaseFont, AbstractBaseImage, FXML, Message, ObjectParameter, StyleSheet

public abstract class AbstractBaseParams
extends Object
implements ResourceParams

The class AbstractBaseParams.

Author:

Sébastien Bordes

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	changed The flag that indicates if the resource params has changed.
private String	key The dynamic key used to store the resource into a map.
private static org.slf4j.Logger	LOGGER The class logger.

Fields inherited from interface org.jrebirth.af.core.resource.ResourceParams

PARAMETER_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
AbstractBaseParams() Default Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	activateAutoRefresh() Activate AutoRefresh that will mark the ResourceParams as 'Updated' to force the rebuild of the resource on next call.
protected abstract List<? extends Object>	getFieldValues() Return all values of ParameterEntry object.
String	getKey() Return the dynamic key used to hold resources without static field.
boolean	hasChanged() Checks for resource changes.
void	hasChanged(boolean changed) Define if the resource has changed or not.
protected boolean	readBoolean(String parameter) Read a boolean string value.
protected double	readDouble(String doubleString, double min, double max) Read a double string value.
protected int	readInteger(String intString, int min, int max) Read ab integer string value.
void	setKey(String key) Define the dynamic key used to hold resources without static field.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jrebirth.af.core.resource.ResourceParams

parse

Field Detail

LOGGER

private static final org.slf4j.Logger LOGGER

The class logger.

changed

private boolean changed

The flag that indicates if the resource params has changed.

key

private String key

The dynamic key used to store the resource into a map.

Constructor Detail

AbstractBaseParams

public AbstractBaseParams()

Default Constructor. Set the hasChnaged boolean to true to force the first creation of the resource.

Method Detail

activateAutoRefresh

public void activateAutoRefresh()

Activate AutoRefresh that will mark the ResourceParams as 'Updated' to force the rebuild of the resource on next call.

Specified by:

activateAutoRefresh in interface ResourceParams

hasChanged

public boolean hasChanged()

Checks for resource changes.

Specified by:

hasChanged in interface ResourceParams

Returns:

true, if resource has changed and need to be reloaded

hasChanged

public void hasChanged(boolean changed)

Define if the resource has changed or not.

Specified by:

hasChanged in interface ResourceParams

Parameters:

changed - the changed argument

getKey

public String getKey()

Description copied from interface: ResourceParams

Return the dynamic key used to hold resources without static field.

Specified by:

getKey in interface ResourceParams

Returns:

Returns the dynamicKey.

setKey

public void setKey(String key)

Description copied from interface: ResourceParams

Define the dynamic key used to hold resources without static field.

Specified by:

setKey in interface ResourceParams

Parameters:

key - The key to set.

readDouble

protected double readDouble(String doubleString,
                double min,
                double max)

Read a double string value.

Parameters:

doubleString - the double value

min - the minimum value allowed

max - the maximum value allowed

Returns:

the value parsed according to its range

readInteger

protected int readInteger(String intString,
              int min,
              int max)

Read ab integer string value.

Parameters:

intString - the integer value

min - the minimum value allowed

max - the maximum value allowed

Returns:

the value parsed according to its range

readBoolean

protected boolean readBoolean(String parameter)

Read a boolean string value.
Values allowed are (case insensitive):

• true
• yes
• 1

Parameters:

parameter - the boolean string value

Returns:

the boolean or false

toString

public String toString()

Overrides:

toString in class Object

getFieldValues

protected abstract List<? extends Object> getFieldValues()

Return all values of ParameterEntry object.

Returns:

the list of parameters describing the resource to build