com.pega.mobile.filesystem

Enum FileSystemPathResolver

java.lang.Object

java.lang.Enum<FileSystemPathResolver>

com.pega.mobile.filesystem.FileSystemPathResolver

All Implemented Interfaces:

Serializable, Comparable<FileSystemPathResolver>

public enum FileSystemPathResolver
extends Enum<FileSystemPathResolver>

The native path are as follows: PRIVATE FOR USER AND WEBAPP [native_root]/filesystem/user/[username]/private/[webAppID]/localstorage/[relative_path_from_JS_root] PRIVATE FOR USER AND SHARED BETWEEN WEBAPPS [native_root]/filesystem/user/[username]/shared/localstorage/[relative_path_from_JS_root] SHARED BETWEEN USERS BUT PRIVATE FOR WEBAPP [native_root]/filesystem/shared/private/[webAppID]/localstorage/[relative_path_from_JS_root] SHARED BETWEEN USERS AND WEBAPPS [native_root]/filesystem/shared/shared/localstorage/[relative_path_from_JS_root] EXTERNAL [external_root]/[relative_path_from_JS_root] The JS path is as follows: content://contentProviderName/[js_root_type]/[optional hash]/[relative_path_from_JS_root] where js_root_type is one of: persistent, temporary, shared_persistent, shared_temporary, multiuser_persistent, multiuser_temporary, multiuser_shared_persistent, multiuser_shared_temporary, external

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXTERNAL
static String	MULTIUSER_PERSISTENT
static String	MULTIUSER_SHARED_PERSISTENT
static String	MULTIUSER_SHARED_TEMPORARY
static String	MULTIUSER_TEMPORARY
static String	PERSISTENT
static String	SHARED_PERSISTENT
static String	SHARED_TEMPORARY
static String	TEMPORARY

Method Summary

Methods

Modifier and Type	Method and Description
Uri	getJavaScriptPath(Uri nativePath) Converts a native path URL to a JavaScript File API path URI.
Uri	getNativePath(Uri jsPath) Converts a JavaScript File API URL path to a native path URL.
Uri	getNativeRootPath(String jsRootType, String appIdentifier) Returns a native path for a specified JS root type and given application.
Uri	getNativeRootPath(Uri nativePath) Returns a native root path for a specified native path.
boolean	isPathExternal(Uri jsPath) Returns whether the Javascript path points to external storage on the device
static FileSystemPathResolver	valueOf(String name) Returns the enum constant of this type with the specified name.
static FileSystemPathResolver[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final FileSystemPathResolver INSTANCE

Field Detail

PERSISTENT

public static final String PERSISTENT

See Also:

Constant Field Values

TEMPORARY

public static final String TEMPORARY

See Also:

Constant Field Values

EXTERNAL

public static final String EXTERNAL

See Also:

Constant Field Values

MULTIUSER_TEMPORARY

public static final String MULTIUSER_TEMPORARY

See Also:

Constant Field Values

MULTIUSER_PERSISTENT

public static final String MULTIUSER_PERSISTENT

See Also:

Constant Field Values

SHARED_PERSISTENT

public static final String SHARED_PERSISTENT

See Also:

Constant Field Values

SHARED_TEMPORARY

public static final String SHARED_TEMPORARY

See Also:

Constant Field Values

MULTIUSER_SHARED_TEMPORARY

public static final String MULTIUSER_SHARED_TEMPORARY

See Also:

Constant Field Values

MULTIUSER_SHARED_PERSISTENT

public static final String MULTIUSER_SHARED_PERSISTENT

See Also:

Constant Field Values

Method Detail

values

public static FileSystemPathResolver[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FileSystemPathResolver c : FileSystemPathResolver.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FileSystemPathResolver valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getNativeRootPath

public Uri getNativeRootPath(String jsRootType,
                    String appIdentifier)
                      throws Exception

Returns a native path for a specified JS root type and given application.

Parameters:

jsRootType - On of the js root types defined in the class description.

appIdentifier - Web application identifier.

Returns:

A native path for a specified JS root type and given application or null

Throws:

Exception

getNativeRootPath

public Uri getNativeRootPath(Uri nativePath)
                      throws Exception

Returns a native root path for a specified native path.

Parameters:

nativePath - A native URI to be converted.

Returns:

A native root path URI.

Throws:

Exception

getNativePath

public Uri getNativePath(Uri jsPath)
                  throws Exception

Converts a JavaScript File API URL path to a native path URL. Web ContainerApplication and account identifiers are automatically resolved.

Parameters:

jsPath - A JavaScript File API URI to be converted.

Returns:

A native file path URL or null in case of invalid Uri provided.

Throws:

Exception

getJavaScriptPath

public Uri getJavaScriptPath(Uri nativePath)
                      throws Exception

Converts a native path URL to a JavaScript File API path URI. Web ContainerApplication identifier is hidden with a random hash.

Parameters:

nativePath - A native URI to be converted.

Returns:

A JavaScript file path URL or null in case of invalid Uri provided.

Throws:

Exception

isPathExternal

public boolean isPathExternal(Uri jsPath)
                       throws Exception

Returns whether the Javascript path points to external storage on the device

Parameters:

jsPath - A JavaScript File API URI

Returns:

true if points to external storage, false if not

Throws:

Exception