com.runehive.fs.cache.Sector Class Reference

Represents a sector within some Cache. More...

Public Member Functions
void	check (int cacheId, int indexId, int chunk)
	Tests whether or not this sector is valid.
int	getCacheId ()
	Returns the id of the cache this sector is in.
int	getChunk ()
	Returns this sectors chunk.
int	getIndexId ()
	Returns the id of the index this sector is within.
int	getNextIndexId ()
	Returns the next index within this sector.

Static Public Member Functions
static Sector	decode (ByteBuffer buffer, byte[] data, int offset, int length)
	Decodes a Sector from the specified ByteBuffer.

Private Member Functions
	Sector (int indexId, int chunk, int nextIndexId, int cacheId)
	Constructs a new Sector with the expected index id, chunk, next index id and cache id.

Private Attributes
final int	cacheId
	The id of the cache this sector is in.
final int	chunk
	This sectors chunk.
final int	indexId
	The id of the index this sector is within.
final int	nextIndexId
	The next index within this sector.

Detailed Description

Represents a sector within some Cache.

Author

Ryley Kimmel ryley.nosp@m..kim.nosp@m.mel@l.nosp@m.ive..nosp@m.com

Definition at line 13 of file Sector.java.

Constructor & Destructor Documentation

Sector()

com.runehive.fs.cache.Sector.Sector ( int indexId, int chunk, int nextIndexId, int cacheId )

private

Constructs a new Sector with the expected index id, chunk, next index id and cache id.

This constructor is marked private and should not be modified to be invoked directly, use Sector#decode(ByteBuffer, byte[], int, int) instead.

Parameters

indexId	The id of the index this sector is within.
chunk	This sectors chunk.
nextIndexId	The next index within this sector.
cacheId	The id of the cache this sector is in.

Definition at line 38 of file Sector.java.

                                                                         {
        this.indexId = indexId;
        this.chunk = chunk;
        this.nextIndexId = nextIndexId;
        this.cacheId = cacheId;
    }

References cacheId, chunk, indexId, and nextIndexId.

Referenced by decode().

Here is the caller graph for this function:

Member Function Documentation

check()

void com.runehive.fs.cache.Sector.check	(	int	cacheId,
		int	indexId,
		int	chunk )

Tests whether or not this sector is valid.

Parameters

cacheId	The cache id to test.
indexId	The index id to test.
chunk	The chunk id to test.

Definition at line 70 of file Sector.java.

                                                           {
        Preconditions.checkArgument(this.cacheId == cacheId);
        Preconditions.checkArgument(this.indexId == indexId);
        Preconditions.checkArgument(this.chunk == chunk);
    }

References cacheId, chunk, and indexId.

Referenced by com.runehive.fs.cache.Cache.get().

Here is the caller graph for this function:

decode()

Sector com.runehive.fs.cache.Sector.decode ( ByteBuffer buffer, byte[] data, int offset, int length )

static

Decodes a Sector from the specified ByteBuffer.

Parameters

buffer	The ByteBuffer to get the sector from.
data	The expected data within the sector.
offset	The expected offset of the sector.
length	The expected length of the sector.

Returns

The decoded sector.

Definition at line 54 of file Sector.java.

                                                                                        {
        int indexId = buffer.getShort() & 0xFFFF;
        int chunk = buffer.getShort() & 0xFFFF;
        int nextIndexId = ByteBufferUtil.getMedium(buffer);
        int cacheId = buffer.get() & 0xFF;
        buffer.get(data, offset, length);
        return new Sector(indexId, chunk, nextIndexId, cacheId);
    }

References cacheId, chunk, com.runehive.fs.util.ByteBufferUtil.getMedium(), indexId, nextIndexId, and Sector().

Referenced by com.runehive.fs.cache.Cache.readSector().

Here is the call graph for this function:

Here is the caller graph for this function:

getCacheId()

int com.runehive.fs.cache.Sector.getCacheId

(

)

Returns the id of the cache this sector is in.

Definition at line 92 of file Sector.java.

                            {
        return cacheId;
    }

References cacheId.

getChunk()

int com.runehive.fs.cache.Sector.getChunk

(

)

Returns this sectors chunk.

Definition at line 82 of file Sector.java.

                          {
        return chunk;
    }

References chunk.

getIndexId()

int com.runehive.fs.cache.Sector.getIndexId

(

)

Returns the id of the index this sector is within.

Definition at line 77 of file Sector.java.

                            {
        return indexId;
    }

References indexId.

getNextIndexId()

int com.runehive.fs.cache.Sector.getNextIndexId

(

)

Returns the next index within this sector.

Definition at line 87 of file Sector.java.

                                {
        return nextIndexId;
    }

References nextIndexId.

Referenced by com.runehive.fs.cache.Cache.get().

Here is the caller graph for this function:

Member Data Documentation

cacheId

final int com.runehive.fs.cache.Sector.cacheId

private

The id of the cache this sector is in.

Definition at line 25 of file Sector.java.

Referenced by check(), decode(), getCacheId(), and Sector().

chunk

final int com.runehive.fs.cache.Sector.chunk

private

This sectors chunk.

Definition at line 19 of file Sector.java.

Referenced by check(), decode(), getChunk(), and Sector().

indexId

final int com.runehive.fs.cache.Sector.indexId

private

The id of the index this sector is within.

Definition at line 16 of file Sector.java.

Referenced by check(), decode(), getIndexId(), and Sector().

nextIndexId

final int com.runehive.fs.cache.Sector.nextIndexId

private

The next index within this sector.

Definition at line 22 of file Sector.java.

Referenced by decode(), getNextIndexId(), and Sector().

---

The documentation for this class was generated from the following file:

• java/com/runehive/fs/cache/Sector.java