Package com.aspectran.core.context.env

Class ActivityEnvironment

java.lang.Object

com.aspectran.core.context.env.ActivityEnvironment

All Implemented Interfaces:

Environment

public class ActivityEnvironment
extends Object
implements Environment

The Class ActivityEnvironment.

Constructor Summary

Constructors

Constructor	Description
ActivityEnvironment(ActivityContext context, EnvironmentProfiles environmentProfiles)

Method Summary

Modifier and Type	Method	Description
boolean	acceptsProfiles(Profiles profiles)	Determine whether the given Profiles predicate matches the active profiles — or in the case of no explicit active profiles, whether the given Profiles predicate matches the default profiles.
boolean	acceptsProfiles(String... profiles)	Return whether one or more of the given profiles is active or, in the case of no explicit active profiles, whether one or more of the given profiles is included in the set of default profiles.
void	addActiveProfile(String profile)	Add a profile to the current set of active profiles.
void	addPropertyItemRule(ItemRuleMap propertyItemRuleMap)
String[]	getActiveProfiles()	Return the set of profiles explicitly made active for this environment.
String[]	getCurrentProfiles()	Return the set of profiles explicitly made active for this environment.
String[]	getDefaultProfiles()	Return the set of profiles to be active by default when no active profiles have been set explicitly.
<T> T	getProperty(String name)	Returns the value of the property on environment via the currently available activity.
<T> T	getProperty(String name, Activity activity)	Returns the value of the property on environment via the specified activity.
ItemRuleMap	getPropertyItemRuleMap()
boolean	matchesProfiles(String profileExpression)	Determine whether one of the given profile expressions matches the active profiles — or in the case of no explicit active profiles, whether one of the given profile expressions matches the default profiles.
void	setPropertyItemRuleMap(ItemRuleMap propertyItemRuleMap)

Methods inherited from class java.lang.Object

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

Constructor Details

ActivityEnvironment

public ActivityEnvironment(ActivityContext context,
 EnvironmentProfiles environmentProfiles)

Method Details

getActiveProfiles

public String[] getActiveProfiles()

Description copied from interface: Environment

Return the set of profiles explicitly made active for this environment. Profiles are used for creating logical groupings of bean definitions to be registered conditionally, for example based on deployment environment. Profiles can be activated by setting "aspectran.profiles.active" as a system property or by calling EnvironmentProfiles.setActiveProfiles(String...).

If no profiles have explicitly been specified as active, then any default profiles will automatically be activated.

Specified by:

getActiveProfiles in interface Environment

See Also:

• Environment.getDefaultProfiles()
• EnvironmentProfiles.setActiveProfiles(java.lang.String...)
• EnvironmentProfiles.ACTIVE_PROFILES_PROPERTY_NAME

getDefaultProfiles

public String[] getDefaultProfiles()

Description copied from interface: Environment

Return the set of profiles to be active by default when no active profiles have been set explicitly.

Specified by:

getDefaultProfiles in interface Environment

See Also:

• Environment.getActiveProfiles()
• EnvironmentProfiles.setDefaultProfiles(java.lang.String...)
• EnvironmentProfiles.DEFAULT_PROFILES_PROPERTY_NAME

getCurrentProfiles

public String[] getCurrentProfiles()

Description copied from interface: Environment

Return the set of profiles explicitly made active for this environment. If no active profile is explicitly set, returns the set of profiles to be active by default.

Specified by:

getCurrentProfiles in interface Environment

See Also:

• Environment.getActiveProfiles()
• EnvironmentProfiles.getActiveProfiles()
• Environment.getDefaultProfiles()
• EnvironmentProfiles.getDefaultProfiles()

matchesProfiles

public boolean matchesProfiles(String profileExpression)

Description copied from interface: Environment

Determine whether one of the given profile expressions matches the active profiles — or in the case of no explicit active profiles, whether one of the given profile expressions matches the default profiles.

Profile expressions allow for complex, boolean profile logic to be expressed — for example "p1 & p2", "(p1 & p2) | p3", etc. See Profiles.of(String) for details on the supported expression syntax.

This method is a convenient shortcut for env.acceptsProfiles(Profiles.of(profileExpression)).

Specified by:

matchesProfiles in interface Environment

See Also:

• Profiles.of(String)
• Environment.acceptsProfiles(Profiles)

acceptsProfiles

public boolean acceptsProfiles(Profiles profiles)

Description copied from interface: Environment

Determine whether the given Profiles predicate matches the active profiles — or in the case of no explicit active profiles, whether the given Profiles predicate matches the default profiles.

If you wish provide profile expressions directly as strings, use Environment.matchesProfiles(String) instead.

Specified by:

acceptsProfiles in interface Environment

See Also:

• Environment.matchesProfiles(String)
• Profiles.of(String)

acceptsProfiles

public boolean acceptsProfiles(String... profiles)

Description copied from interface: Environment

Return whether one or more of the given profiles is active or, in the case of no explicit active profiles, whether one or more of the given profiles is included in the set of default profiles. If a profile begins with '!' the logic is inverted, i.e. the method will return true if the given profile is not active. For example,

env.acceptsProfiles("p1", "!p2")

will return true if profile 'p1' is active or 'p2' is not active.

Specified by:

acceptsProfiles in interface Environment

Parameters:

profiles - the given profiles

Returns:

true if the given profile is active; false otherwise

See Also:

• Environment.getActiveProfiles()
• Environment.getDefaultProfiles()

addActiveProfile

public void addActiveProfile(String profile)

Description copied from interface: Environment

Add a profile to the current set of active profiles.

Specified by:

addActiveProfile in interface Environment

getPropertyItemRuleMap

public ItemRuleMap getPropertyItemRuleMap()

setPropertyItemRuleMap

public void setPropertyItemRuleMap(ItemRuleMap propertyItemRuleMap)

addPropertyItemRule

public void addPropertyItemRule(ItemRuleMap propertyItemRuleMap)

getProperty

public <T> T getProperty(String name)

Description copied from interface: Environment

Returns the value of the property on environment via the currently available activity.

Specified by:

getProperty in interface Environment

Type Parameters:

T - the type of the value

Parameters:

name - the given property name

Returns:

the value of the property on environment

getProperty

public <T> T getProperty(String name,
 Activity activity)

Description copied from interface: Environment

Returns the value of the property on environment via the specified activity.

Specified by:

getProperty in interface Environment

Type Parameters:

T - the type of the value

Parameters:

name - the given property name

activity - the activity

Returns:

the value of the property on environment