public interface DefinitionsFactory
Definition
s and managing their contents.
DefinitionsFactory implementations are responsible for maintaining the data sources of Tiles configuration data and using the data to create Definitions sets. Implementations also know how to append locale-specific configuration data to an existing Definitions set.
Modifier and Type | Field and Description |
---|---|
static String |
DEFINITION_DAO_INIT_PARAM
Constant representing the configuration parameter used to define the
definition DAO to use.
|
static String |
DEFINITIONS_CONFIG
Constant representing the configuration parameter
used to define the tiles definition resources.
|
static String |
LOCALE_RESOLVER_IMPL_PROPERTY
Property name that specifies the implementation of
LocaleResolver . |
static String |
READER_IMPL_PROPERTY
Property name that specifies the implementation of the DefinitionsReader.
|
Modifier and Type | Method and Description |
---|---|
void |
addSource(Object source)
Deprecated.
Let the Definitions Factory load its sources by itself.
|
Definition |
getDefinition(String name,
TilesRequestContext tilesContext)
Returns a Definition object that matches the given name and
Tiles context.
|
void |
init(Map<String,String> params)
Deprecated.
Parameter based initialization is deprecated, please compose your
definitions factory using methods.
|
Definitions |
readDefinitions()
Deprecated.
Let the Definitions Factory use it.
|
static final String READER_IMPL_PROPERTY
static final String LOCALE_RESOLVER_IMPL_PROPERTY
LocaleResolver
.static final String DEFINITIONS_CONFIG
static final String DEFINITION_DAO_INIT_PARAM
void init(Map<String,String> params)
params
- The Map of configuration properties.DefinitionsFactoryException
- If a Tiles exception, such as an initialization
error, occurs.Definition getDefinition(String name, TilesRequestContext tilesContext)
name
- The name of the Definition to return.tilesContext
- The Tiles context to use to resolve the definition.@Deprecated void addSource(Object source)
source
- The configuration source for definitions.@Deprecated Definitions readDefinitions()
Definitions
set by reading
configuration data from the applied sources.Copyright © 2017. All rights reserved.