org.jboss.forge
Interface ForgeEnvironment

public interface ForgeEnvironment

Author:

Lincoln Baxter, III

Method Summary

DirectoryResource	getConfigDirectory() Get the configuration directory.
DirectoryResource	getForgeHome() Get the Forge Home directory.
DirectoryResource	getPluginDirectory() Return the directory Forge is using to store and load third-party plugins.
Map<String,Object>	getProperties() Get a map of all configuration properties for the current Forge execution.
Object	getProperty(String name) Get a named property for the current Forge execution
String	getRuntimeVersion() Return the current Forge version as a String.
FileResource<?>	getUserConfiguration() Get the current User's configuration file.
boolean	isEmbedded() Returns true if Forge is running in embedded mode (inside JBoss Tools for example)
boolean	isOnline() Return true if Forge is currently operating with the assumption that an Internet connection is available.
void	removeProperty(String funcName) Get a named property for the current Forge execution
void	setProperty(String name, Object value) Set a configuration property for the current Forge execution.

Method Detail

getRuntimeVersion

String getRuntimeVersion()

Return the current Forge version as a String. E.g.: "1.0.0.Final"

getPluginDirectory

DirectoryResource getPluginDirectory()

Return the directory Forge is using to store and load third-party plugins.

isOnline

boolean isOnline()

Return true if Forge is currently operating with the assumption that an Internet connection is available.

setProperty

void setProperty(String name,
                 Object value)

Set a configuration property for the current Forge execution.

getProperties

Map<String,Object> getProperties()

Get a map of all configuration properties for the current Forge execution.

getProperty

Object getProperty(String name)

Get a named property for the current Forge execution

removeProperty

void removeProperty(String funcName)

Get a named property for the current Forge execution

getConfigDirectory

DirectoryResource getConfigDirectory()

Get the configuration directory.

getUserConfiguration

FileResource<?> getUserConfiguration()

Get the current User's configuration file.

getForgeHome

DirectoryResource getForgeHome()

Get the Forge Home directory. The current value is defined by the "forge.home" system.property

isEmbedded

boolean isEmbedded()

Returns true if Forge is running in embedded mode (inside JBoss Tools for example)