org.gillius.jalleg.framework

Class AllegroConfig

java.lang.Object

org.gillius.jalleg.framework.AllegroConfig

public class AllegroConfig
extends java.lang.Object

AllegroConfig implements the same sections model as an AllegroLibrary.ALLEGRO_CONFIG, but completely within Java. There are methods to convert to and from an AllegroLibrary.ALLEGRO_CONFIG. The main reason to keep it within Java is for efficiency (avoiding the penalty of Java to native), easy ability to provide Java structures (Map), and to not need to worry about needing to free native resources with AllegroLibrary.al_destroy_config(org.gillius.jalleg.binding.AllegroLibrary.ALLEGRO_CONFIG).

Constructor Summary

Constructors

Constructor and Description
AllegroConfig(org.gillius.jalleg.binding.AllegroLibrary.ALLEGRO_CONFIG config)

Method Summary

Modifier and Type	Method and Description
org.gillius.jalleg.binding.AllegroLibrary.ALLEGRO_CONFIG	createConfig() Creates a new AllegroLibrary.ALLEGRO_CONFIG with AllegroLibrary.al_create_config() and writes all current values into it.
static AllegroConfig	fromConfigAndDestroy(org.gillius.jalleg.binding.AllegroLibrary.ALLEGRO_CONFIG config)
java.lang.String	getConfigValue(java.lang.String section, java.lang.String key)
java.lang.String	getConfigValue(java.lang.String section, java.lang.String key, java.lang.String defaultValue) Returns the specified configuration value, or defaultValue if there is no entry.
java.util.Map<java.lang.String,java.lang.String>	getSection(java.lang.String section, boolean create) Returns a mutable view into a configuration section.
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	getSections() Returns a mutable view into this AllegroConfig.
void	mergeInto(AllegroConfig config)
void	mergeInto(org.gillius.jalleg.binding.AllegroLibrary.ALLEGRO_CONFIG config)
void	saveConfig(org.gillius.jalleg.binding.AllegroLibrary.ALLEGRO_FILE file)
void	saveConfig(java.lang.String filename) Saves the configuration to a file.
void	setConfigValue(java.lang.String section, java.lang.String key, java.lang.Object value) Sets the given value in a section under the given key.

Methods inherited from class java.lang.Object

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

Constructor Detail

AllegroConfig

public AllegroConfig(org.gillius.jalleg.binding.AllegroLibrary.ALLEGRO_CONFIG config)

Method Detail

fromConfigAndDestroy

public static AllegroConfig fromConfigAndDestroy(org.gillius.jalleg.binding.AllegroLibrary.ALLEGRO_CONFIG config)

getConfigValue

public java.lang.String getConfigValue(java.lang.String section,
                                       java.lang.String key)

getConfigValue

public java.lang.String getConfigValue(java.lang.String section,
                                       java.lang.String key,
                                       java.lang.String defaultValue)

Returns the specified configuration value, or defaultValue if there is no entry.

getSections

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getSections()

Returns a mutable view into this AllegroConfig. The map is a multi-level map of section to values, and the values map is key to value.

getSection

public java.util.Map<java.lang.String,java.lang.String> getSection(java.lang.String section,
                                                                   boolean create)

Returns a mutable view into a configuration section.

Parameters:

section - section to get

create - true if to create a new section if not found

Returns:

section if found. If not found, returns new section if create is true, else null

setConfigValue

public void setConfigValue(java.lang.String section,
                           java.lang.String key,
                           java.lang.Object value)

Sets the given value in a section under the given key. The value is converted into a String.

mergeInto

public void mergeInto(AllegroConfig config)

mergeInto

public void mergeInto(org.gillius.jalleg.binding.AllegroLibrary.ALLEGRO_CONFIG config)

createConfig

public org.gillius.jalleg.binding.AllegroLibrary.ALLEGRO_CONFIG createConfig()

Creates a new AllegroLibrary.ALLEGRO_CONFIG with AllegroLibrary.al_create_config() and writes all current values into it. The returned config must be freed with AllegroLibrary.al_destroy_config(ALLEGRO_CONFIG).

saveConfig

public void saveConfig(java.lang.String filename)

Saves the configuration to a file.

saveConfig

public void saveConfig(org.gillius.jalleg.binding.AllegroLibrary.ALLEGRO_FILE file)