ComponentClassResolverImpl (Tapestry API

java.lang.Object
- org.apache.tapestry5.internal.services.ComponentClassResolverImpl

All Implemented Interfaces:: ComponentClassResolver, InvalidationListener

public class ComponentClassResolverImpl
extends Object
implements ComponentClassResolver, InvalidationListener

Constructor Summary

Constructors
Constructor and Description
`ComponentClassResolverImpl(org.slf4j.Logger logger, ClassNameLocator classNameLocator, String startPageName, Collection<LibraryMapping> mappings)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`canonicalizePageName(String pageName)` Returns the canonical form of a page name.
`List<String>`	`getComponentNames()` Returns a list of all component names, in sorted order.
`Map<String,ControlledPackageType>`	`getControlledPackageMapping()` Used to identify which packages are controlled packages (from which components are loaded).
`Map<String,String>`	`getFolderToPackageMapping()` A mapping from virtual folder name to a package name (used for converting classpath `Asset`s to client URLs).
`Collection<LibraryMapping>`	`getLibraryMappings()` Returns the library mappings.
`String`	`getLibraryNameForClass(String className)` Given a class name of a component class, returns the library name (as defined by a contributed library name).
`List<String>`	`getLibraryNames()` Returns the names of all libraries (as configured).
`List<String>`	`getMixinNames()` Returns a list of all mixin names, in sorted order.
`List<String>`	`getPageNames()` Returns a list of all page names, in sorted order.
`boolean`	`isPage(String pageClassName)` Returns true if the class name is specifically a page class, and not a component, mixin or base class.
`boolean`	`isPageName(String pageName)` For a particular path, determines if the path is a logical page name.
`void`	`objectWasInvalidated()` When the class loader is invalidated, clear any cached page names or component types.
`String`	`resolveComponentTypeToClassName(String componentType)` Converts a component type (a logical component name such as might be used inside a template or annotation) into a fully qualified class name.
`String`	`resolveMixinTypeToClassName(String mixinType)` Converts a logical mixin type (as with component types) into a fully qualified class name.
`String`	`resolvePageClassNameToPageName(String pageClassName)` Converts a fully qualified page class name into a page name (often, for inclusion as part of the URI).
`String`	`resolvePageNameToClassName(String pageName)` Converts a logical page name (such as might be encoded into a URL) into a fully qualified class name.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ComponentClassResolverImpl
```
public ComponentClassResolverImpl(org.slf4j.Logger logger,
                                  ClassNameLocator classNameLocator,
                                  @Symbol(value="tapestry.start-page-name")
                                  String startPageName,
                                  Collection<LibraryMapping> mappings)
```
- Method Detail
  - getControlledPackageMapping
```
public Map<String,ControlledPackageType> getControlledPackageMapping()
```
    Description copied from interface: ComponentClassResolver
    
    Used to identify which packages are controlled packages (from which components are loaded). Future expansion may allow for additional packages which are live reloaded but not components (or perhaps are transformed, but not as components).
    
    Specified by:
    
    getControlledPackageMapping in interface ComponentClassResolver
    
    Returns:
    
    a mapping from package name to ControlledPackageType.
  - objectWasInvalidated
```
public void objectWasInvalidated()
```
    When the class loader is invalidated, clear any cached page names or component types.
    
    Specified by:
    
    objectWasInvalidated in interface InvalidationListener
  - resolvePageNameToClassName
```
public String resolvePageNameToClassName(String pageName)
```
    Description copied from interface: ComponentClassResolver
    
    Converts a logical page name (such as might be encoded into a URL) into a fully qualified class name. The case of the page name is irrelevant.
    
    Specified by:
    
    resolvePageNameToClassName in interface ComponentClassResolver
    
    Parameters:
    
    pageName - page name
    
    Returns:
    
    fully qualified class name for the page
  - isPageName
```
public boolean isPageName(String pageName)
```
    Description copied from interface: ComponentClassResolver
    
    For a particular path, determines if the path is a logical page name. The check is case insensitive.
    
    Specified by:
    
    isPageName in interface ComponentClassResolver
    
    Parameters:
    
    pageName - potential logical page name
    
    Returns:
    
    true if the page name is valid
  - isPage
```
public boolean isPage(String pageClassName)
```
    Description copied from interface: ComponentClassResolver
    
    Returns true if the class name is specifically a page class, and not a component, mixin or base class.
    
    Specified by:
    
    isPage in interface ComponentClassResolver
    
    Returns:
    
    true if a page class
  - getPageNames
```
public List<String> getPageNames()
```
    Description copied from interface: ComponentClassResolver
    
    Returns a list of all page names, in sorted order. These are the "canonical" page names.
    
    Specified by:
    
    getPageNames in interface ComponentClassResolver
  - getComponentNames
```
public List<String> getComponentNames()
```
    Description copied from interface: ComponentClassResolver
    
    Returns a list of all component names, in sorted order. These are the "canonical" component names.
    
    Specified by:
    
    getComponentNames in interface ComponentClassResolver
  - getMixinNames
```
public List<String> getMixinNames()
```
    Description copied from interface: ComponentClassResolver
    
    Returns a list of all mixin names, in sorted order. These are the "canonical" mixin names.
    
    Specified by:
    
    getMixinNames in interface ComponentClassResolver
  - resolveComponentTypeToClassName
```
public String resolveComponentTypeToClassName(String componentType)
```
    Description copied from interface: ComponentClassResolver
    
    Converts a component type (a logical component name such as might be used inside a template or annotation) into a fully qualified class name. Case is ignored in resolving the name.
    
    Specified by:
    
    resolveComponentTypeToClassName in interface ComponentClassResolver
    
    Parameters:
    
    componentType - a logical component type
    
    Returns:
    
    fully qualified class name
  - resolveMixinTypeToClassName
```
public String resolveMixinTypeToClassName(String mixinType)
```
    Description copied from interface: ComponentClassResolver
    
    Converts a logical mixin type (as with component types) into a fully qualified class name. Case is ignored when resolving the name.
    
    Specified by:
    
    resolveMixinTypeToClassName in interface ComponentClassResolver
    
    Parameters:
    
    mixinType - a logical mixin type
    
    Returns:
    
    fully qualified class name
  - resolvePageClassNameToPageName
```
public String resolvePageClassNameToPageName(String pageClassName)
```
    Description copied from interface: ComponentClassResolver
    
    Converts a fully qualified page class name into a page name (often, for inclusion as part of the URI). This value may later be passed to ComponentClassResolver.resolvePageNameToClassName(String).
    
    Specified by:
    
    resolvePageClassNameToPageName in interface ComponentClassResolver
    
    Parameters:
    
    pageClassName - fully qualified name of a page class
    
    Returns:
    
    equivalent logical page name
  - canonicalizePageName
```
public String canonicalizePageName(String pageName)
```
    Description copied from interface: ComponentClassResolver
    
    Returns the canonical form of a page name. The canonical form uses character case matching the underlying class name.
    
    Specified by:
    
    canonicalizePageName in interface ComponentClassResolver
  - getFolderToPackageMapping
```
public Map<String,String> getFolderToPackageMapping()
```
    Description copied from interface: ComponentClassResolver
    
    A mapping from virtual folder name to a package name (used for converting classpath Assets to client URLs). This is derived from the contributed LibraryMappings. It is allowed to contribute multiple root packages as a single folder name. In this case, the best common package name is used. For example, if both com.example.main and com.example.extras is mapped to folder "example", then the package mapping for "example" will be com.example.
    
    Specified by:
    
    getFolderToPackageMapping in interface ComponentClassResolver
    
    See Also:
    
    ClasspathAssetAliasManager
  - getLibraryNames
```
public List<String> getLibraryNames()
```
    Description copied from interface: ComponentClassResolver
    
    Returns the names of all libraries (as configured). This does not include the application itself (which is a library with the virtual path of empty string).
    
    Specified by:
    
    getLibraryNames in interface ComponentClassResolver
    
    Returns:
    
    sorted names of libraries
  - getLibraryNameForClass
```
public String getLibraryNameForClass(String className)
```
    Description copied from interface: ComponentClassResolver
    
    Given a class name of a component class, returns the library name (as defined by a contributed library name).
    
    Specified by:
    
    getLibraryNameForClass in interface ComponentClassResolver
    
    Returns:
    
    library name
  - getLibraryMappings
```
public Collection<LibraryMapping> getLibraryMappings()
```
    Description copied from interface: ComponentClassResolver
    
    Returns the library mappings.
    
    Specified by:
    
    getLibraryMappings in interface ComponentClassResolver
    
    Returns:

Class ComponentClassResolverImpl

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ComponentClassResolverImpl

Method Detail

getControlledPackageMapping

objectWasInvalidated

resolvePageNameToClassName

isPageName

isPage

getPageNames

getComponentNames

getMixinNames

resolveComponentTypeToClassName

resolveMixinTypeToClassName

resolvePageClassNameToPageName

canonicalizePageName

getFolderToPackageMapping

getLibraryNames

getLibraryNameForClass

getLibraryMappings