Class PathUtils

java.lang.Object

org.opensearch.common.io.PathUtils

public final class PathUtils
extends Object

Utilities for creating a Path from names, or accessing the default FileSystem.

This class allows the default filesystem to be changed during tests.

Opensearch.internal:

Method Summary

Modifier and Type	Method	Description
static Path	get(String first, String... more)	Returns a Path from name components.
static Path	get(URI uri)	Returns a Path from a URI
static Path	get(Path[] roots, String path)	Tries to resolve the given path against the list of available roots.
static Path	get(Path[] roots, URI uri)	Tries to resolve the given file uri against the list of available roots.
static FileSystem	getDefaultFileSystem()	Returns the default FileSystem.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

get

public static Path get(String first,
 String... more)

Returns a Path from name components.

This works just like Paths.get(). Remember: just like Paths.get() this is NOT A STRING CONCATENATION UTILITY FUNCTION.

Remember: this should almost never be used. Usually resolve a path against an existing one!

get

public static Path get(URI uri)

Returns a Path from a URI

This works just like Paths.get().

Remember: this should almost never be used. Usually resolve a path against an existing one!

get

public static Path get(Path[] roots,
 String path)

Tries to resolve the given path against the list of available roots.

If path starts with one of the listed roots, it returned back by this method, otherwise null is returned.

get

public static Path get(Path[] roots,
 URI uri)

Tries to resolve the given file uri against the list of available roots.

If uri starts with one of the listed roots, it returned back by this method, otherwise null is returned.

getDefaultFileSystem

public static FileSystem getDefaultFileSystem()

Returns the default FileSystem.