## org.gjt.sp.jedit.bufferio
Class BufferIORequest

    java.lang.Object
      org.gjt.sp.util.WorkRequest
          org.gjt.sp.jedit.bufferio.BufferIORequest

All Implemented Interfaces:
  java.lang.Runnable, ProgressObserver

Direct Known Subclasses:
  BufferAutosaveRequest, BufferInsertRequest, BufferLoadRequest, BufferSaveRequest

    public abstract class BufferIORequest

extends WorkRequest

A buffer I/O request.

Field Summary
`protected Buffer` `buffer`
`static java.lang.String` `END_OFFSETS`
`static java.lang.String` `ERROR_OCCURRED` Buffer boolean property set when an error occurs.
`static int` `GZIP_MAGIC_1` Deprecated.
`static int` `GZIP_MAGIC_2` Deprecated.
`static int` `IOBUFSIZE` Size of I/O buffers.
`static java.lang.String` `LOAD_DATA`
`protected java.lang.String` `markersPath`
`static java.lang.String` `NEW_PATH`
`protected java.lang.String` `path`
`static int` `PROGRESS_INTERVAL` Number of lines per progress increment.
`protected java.lang.Object` `session`
`static int` `UNICODE_MAGIC_1` Deprecated.
`static int` `UNICODE_MAGIC_2` Deprecated.
`static int` `UTF8_MAGIC_1` Deprecated.
`static int` `UTF8_MAGIC_2` Deprecated.
`static int` `UTF8_MAGIC_3` Deprecated.
`protected VFS` `vfs`
`protected View` `view`
`static int` `XML_PI_LENGTH` Deprecated.

Constructor Summary
`protected` `BufferIORequest(View view, Buffer buffer, java.lang.Object session, VFS vfs, java.lang.String path)` Creates a new buffer I/O request.

Method Summary
`protected java.io.Reader` `autodetect(java.io.InputStream in)` Tries to detect if the stream is gzipped, and if it has an encoding specified with an XML PI.
`static int` `getByteIOBufferSize()` Size of byte I/O buffers.
`static int` `getCharIOBufferSize()` Size of character I/O buffers.
`protected SegmentBuffer` `read(java.io.Reader in, long length, boolean insert)`
`java.lang.String` `toString()`
`protected void` `write(Buffer buffer, java.io.OutputStream out)`

Methods inherited from class org.gjt.sp.util.WorkRequest
`setAbortable, setMaximum, setProgressMaximum, setProgressValue, setStatus, setValue`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Methods inherited from interface java.lang.Runnable
`run`

Field Detail

### IOBUFSIZE

    public static final int IOBUFSIZE

  Size of I/O buffers.

  See Also:
    Constant Field Values

### PROGRESS_INTERVAL

    public static final int PROGRESS_INTERVAL

  Number of lines per progress increment.

  See Also:
    Constant Field Values

### LOAD_DATA

    public static final java.lang.String LOAD_DATA

See Also:
  Constant Field Values

### END_OFFSETS

    public static final java.lang.String END_OFFSETS

See Also:
  Constant Field Values

### NEW_PATH

    public static final java.lang.String NEW_PATH

See Also:
  Constant Field Values

### ERROR_OCCURRED

    public static final java.lang.String ERROR_OCCURRED

  Buffer boolean property set when an error occurs.

  See Also:
    Constant Field Values

### UTF8_MAGIC_1

    @Deprecated
    public static final int UTF8_MAGIC_1

  Deprecated.
  See Also:
    Constant Field Values

### UTF8_MAGIC_2

    @Deprecated
    public static final int UTF8_MAGIC_2

  Deprecated.
  See Also:
    Constant Field Values

### UTF8_MAGIC_3

    @Deprecated
    public static final int UTF8_MAGIC_3

  Deprecated.
  See Also:
    Constant Field Values

### UNICODE_MAGIC_1

    @Deprecated
    public static final int UNICODE_MAGIC_1

  Deprecated.
  See Also:
    Constant Field Values

### UNICODE_MAGIC_2

    @Deprecated
    public static final int UNICODE_MAGIC_2

  Deprecated.
  See Also:
    Constant Field Values

### XML_PI_LENGTH

    @Deprecated
    public static final int XML_PI_LENGTH

  Deprecated.
  See Also:
    Constant Field Values

### GZIP_MAGIC_1

    @Deprecated
    public static final int GZIP_MAGIC_1

  Deprecated.
  See Also:
    Constant Field Values

### GZIP_MAGIC_2

    @Deprecated
    public static final int GZIP_MAGIC_2

  Deprecated.
  See Also:
    Constant Field Values

### view

    protected final View view

### buffer

    protected final Buffer buffer

### session

    protected final java.lang.Object session

### vfs

    protected final VFS vfs

### path

    protected java.lang.String path

### markersPath

    protected final java.lang.String markersPath

Constructor Detail

### BufferIORequest

    protected BufferIORequest(View view,
                              Buffer buffer,
                              java.lang.Object session,
                              VFS vfs,
                              java.lang.String path)

  Creates a new buffer I/O request.

  Parameters:
    `view` - The view
    `buffer` - The buffer
    `session` - The VFS session
    `vfs` - The VFS
    `path` - The path

Method Detail

### toString

    public java.lang.String toString()

  Overrides:
    `toString` in class `java.lang.Object`

### getCharIOBufferSize

    public static int getCharIOBufferSize()

  Size of character I/O buffers.

### getByteIOBufferSize

    public static int getByteIOBufferSize()

  Size of byte I/O buffers.

### autodetect

    protected java.io.Reader autodetect(java.io.InputStream in)
                                 throws java.io.IOException

  Tries to detect if the stream is gzipped, and if it has an encoding specified with an XML PI.

  Throws:
    `java.io.IOException`

### read

    protected SegmentBuffer read(java.io.Reader in,
                                 long length,
                                 boolean insert)
                          throws java.io.IOException

  Throws:
    `java.io.IOException`

### write

    protected void write(Buffer buffer,
                         java.io.OutputStream out)
                  throws java.io.IOException

  Throws:
    `java.io.IOException`