io.scanbot.sdk.util

Class FileUtils

io.scanbot.sdk.util.FileUtils

public class FileUtils

Contains helper methods for working with files and directories

Field Detail

SCANBOT_SDK_FILES_DIR

@NotNull
public static java.lang.String SCANBOT_SDK_FILES_DIR

See Also:

Constant Field Values

INSTANCE

public static FileUtils INSTANCE

Contains helper methods for working with files and directories

Method Detail

isFileNameSafe

@JvmStatic
public static boolean isFileNameSafe(@NotNull
                                                java.lang.CharSequence name)

Returns:

true if filename can be used on filesystem. false otherwise.

getExternalFilesDirOrShowError

@JvmStatic
 @NotNull
public static java.io.File getExternalFilesDirOrShowError(@NotNull
                                                                               android.content.Context context,
                                                                               @Nullable
                                                                               java.lang.String directoryName)

Returns external directory with provided name (creates if needed). On failure shows toast message.

Parameters:

directoryName - name of the directory being created

context -

Returns:

external directory with provided name (creates if needed)

Throws:

IOException - in case if IO failure

getExternalStorageDirOrShowError

@JvmStatic
 @NotNull
public static java.io.File getExternalStorageDirOrShowError(@Nullable
                                                                                 java.lang.String directoryName)

Returns external directory with provided name (creates if needed). On failure shows toast message.

Parameters:

directoryName - name of the directory being created

Returns:

external directory with provided name (creates if needed)

Throws:

IOException - in case if IO failure

getAppFilesDirOrShowError

@JvmStatic
 @NotNull
public static java.io.File getAppFilesDirOrShowError(@NotNull
                                                                          android.content.Context context,
                                                                          @Nullable
                                                                          java.lang.String directoryName)

Returns the application (internal or external) directory with provided name (creates if needed). On failure shows toast message.

Parameters:

directoryName - name of the directory being created

context -

Returns:

internal directory with provided name (creates if needed)

Throws:

IOException - in case if IO failure

getExternalCacheDirOrShowError

@JvmStatic
 @NotNull
public static java.io.File getExternalCacheDirOrShowError(@NotNull
                                                                               android.content.Context context,
                                                                               @Nullable
                                                                               java.lang.String directoryName)

Returns external cache directory with provided name (creates if needed). On failure shows toast message.

Parameters:

directoryName - name of the directory being created

context -

Returns:

external directory with provided name (creates if needed)

Throws:

IOException - in case if IO failure

ensureDirExists

@JvmStatic
public static boolean ensureDirExists(@Nullable
                                                 java.lang.String directoryPath)

Parameters:

directoryPath - path to directory

Returns:

true if directory exists, false - otherwise

getFilesDirOrShowError

@JvmStatic
 @NotNull
public static java.io.File getFilesDirOrShowError(@Nullable
                                                                       java.lang.String parentDirPath,
                                                                       @Nullable
                                                                       java.lang.String directoryName)

Returns directory with provided path (creates if needed). On failure shows toast message.

Parameters:

parentDirPath - path to the parent directory

directoryName - name of the directory being created

Returns:

external directory with provided name (creates if needed)

Throws:

IOException - in case if IO failure