com.goldencode.p2j.cfg

Class ProfileConfig

java.lang.Object

com.goldencode.p2j.cfg.ProfileConfig

public class ProfileConfig
extends java.lang.Object

Contains a profile configuration from the main configuration file.

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Set<java.lang.String>	fileList The file list resolved from the fileSet.
private FileSet	fileSet The FILE-SET specified at the profile.
private java.util.Map<java.lang.String,java.lang.String>	includeRemap Profile's include remapping.
private boolean	isDefault Flag indicating if this profile is loaded by default, if no explicit profile is used.
private java.lang.String	name Profile name.
private java.util.Map<java.lang.String,java.lang.String>	parameters The explicit parameters specified for this profile.
private java.lang.String[]	paths The PROPATH paths for this config.
private java.util.Map<java.lang.Object,java.lang.Object>	savedStates Used at runtime, to save state at this profile, to be able to restore it when switching back to this profile.
private SchemaConfig	schema Profile's schema configuration.

Constructor Summary

Constructors

Constructor and Description
ProfileConfig() Create a new instance.

Method Summary

Modifier and Type	Method and Description
void	addIncludeRemap(java.util.Map<java.lang.String,java.lang.String> remap) Add all include remappings to this profile.
void	addParameter(java.lang.String name, java.lang.String value) Add these parameters to the profile.
void	addParameters(java.util.Map<java.lang.String,java.lang.String> parameters) Add all the parameters to this profile.
void	addState(java.lang.Object key, java.lang.Object state) Save a state with the specified key.
(package private) java.util.Set<java.lang.String>	getFileList() Get the profile's file-list.
FileSet	getFileSet() Get a copy of the profile's fileSet.
java.util.Map<java.lang.String,java.lang.String>	getIncludeRemap() Get a copy of the profile's include remapping.
java.lang.String	getName() Get the profile name.
java.util.Map<java.lang.String,java.lang.String>	getParameters() Get a copy of the profile's parameters.
java.lang.String[]	getPaths() Get the paths.
SchemaConfig	getSchema() Get the profile's schema config.
java.lang.Object	getState(java.lang.Object key) Get a state for the specified key.
boolean	isDefault() Get the isDefault flag.
void	setDefault(boolean isDefault) Set the isDefault flag.
(package private) void	setFileList(java.util.Set<java.lang.String> fl) Set the profile's file-list.
void	setFileSet(FileSet fileSet) Set the profile's file-set.
void	setName(java.lang.String name) Set the profile name.
void	setPaths(java.lang.String[] paths) Set the paths.
void	setSchema(SchemaConfig schema) Set the profile's schema configuration.

Methods inherited from class java.lang.Object

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

Field Detail

parameters

private final java.util.Map<java.lang.String,java.lang.String> parameters

The explicit parameters specified for this profile.

fileSet

private FileSet fileSet

The FILE-SET specified at the profile.

schema

private SchemaConfig schema

Profile's schema configuration.

includeRemap

private final java.util.Map<java.lang.String,java.lang.String> includeRemap

Profile's include remapping.

name

private java.lang.String name

Profile name.

isDefault

private boolean isDefault

Flag indicating if this profile is loaded by default, if no explicit profile is used.

savedStates

private java.util.Map<java.lang.Object,java.lang.Object> savedStates

Used at runtime, to save state at this profile, to be able to restore it when switching back to this profile.

paths

private java.lang.String[] paths

The PROPATH paths for this config.

fileList

private java.util.Set<java.lang.String> fileList

The file list resolved from the fileSet.

Constructor Detail

ProfileConfig

public ProfileConfig()

Create a new instance.

Method Detail

isDefault

public boolean isDefault()

Get the isDefault flag.

Returns:

See above.

setDefault

public void setDefault(boolean isDefault)

Set the isDefault flag.

Parameters:

isDefault - Flag indicating if this profile is loaded by default, if no explicit profile is used.

getName

public java.lang.String getName()

Get the profile name.

Returns:

See above.

setName

public void setName(java.lang.String name)

Set the profile name.

Parameters:

name - See above.

addParameter

public void addParameter(java.lang.String name,
                         java.lang.String value)
                  throws ConfigurationException

Add these parameters to the profile.

Parameters:

name - The parameter name.

value - The parameter's value.

Throws:

ConfigurationException - If the parameter is already set.

getParameters

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

Get a copy of the profile's parameters.

Returns:

See above.

getFileSet

public FileSet getFileSet()

Get a copy of the profile's fileSet.

Returns:

See above.

setFileSet

public void setFileSet(FileSet fileSet)
                throws ConfigurationException

Set the profile's file-set.

Parameters:

fileSet - The file-set to use.

Throws:

ConfigurationException - If the fileSet is already set.

getSchema

public SchemaConfig getSchema()

Get the profile's schema config.

Returns:

See above.

setSchema

public void setSchema(SchemaConfig schema)
               throws ConfigurationException

Set the profile's schema configuration.

Parameters:

schema - The schema configuration.

Throws:

ConfigurationException - If the schema is already set.

getIncludeRemap

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

Get a copy of the profile's include remapping.

Returns:

See above.

addIncludeRemap

public void addIncludeRemap(java.util.Map<java.lang.String,java.lang.String> remap)
                     throws ConfigurationException

Add all include remappings to this profile.

Parameters:

remap - The include remappings.

Throws:

ConfigurationException

addParameters

public void addParameters(java.util.Map<java.lang.String,java.lang.String> parameters)

Add all the parameters to this profile.

Parameters:

parameters - The parameters to add.

getState

public java.lang.Object getState(java.lang.Object key)

Get a state for the specified key.

Parameters:

key - The key.

Returns:

The saved state.

addState

public void addState(java.lang.Object key,
                     java.lang.Object state)

Save a state with the specified key.

Parameters:

key - The state's key.

state - The state.

setPaths

public void setPaths(java.lang.String[] paths)

Set the paths.

Parameters:

paths - The PROPATH paths for this config.

getPaths

public java.lang.String[] getPaths()

Get the paths.

Returns:

See above.

getFileList

java.util.Set<java.lang.String> getFileList()

Get the profile's file-list.

Returns:

The fileList.

setFileList

void setFileList(java.util.Set<java.lang.String> fl)

Set the profile's file-list.

Parameters:

fl - The file-list associated with the fileSet.