com.asakusafw.windgate.core.process

Class ProcessProfile

java.lang.Object

com.asakusafw.windgate.core.BaseProfile<ProcessProfile,ProcessProvider>

com.asakusafw.windgate.core.process.ProcessProfile

public class ProcessProfile
extends BaseProfile<ProcessProfile,ProcessProvider>

A configuration for each process.

Since:

0.2.2

Version:

0.2.4

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_PREFIX Prefix of property keys about processs.
static Pattern	NAME_PATTERN Process name pattern.

Fields inherited from class com.asakusafw.windgate.core.BaseProfile

QUALIFIER

Constructor Summary

Constructors

Constructor and Description
ProcessProfile(String name, Class<? extends ProcessProvider> providerClass, ProfileContext context, Map<String,String> configuration) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
Map<String,String>	getConfiguration() Returns the extra configuration of this process.
ProfileContext	getContext() Returns the current profile context.
String	getName() Returns this name.
Class<? extends ProcessProvider>	getProviderClass() Returns the class of corresponded provider.
protected ProcessProfile	getThis() Returns this object.
static Collection<? extends ProcessProfile>	loadFrom(Properties properties, ClassLoader loader) Deprecated. use loadFrom(Properties, ProfileContext) instead
static Collection<? extends ProcessProfile>	loadFrom(Properties properties, ProfileContext context) Loads process profiles from the properties.
static void	removeCorrespondingKeys(Properties properties) Removes entries corresponding to process profiles.
void	storeTo(Properties properties) Stores this profile into the specified properties.

Methods inherited from class com.asakusafw.windgate.core.BaseProfile

createProvider, getClassLoader, loadProviderClass

Methods inherited from class java.lang.Object

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

Field Detail

NAME_PATTERN

public static final Pattern NAME_PATTERN

Process name pattern.

KEY_PREFIX

public static final String KEY_PREFIX

Prefix of property keys about processs.

See Also:

Constant Field Values

Constructor Detail

ProcessProfile

public ProcessProfile(String name,
                      Class<? extends ProcessProvider> providerClass,
                      ProfileContext context,
                      Map<String,String> configuration)

Creates a new instance.

Parameters:

name - the name of this process

providerClass - the class which can provide this process

context - the current profile context

configuration - the extra configuration

Throws:

IllegalArgumentException - if any parameter is null

Method Detail

getName

public String getName()

Returns this name.

Returns:

this name

getProviderClass

public Class<? extends ProcessProvider> getProviderClass()

Description copied from class: BaseProfile

Returns the class of corresponded provider.

Specified by:

getProviderClass in class BaseProfile<ProcessProfile,ProcessProvider>

Returns:

the provider class

getContext

public ProfileContext getContext()

Description copied from class: BaseProfile

Returns the current profile context.

Specified by:

getContext in class BaseProfile<ProcessProfile,ProcessProvider>

Returns:

the current profile context

getConfiguration

public Map<String,String> getConfiguration()

Returns the extra configuration of this process.

Returns:

the configuration

getThis

protected ProcessProfile getThis()

Description copied from class: BaseProfile

Returns this object.

Specified by:

getThis in class BaseProfile<ProcessProfile,ProcessProvider>

Returns:

this object

loadFrom

@Deprecated
public static Collection<? extends ProcessProfile> loadFrom(Properties properties,
                                                                        ClassLoader loader)

Deprecated. use loadFrom(Properties, ProfileContext) instead

Loads process profiles from the properties.

Parameters:

properties - source properties

loader - class loader to load the ProcessProvider

Returns:

the loaded profiles

Throws:

IllegalArgumentException - if properties are invalid, or if any parameter is null

loadFrom

public static Collection<? extends ProcessProfile> loadFrom(Properties properties,
                                                            ProfileContext context)

Loads process profiles from the properties.

Parameters:

properties - source properties

context - the curren profile context

Returns:

the loaded profiles

Throws:

IllegalArgumentException - if properties are invalid, or if any parameter is null

storeTo

public void storeTo(Properties properties)

Stores this profile into the specified properties.

Parameters:

properties - target properties object

Throws:

IllegalArgumentException - if target properties already contains keys about this process, or if any parameter is null

removeCorrespondingKeys

public static void removeCorrespondingKeys(Properties properties)

Removes entries corresponding to process profiles.

Parameters:

properties - target properties

Throws:

IllegalArgumentException - if any parameter is null