Package org.apache.catalina.util
Class ContextName
- java.lang.Object
-
- org.apache.catalina.util.ContextName
-
public final class ContextName extends Object
Utility class to manage context names so there is one place where the conversions between baseName, path and version take place.
-
-
Constructor Summary
Constructors Constructor Description ContextName(String name, boolean stripFileExtension)
Creates an instance from a context name, display name, base name, directory name, WAR name or context.xml name.ContextName(String path, String version)
Construct an instance from a path and version.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ContextName
extractFromPath(String path)
Extract the final component of the given path which is assumed to be a base name and generate aContextName
from that base name.String
getBaseName()
String
getDisplayName()
String
getName()
String
getPath()
String
getVersion()
String
toString()
-
-
-
Field Detail
-
ROOT_NAME
public static final String ROOT_NAME
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ContextName
public ContextName(String name, boolean stripFileExtension)
Creates an instance from a context name, display name, base name, directory name, WAR name or context.xml name.- Parameters:
name
- The name to use as the basis for this objectstripFileExtension
- If a .war or .xml file extension is present at the end of the provided name should it be removed?
-
-
Method Detail
-
getBaseName
public String getBaseName()
-
getPath
public String getPath()
-
getVersion
public String getVersion()
-
getName
public String getName()
-
getDisplayName
public String getDisplayName()
-
extractFromPath
public static ContextName extractFromPath(String path)
Extract the final component of the given path which is assumed to be a base name and generate aContextName
from that base name.- Parameters:
path
- The path that ends in a base name- Returns:
- the
ContextName
generated from the given base name
-
-