org.deviceconnect.android.provider

クラス FileManager

java.lang.Object

org.deviceconnect.android.provider.FileManager

public class FileManager
extends java.lang.Object

ファイルを管理するためのクラス.

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	クラスと説明
static interface	FileManager.CheckPermissionCallback
static interface	FileManager.RemoveFileCallback
static interface	FileManager.SaveFileCallback

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
FileManager(android.content.Context context) コンストラクタ.
FileManager(android.content.Context context, java.lang.String fileProvider) コンストラクタ.

メソッドのサマリー

修飾子とタイプ	メソッドと説明
boolean	checkAndRemove() 非推奨です。 use FileManager#checkAndRemove(RemoveFileCallback) instead.
boolean	checkAndRemove(java.io.File file) 非推奨です。 use FileManager#checkAndRemove(File, RemoveFileCallback) instead.
void	checkAndRemove(java.io.File file, FileManager.RemoveFileCallback callback) ファイルをチェックして、中身を削除する.
void	checkAndRemove(FileManager.RemoveFileCallback callback) デフォルトのフォルダをチェックして、中身を削除する.
boolean	checkAndRemove(java.lang.String name) 非推奨です。 use FileManager#checkAndRemove(String, RemoveFileCallback) instead.
void	checkAndRemove(java.lang.String name, FileManager.RemoveFileCallback callback) デフォルトのフォルダまたはファイルをチェックして、中身を削除する.
void	checkReadPermission(FileManager.CheckPermissionCallback callback) ファイルシステムへの読み込み権限をチェックし、必要であればユーザに権限のリクエストを行う。
void	checkWritePermission(FileManager.CheckPermissionCallback callback) ファイルシステムへの書き込み権限をチェックし、必要であればユーザに権限のリクエストを行う。
protected void	finalize()
java.io.File	getBasePath() ファイルを管理するためのベースとなるパスを取得する.
java.lang.String	getContentUri() デバイスプラグインのファイルコンテンツへのURIを取得する.
android.content.Context	getContext() コンテキストを取得する.
boolean	removeFile(java.lang.String name) 非推奨です。 use FileManager#removeFile(String, RemoveFileCallback) instead.
void	removeFile(java.lang.String name, FileManager.RemoveFileCallback callback) 指定された名前のファイルを削除する.
java.lang.String	saveFile(java.lang.String filename, byte[] data) 非推奨です。 use FileManager#saveFile(String, byte[], SaveFileCallback) instead.
void	saveFile(java.lang.String filename, byte[] data, boolean forceOverwrite, FileManager.SaveFileCallback callback) ファイルを保存して、アクセスするためのContentURIを返却する.
java.lang.String	saveFile(java.lang.String filename, java.io.InputStream in) 非推奨です。 use FileManager#saveFile(String, InputStream, SaveFileCallback) instead.
void	saveFile(java.lang.String filename, java.io.InputStream in, FileManager.SaveFileCallback callback) ファイルを保存する.
void	setExpire(long expire) 有効期限の期間を指定する.

クラスから継承されたメソッド java.lang.Object

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

コンストラクタの詳細

FileManager

public FileManager(android.content.Context context)

コンストラクタ.

パラメータ:

context - コンテキスト

FileManager

public FileManager(android.content.Context context,
                   java.lang.String fileProvider)

コンストラクタ.

パラメータ:

context - コンテキスト

fileProvider - FileProviderクラス名

メソッドの詳細

finalize

protected void finalize()
                 throws java.lang.Throwable

オーバーライド:

finalize クラス内 java.lang.Object

例外:

java.lang.Throwable

checkWritePermission

public void checkWritePermission(@NonNull
                                 FileManager.CheckPermissionCallback callback)

ファイルシステムへの書き込み権限をチェックし、必要であればユーザに権限のリクエストを行う。

パラメータ:

callback - コールバック

checkReadPermission

public void checkReadPermission(@NonNull
                                FileManager.CheckPermissionCallback callback)

ファイルシステムへの読み込み権限をチェックし、必要であればユーザに権限のリクエストを行う。

パラメータ:

callback - コールバック

getBasePath

public java.io.File getBasePath()

ファイルを管理するためのベースとなるパスを取得する.

戻り値:

パス

getContentUri

public java.lang.String getContentUri()

デバイスプラグインのファイルコンテンツへのURIを取得する.

戻り値:

Content URI

getContext

public final android.content.Context getContext()

コンテキストを取得する.

戻り値:

コンテキスト

saveFile

@Deprecated
public final java.lang.String saveFile(java.lang.String filename,
                                                   byte[] data)
                                            throws java.io.IOException

非推奨です。 use FileManager#saveFile(String, byte[], SaveFileCallback) instead.

ファイルを保存して、アクセスするためのContentURIを返却する. ここで、保存すると返り値にURIが返ってくる。 このURIをFile Profileのuriの値としてDevice Connect Managerに 渡す事で、ファイルのやり取りができるようになる。 TODO 既に同じ名前のファイルが存在する場合の処理を考慮すること。

パラメータ:

filename - ファイル名

data - ファイルデータ

戻り値:

保存したファイルへのURI

例外:

java.io.IOException - ファイルの保存に失敗した場合に発生

saveFile

@Deprecated
public final java.lang.String saveFile(java.lang.String filename,
                                                   java.io.InputStream in)
                                            throws java.io.IOException

非推奨です。 use FileManager#saveFile(String, InputStream, SaveFileCallback) instead.

ファイルを保存する. ここで、保存すると返り値にURIが返ってくる。 このURIをFile Profileのuriの値としてDevice Connect Managerに 渡す事で、ファイルのやり取りができるようになる。

パラメータ:

filename - ファイル名

in - ストリーム

戻り値:

保存したファイルへのURI

例外:

java.io.IOException - ファイルの保存に失敗した場合に発生

saveFile

public final void saveFile(@NonNull
                           java.lang.String filename,
                           @NonNull
                           byte[] data,
                           boolean forceOverwrite,
                           @NonNull
                           FileManager.SaveFileCallback callback)

ファイルを保存して、アクセスするためのContentURIを返却する. ここで、保存すると返り値にURIが返ってくる。 このURIをFile Profileのuriの値としてDevice Connect Managerに 渡す事で、ファイルのやり取りができるようになる。

パラメータ:

filename - ファイル名

data - ファイルデータ

forceOverwrite - 強制上書きフラグ

callback - コールバック

saveFile

public final void saveFile(@NonNull
                           java.lang.String filename,
                           @NonNull
                           java.io.InputStream in,
                           @NonNull
                           FileManager.SaveFileCallback callback)

ファイルを保存する. ここで、保存すると返り値にURIが返ってくる。 このURIをFile Profileのuriの値としてDevice Connect Managerに 渡す事で、ファイルのやり取りができるようになる。

パラメータ:

filename - ファイル名

in - ストリーム

callback - コールバック

setExpire

public final void setExpire(long expire)

有効期限の期間を指定する. デフォルトでは、300000(5分)が設定してある。 あまり長い時間を指定するとキャッシュが消えないので注意が必要。

パラメータ:

expire - 有効期限(ミリ秒)

removeFile

@Deprecated
public boolean removeFile(java.lang.String name)

非推奨です。 use FileManager#removeFile(String, RemoveFileCallback) instead.

指定された名前のファイルを削除する.

パラメータ:

name - 削除するファイル名

戻り値:

ファイルの削除に成功した場合はtrue、それ以外はfalse

removeFile

public void removeFile(@NonNull
                       java.lang.String name,
                       @NonNull
                       FileManager.RemoveFileCallback callback)

指定された名前のファイルを削除する.

パラメータ:

name - 削除するファイル名

checkAndRemove

@Deprecated
public boolean checkAndRemove()

非推奨です。 use FileManager#checkAndRemove(RemoveFileCallback) instead.

デフォルトのフォルダをチェックして、中身を削除する.

戻り値:

削除に成功した場合はtrue、失敗した場合はfalse

checkAndRemove

@Deprecated
public boolean checkAndRemove(java.lang.String name)

非推奨です。 use FileManager#checkAndRemove(String, RemoveFileCallback) instead.

デフォルトのフォルダまたはファイルをチェックして、中身を削除する.

パラメータ:

name - フォルダ名

戻り値:

削除に成功した場合はtrue、失敗した場合はfalse

checkAndRemove

@Deprecated
public boolean checkAndRemove(java.io.File file)

非推奨です。 use FileManager#checkAndRemove(File, RemoveFileCallback) instead.

ファイルをチェックして、中身を削除する.

パラメータ:

file - 削除するファイル

戻り値:

削除に成功した場合はtrue、失敗した場合はfalse

checkAndRemove

public void checkAndRemove(@NonNull
                           FileManager.RemoveFileCallback callback)

デフォルトのフォルダをチェックして、中身を削除する.

パラメータ:

callback - コールバック

checkAndRemove

public void checkAndRemove(@NonNull
                           java.lang.String name,
                           @NonNull
                           FileManager.RemoveFileCallback callback)

デフォルトのフォルダまたはファイルをチェックして、中身を削除する.

パラメータ:

name - フォルダ名

callback - コールバック

checkAndRemove

public void checkAndRemove(@NonNull
                           java.io.File file,
                           @NonNull
                           FileManager.RemoveFileCallback callback)

ファイルをチェックして、中身を削除する.

パラメータ:

file - 削除するファイル

callback - コールバック