StreamContainer

Inheritance: java.lang.Object, com.aspose.imaging.DisposableObject

All Implemented Interfaces: com.aspose.internal.interfaces.ISynchronizable

public class StreamContainer extends DisposableObject implements ISynchronizable

Представляет контейнер потока, который содержит поток и предоставляет процедуры обработки потока.

Конструкторы

КонструкторОписание
StreamContainer(InputStream stream)Инициализирует новый экземпляр класса StreamContainer.
StreamContainer(System.IO.Stream stream)Инициализирует новый экземпляр класса StreamContainer.
StreamContainer(InputStream stream, boolean disposeStream)Инициализирует новый экземпляр класса StreamContainer.
StreamContainer(System.IO.Stream stream, boolean disposeStream)Инициализирует новый экземпляр класса StreamContainer.

Поля

ПолеОписание
READ_WRITE_BYTES_COUNTУказывает количество байтов для чтения и записи при последовательном чтении.

Методы

МетодОписание
to_Stream(StreamContainer streamContainer)Выполняет явное преобразование из com.aspose.imaging.StreamContainer в System.IO.Stream.
getSyncRoot()Получает объект, который может использоваться для синхронизации доступа к синхронизированному ресурсу.
getPosition()Получает или задает текущую позицию в потоке.
setPosition(long value)Получает или задает текущую позицию в потоке.
getStream()Получает поток данных.
isStreamDisposedOnClose()Получает значение, указывающее, будет ли поток освобожден при закрытии.
getLength()Получает или задает длину потока в байтах.
setLength(long value)Получает или задает длину потока в байтах.
canRead()Получает значение, указывающее, поддерживает ли поток чтение.
canSeek()Получает значение, указывающее, поддерживает ли поток перемещение.
canWrite()Получает значение, указывающее, поддерживает ли поток запись.
flush()Очищает все буферы этого потока и заставляет любые буферизованные данные записаться в базовое устройство.
write(byte[] bytes)Записывает все указанные байты в поток.
writeByte(byte value)Записывает байт в текущую позицию потока и перемещает позицию в потоке на один байт вперёд.
read(byte[] bytes)Читает байты, заполняя указанный буфер байтов.
toBytes()Преобразует данные потока в массив byte.
toBytes(long position, long bytesCount)Преобразует данные потока в массив byte.
read(byte[] buffer, int offset, int count)Читает последовательность байтов из текущего потока и перемещает позицию в потоке на количество прочитанных байтов.
readByte()Читает один байт из потока и перемещает позицию в потоке на один байт, либо возвращает -1, если достигнут конец потока.
seek(long offset, int origin)Устанавливает позицию в текущем потоке.
seekBegin()Устанавливает позицию потока в начало потока.
write(byte[] buffer, int offset, int count)Записывает последовательность байтов в текущий поток и перемещает текущую позицию в этом потоке на количество записанных байтов.
save(OutputStream destinationStream)Сохраняет (копирует) данные потока в указанный поток.
save(OutputStream destinationStream, int bufferSize)Сохраняет (копирует) все данные потока в указанный поток.
save(OutputStream destinationStream, int bufferSize, long length)Сохраняет (копирует) данные потока в указанный поток.
save(String filePath)Сохраняет (копирует) данные потока в указанный поток.
save(String filePath, int bufferSize)Сохраняет (копирует) данные потока в указанный поток.
save(String filePath, int bufferSize, long length)Сохраняет (копирует) данные потока в указанный поток.
writeTo(StreamContainer streamContainer)Копирует содержащиеся данные в другой StreamContainer.
writeTo(StreamContainer streamContainer, long length)Копирует содержащиеся данные в другой StreamContainer.

StreamContainer(InputStream stream)

public StreamContainer(InputStream stream)

Инициализирует новый экземпляр класса StreamContainer.

Parameters:

ПараметрТипОписание
streamjava.io.InputStreamПоток.

StreamContainer(System.IO.Stream stream)

public StreamContainer(System.IO.Stream stream)

Инициализирует новый экземпляр класса StreamContainer.

Parameters:

ПараметрТипОписание
streamcom.aspose.ms.System.IO.StreamПоток.

StreamContainer(InputStream stream, boolean disposeStream)

public StreamContainer(InputStream stream, boolean disposeStream)

Инициализирует новый экземпляр класса StreamContainer.

Parameters:

ПараметрТипОписание
streamjava.io.InputStreamПоток данных.
disposeStreambooleanесли установить в true, поток будет освобождён при освобождении контейнера.

StreamContainer(System.IO.Stream stream, boolean disposeStream)

public StreamContainer(System.IO.Stream stream, boolean disposeStream)

Инициализирует новый экземпляр класса StreamContainer.

Parameters:

ПараметрТипОписание
streamcom.aspose.ms.System.IO.StreamПоток данных.
disposeStreambooleanесли установить в true, поток будет освобождён при освобождении контейнера.

READ_WRITE_BYTES_COUNT

public static final int READ_WRITE_BYTES_COUNT

Указывает количество байтов для чтения и записи при последовательном чтении.

to_Stream(StreamContainer streamContainer)

public static System.IO.Stream to_Stream(StreamContainer streamContainer)

Выполняет явное преобразование из com.aspose.imaging.StreamContainer в System.IO.Stream.

Parameters:

ПараметрТипОписание
streamContainerStreamContainerКонтейнер потока.

Returns: com.aspose.ms.System.IO.Stream — результат преобразования.

getSyncRoot()

public Object getSyncRoot()

Получает объект, который может использоваться для синхронизации доступа к синхронизированному ресурсу.

Значение: Объект, который может использоваться для синхронизации доступа к синхронизируемому ресурсу.

Returns: java.lang.Object

getPosition()

public long getPosition()

Получает или задает текущую позицию в потоке. Это значение представляет смещение от начальной позиции потока, переданной в конструкторе StreamContainer.

Значение: Текущая позиция потока.

Returns: long

setPosition(long value)

public void setPosition(long value)

Получает или задает текущую позицию в потоке. Это значение представляет смещение от начальной позиции потока, переданной в конструкторе StreamContainer.

Значение: Текущая позиция потока.

Parameters:

ПараметрТипОписание
valuelong

getStream()

public InputStream getStream()

Получает поток данных.

Значение: Поток данных.

Returns: java.io.InputStream

isStreamDisposedOnClose()

public boolean isStreamDisposedOnClose()

Получает значение, указывающее, будет ли поток освобожден при закрытии.

Значение: true, если поток освобождается при закрытии; иначе false.

Returns: boolean

getLength()

public long getLength()

Получает или задает длину потока в байтах. Это значение меньше, чем Stream#getLength().getLength(), на начальную позицию потока, переданную в конструкторе StreamContainer.

Значение: Длина потока.

Returns: long

setLength(long value)

public void setLength(long value)

Получает или задает длину потока в байтах. Это значение меньше, чем Stream#getLength().getLength(), на начальную позицию потока, переданную в конструкторе StreamContainer.

Значение: Длина потока.

Parameters:

ПараметрТипОписание
valuelong

canRead()

public boolean canRead()

Получает значение, указывающее, поддерживает ли поток чтение.

Значение: true, если поток поддерживает чтение; иначе false.

Returns: boolean

canSeek()

public boolean canSeek()

Получает значение, указывающее, поддерживает ли поток перемещение.

Значение: true, если поток поддерживает перемещение; иначе false.

Returns: boolean

canWrite()

public boolean canWrite()

Получает значение, указывающее, поддерживает ли поток запись.

Значение: true, если поток поддерживает запись; в противном случае false.

Returns: boolean

flush()

public void flush()

Очищает все буферы этого потока и заставляет любые буферизованные данные записаться в базовое устройство.

write(byte[] bytes)

public void write(byte[] bytes)

Записывает все указанные байты в поток.

Parameters:

ПараметрТипОписание
байтыbyte[]Байты для записи.

writeByte(byte value)

public void writeByte(byte value)

Записывает байт в текущую позицию потока и перемещает позицию в потоке на один байт вперёд.

Parameters:

ПараметрТипОписание
valuebyteБайт для записи в поток.

read(byte[] bytes)

public int read(byte[] bytes)

Читает байты, заполняя указанный буфер байтов.

Parameters:

ПараметрТипОписание
байтыbyte[]Байты для заполнения.

Returns: int - Количество прочитанных байтов. Это значение может быть меньше количества байтов в буфере, если в потоке недостаточно байтов.

toBytes()

public byte[] toBytes()

Преобразует данные потока в массив byte.

Returns: byte[] - Данные потока, преобразованные в массив byte.

toBytes(long position, long bytesCount)

public byte[] toBytes(long position, long bytesCount)

Преобразует данные потока в массив byte.

Parameters:

ПараметрТипОписание
позицияlongПозиция, с которой начинать чтение байтов.
bytesCountlongКоличество байтов для чтения.

Returns: byte[] - Данные потока, преобразованные в массив byte.

read(byte[] buffer, int offset, int count)

public int read(byte[] buffer, int offset, int count)

Читает последовательность байтов из текущего потока и перемещает позицию в потоке на количество прочитанных байтов.

Parameters:

ПараметрТипОписание
bufferbyte[]Массив байтов. После возврата этого метода буфер содержит указанный массив байтов, где значения между offset и (offset + count - 1) заменены байтами, прочитанными из текущего источника.
offsetintНулевое байтовое смещение в buffer, с которого начинать сохранять данные, прочитанные из текущего потока.
countintМаксимальное количество байтов, которое может быть прочитано из текущего потока.

Returns: int - Общее количество байтов, прочитанных в буфер. Это может быть меньше запрошенного количества байтов, если их в данный момент недоступно, или равно нулю (0), если достигнут конец потока.

readByte()

public int readByte()

Читает один байт из потока и перемещает позицию в потоке на один байт, либо возвращает -1, если достигнут конец потока.

Returns: int - Беззнаковый байт, приведённый к Int32, или -1, если достигнут конец потока.

seek(long offset, int origin)

public long seek(long offset, int origin)

Устанавливает позицию в текущем потоке.

Parameters:

ПараметрТипОписание
offsetlongБайтовое смещение относительно параметра origin. Это значение представляет смещение от начальной позиции потока, переданной в конструктор StreamContainer.
originintЗначение типа System.IO.SeekOrigin, указывающее точку отсчёта, используемую для получения новой позиции.

Returns: long - Новая позиция внутри текущего потока.

seekBegin()

public void seekBegin()

Устанавливает позицию потока в начало потока. Это значение представляет смещение от начальной позиции потока, переданной в конструктор StreamContainer.

write(byte[] buffer, int offset, int count)

public void write(byte[] buffer, int offset, int count)

Записывает последовательность байтов в текущий поток и перемещает текущую позицию в этом потоке на количество записанных байтов.

Parameters:

ПараметрТипОписание
bufferbyte[]Массив байтов. Этот метод копирует count байтов из buffer в текущий поток.
offsetintНулевое байтовое смещение в buffer, с которого начинать копировать байты в текущий поток.
countintКоличество байтов, которое будет записано в текущий поток.

save(OutputStream destinationStream)

public void save(OutputStream destinationStream)

Сохраняет (копирует) данные потока в указанный поток. Использует размер буфера по умолчанию ReadWriteBytesCount и значение Length потока.

Parameters:

ПараметрТипОписание
destinationStreamjava.io.OutputStreamПоток, в который сохраняются данные.

save(OutputStream destinationStream, int bufferSize)

public void save(OutputStream destinationStream, int bufferSize)

Сохраняет (копирует) все данные потока в указанный поток. Использует значение Length потока.

Parameters:

ПараметрТипОписание
destinationStreamjava.io.OutputStreamПоток, в который сохраняются данные.
bufferSizeintБуфер.

save(OutputStream destinationStream, int bufferSize, long length)

public void save(OutputStream destinationStream, int bufferSize, long length)

Сохраняет (копирует) данные потока в указанный поток.

Parameters:

ПараметрТипОписание
destinationStreamjava.io.OutputStreamПоток, в который сохраняются данные.
bufferSizeintРазмер буфера. По умолчанию используется значение ReadWriteBytesCount.
lengthlongДлина данных потока для копирования. По умолчанию длина устанавливается в значение Length.

save(String filePath)

public void save(String filePath)

Сохраняет (копирует) данные потока в указанный поток. Использует размер буфера по умолчанию ReadWriteBytesCount и значение Length потока.

Parameters:

ПараметрТипОписание
filePathjava.lang.StringПуть к файлу, в который сохраняются данные потока.

save(String filePath, int bufferSize)

public void save(String filePath, int bufferSize)

Сохраняет (копирует) данные потока в указанный поток. Использует значение Length потока.

Parameters:

ПараметрТипОписание
filePathjava.lang.StringПуть к файлу, в который сохраняются данные потока.
bufferSizeintРазмер буфера. По умолчанию используется значение ReadWriteBytesCount.

save(String filePath, int bufferSize, long length)

public void save(String filePath, int bufferSize, long length)

Сохраняет (копирует) данные потока в указанный поток.

Parameters:

ПараметрТипОписание
filePathjava.lang.StringПуть к файлу, в который сохраняются данные потока.
bufferSizeintРазмер буфера. По умолчанию используется значение ReadWriteBytesCount.
lengthlongДлина данных потока для копирования. По умолчанию длина устанавливается в значение Length.

writeTo(StreamContainer streamContainer)

public void writeTo(StreamContainer streamContainer)

Копирует содержащиеся данные в другой StreamContainer.

Parameters:

ПараметрТипОписание
streamContainerStreamContainerКонтейнер потока, в который копировать.

writeTo(StreamContainer streamContainer, long length)

public void writeTo(StreamContainer streamContainer, long length)

Копирует содержащиеся данные в другой StreamContainer.

Parameters:

ПараметрТипОписание
streamContainerStreamContainerКонтейнер потока, в который копировать.
lengthlongКоличество байтов для записи.