com.asakusafw.windgate.core.resource

Class ResourceProfile

java.lang.Object

com.asakusafw.windgate.core.BaseProfile<ResourceProfile,ResourceProvider>

com.asakusafw.windgate.core.resource.ResourceProfile

public final class ResourceProfile
extends BaseProfile<ResourceProfile,ResourceProvider>

A configuration for each resource.

Since:

0.2.2

Field Summary

Fields

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

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

QUALIFIER

Constructor Summary

Constructors

Constructor and Description
ResourceProfile(String name, Class<? extends ResourceProvider> 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 resource.
ProfileContext	getContext() Returns the current profile context.
String	getName() Returns this name.
Class<? extends ResourceProvider>	getProviderClass() Returns the class of corresponded provider.
protected ResourceProfile	getThis() Returns this object.
static Collection<? extends ResourceProfile>	loadFrom(Properties properties, ClassLoader loader) Deprecated. use loadFrom(Properties, ProfileContext) instead
static Collection<? extends ResourceProfile>	loadFrom(Properties properties, ProfileContext context) Loads resource profiles from the properties.
static void	removeCorrespondingKeys(Properties properties) Removes entries corresponding to resource 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

Resource name pattern.

KEY_PREFIX

public static final String KEY_PREFIX

Prefix of property keys about resources.

See Also:

Constant Field Values

Constructor Detail

ResourceProfile

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

Creates a new instance.

Parameters:

name - the name of this resource

providerClass - the class which can provide this resource

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 ResourceProvider> getProviderClass()

Description copied from class: BaseProfile

Returns the class of corresponded provider.

Specified by:

getProviderClass in class BaseProfile<ResourceProfile,ResourceProvider>

Returns:

the provider class

getContext

public ProfileContext getContext()

Description copied from class: BaseProfile

Returns the current profile context.

Specified by:

getContext in class BaseProfile<ResourceProfile,ResourceProvider>

Returns:

the current profile context

getConfiguration

public Map<String,String> getConfiguration()

Returns the extra configuration of this resource.

Returns:

the configuration

getThis

protected ResourceProfile getThis()

Description copied from class: BaseProfile

Returns this object.

Specified by:

getThis in class BaseProfile<ResourceProfile,ResourceProvider>

Returns:

this object

loadFrom

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

Deprecated. use loadFrom(Properties, ProfileContext) instead

Loads resource profiles from the properties.

Parameters:

properties - source properties

loader - class loader to load the ResourceProvider

Returns:

the loaded profiles

Throws:

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

loadFrom

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

Loads resource profiles from the properties.

Parameters:

properties - source properties

context - the current context

Returns:

the loaded profiles

Throws:

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

Since:

0.2.4

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 resource, or if any parameter is null

removeCorrespondingKeys

public static void removeCorrespondingKeys(Properties properties)

Removes entries corresponding to resource profiles.

Parameters:

properties - target properties

Throws:

IllegalArgumentException - if any parameter is null