Module de.turnertech.tz.swing

Package de.turnertech.tz.swing

Class TacticalSymbolFactory

java.lang.Object

de.turnertech.tz.swing.TacticalSymbolFactory

public class TacticalSymbolFactory
extends Object

A static factory class for creating and accessing the tactical symbols provided in this module via a programmer friendly method.

Make sure to call initialise() early in your application startup to get the most expensive part of starting up out of the way. This triggers the reading of the index file and will create an ArrayList of TacticalSymbolResource with instances for every symbol. If not explicitely called, it will be called on the first attempt to access the symbols via getTacticalSymbols().

Since:

1.2

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LOGGER_NAME	We use java.util logging.

Method Summary

Modifier and Type	Method	Description
static Optional<TacticalSymbol>	getTacticalSymbol(int hashCode)	Returns a tactical symbol based on its unique Id (hashCode).
static Collection<TacticalSymbol>	getTacticalSymbols()	Returns the internal storage wrapped in an unmodifiable list.
static Collection<TacticalSymbol>	getTacticalSymbols(TacticalSymbolTag... tags)	A search mechanism using "AND" logic to retrieve all TacticalSymbols with all of the desired TacticalSymbolTags
static boolean	initialise()	Uses TacticalSymbolResourceFactory to initialise an internal list aof all available tactical symbols wrapped and prepared in TacticalSymbol instances
static boolean	isInitialised()	Simple check to see if the internal storage has been initialised.
static void	reset()	Resets the cache back to a default state.

Methods inherited from class java.lang.Object

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

Field Details

LOGGER_NAME

public static final String LOGGER_NAME

We use java.util logging. This is the name of the logger we are using.

See Also:

• Constant Field Values

Method Details

initialise

public static boolean initialise()

Uses TacticalSymbolResourceFactory to initialise an internal list aof all available tactical symbols wrapped and prepared in TacticalSymbol instances

Returns:

if the initialisation was successfull or not.

See Also:

• reset()

reset

public static void reset()

Resets the cache back to a default state. After calling clear, a subsequent call to isInitialised() will return false.

See Also:

• initialise()

isInitialised

public static boolean isInitialised()

Simple check to see if the internal storage has been initialised.

Returns:

if the symbols instances have been prepared.

getTacticalSymbols

public static Collection<TacticalSymbol> getTacticalSymbols(TacticalSymbolTag... tags)

A search mechanism using "AND" logic to retrieve all TacticalSymbols with all of the desired TacticalSymbolTags

Parameters:

tags - The TacticalSymbolTags to be used to search for the symbols

Returns:

A collection of symbols matching all tags

See Also:

• getTacticalSymbols()

getTacticalSymbol

public static Optional<TacticalSymbol> getTacticalSymbol(int hashCode)

Returns a tactical symbol based on its unique Id (hashCode).

Parameters:

hashCode - The unique Id of the underlying TacticalSymbolResource

Returns:

The symbol, if it was present.

getTacticalSymbols

public static Collection<TacticalSymbol> getTacticalSymbols()

Returns the internal storage wrapped in an unmodifiable list.

Returns:

All of the loaded TacticalSymbols

See Also:

• getTacticalSymbols(TacticalSymbolTag...)