grails.util
Class AbstractBuildSettings

java.lang.Object
  grails.util.AbstractBuildSettings

public abstract class AbstractBuildSettings
extends java.lang.Object

Methods optimized to Java for the BuildSettings class.

Since:

1.3.4

Field Summary

protected java.util.Map<java.lang.String,java.lang.Object>	cache Used to cache results of certain expensive operations
protected groovy.util.ConfigObject	config The settings stored in the project's BuildConfig.groovy file if there is one.
protected java.util.Map	flatConfig Flattened version of the ConfigObject for easy access from Java
protected java.io.File	globalPluginsDir The location where global plugins are installed to.
protected boolean	globalPluginsDirSet
protected java.io.File	projectPluginsDir The location where project-specific plugins are installed to.
protected boolean	projectPluginsDirSet

Constructor Summary

AbstractBuildSettings()

Method Summary

void	addPluginDirectory(java.io.File location, boolean isInline) Adds a plugin directory
groovy.util.ConfigObject	getConfig()
java.io.File	getGlobalPluginsDir()
java.util.Collection<java.io.File>	getImplicitPluginDirectories() Returns a list of all plugin directories in both the given path and the global "plugins" directory together.
java.util.Collection<java.io.File>	getInlinePluginDirectories() Returns an array of the inplace plugin locations.
protected java.util.Collection<java.io.File>	getInlinePluginsFromConfiguration(java.util.Map config) Extracts the inline plugin dirs relative to the base dir of this project.
protected java.util.Collection<java.io.File>	getInlinePluginsFromConfiguration(java.util.Map config, java.io.File baseDir) Extracts the inline plugin dirs from the given config, relative to the given baseDir.
java.util.Collection<java.lang.String>	getPluginBaseDirectories() Gets a list of all the known plugin base directories (directories where plugins are installed to).
java.util.Collection<java.io.File>	getPluginDirectories() Obtains a list of plugin directories for the application
java.io.File	getProjectPluginsDir()
boolean	isInlinePluginLocation(java.io.File pluginLocation) Returns true if the specified plugin location is an inline location.
void	setConfig(groovy.util.ConfigObject config)
void	setGlobalPluginsDir(java.io.File globalPluginsDir)
void	setProjectPluginsDir(java.io.File projectPluginsDir)

Methods inherited from class java.lang.Object

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

Field Detail

cache

protected java.util.Map<java.lang.String,java.lang.Object> cache

Used to cache results of certain expensive operations

config

protected groovy.util.ConfigObject config

The settings stored in the project's BuildConfig.groovy file if there is one.

projectPluginsDir

protected java.io.File projectPluginsDir

The location where project-specific plugins are installed to.

globalPluginsDir

protected java.io.File globalPluginsDir

The location where global plugins are installed to.

projectPluginsDirSet

protected boolean projectPluginsDirSet

globalPluginsDirSet

protected boolean globalPluginsDirSet

flatConfig

protected java.util.Map flatConfig

Flattened version of the ConfigObject for easy access from Java

Constructor Detail

AbstractBuildSettings

public AbstractBuildSettings()

Method Detail

getConfig

public groovy.util.ConfigObject getConfig()

setConfig

public void setConfig(groovy.util.ConfigObject config)

getProjectPluginsDir

public java.io.File getProjectPluginsDir()

setProjectPluginsDir

public void setProjectPluginsDir(java.io.File projectPluginsDir)

getGlobalPluginsDir

public java.io.File getGlobalPluginsDir()

setGlobalPluginsDir

public void setGlobalPluginsDir(java.io.File globalPluginsDir)

addPluginDirectory

public void addPluginDirectory(java.io.File location,
                               boolean isInline)

Adds a plugin directory

Parameters:

location - The plugin's locatino

getPluginDirectories

public java.util.Collection<java.io.File> getPluginDirectories()

Obtains a list of plugin directories for the application

getInlinePluginsFromConfiguration

protected java.util.Collection<java.io.File> getInlinePluginsFromConfiguration(java.util.Map config)

Extracts the inline plugin dirs relative to the base dir of this project.

See Also:

getInlinePluginsFromConfiguration(Map, File)

getInlinePluginsFromConfiguration

protected java.util.Collection<java.io.File> getInlinePluginsFromConfiguration(java.util.Map config,
                                                                               java.io.File baseDir)

Extracts the inline plugin dirs from the given config, relative to the given baseDir. TODO: consider trowing an error here if an plugin does not exists at the location.

getImplicitPluginDirectories

public java.util.Collection<java.io.File> getImplicitPluginDirectories()

Returns a list of all plugin directories in both the given path and the global "plugins" directory together.

Returns:

A list of plugin directories as File objects

getPluginBaseDirectories

public java.util.Collection<java.lang.String> getPluginBaseDirectories()

Gets a list of all the known plugin base directories (directories where plugins are installed to).

Returns:

Returns the base location where plugins are kept

isInlinePluginLocation

public boolean isInlinePluginLocation(java.io.File pluginLocation)

Returns true if the specified plugin location is an inline location.

getInlinePluginDirectories

public java.util.Collection<java.io.File> getInlinePluginDirectories()

Returns an array of the inplace plugin locations.