Module de.sayayi.lib.pack

Package de.sayayi.lib.pack

Class PackInputStream

Object

de.sayayi.lib.pack.PackInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class PackInputStream
extends Object
implements Closeable

Since:

0.1.0

Constructor Summary

Constructors

Constructor	Description
PackInputStream(@NotNull PackConfig packConfig, @NotNull InputStream stream)
PackInputStream(@NotNull InputStream stream)

Method Summary

Modifier and Type	Method	Description
protected void	assertData()
void	close()
protected void	forceByteAlignment()
@NotNull OptionalInt	getVersion()
boolean	isCompressed()
protected byte	read()
boolean	readBoolean()
<T extends Enum<T>> T	readEnum(@NotNull Class<T> enumType)
<T extends Enum<T>> T	readEnum(@NotNull Class<T> enumType, @org.jetbrains.annotations.Range(from=1L, to=16L) int bitWidth)
int	readInt()
long	readLarge(@org.jetbrains.annotations.Range(from=9L, to=64L) int bitWidth)
long	readLong()
@org.jetbrains.annotations.Range(from=0L, to=255L) int	readSmall(@org.jetbrains.annotations.Range(from=1L, to=8L) int bitWidth)
@org.jetbrains.annotations.Range(from=0L, to=255L) int	readSmallVar()	Ranges: 0..7 (4 bit), 8..15 (5 bit), 16..255 (10 bit)
String	readString()
@org.jetbrains.annotations.Range(from=0L, to=65535L) int	readUnsignedShort()
void	skip(@org.jetbrains.annotations.Range(from=0L, to=2147483647L) int bitWidth)
void	skipBoolean()
<T extends Enum<T>> void	skipEnum(@NotNull Class<T> enumType)
void	skipInt()
void	skipLong()
void	skipSmallVar()
void	skipString()
void	skipUnsignedShort()

Methods inherited from class java.lang.Object

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

Constructor Details

PackInputStream

@Contract(mutates="param1,io")
public PackInputStream(@NotNull
 @NotNull InputStream stream)
                throws IOException

Throws:

IOException

Since:

0.1.2

PackInputStream

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

Throws:

IOException

Method Details

isCompressed

@Contract(pure=true)
public boolean isCompressed()

getVersion

@Contract(pure=true)
@NotNull
public @NotNull OptionalInt getVersion()

readBoolean

@Contract(mutates="this,io")
public boolean readBoolean()
                    throws IOException

Throws:

IOException

skipBoolean

@Contract(mutates="this,io")
public void skipBoolean()
                 throws IOException

Throws:

IOException

readEnum

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

Throws:

IOException

readEnum

@Contract(mutates="this,io")
@NotNull
public <T extends Enum<T>> T readEnum(@NotNull
 @NotNull Class<T> enumType)
                               throws IOException

Throws:

IOException

skipEnum

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

Throws:

IOException

readUnsignedShort

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

Returns:

unsigned value (0..65535)

Throws:

IOException - if an I/O error occurs

skipUnsignedShort

@Contract(mutates="this,io")
public void skipUnsignedShort()
                       throws IOException

Throws:

IOException

readInt

@Contract(mutates="this,io")
public int readInt()
            throws IOException

Throws:

IOException

skipInt

@Contract(mutates="this,io")
public void skipInt()
             throws IOException

Throws:

IOException

readLong

@Contract(mutates="this,io")
public long readLong()
              throws IOException

Throws:

IOException

skipLong

@Contract(mutates="this,io")
public void skipLong()
              throws IOException

Throws:

IOException

readString

@Contract(mutates="this,io")
public String readString()
                  throws IOException

Throws:

IOException

skipString

@Contract(mutates="this,io")
public void skipString()
                throws IOException

Throws:

IOException

readSmallVar

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

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

Returns:

value in range 0..255

Throws:

IOException - if an I/O error occurs

skipSmallVar

@Contract(mutates="this,io")
public void skipSmallVar()
                  throws IOException

Throws:

IOException

readSmall

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

Parameters:

bitWidth - bit width (1..8)

Returns:

value in range 0..255

Throws:

IOException - if an I/O error occurs

readLarge

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

Parameters:

bitWidth - bit width (9..64)

Returns:

long value

Throws:

IOException - if an I/O error occurs

assertData

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

Throws:

IOException

forceByteAlignment

@Contract(mutates="this")
protected void forceByteAlignment()

skip

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

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

read

@Contract(mutates="io")
protected byte read()
             throws IOException

Throws:

IOException