PFBinaryFileReader (MZPlatform Component API)

java.lang.Object
- jp.go.aist.dmrc.platform.beans.io.PFReader
- - jp.go.aist.dmrc.platform.beans.io.PFBinaryFileReader

すべての実装されたインタフェース:

java.io.Serializable, PFComponent, PFXMLSerializable, PFDataCreateEventSource, PFEventSource
```
public class PFBinaryFileReader
extends PFReader
implements PFXMLSerializable
```
ファイルからバイナリデータを読み込むためのコンポーネント。
このコンポーネントからはイベントが発生しない。
openメソッドでファイルを開き、closeメソッドでファイルを閉じるまでの間に、各種readメソッドで任意のバイトデータを読み込むことができる。

関連項目:

直列化された形式

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

コンストラクタ
コンストラクタと説明

PFBinaryFileReader()
デフォルトコンストラクタ

コンストラクタ
コンストラクタと説明
`PFBinaryFileReader()` デフォルトコンストラクタ

メソッドのサマリー

All Methods Instance Methods Concrete Methods
修飾子とタイプ	メソッドと説明
`int`	`available()` ファイルが読み込み可能か取得する
`void`	`close()` ファイルを閉じる
`java.lang.String`	`getComponentName()` コンポーネント名称を取得する。
`boolean`	`isLittleEndian()` 下位ビットが先にバイト列から読み込まれる(リトルエンディアン)かどうかを取得する。
`boolean`	`isOpen()` ファイルを開いているか判定する
`void`	`localeUpdated()` ロケール変更に対応する。
`void`	`mark(int readlimit)` 現在位置を記憶する。
`void`	`open(java.io.File file)` ファイルオブジェクトを指定してファイルを開く
`void`	`open(java.lang.String filename)` ファイル名を指定してファイルを開く
`boolean`	`readBoolean()` 1バイト読み込んでbooleanの値を取得する。
`byte`	`readByte()` 1バイト読み込んでbyteの値を取得する。
`char`	`readChar()` 2バイト読み込んで1文字を取得する。
`double`	`readDouble()` 8バイト読み込んでdoubleの値を取得する。
`float`	`readFloat()` 4バイト読み込んでfloatの値を取得する。
`int`	`readInt()` 4バイト読み込んでintの値を取得する。
`long`	`readLong()` 8バイト読み込んでlongの値を取得する。
`short`	`readShort()` 2バイト読み込んでshortの値を取得する。
`java.lang.String`	`readString(int length)` 指定長の文字列を取得する。
`java.lang.String`	`readStringAsSingleByteChar()` 終端(\0)まで文字列を取得する。
`java.lang.String`	`readStringAsSingleByteChar(int length)` 指定長の文字列を取得する。
`int`	`readUnsignedByte()` 1バイト読み込んでunsigned byteの値を取得する。
`int`	`readUnsignedShort()` 2バイト読み込んで0から65535の範囲の値を取得する。
`void`	`readXML(PFXMLLoader in)` コンポーネントのXML入力.
`void`	`reset()` 最後に記憶した位置に戻る。
`void`	`setLittleEndian(boolean flag)` 下位ビットが先にバイト列から読み込まれる(リトルエンディアン)かどうかを設定する。
`int`	`skipBytes(int length)` 指定長のバイト数を無視する。
`void`	`writeXML(PFXMLGenerator out)` コンポーネントのXML出力.

クラスから継承されたメソッド jp.go.aist.dmrc.platform.beans.io.PFReader
addPFDataCreateListener, firePFDataCreated, getComponentID, getComponentKey, getComponentKeys, getComponentPublicName, getComponentString, getCurrentFile, getExceptionIgnoring, getFile, getPFDataCreateListenerList, isAllowPullTransfer, isAllowPushTransfer, isAllowRemoteInvocation, removePFDataCreateListener, setAllowPullTransfer, setAllowPushTransfer, setAllowRemoteInvocation, setComponentID, setComponentKey, setComponentKeys, setComponentPublicName, setExceptionIgnoring, setFile, setFile

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - PFBinaryFileReader
```
public PFBinaryFileReader()
```
    デフォルトコンストラクタ
- メソッドの詳細
  - getComponentName
```
public java.lang.String getComponentName()
```
    コンポーネント名称を取得する。
    
    定義:
    
    getComponentName インタフェース内 PFComponent
    
    戻り値:
    
    コンポーネント名
    
    関連項目:
    
    PFComponent.getComponentName()
  - localeUpdated
```
public void localeUpdated()
```
    ロケール変更に対応する。
    
    定義:
    
    localeUpdated インタフェース内 PFComponent
    
    オーバーライド:
    
    localeUpdated クラス内 PFReader
    
    関連項目:
    
    PFComponent.localeUpdated()
  - readXML
```
public void readXML(PFXMLLoader in)
```
    コンポーネントのXML入力.
    
    定義:
    
    readXML インタフェース内 PFXMLSerializable
    
    パラメータ:
    
    in - XML入力ユーティリティ
  - writeXML
```
public void writeXML(PFXMLGenerator out)
              throws java.io.IOException
```
    コンポーネントのXML出力.
    
    定義:
    
    writeXML インタフェース内 PFXMLSerializable
    
    パラメータ:
    
    out - XML出力ユーティリティ
    
    例外:
    
    java.io.IOException
  - open
```
public void open(java.lang.String filename)
          throws PFComponentException
```
    ファイル名を指定してファイルを開く
    
    パラメータ:
    
    filename - ファイル名
    
    例外:
    
    PFComponentException - ファイルオープンの失敗
  - open
```
public void open(java.io.File file)
          throws PFComponentException
```
    ファイルオブジェクトを指定してファイルを開く
    
    パラメータ:
    
    file - ファイルオブジェクト
    
    例外:
    
    PFComponentException - ファイルオープンの失敗
  - close
```
public void close()
           throws PFComponentException
```
    ファイルを閉じる
    
    例外:
    
    PFComponentException - ファイルクローズの失敗
  - isOpen
```
public boolean isOpen()
```
    ファイルを開いているか判定する
    
    戻り値:
    
    真偽値
  - available
```
public int available()
              throws PFComponentException
```
    ファイルが読み込み可能か取得する
    
    戻り値:
    
    読み込み可能バイト数
    
    例外:
    
    PFComponentException - 失敗
  - isLittleEndian
```
public boolean isLittleEndian()
```
    下位ビットが先にバイト列から読み込まれる(リトルエンディアン)かどうかを取得する。
    
    戻り値:
    
    下位ビットが先かどうかのフラグ
  - setLittleEndian
```
public void setLittleEndian(boolean flag)
```
    下位ビットが先にバイト列から読み込まれる(リトルエンディアン)かどうかを設定する。
    
    パラメータ:
    
    flag - 下位ビットが先かどうかのフラグ
  - readBoolean
```
public boolean readBoolean()
                    throws PFComponentException
```
    1バイト読み込んでbooleanの値を取得する。
    
    戻り値:
    
    booleanの値
    
    例外:
    
    PFComponentException
  - readByte
```
public byte readByte()
              throws PFComponentException
```
    1バイト読み込んでbyteの値を取得する。
    
    戻り値:
    
    byteの値
    
    例外:
    
    PFComponentException
  - readUnsignedByte
```
public int readUnsignedByte()
                     throws PFComponentException
```
    1バイト読み込んでunsigned byteの値を取得する。
    
    戻り値:
    
    unsigned byteの値
    
    例外:
    
    PFComponentException
  - readInt
```
public int readInt()
            throws PFComponentException
```
    4バイト読み込んでintの値を取得する。
    
    戻り値:
    
    intの値
    
    例外:
    
    PFComponentException
  - readLong
```
public long readLong()
              throws PFComponentException
```
    8バイト読み込んでlongの値を取得する。
    
    戻り値:
    
    longの値
    
    例外:
    
    PFComponentException
  - readShort
```
public short readShort()
                throws PFComponentException
```
    2バイト読み込んでshortの値を取得する。
    
    戻り値:
    
    shortの値
    
    例外:
    
    PFComponentException
  - readUnsignedShort
```
public int readUnsignedShort()
                      throws PFComponentException
```
    2バイト読み込んで0から65535の範囲の値を取得する。
    
    戻り値:
    
    unsigned shortの値
    
    例外:
    
    PFComponentException
  - readChar
```
public char readChar()
              throws PFComponentException
```
    2バイト読み込んで1文字を取得する。
    
    戻り値:
    
    文字
    
    例外:
    
    PFComponentException
  - readFloat
```
public float readFloat()
                throws PFComponentException
```
    4バイト読み込んでfloatの値を取得する。
    
    戻り値:
    
    floatの値
    
    例外:
    
    PFComponentException
  - readDouble
```
public double readDouble()
                  throws PFComponentException
```
    8バイト読み込んでdoubleの値を取得する。
    
    戻り値:
    
    floatの値
    
    例外:
    
    PFComponentException
  - readString
```
public java.lang.String readString(int length)
                            throws PFComponentException
```
    指定長の文字列を取得する。 readChar()で2バイトを1文字として読み込む。
    
    パラメータ:
    
    length - 長さ
    
    戻り値:
    
    文字列
    
    例外:
    
    PFComponentException
  - readStringAsSingleByteChar
```
public java.lang.String readStringAsSingleByteChar(int length)
                                            throws PFComponentException
```
    指定長の文字列を取得する。 readByte()の値を1文字として読み込む。
    
    パラメータ:
    
    length - 長さ
    
    戻り値:
    
    文字列
    
    例外:
    
    PFComponentException
  - readStringAsSingleByteChar
```
public java.lang.String readStringAsSingleByteChar()
                                            throws PFComponentException
```
    終端(\0)まで文字列を取得する。 readByte()の値を1文字として読み込む。
    
    戻り値:
    
    文字列
    
    例外:
    
    PFComponentException
  - skipBytes
```
public int skipBytes(int length)
              throws PFComponentException
```
    指定長のバイト数を無視する。
    
    パラメータ:
    
    length - 長さ
    
    戻り値:
    
    実際に無視した長さ
    
    例外:
    
    PFComponentException
  - mark
```
public void mark(int readlimit)
          throws PFComponentException
```
    現在位置を記憶する。
    
    パラメータ:
    
    readlimit - 記憶位置に戻れなくなる限界長さ
    
    例外:
    
    PFComponentException
  - reset
```
public void reset()
           throws PFComponentException
```
    最後に記憶した位置に戻る。
    
    例外:
    
    PFComponentException

クラス PFBinaryFileReader

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

メソッドのサマリー

クラスから継承されたメソッド jp.go.aist.dmrc.platform.beans.io.PFReader

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

コンストラクタの詳細

PFBinaryFileReader

メソッドの詳細

getComponentName

localeUpdated

readXML

writeXML

open

open

close

isOpen

available

isLittleEndian

setLittleEndian

readBoolean

readByte

readUnsignedByte

readInt

readLong

readShort

readUnsignedShort

readChar

readFloat

readDouble

readString

readStringAsSingleByteChar

readStringAsSingleByteChar

skipBytes

mark

reset