Package org.smooks.engine.resource.config.loader.xml.extension

Class ExtensionContext

java.lang.Object

org.smooks.engine.resource.config.loader.xml.extension.ExtensionContext

public class ExtensionContext
extends Object

Context object used by Smooks configuration extension visitors.

Author:

tom.fennelly@gmail.com

Field Summary

Fields

Modifier and Type	Field	Description
static org.smooks.api.TypedKey<ExtensionContext>	EXTENSION_CONTEXT_TYPED_KEY

Constructor Summary

Constructors

Constructor	Description
ExtensionContext(XmlResourceConfigLoader xmlResourceConfigLoader, String defaultProfile, org.smooks.api.expression.ExpressionEvaluator defaultConditionEvaluator)	Public constructor.

Method Summary

Modifier and Type	Method	Description
void	addResourceConfig(org.smooks.api.resource.config.ResourceConfig resourceConfig)	Add a resource configuration to the list of resources for this Extension Context.
void	addResourceTemplate(org.smooks.api.resource.config.ResourceConfig resourceConfig)	Add a resource configuration template to the resources stack for this Extension Context.
org.smooks.api.expression.ExpressionEvaluator	getDefaultConditionEvaluator()
String	getDefaultProfile()
org.smooks.api.resource.config.ResourceConfig	getResourceConfigsByName(String name)
List<org.smooks.api.resource.config.ResourceConfig>	getResources()	Get the resource list.
Stack<org.smooks.api.resource.config.ResourceConfig>	getResourceStack()	Get the resource stack.
XmlResourceConfigLoader	getXmlResourceConfigLoader()
List<org.smooks.api.resource.config.ResourceConfig>	lookupResourceConfigs(org.smooks.api.resource.config.ConfigSearch searchCriteria)	Lookup an existing resource configuration from the global config list.

Methods inherited from class java.lang.Object

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

Field Detail

EXTENSION_CONTEXT_TYPED_KEY

public static final org.smooks.api.TypedKey<ExtensionContext> EXTENSION_CONTEXT_TYPED_KEY

Constructor Detail

ExtensionContext

public ExtensionContext(XmlResourceConfigLoader xmlResourceConfigLoader,
                        String defaultProfile,
                        org.smooks.api.expression.ExpressionEvaluator defaultConditionEvaluator)

Public constructor.

Parameters:

xmlResourceConfigLoader - The base XMLConfigDigester.

defaultProfile - The default profile.

defaultConditionEvaluator - The default condition evaluator.

Method Detail

addResourceConfig

public void addResourceConfig(org.smooks.api.resource.config.ResourceConfig resourceConfig)

Add a resource configuration to the list of resources for this Extension Context.

The resource gets added to the resourceStack and the basic list of resources.

Parameters:

resourceConfig - The resource to be added.

addResourceTemplate

public void addResourceTemplate(org.smooks.api.resource.config.ResourceConfig resourceConfig)

Add a resource configuration template to the resources stack for this Extension Context.

This resource is not added as a resource on the Smooks instance, but is instead available for cloning.

Parameters:

resourceConfig - The resource to be added.

getResourceStack

public Stack<org.smooks.api.resource.config.ResourceConfig> getResourceStack()

Get the resource stack.

Returns:

The resource stack.

See Also:

addResourceConfig(ResourceConfig)

getResources

public List<org.smooks.api.resource.config.ResourceConfig> getResources()

Get the resource list.

Returns:

The resource list.

See Also:

addResourceConfig(ResourceConfig)

getXmlResourceConfigLoader

public XmlResourceConfigLoader getXmlResourceConfigLoader()

getDefaultProfile

public String getDefaultProfile()

getDefaultConditionEvaluator

public org.smooks.api.expression.ExpressionEvaluator getDefaultConditionEvaluator()

getResourceConfigsByName

public org.smooks.api.resource.config.ResourceConfig getResourceConfigsByName(String name)

lookupResourceConfigs

public List<org.smooks.api.resource.config.ResourceConfig> lookupResourceConfigs(org.smooks.api.resource.config.ConfigSearch searchCriteria)

Lookup an existing resource configuration from the global config list.

Note that this is resource config order-dependent. It will not locate configs that have not yet been loaded.

Parameters:

searchCriteria - The resource lookup criteria.

Returns:

List of matches resources, or an empty List if no matches are found.