|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jst.jsf.core.jsfappconfig.JSFAppConfigUtils
public class JSFAppConfigUtils
JSFAppConfigUtils provides utility methods useful in processing of a JSF application configuration.
Provisional API - subject to change
Field Summary | |
---|---|
static java.lang.String |
CONFIG_FILES_CONTEXT_PARAM_NAME
Name of JSF CONFIG_FILES context parameter ("javax.faces.CONFIG_FILES"). |
static java.lang.String |
FACES_CONFIG_IN_JAR_PATH
Location in JAR file of application configuration resource file ("META-INF/faces-config.xml"). |
Constructor Summary | |
---|---|
JSFAppConfigUtils()
|
Method Summary | |
---|---|
static java.util.List |
getConfigFileJARsFromClasspath(org.eclipse.core.resources.IProject project)
Gets list of JAR file names, where each file name represents a JAR on the classpath that contains a /META-INF/faces-config.xml entry. |
static java.util.List |
getConfigFilesFromContextParam(org.eclipse.core.resources.IProject project)
Gets list of application configuration file names as listed in the JSF CONFIG_FILES context parameter ("javax.faces.CONFIG_FILES"). |
static org.eclipse.wst.common.project.facet.core.IProjectFacetVersion |
getProjectFacet(org.eclipse.core.resources.IProject project)
Get the facet version for the project |
static org.eclipse.wst.common.componentcore.resources.IVirtualFolder |
getWebContentFolder(org.eclipse.core.resources.IProject project)
Gets an IVirtualFolder instance which represents the root context's web content folder. |
static org.eclipse.core.runtime.IPath |
getWebContentFolderRelativePath(org.eclipse.core.resources.IFile file)
Gets an IPath instance representing the path of the passed IFile instance relative to the web content folder. |
static boolean |
isValidJSFProject(org.eclipse.core.resources.IProject project)
Tests if the passed IProject instance is a valid JSF project in the following ways: project is not null and is accessible, project has the JSF facet set on it. |
static boolean |
isValidJSFProject(org.eclipse.core.resources.IProject project,
java.lang.String minVersion)
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String CONFIG_FILES_CONTEXT_PARAM_NAME
public static final java.lang.String FACES_CONFIG_IN_JAR_PATH
Constructor Detail |
---|
public JSFAppConfigUtils()
Method Detail |
---|
public static boolean isValidJSFProject(org.eclipse.core.resources.IProject project, java.lang.String minVersion)
project
- minVersion
-
public static boolean isValidJSFProject(org.eclipse.core.resources.IProject project)
project
- IProject instance to be tested.
public static org.eclipse.wst.common.project.facet.core.IProjectFacetVersion getProjectFacet(org.eclipse.core.resources.IProject project)
project
-
public static org.eclipse.wst.common.componentcore.resources.IVirtualFolder getWebContentFolder(org.eclipse.core.resources.IProject project)
project
- IProject instance for which to get the folder.
public static org.eclipse.core.runtime.IPath getWebContentFolderRelativePath(org.eclipse.core.resources.IFile file)
file
- IFile instance for which a path is required.
public static java.util.List getConfigFilesFromContextParam(org.eclipse.core.resources.IProject project)
project
- IProject instance for which to get the context
parameter's value.
public static java.util.List getConfigFileJARsFromClasspath(org.eclipse.core.resources.IProject project) throws org.eclipse.core.runtime.CoreException, java.io.IOException
project
- IProject instance for which to scan the classpath.
org.eclipse.core.runtime.CoreException
- Thrown when underlying calls into JavaCore fail.
java.io.IOException
- Thrown when attempt to open JAR to determine if it
contains a /META-INF/faces-config.xml entry fails.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |