grails.util
Class Metadata

java.lang.Object
  java.util.Dictionary<K,V>
      java.util.Hashtable<java.lang.Object,java.lang.Object>
          java.util.Properties
              grails.util.Metadata

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Object,java.lang.Object>

public class Metadata
extends java.util.Properties

Represents the application Metadata and loading mechanics.

Since:

1.1

See Also:

Serialized Form

Field Summary

static java.lang.String	APPLICATION_GRAILS_VERSION
static java.lang.String	APPLICATION_NAME
static java.lang.String	APPLICATION_VERSION
static java.lang.String	DEFAULT_SERVLET_VERSION
static java.lang.String	FILE
static java.lang.String	SERVLET_VERSION
static java.lang.String	WAR_DEPLOYED

Fields inherited from class java.util.Properties

defaults

Method Summary

java.lang.String	getApplicationName()
java.lang.String	getApplicationVersion()
static Metadata	getCurrent()
java.lang.String	getEnvironment()
java.lang.String	getGrailsVersion()
java.util.Map<java.lang.String,java.lang.String>	getInstalledPlugins() Obtains a map (name->version) of installed plugins specified in the project metadata
static Metadata	getInstance(java.io.File file) Loads and returns a new Metadata object for the given File.
static Metadata	getInstance(java.io.InputStream inputStream) Loads a Metadata instance from a Reader
java.io.File	getMetadataFile()
java.lang.String	getServletVersion()
boolean	isWarDeployed()
java.util.Enumeration	keys() Overrides, called by the store method.
void	persist() Saves the current state of the Metadata object.
boolean	propertiesHaveNotChanged()
java.lang.Object	put(java.lang.Object key, java.lang.Object o2)
static Metadata	reload() Reloads the application metadata.
static void	reset() Resets the current state of the Metadata so it is re-read.
void	setGrailsVersion(java.lang.String version)
void	setServletVersion(java.lang.String servletVersion)

Methods inherited from class java.util.Properties

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

Methods inherited from class java.util.Hashtable

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

Methods inherited from class java.lang.Object

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

Field Detail

FILE

public static final java.lang.String FILE

See Also:

Constant Field Values

APPLICATION_VERSION

public static final java.lang.String APPLICATION_VERSION

See Also:

Constant Field Values

APPLICATION_NAME

public static final java.lang.String APPLICATION_NAME

See Also:

Constant Field Values

APPLICATION_GRAILS_VERSION

public static final java.lang.String APPLICATION_GRAILS_VERSION

See Also:

Constant Field Values

SERVLET_VERSION

public static final java.lang.String SERVLET_VERSION

See Also:

Constant Field Values

WAR_DEPLOYED

public static final java.lang.String WAR_DEPLOYED

See Also:

Constant Field Values

DEFAULT_SERVLET_VERSION

public static final java.lang.String DEFAULT_SERVLET_VERSION

See Also:

Constant Field Values

Method Detail

getMetadataFile

public java.io.File getMetadataFile()

reset

public static void reset()

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

getCurrent

public static Metadata getCurrent()

Returns:

the metadata for the current application

getInstance

public static Metadata getInstance(java.io.InputStream inputStream)

Loads a Metadata instance from a Reader

Parameters:

inputStream - The InputStream

Returns:

a Metadata instance

getInstance

public static Metadata getInstance(java.io.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 java.lang.String getApplicationVersion()

Returns:

The application version

getGrailsVersion

public java.lang.String getGrailsVersion()

Returns:

The Grails version used to build the application

setGrailsVersion

public void setGrailsVersion(java.lang.String version)

getEnvironment

public java.lang.String getEnvironment()

Returns:

The environment the application expects to run in

getApplicationName

public java.lang.String getApplicationName()

Returns:

The application name

getInstalledPlugins

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

Obtains a map (name->version) of installed plugins specified in the project metadata

Returns:

A map of installed plugins

getServletVersion

public java.lang.String getServletVersion()

Returns:

The version of the servlet spec the application was created for

setServletVersion

public void setServletVersion(java.lang.String servletVersion)

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

keys

public java.util.Enumeration keys()

Overrides, called by the store method.

Overrides:

keys in class java.util.Hashtable<java.lang.Object,java.lang.Object>

isWarDeployed

public boolean isWarDeployed()

Returns:

true if this application is deployed as a WAR

put

public java.lang.Object put(java.lang.Object key,
                            java.lang.Object o2)

Specified by:

put in interface java.util.Map<java.lang.Object,java.lang.Object>

Overrides:

put in class java.util.Hashtable<java.lang.Object,java.lang.Object>