# Uses of Class
org.apache.tiles.api.Definition

Packages that use Definition
Package
Description
org.apache.struts2.tiles
org.apache.tiles.api
The Tiles taglib and framework allows building web pages by assembling reusable pieces of pages, called Tiles.
org.apache.tiles.api.mgmt
Classes and interfaces to be used when it is needed to create Tiles definitions during the execution of the application.
org.apache.tiles.core.definition
It contains classes and interfaces to allow manipulations of "definitions", i.e.
org.apache.tiles.core.definition.dao
Classes to simply load definitions depending on a customization key.
org.apache.tiles.core.definition.digester
Allows reading definitions with the use of Jakarta Commons Digester.
org.apache.tiles.core.definition.pattern
Classes to manage pattern matching in definition names, and substitution in attributes.
org.apache.tiles.core.definition.pattern.regexp
In Tiles it is possible to use regular expression patterns thanks to this package.
org.apache.tiles.core.definition.pattern.wildcard
In Tiles it is possible to use wildcard patterns thanks to this package.
org.apache.tiles.core.impl
It contains the basic implementations of Tiles container.
org.apache.tiles.core.impl.mgmt
It contains the basic implementations of mutable Tiles containers.

- ## Uses of Definition in org.apache.struts2.tiles

  Methods in org.apache.struts2.tiles that return Definition
  Modifier and Type
  Method
  Description
  `Definition`
  StrutsTilesAnnotationProcessor.`buildTilesDefinition(String tileName, TilesDefinition tilesDefinition)`
  Builds a `Definition` based on given `TilesDefinition` with given name.

- ## Uses of Definition in org.apache.tiles.api

  Methods in org.apache.tiles.api that return Definition
  Modifier and Type
  Method
  Description
  `Definition`
  TilesContainer.`getDefinition(String definitionName, Request request)`
  Returns a definition specifying its name.
  `Definition`
  TilesContainerWrapper.`getDefinition(String definitionName, Request request)`
  Methods in org.apache.tiles.api with parameters of type Definition
  Modifier and Type
  Method
  Description
  `void`
  TilesContainer.`render(Definition definition, Request request)`
  Renders the specified definition.
  `void`
  TilesContainerWrapper.`render(Definition definition, Request request)`
  Constructors in org.apache.tiles.api with parameters of type Definition
  Modifier
  Constructor
  Description
  ``
  `Definition(Definition definition)`
  Copy Constructor.

- ## Uses of Definition in org.apache.tiles.api.mgmt

  Methods in org.apache.tiles.api.mgmt with parameters of type Definition
  Modifier and Type
  Method
  Description
  `void`
  MutableTilesContainer.`register(Definition definition, Request request)`
  Register a new definition with the container.

- ## Uses of Definition in org.apache.tiles.core.definition

  Methods in org.apache.tiles.core.definition that return Definition
  Modifier and Type
  Method
  Description
  `Definition`
  DefinitionsFactory.`getDefinition(String name, Request tilesContext)`
  Returns a Definition object that matches the given name and Tiles context.
  `Definition`
  UnresolvingLocaleDefinitionsFactory.`getDefinition(String name, Request tilesContext)`
  Returns a Definition object that matches the given name and Tiles context.
  Methods in org.apache.tiles.core.definition that return types with arguments of type Definition
  Modifier and Type
  Method
  Description
  `Map<String,Definition>`
  DefinitionsReader.`read(Object source)`
  Reads ``Definition`` objects from a source.

- ## Uses of Definition in org.apache.tiles.core.definition.dao

  Fields in org.apache.tiles.core.definition.dao with type parameters of type Definition
  Modifier and Type
  Field
  Description
  `protected Map<Locale,Map<String,Definition>>`
  CachingLocaleUrlDefinitionDAO.`locale2definitionMap`
  The locale-specific set of definitions objects.
  Methods in org.apache.tiles.core.definition.dao that return Definition
  Modifier and Type
  Method
  Description
  `Definition`
  CachingLocaleUrlDefinitionDAO.`getDefinition(String name, Locale customizationKey)`
  Returns a definition, given its name and the customization key.
  `Definition`
  DefinitionDAO.`getDefinition(String name, K customizationKey)`
  Returns a definition, given its name and the customization key.
  `protected Definition`
  CachingLocaleUrlDefinitionDAO.`getDefinitionFromResolver(String name, Locale customizationKey)`
  Returns a definition from the definition resolver.
  `protected Definition`
  ResolvingLocaleUrlDefinitionDAO.`getDefinitionFromResolver(String name, Locale customizationKey)`
  Returns a definition from the definition resolver.
  Methods in org.apache.tiles.core.definition.dao that return types with arguments of type Definition
  Modifier and Type
  Method
  Description
  `protected Map<String,Definition>`
  CachingLocaleUrlDefinitionDAO.`checkAndloadDefinitions(Locale customizationKey)`
  Checks if sources have changed.
  `protected Map<String,Definition>`
  CachingLocaleUrlDefinitionDAO.`copyDefinitionMap(Map<String,Definition> localeDefsMap)`
  Copies the definition map to be passed to a higher level of customization key.
  `protected Map<String,Definition>`
  ResolvingLocaleUrlDefinitionDAO.`copyDefinitionMap(Map<String,Definition> localeDefsMap)`
  Copies the definition map to be passed to a higher level of customization key.
  `Map<String,Definition>`
  CachingLocaleUrlDefinitionDAO.`getDefinitions(Locale customizationKey)`
  Returns all the definitions used of a customization key.
  `Map<String,Definition>`
  DefinitionDAO.`getDefinitions(K customizationKey)`
  Returns all the definitions used of a customization key.
  `protected Map<String,Definition>`
  CachingLocaleUrlDefinitionDAO.`loadDefinitions(Locale customizationKey)`
  Tries to load definitions if necessary.
  `protected Map<String,Definition>`
  ResolvingLocaleUrlDefinitionDAO.`loadDefinitions(Locale customizationKey)`
  `protected Map<String,Definition>`
  BaseLocaleUrlDefinitionDAO.`loadDefinitionsFromResource(ApplicationResource resource)`
  Loads definitions from an URL without loading from "parent" URLs.
  `protected Map<String,Definition>`
  CachingLocaleUrlDefinitionDAO.`loadDefinitionsFromResources(Locale customizationKey)`
  Loads definitions from the sources.
  `protected Map<String,Definition>`
  CachingLocaleUrlDefinitionDAO.`loadParentDefinitions(Locale parentLocale)`
  Loads parent definitions, i.e.
  `protected Map<String,Definition>`
  ResolvingLocaleUrlDefinitionDAO.`loadParentDefinitions(Locale parentLocale)`
  Loads parent definitions, i.e.
  `protected Map<String,Definition>`
  CachingLocaleUrlDefinitionDAO.`loadRawDefinitionsFromResources(Locale customizationKey)`
  Loads the raw definitions from the sources associated with a locale.
  Methods in org.apache.tiles.core.definition.dao with parameters of type Definition
  Modifier and Type
  Method
  Description
  `protected void`
  ResolvingLocaleUrlDefinitionDAO.`resolveInheritance(Definition definition, Map<String,Definition> definitions, Locale locale, Set<String> alreadyResolvedDefinitions)`
  Resolve locale-specific inheritance.
  Method parameters in org.apache.tiles.core.definition.dao with type arguments of type Definition
  Modifier and Type
  Method
  Description
  `protected Map<String,Definition>`
  CachingLocaleUrlDefinitionDAO.`copyDefinitionMap(Map<String,Definition> localeDefsMap)`
  Copies the definition map to be passed to a higher level of customization key.
  `protected Map<String,Definition>`
  ResolvingLocaleUrlDefinitionDAO.`copyDefinitionMap(Map<String,Definition> localeDefsMap)`
  Copies the definition map to be passed to a higher level of customization key.
  `protected void`
  ResolvingLocaleUrlDefinitionDAO.`resolveInheritance(Definition definition, Map<String,Definition> definitions, Locale locale, Set<String> alreadyResolvedDefinitions)`
  Resolve locale-specific inheritance.
  `protected void`
  ResolvingLocaleUrlDefinitionDAO.`resolveInheritances(Map<String,Definition> map, Locale locale)`
  Resolve locale-specific extended instances.

- ## Uses of Definition in org.apache.tiles.core.definition.digester

  Fields in org.apache.tiles.core.definition.digester with type parameters of type Definition
  Modifier and Type
  Field
  Description
  `protected Map<String,Definition>`
  DigesterDefinitionsReader.`definitions`
  Stores Definition objects.
  Methods in org.apache.tiles.core.definition.digester that return types with arguments of type Definition
  Modifier and Type
  Method
  Description
  `Map<String,Definition>`
  DigesterDefinitionsReader.`read(Object source)`
  Reads ``Definition`` objects from a source.
  Methods in org.apache.tiles.core.definition.digester with parameters of type Definition
  Modifier and Type
  Method
  Description
  `void`
  DigesterDefinitionsReader.`addDefinition(Definition definition)`
  Adds a new `Definition` to the internal Map or replaces an existing one.

- ## Uses of Definition in org.apache.tiles.core.definition.pattern

  Methods in org.apache.tiles.core.definition.pattern that return Definition
  Modifier and Type
  Method
  Description
  `Definition`
  DefinitionPatternMatcher.`createDefinition(String definitionName)`
  Creates a definition, given the definition name, through the use of pattern matching.
  `static Definition`
  PatternUtil.`replacePlaceholders(Definition d, String name, Object... varsOrig)`
  Creates a definition given its representation with wildcards and attribute values with placeholders, replacing real values into placeholders.
  `Definition`
  AbstractPatternDefinitionResolver.`resolveDefinition(String name, T customizationKey)`
  Resolves a definition searching in all patterns for the requested customization key.
  `Definition`
  PatternDefinitionResolver.`resolveDefinition(String name, T customizationKey)`
  Resolves a definition searching in all patterns for the requested customization key.
  Methods in org.apache.tiles.core.definition.pattern that return types with arguments of type Definition
  Modifier and Type
  Method
  Description
  `protected abstract Map<String,Definition>`
  AbstractPatternDefinitionResolver.`addDefinitionsAsPatternMatchers(List<DefinitionPatternMatcher> matchers, Map<String,Definition> defsMap)`
  Adds definitions, filtering and adding them to the list of definition pattern matchers.
  `protected Map<String,Definition>`
  BasicPatternDefinitionResolver.`addDefinitionsAsPatternMatchers(List<DefinitionPatternMatcher> matchers, Map<String,Definition> defsMap)`
  Adds definitions, filtering and adding them to the list of definition pattern matchers.
  `protected Map<String,Definition>`
  PrefixedPatternDefinitionResolver.`addDefinitionsAsPatternMatchers(List<DefinitionPatternMatcher> matchers, Map<String,Definition> defsMap)`
  Adds definitions, filtering and adding them to the list of definition pattern matchers.
  `Map<String,Definition>`
  AbstractPatternDefinitionResolver.`storeDefinitionPatterns(Map<String,Definition> localeDefsMap, T customizationKey)`
  Stores definition patterns.
  `Map<String,Definition>`
  PatternDefinitionResolver.`storeDefinitionPatterns(Map<String,Definition> localeDefsMap, T customizationKey)`
  Stores definition patterns.
  Methods in org.apache.tiles.core.definition.pattern with parameters of type Definition
  Modifier and Type
  Method
  Description
  `DefinitionPatternMatcher`
  DefinitionPatternMatcherFactory.`createDefinitionPatternMatcher(String pattern, Definition definition)`
  Creates a new definition pattern matcher.
  `static Definition`
  PatternUtil.`replacePlaceholders(Definition d, String name, Object... varsOrig)`
  Creates a definition given its representation with wildcards and attribute values with placeholders, replacing real values into placeholders.
  Method parameters in org.apache.tiles.core.definition.pattern with type arguments of type Definition
  Modifier and Type
  Method
  Description
  `protected abstract Map<String,Definition>`
  AbstractPatternDefinitionResolver.`addDefinitionsAsPatternMatchers(List<DefinitionPatternMatcher> matchers, Map<String,Definition> defsMap)`
  Adds definitions, filtering and adding them to the list of definition pattern matchers.
  `protected Map<String,Definition>`
  BasicPatternDefinitionResolver.`addDefinitionsAsPatternMatchers(List<DefinitionPatternMatcher> matchers, Map<String,Definition> defsMap)`
  Adds definitions, filtering and adding them to the list of definition pattern matchers.
  `protected Map<String,Definition>`
  PrefixedPatternDefinitionResolver.`addDefinitionsAsPatternMatchers(List<DefinitionPatternMatcher> matchers, Map<String,Definition> defsMap)`
  Adds definitions, filtering and adding them to the list of definition pattern matchers.
  `Map<String,Definition>`
  AbstractPatternDefinitionResolver.`storeDefinitionPatterns(Map<String,Definition> localeDefsMap, T customizationKey)`
  Stores definition patterns.
  `Map<String,Definition>`
  PatternDefinitionResolver.`storeDefinitionPatterns(Map<String,Definition> localeDefsMap, T customizationKey)`
  Stores definition patterns.

- ## Uses of Definition in org.apache.tiles.core.definition.pattern.regexp

  Methods in org.apache.tiles.core.definition.pattern.regexp that return Definition
  Modifier and Type
  Method
  Description
  `Definition`
  RegexpDefinitionPatternMatcher.`createDefinition(String definitionName)`
  Creates a definition, given the definition name, through the use of pattern matching.
  Methods in org.apache.tiles.core.definition.pattern.regexp with parameters of type Definition
  Modifier and Type
  Method
  Description
  `DefinitionPatternMatcher`
  RegexpDefinitionPatternMatcherFactory.`createDefinitionPatternMatcher(String pattern, Definition definition)`
  Creates a new definition pattern matcher.
  Constructors in org.apache.tiles.core.definition.pattern.regexp with parameters of type Definition
  Modifier
  Constructor
  Description
  ``
  `RegexpDefinitionPatternMatcher(String pattern, Definition definition)`
  Constructor.

- ## Uses of Definition in org.apache.tiles.core.definition.pattern.wildcard

  Methods in org.apache.tiles.core.definition.pattern.wildcard that return Definition
  Modifier and Type
  Method
  Description
  `Definition`
  WildcardDefinitionPatternMatcher.`createDefinition(String definitionName)`
  Creates a definition, given the definition name, through the use of pattern matching.
  Methods in org.apache.tiles.core.definition.pattern.wildcard with parameters of type Definition
  Modifier and Type
  Method
  Description
  `DefinitionPatternMatcher`
  WildcardDefinitionPatternMatcherFactory.`createDefinitionPatternMatcher(String pattern, Definition definition)`
  Creates a new definition pattern matcher.
  Constructors in org.apache.tiles.core.definition.pattern.wildcard with parameters of type Definition
  Modifier
  Constructor
  Description
  ``
  `WildcardDefinitionPatternMatcher(String pattern, Definition definition, WildcardHelper wildcardHelper)`
  Constructor.

- ## Uses of Definition in org.apache.tiles.core.impl

  Methods in org.apache.tiles.core.impl that return Definition
  Modifier and Type
  Method
  Description
  `Definition`
  BasicTilesContainer.`getDefinition(String definitionName, Request request)`
  Returns a definition specifying its name.
  Methods in org.apache.tiles.core.impl with parameters of type Definition
  Modifier and Type
  Method
  Description
  `void`
  BasicTilesContainer.`render(Definition definition, Request request)`
  Renders the specified definition.

- ## Uses of Definition in org.apache.tiles.core.impl.mgmt

  Methods in org.apache.tiles.core.impl.mgmt that return Definition
  Modifier and Type
  Method
  Description
  `Definition`
  CachingTilesContainer.`getDefinition(String definition, Request request)`
  Returns a definition by name.
  Methods in org.apache.tiles.core.impl.mgmt with parameters of type Definition
  Modifier and Type
  Method
  Description
  `void`
  CachingTilesContainer.`register(Definition definition, Request request)`
  Register a new definition with the container.