Package org.apache.commons.lang3
Class ClassPathUtils
java.lang.Object
org.apache.commons.lang3.ClassPathUtils
Operations regarding the classpath.
The methods of this class do not allow null inputs.
- Since:
- 3.3
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic StringpackageToPath(String path) Converts a package name to a Java path ('/').static StringpathToPackage(String path) Converts a Java path ('/') to a package name.static StringtoFullyQualifiedName(Class<?> context, String resourceName) Returns the fully qualified name for the resource with nameresourceNamerelative to the given context.static StringtoFullyQualifiedName(Package context, String resourceName) Returns the fully qualified name for the resource with nameresourceNamerelative to the given context.static StringtoFullyQualifiedPath(Class<?> context, String resourceName) Returns the fully qualified path for the resource with nameresourceNamerelative to the given context.static StringtoFullyQualifiedPath(Package context, String resourceName) Returns the fully qualified path for the resource with nameresourceNamerelative to the given context.
-
Constructor Details
-
ClassPathUtils
public ClassPathUtils()ClassPathUtilsinstances should NOT be constructed in standard programming. Instead, the class should be used asClassPathUtils.toFullyQualifiedName(MyClass.class, "MyClass.properties");.This constructor is public to permit tools that require a JavaBean instance to operate.
-
-
Method Details
-
packageToPath
Converts a package name to a Java path ('/').- Parameters:
path- the source path.- Returns:
- a package name.
- Throws:
NullPointerException- ifpathis null.- Since:
- 3.13.0
-
pathToPackage
Converts a Java path ('/') to a package name.- Parameters:
path- the source path.- Returns:
- a package name.
- Throws:
NullPointerException- ifpathis null.- Since:
- 3.13.0
-
toFullyQualifiedName
Returns the fully qualified name for the resource with nameresourceNamerelative to the given context.Note that this method does not check whether the resource actually exists. It only constructs the name. Null inputs are not allowed.
ClassPathUtils.toFullyQualifiedName(StringUtils.class, "StringUtils.properties") = "org.apache.commons.lang3.StringUtils.properties"
- Parameters:
context- The context for constructing the name.resourceName- the resource name to construct the fully qualified name for.- Returns:
- the fully qualified name of the resource with name
resourceName. - Throws:
NullPointerException- if eithercontextorresourceNameis null.
-
toFullyQualifiedName
Returns the fully qualified name for the resource with nameresourceNamerelative to the given context.Note that this method does not check whether the resource actually exists. It only constructs the name. Null inputs are not allowed.
ClassPathUtils.toFullyQualifiedName(StringUtils.class.getPackage(), "StringUtils.properties") = "org.apache.commons.lang3.StringUtils.properties"
- Parameters:
context- The context for constructing the name.resourceName- the resource name to construct the fully qualified name for.- Returns:
- the fully qualified name of the resource with name
resourceName. - Throws:
NullPointerException- if eithercontextorresourceNameis null.
-
toFullyQualifiedPath
Returns the fully qualified path for the resource with nameresourceNamerelative to the given context.Note that this method does not check whether the resource actually exists. It only constructs the path. Null inputs are not allowed.
ClassPathUtils.toFullyQualifiedPath(StringUtils.class, "StringUtils.properties") = "org/apache/commons/lang3/StringUtils.properties"
- Parameters:
context- The context for constructing the path.resourceName- the resource name to construct the fully qualified path for.- Returns:
- the fully qualified path of the resource with name
resourceName. - Throws:
NullPointerException- if eithercontextorresourceNameis null.
-
toFullyQualifiedPath
Returns the fully qualified path for the resource with nameresourceNamerelative to the given context.Note that this method does not check whether the resource actually exists. It only constructs the path. Null inputs are not allowed.
ClassPathUtils.toFullyQualifiedPath(StringUtils.class.getPackage(), "StringUtils.properties") = "org/apache/commons/lang3/StringUtils.properties"
- Parameters:
context- The context for constructing the path.resourceName- the resource name to construct the fully qualified path for.- Returns:
- the fully qualified path of the resource with name
resourceName. - Throws:
NullPointerException- if eithercontextorresourceNameis null.
-