org.jrebirth.af.core.resource

Class Resources

java.lang.Object

org.jrebirth.af.core.resource.Resources

public final class Resources
extends Object

The class Resources is the first access point when you want to declare a resource for your application.

Author:

Sébastien Bordes

Field Summary

Fields

Modifier and Type	Field and Description
private static AtomicInteger	colorIdGenerator The generator of unique id for colors.
private static Map<String,ColorItem>	colorMap The dynamic color map.
private static AtomicInteger	fontIdGenerator The generator of unique id for fonts.
private static AtomicInteger	fxmlIdGenerator The generator of unique id for fxml files.
private static AtomicInteger	imageIdGenerator The generator of unique id for images.
private static AtomicInteger	messageIdGenerator The generator of unique id for message items.
private static AtomicInteger	parameterIdGenerator The generator of unique id for parameters.
static String	PATH_SEP The class path separator.
private static AtomicInteger	styleSheetIdGenerator The generator of unique id for style sheets.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	Resources() Private Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static ColorItem	create(ColorParams colorParams) Build a color item.
static ColorItem	create(ColorParams colorParams, String dynamicKey) Build a color item.
static FontItemBase	create(FontParams fontParams) Build a font item.
static FXMLItemBase	create(FXMLParams fxmlParams) Build a fxml item.
static ImageItemBase	create(ImageParams imageParams) Build an image item.
static MessageItemBase	create(Message messageParams) Build a Message item.
static <O> ParameterItemBase<O>	create(ObjectParameter<O> parameterParams) Build a parameter item.
static <O> ParameterItemBase<O>	create(String name, O defaultValue) Build a parameter item.
static StyleSheetItemBase	create(StyleSheetParams styleSheetParams) Build a style sheet item.
static boolean	isNotAutoRefreshParam(ResourceParams params) This utility method allow to avoid doing something if the parameter given is tahe AutoRefresh one.

Methods inherited from class java.lang.Object

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

Field Detail

PATH_SEP

public static final String PATH_SEP

The class path separator.

See Also:

Constant Field Values

parameterIdGenerator

private static AtomicInteger parameterIdGenerator

The generator of unique id for parameters.

colorIdGenerator

private static AtomicInteger colorIdGenerator

The generator of unique id for colors.

fontIdGenerator

private static AtomicInteger fontIdGenerator

The generator of unique id for fonts.

imageIdGenerator

private static AtomicInteger imageIdGenerator

The generator of unique id for images.

styleSheetIdGenerator

private static AtomicInteger styleSheetIdGenerator

The generator of unique id for style sheets.

fxmlIdGenerator

private static AtomicInteger fxmlIdGenerator

The generator of unique id for fxml files.

messageIdGenerator

private static AtomicInteger messageIdGenerator

The generator of unique id for message items.

colorMap

private static Map<String,ColorItem> colorMap

The dynamic color map.

Constructor Detail

Resources

private Resources()

Private Constructor.

Method Detail

create

public static <O> ParameterItemBase<O> create(ObjectParameter<O> parameterParams)

Build a parameter item.

Type Parameters:

O - the type of parameterized object

Parameters:

parameterParams - the primitive values for the color

Returns:

a new fresh color item object

create

public static <O> ParameterItemBase<O> create(String name,
                              O defaultValue)

Build a parameter item.

Type Parameters:

O - the type of parameterized object

Parameters:

name - the parameter unique name

defaultValue - the default object value

Returns:

a new fresh color item object

create

public static ColorItem create(ColorParams colorParams)

Build a color item.

Parameters:

colorParams - the primitive values for the color

Returns:

a new fresh color item object

create

public static ColorItem create(ColorParams colorParams,
               String dynamicKey)

Build a color item.

Parameters:

colorParams - the primitive values for the color

dynamicKey - the dynamic key used to register this color

Returns:

a new fresh color item object

create

public static FontItemBase create(FontParams fontParams)

Build a font item.

Parameters:

fontParams - the primitive values for the font

Returns:

a new fresh font item object

create

public static ImageItemBase create(ImageParams imageParams)

Build an image item.

Parameters:

imageParams - the primitive values for the image

Returns:

a new fresh image item object

create

public static StyleSheetItemBase create(StyleSheetParams styleSheetParams)

Build a style sheet item.

Parameters:

styleSheetParams - the primitive values for the style sheet

Returns:

a new fresh file

create

public static FXMLItemBase create(FXMLParams fxmlParams)

Build a fxml item.

Parameters:

fxmlParams - the primitive values for the fxml resource

Returns:

a new fresh FXML item

create

public static MessageItemBase create(Message messageParams)

Build a Message item.

Parameters:

messageParams - the key of the i18n message

Returns:

a new fresh Message item

isNotAutoRefreshParam

public static boolean isNotAutoRefreshParam(ResourceParams params)

This utility method allow to avoid doing something if the parameter given is tahe AutoRefresh one.
Because this parameter is used to control how other parameters can be updated.

Parameters:

params - the ResourceParams to check

Returns:

true if the resource params is not the auto refresh parameter