me.ryandw11.ods.internal

Class InternalUtils

java.lang.Object

me.ryandw11.ods.internal.InternalUtils

public class InternalUtils
extends java.lang.Object

This class contains the internal methods that all storage types use.

Method Summary

Modifier and Type	Method and Description
protected static byte[]	deleteSubObjectData(byte[] data, KeyScout counter) Delete a key from the file.
protected static boolean	findSubObjectData(java.nio.ByteBuffer data, java.lang.String key) Check to see if a key exists within a file.
static java.util.List<Tag<?>>	getListData(java.nio.ByteBuffer data, int limit) Get the list of tags based upon bytes.
protected static Tag<?>	getSubObjectData(java.nio.ByteBuffer data, java.lang.String key) Get a tag based upon the name.
protected static byte[]	replaceSubObjectData(byte[] data, KeyScout counter, byte[] dataToReplace) Replace a tag with another tag.
protected static KeyScout	scoutObjectData(java.nio.ByteBuffer data, java.lang.String key, KeyScout counter) This object goes through the data and scouts out the information from the given key.
protected static byte[]	setSubObjectData(byte[] data, KeyScout counter, byte[] dataToReplace) Insert in a new tag.

Methods inherited from class java.lang.Object

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

Method Detail

getSubObjectData

protected static Tag<?> getSubObjectData(java.nio.ByteBuffer data,
                                         java.lang.String key)

Get a tag based upon the name. This method is used by the ObjectDataStructure.get(String), this is a recursive method.

Parameters:

data - The list of data.

key - The key

Returns:

The tag

findSubObjectData

protected static boolean findSubObjectData(java.nio.ByteBuffer data,
                                           java.lang.String key)

Check to see if a key exists within a file. This method is used by the ObjectDataStructure.find(String) method.

Parameters:

data - The array of bytes.

key - The key to find

Returns:

If the key could be found.

deleteSubObjectData

protected static byte[] deleteSubObjectData(byte[] data,
                                            KeyScout counter)

Delete a key from the file.

Parameters:

data - The input from the data.

counter - The scout information.

Returns:

The output array of bytes.

replaceSubObjectData

protected static byte[] replaceSubObjectData(byte[] data,
                                             KeyScout counter,
                                             byte[] dataToReplace)

Replace a tag with another tag.

Parameters:

data - The input array of bytes

counter - The scout object

dataToReplace - The bytes of the replacement data.

Returns:

The output bytes.

setSubObjectData

protected static byte[] setSubObjectData(byte[] data,
                                         KeyScout counter,
                                         byte[] dataToReplace)

Insert in a new tag.

Parameters:

data - The input array of bytes

counter - The scout object

dataToReplace - The bytes of the replacement data.

Returns:

The output bytes.

scoutObjectData

protected static KeyScout scoutObjectData(java.nio.ByteBuffer data,
                                          java.lang.String key,
                                          KeyScout counter)

This object goes through the data and scouts out the information from the given key. This method is recursive, which is why the parameter offset exists.

Parameters:

data - The input array of bytes

key - The key

counter - The Scout object.

Returns:

The key scout.

getListData

public static java.util.List<Tag<?>> getListData(java.nio.ByteBuffer data,
                                                 int limit)

Get the list of tags based upon bytes.

This is meant for internal use only.

Parameters:

data - the array of bytes

limit - the number of bytes that should be read.

Returns:

The List of tags.