Module de.sayayi.lib.pack

Package de.sayayi.lib.pack

Class PackOutputStream

Object

de.sayayi.lib.pack.PackOutputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class PackOutputStream
extends Object
implements Closeable

Since:

0.1.0

Constructor Summary

Constructors

Constructor	Description
PackOutputStream(boolean compress, @NotNull OutputStream stream)
PackOutputStream(@NotNull PackConfig packConfig, @org.jetbrains.annotations.Range(from=0L, to=2147483647L) int version, boolean compress, @NotNull OutputStream stream)
PackOutputStream(@NotNull PackConfig packConfig, @org.jetbrains.annotations.Range(from=0L, to=2147483647L) int version, @NotNull OutputStream stream)
PackOutputStream(@NotNull PackConfig packConfig, boolean compress, @NotNull OutputStream stream)
PackOutputStream(@NotNull PackConfig packConfig, @NotNull OutputStream stream)

Method Summary

Modifier and Type	Method	Description
void	close()
protected void	forceByteAlignment()
void	writeBoolean(boolean value)	Write a boolean value to the output stream.
<T extends Enum<T>> void	writeEnum(T value)	Write an enumerated value to the output stream.
<T extends Enum<T>> void	writeEnum(T value, @org.jetbrains.annotations.Range(from=1L, to=16L) int bitWidth)	Write an enumerated value to the output stream.
void	writeInt(int value)
void	writeLarge(long value, @org.jetbrains.annotations.Range(from=9L, to=64L) int bitWidth)
void	writeLong(long value)
void	writeSmall(@org.jetbrains.annotations.Range(from=0L, to=255L) int value, @org.jetbrains.annotations.Range(from=1L, to=8L) int bitWidth)
void	writeSmallVar(@org.jetbrains.annotations.Range(from=0L, to=255L) int value)	Ranges: 0..7 (4 bit), 8..15 (5 bit), 16..255 (10 bit)
void	writeString(String string)
void	writeUnsignedShort(@org.jetbrains.annotations.Range(from=0L, to=65535L) int value)

Methods inherited from class java.lang.Object

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

Constructor Details

PackOutputStream

@Contract(mutates="param2,io")
public PackOutputStream(boolean compress,
 @NotNull
 @NotNull OutputStream stream)
                 throws IOException

Throws:

IOException

Since:

0.1.2

PackOutputStream

@Contract(mutates="param3,io")
public PackOutputStream(@NotNull
 @NotNull PackConfig packConfig,
 @org.jetbrains.annotations.Range(from=0L, to=2147483647L) int version,
 @NotNull
 @NotNull OutputStream stream)
                 throws IOException

Throws:

IOException

PackOutputStream

@Contract(mutates="param2,io")
public PackOutputStream(@NotNull
 @NotNull PackConfig packConfig,
 @NotNull
 @NotNull OutputStream stream)
                 throws IOException

Throws:

IOException

PackOutputStream

@Contract(mutates="param3,io")
public PackOutputStream(@NotNull
 @NotNull PackConfig packConfig,
 boolean compress,
 @NotNull
 @NotNull OutputStream stream)
                 throws IOException

Throws:

IOException

PackOutputStream

@Contract(mutates="param4,io")
public PackOutputStream(@NotNull
 @NotNull PackConfig packConfig,
 @org.jetbrains.annotations.Range(from=0L, to=2147483647L) int version,
 boolean compress,
 @NotNull
 @NotNull OutputStream stream)
                 throws IOException

Throws:

IOException

Method Details

writeBoolean

@Contract(mutates="this,io")
public void writeBoolean(boolean value)
                  throws IOException

Write a boolean value to the output stream.

Parameters:

value - boolean value to write

Throws:

IOException - if an I/O error occurs

writeEnum

@Contract(mutates="this,io")
public <T extends Enum<T>> void writeEnum(@NotNull
 T value,
 @org.jetbrains.annotations.Range(from=1L, to=16L) int bitWidth)
                                   throws IOException

Write an enumerated value to the output stream.

Parameters:

value - enumerated value to write, not null

bitWidth - number of bits to use for the enumerated value

Throws:

IllegalArgumentException - if bitWidth is not in the range 1..16 or if the ordinal of the enumerated value exceeds the bitWidth

IOException - if an I/O error occurs

writeEnum

@Contract(mutates="this,io")
public <T extends Enum<T>> void writeEnum(@NotNull
 T value)
                                   throws IOException

Write an enumerated value to the output stream.

Parameters:

value - enumerated value to write, not null

Throws:

IOException - if an I/O error occurs

writeUnsignedShort

@Contract(mutates="this,io")
public void writeUnsignedShort(@org.jetbrains.annotations.Range(from=0L, to=65535L) int value)
                        throws IOException

Parameters:

value - unsigned value (0..65535)

Throws:

IOException - if an I/O error occurs

writeInt

@Contract(mutates="this,io")
public void writeInt(int value)
              throws IOException

Throws:

IOException

writeLong

@Contract(mutates="this,io")
public void writeLong(long value)
               throws IOException

Throws:

IOException

writeString

@Contract(mutates="this,io")
public void writeString(String string)
                 throws IOException

Throws:

IOException

writeSmallVar

@Contract(mutates="this,io")
public void writeSmallVar(@org.jetbrains.annotations.Range(from=0L, to=255L) int value)
                   throws IOException

Ranges: 0..7 (4 bit), 8..15 (5 bit), 16..255 (10 bit)

Parameters:

value - unsigned value (0..255)

Throws:

IOException - if an I/O error occurs

writeSmall

@Contract(mutates="this,io")
public void writeSmall(@org.jetbrains.annotations.Range(from=0L, to=255L) int value,
 @org.jetbrains.annotations.Range(from=1L, to=8L) int bitWidth)
                throws IOException

Parameters:

value - unsigned value (0..255)

bitWidth - range 1..8 bits

Throws:

IOException - if an I/O error occurs

writeLarge

@Contract(mutates="this,io")
public void writeLarge(long value,
 @org.jetbrains.annotations.Range(from=9L, to=64L) int bitWidth)
                throws IOException

Parameters:

value - signed value

bitWidth - range 9..64 bits

Throws:

IOException - if an I/O error occurs

forceByteAlignment

@Contract(mutates="this,io")
protected void forceByteAlignment()
                           throws IOException

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException