com.j_phone.io
クラス FileUtility

java.lang.Object
  |
  +--com.j_phone.io.FileUtility

public final class FileUtility
extends java.lang.Object

ファイルに関するユーティリティを提供するクラスです。

ファイルをネイティブアプリケーション、またはメディアプレイヤーで再生するためのメソッドを提供します。

導入されたバージョン:
JSCL1.2

フィールドの概要
static int COUNT_LIMIT
          保存可否:指定フォルダのファイル数制限超過
static int EXISTS
          保存可否:同名ファイルが存在することを示します。
static int FILETYPE_DIFFERENT
          保存可否:ファイルタイプが不正(保存先に指定したフォルダには保存不可など)
static int INSUFFICIENT
          保存可否:空き容量が不足
static int OTHER_ERROR
          保存可否:その他のエラー
static int WRITABLE
          保存可否:保存可能を示します。
static int WRITE_PROTECT
          保存可否:書込禁止
 
メソッドの概要
 int getFreeSpace(java.lang.String rootpath)
          指定先の空き領域を取得します。
static FileUtility getInstance()
          唯一の FileUtility インスタンスを取得します。
 MediaData getMediaData(java.lang.String path)
          メディアデータを取得します。
 MediaData getMediaData(java.lang.String path, int type)
          メディアデータを取得します。
 MediaPlayer getMediaPlayer(java.lang.String path)
          メディアプレイヤーを取得します。
 MediaPlayer getMediaPlayer(java.lang.String path, int type)
          メディアプレイヤーを取得します。
 void play(MailData mailData, int attachedFileIndex)
          メールデータの添付ファイルをネイティブアプリケーションで再生します。
 void play(java.lang.String path)
          ファイルをネイティブアプリケーションで再生します。
 int precheckStorable(java.lang.String path, int size)
          ファイルの保存可否を判定します。
 
クラス java.lang.Object から継承したメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

WRITABLE

public static final int WRITABLE
保存可否:保存可能を示します。

EXISTS

public static final int EXISTS
保存可否:同名ファイルが存在することを示します。

INSUFFICIENT

public static final int INSUFFICIENT
保存可否:空き容量が不足

COUNT_LIMIT

public static final int COUNT_LIMIT
保存可否:指定フォルダのファイル数制限超過

FILETYPE_DIFFERENT

public static final int FILETYPE_DIFFERENT
保存可否:ファイルタイプが不正(保存先に指定したフォルダには保存不可など)

WRITE_PROTECT

public static final int WRITE_PROTECT
保存可否:書込禁止

OTHER_ERROR

public static final int OTHER_ERROR
保存可否:その他のエラー
メソッドの詳細

getInstance

public static FileUtility getInstance()
唯一の FileUtility インスタンスを取得します。 FileUtility クラスのメソッドを使用する場合は、このメソッドでインスタンスを取得して下さい。
戻り値:
FileUtility のインスタンス

play

public void play(java.lang.String path)
          throws java.io.IOException
ファイルをネイティブアプリケーションで再生します。

引数pathに指定されたファイルを、ネイティブアプリケーションによって再生します。 引数pathには、再生するファイルを StorageConnectionインタフェースで定義されているパス名と同じ形式で、 ルートから指定してください。

このメソッドはネイティブアプリケーションがファイルを再生している間、すべてのJavaスレッドをブロックします。 ファイルの再生が終了するとこのメソッドから戻ります。

パラメータ:
path - 再生するファイルのパス名
例外:
NullPointerException - 引数pathにnullが指定された時に発生する
java.io.IOException - 引数pathが指すデータの読み込みに失敗した場合、またはデータがネイティブシステムによってサポートされていない場合に発生する

play

public void play(MailData mailData,
                 int attachedFileIndex)
          throws java.io.IOException
メールデータの添付ファイルをネイティブアプリケーションで再生します。

引数mailDataに添付されたファイルを、ネイティブアプリケーションによって再生します。 このメソッドはネイティブアプリケーションがファイルを再生している間、すべてのJavaスレッドをブロックします。 ファイルの再生が終了するとこのメソッドから戻ります。

引数mailDataには、受信メールボックスまたは送信メールボックスにある既存メールが指定できます。 新規作成したメールデータを指定した場合、添付ファイルは再生されません。

パラメータ:
mailData - 再生する添付ファイルが存在するメールデータ
attachedFileIndex - 再生する添付ファイルの番号(添付ファイルの何番目か)
例外:
NullPointerException - 引数mailDataにnullが指定された時に発生する
java.lang.IllegalArgumentException - 引数attachedFileIndexが添付ファイルの番号に対応していなかった時に発生する
java.io.IOException - 引数mailDataに指定されたデータの読み込みに失敗した場合、またはデータがネイティブシステムによってサポートされていない場合に発生する

getMediaPlayer

public MediaPlayer getMediaPlayer(java.lang.String path)
                           throws java.io.IOException
メディアプレイヤーを取得します。

指定されたファイルを再生するためのメディアプレイヤーを生成します。 引数pathには、再生するファイルを StorageConnectionインタフェースで定義されているパス名と同じ形式で、 ルートから指定してください。

パラメータ:
path - 再生するファイルのパス名
戻り値:
メディアプレイヤー
例外:
NullPointerException - 引数pathにnullが指定された時に発生する
java.io.IOException - 引数pathのデータの読み込みに失敗した場合に発生する
java.lang.RuntimeException - ネイティブプレイヤーの生成に失敗した場合に発生する
関連項目:
MediaPlayer

getMediaPlayer

public MediaPlayer getMediaPlayer(java.lang.String path,
                                  int type)
                           throws java.io.IOException
メディアプレイヤーを取得します。

指定されたファイルを再生するためのメディアプレイヤーを生成します。 引数pathには、再生するファイルを StorageConnectionインタフェースで定義されているパス名と同じ形式で、 ルートから指定してください。 引数typeには MediaFactory で定義されているメディアタイプを指定してください。 メディアデータがSmafデータの場合、引数typeに指定されたメディアプレイヤーを生成します。 引数typeが不正な場合は SmafPlayer を生成します。

パラメータ:
path - 再生するファイルのパス名
type - 取得するMediaPlayerのタイプ
戻り値:
メディアプレイヤー
例外:
NullPointerException - 引数pathにnullが指定された時に発生する
java.io.IOException - 引数pathのデータの読み込みに失敗した場合に発生する
java.lang.RuntimeException - ネイティブプレイヤーの生成に失敗した場合に発生する
導入されたバージョン:
JSCL 1.3.2
関連項目:
MediaPlayer

getMediaData

public MediaData getMediaData(java.lang.String path)
                       throws java.io.IOException
メディアデータを取得します。

指定されたファイルのメディアデータを生成します。 引数pathには、メディアデータに設定するファイルを StorageConnectionインタフェースで定義されているパス名と同じ形式で、 ルートから指定してください。

パラメータ:
path - メディアデータに設定するファイルのパス名
戻り値:
メディアデータ
例外:
NullPointerException - 引数pathにnullが指定された時に発生する
java.io.IOException - 引数pathのデータの読み込みに失敗した場合に発生する
導入されたバージョン:
JSCL 1.3.2
関連項目:
MediaData

getMediaData

public MediaData getMediaData(java.lang.String path,
                              int type)
                       throws java.io.IOException
メディアデータを取得します。

指定されたファイルのメディアデータを生成します。 引数pathには、メディアデータに設定するファイルを StorageConnectionインタフェースで定義されているパス名と同じ形式で、 ルートから指定してください。 引数typeには MediaFactory で定義されているメディアタイプを指定してください。 メディアデータがSmafデータの場合、引数typeに指定されたメディアデータを生成します。 引数typeが不正な場合は SmafData を生成します。

パラメータ:
path - メディアデータに設定するファイルのパス名
type - 取得するMediaDataのタイプ
戻り値:
メディアデータ
例外:
NullPointerException - 引数pathにnullが指定された時に発生する
java.io.IOException - 引数pathのデータの読み込みに失敗した場合に発生する
導入されたバージョン:
JSCL 1.3.2
関連項目:
MediaData

getFreeSpace

public int getFreeSpace(java.lang.String rootpath)
                 throws java.io.IOException
指定先の空き領域を取得します。

指定先は StorageConnection.ROOT_INTERNAL, StorageConnection.ROOT_EXTERNALいずれかです。

パラメータ:
rootpath - ルートパス
戻り値:
指定されたフォルダの空き領域(単位 byte)。検出可能サイズ(2,147,483,647)を超えた場合は -1 が返ります。
例外:
NullPointerException - 引数 rootpath が null の場合に発生する。
java.lang.IllegalArgumentException - 不正な引数の場合に発生する。
java.io.IOException - 指定先へのアクセスエラーの場合に発生する。
導入されたバージョン:
JSCL 1.3.2

precheckStorable

public int precheckStorable(java.lang.String path,
                            int size)
ファイルの保存可否を判定します。

StorageConnectionクラスに準じるパス名の指定を行い、そのファイルが保存可能か判定します。 引数pathには、StorageConnectionインタフェースで定義されているパス名と同じ形式で、 ルートから指定してください。

パラメータ:
path - 保存先のパス
size - 保存サイズ(単位 byte)
戻り値:
保存可否
例外:
NullPointerException - 引数 rootpath が null の場合に発生する。
java.lang.IllegalArgumentException - フォルダを指定、無効な文字を含むなど不正な引数の場合に発生する。
導入されたバージョン:
JSCL 1.3.2