griffon.core.env

Class Metadata

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<Object,Object>

java.util.Properties

griffon.core.env.Metadata

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>

public class Metadata
extends Properties

Represents the application Metadata and loading mechanics

Author:

Graeme Rocher (Grails 1.1)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	APPLICATION_NAME
static String	APPLICATION_VERSION
static String	FILE

Fields inherited from class java.util.Properties

defaults

Method Summary

Methods

Modifier and Type	Method and Description
String	getApplicationName()
String	getApplicationVersion()
static Metadata	getCurrent()
String	getEnvironment()
static Metadata	getInstance(File file) Loads and returns a new Metadata object for the given File
static Metadata	getInstance(InputStream inputStream) Loads a Metadata instance from a Reader
Enumeration	keys() Overrides, called by the store method.
void	persist() Saves the current state of the Metadata object
boolean	propertiesHaveNotChanged()
Object	put(Object key, Object value)
void	putAll(Map<?,?> map)
static Metadata	reload() Reloads the application metadata
Object	remove(Object o)
static void	reset() Resets the current state of the Metadata so it is re-read
Object	setProperty(String name, String value)

Methods inherited from class java.util.Properties

getProperty, getProperty, list, list, load, load, loadFromXML, propertyNames, save, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable

clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keySet, rehash, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

FILE

public static final String FILE

See Also:

Constant Field Values

APPLICATION_VERSION

public static final String APPLICATION_VERSION

See Also:

Constant Field Values

APPLICATION_NAME

public static final String APPLICATION_NAME

See Also:

Constant Field Values

Method Detail

reset

public static void reset()

Resets the current state of the Metadata so it is re-read

getCurrent

public static Metadata getCurrent()

Returns:

Returns the metadata for the current application

getInstance

public static Metadata getInstance(InputStream inputStream)

Loads a Metadata instance from a Reader

Parameters:

inputStream - The InputStream

Returns:

a Metadata instance

getInstance

public static Metadata getInstance(File file)

Loads and returns a new Metadata object for the given File

Parameters:

file - The File

Returns:

A Metadata object

reload

public static Metadata reload()

Reloads the application metadata

Returns:

The metadata object

getApplicationVersion

public String getApplicationVersion()

Returns:

The application version

getEnvironment

public String getEnvironment()

Returns:

The environment the application expects to run in

getApplicationName

public String getApplicationName()

Returns:

The application name

persist

public void persist()

Saves the current state of the Metadata object

propertiesHaveNotChanged

public boolean propertiesHaveNotChanged()

Returns:

Returns true if these properties have not changed since they were loaded

remove

public Object remove(Object o)

Specified by:

remove in interface Map<Object,Object>

Overrides:

remove in class Hashtable<Object,Object>

setProperty

public Object setProperty(String name,
                 String value)

Overrides:

setProperty in class Properties

put

public Object put(Object key,
         Object value)

Specified by:

put in interface Map<Object,Object>

Overrides:

put in class Hashtable<Object,Object>

putAll

public void putAll(Map<?,?> map)

Specified by:

putAll in interface Map<Object,Object>

Overrides:

putAll in class Hashtable<Object,Object>

keys

public Enumeration keys()

Overrides, called by the store method.

Overrides:

keys in class Hashtable<Object,Object>