org.povclipse2.property

Class ProjectPropertyStore

java.lang.Object

PreferenceStore

org.povclipse2.property.ProjectPropertyStore

public class ProjectPropertyStore
extends PreferenceStore

Store for saving all project related preferences.

The properties will be stored using the file defined by the constant PROJECT_PROPERTY_STORE_FILE. The file will be created for each project automatically.

Author:

Wolfgang Möstl

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	P_PRJ_PROP_DATA_FOLDER
static java.lang.String	P_PRJ_PROP_INCLUDE_FOLDER
static java.lang.String	P_PRJ_PROP_INICOMMANDLINE
static java.lang.String	P_PRJ_PROP_LIB_PATH
static java.lang.String	P_PRJ_PROP_OUTPUT_FOLDER
static java.lang.String	P_PRJ_PROP_SCENE_FOLDER

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCommandLine(java.lang.String iniFile)
static java.lang.String	getDefaultIncludePath(java.lang.String executeablePath)
java.util.List<java.lang.String>	getDefaultLibraryPath(java.util.List<java.lang.String> lstLibPath) If the given List does not include the default entries these will be included.
java.util.List<java.lang.String>	getLibraryPath()
java.util.List<java.lang.String>	getLibraryPathIncludingBaseFolder(java.io.File folder)
java.util.List<java.lang.String>	getLibraryPathIncludingBaseFolderForFile(java.io.File file)
static ProjectPropertyStore	getProjectPropertyStore(IProject project) Gets an ProjectPropertyStore instance related to a specific project.
static boolean	hasListElement(java.util.List<?> lst, java.lang.Object element) Checks if the given List includes the given element.
void	setCommandLine(IPath iniFile, java.lang.String cl)
void	setLibraryPath(java.util.List<java.lang.String> lstLibPath) Sets the list of library path entries.

Methods inherited from class java.lang.Object

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

Field Detail

P_PRJ_PROP_LIB_PATH

public static final java.lang.String P_PRJ_PROP_LIB_PATH

See Also:

Constant Field Values

P_PRJ_PROP_SCENE_FOLDER

public static final java.lang.String P_PRJ_PROP_SCENE_FOLDER

See Also:

Constant Field Values

P_PRJ_PROP_INCLUDE_FOLDER

public static final java.lang.String P_PRJ_PROP_INCLUDE_FOLDER

See Also:

Constant Field Values

P_PRJ_PROP_DATA_FOLDER

public static final java.lang.String P_PRJ_PROP_DATA_FOLDER

See Also:

Constant Field Values

P_PRJ_PROP_OUTPUT_FOLDER

public static final java.lang.String P_PRJ_PROP_OUTPUT_FOLDER

See Also:

Constant Field Values

P_PRJ_PROP_INICOMMANDLINE

public static final java.lang.String P_PRJ_PROP_INICOMMANDLINE

See Also:

Constant Field Values

Method Detail

getProjectPropertyStore

public static ProjectPropertyStore getProjectPropertyStore(IProject project)
                                                    throws PovrayException

Gets an ProjectPropertyStore instance related to a specific project.

Parameters:

project - The project this ProjectPropertyStore belongs to.

Returns:

The property store for the given project.

Throws:

PovrayException - if the store could not be loaded.

getLibraryPathIncludingBaseFolderForFile

public java.util.List<java.lang.String> getLibraryPathIncludingBaseFolderForFile(java.io.File file)

getLibraryPathIncludingBaseFolder

public java.util.List<java.lang.String> getLibraryPathIncludingBaseFolder(java.io.File folder)

getLibraryPath

public java.util.List<java.lang.String> getLibraryPath()

Returns:

A List of Strings, each representing a single library path entry.

setLibraryPath

public void setLibraryPath(java.util.List<java.lang.String> lstLibPath)

Sets the list of library path entries.

Parameters:

lstLibPath - A List of Strings, each representing a single library path entry.

getDefaultIncludePath

public static java.lang.String getDefaultIncludePath(java.lang.String executeablePath)

Returns:

The default include path, extracted using the given executeable path or an empty String if the library pat can not be extracted. Never null!

getDefaultLibraryPath

public java.util.List<java.lang.String> getDefaultLibraryPath(java.util.List<java.lang.String> lstLibPath)

If the given List does not include the default entries these will be included.

Parameters:

lstLibPath - The List to be checked. If NULL a new, empty List will be created.

The default entries are:

[MEGAPOV_PATH]/include
[POVRAY_PATH]/include
[PROJECT_PATH]
All referenced Projects

Returns:

The given List including the default library path entries.

hasListElement

public static boolean hasListElement(java.util.List<?> lst,
                                     java.lang.Object element)

Checks if the given List includes the given element.

Parameters:

lst - The List to be checked

element - The element to be checked

Returns:

true if the list has the element, false otherwise.

getCommandLine

public java.lang.String getCommandLine(java.lang.String iniFile)

setCommandLine

public void setCommandLine(IPath iniFile,
                           java.lang.String cl)