me.ryandw11.ods.internal

Class ODSFile

java.lang.Object

me.ryandw11.ods.internal.ODSFile

All Implemented Interfaces:

ODSInternal

public class ODSFile
extends java.lang.Object
implements ODSInternal

The internal code for using a file.

Constructor Summary

Constructors

Constructor and Description
ODSFile(java.io.File file, Compressor compression) The file to be saved to

Method Summary

Modifier and Type	Method and Description
void	append(Tag<?> tag) Append tags to the end of the file.
void	appendAll(java.util.List<Tag<?>> tags) Append a list of tags to the end of the file.
void	clear() Clears all the data from a file.
boolean	delete(java.lang.String key) Remove a tag from the list.
byte[]	export(Compressor compressor)
boolean	find(java.lang.String key) Find if a key exists within the file.
<T extends Tag<?>> T	get(java.lang.String key) Grab a tag based upon an object key.
java.util.List<Tag<?>>	getAll() Get all of the tags in the file.
void	importFile(java.io.File file, Compressor compressor) Import a file into this file.
boolean	replaceData(java.lang.String key, Tag<?> replacement) Replace a key with another tag.
void	save(java.util.List<? extends Tag<?>> tags) Save tags to the file.
void	saveToFile(java.io.File file, Compressor compressor) Export to another file.
void	set(java.lang.String key, Tag<?> value) This method can append, delete, and set tags.

Methods inherited from class java.lang.Object

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

Constructor Detail

ODSFile

public ODSFile(java.io.File file,
               Compressor compression)

The file to be saved to

Parameters:

file - The file.

compression - What compression the file should use.

Method Detail

get

public <T extends Tag<?>> T get(java.lang.String key)

Grab a tag based upon an object key.

This method allows you to directly get sub-objects with little overhead.

get("Object1.Object2.valuetag");

Specified by:

get in interface ODSInternal

Type Parameters:

T - The tag type.

Parameters:

key - The key to use.

Returns:

The object Tag.

This will return null if the requested sub-object does not exist, or if the file does not exist.

getAll

public java.util.List<Tag<?>> getAll()

Get all of the tags in the file.

Specified by:

getAll in interface ODSInternal

Returns:

All of the tags.

This will return null if there are no tags, or if the file does not exist.

save

public void save(java.util.List<? extends Tag<?>> tags)

Save tags to the file.

This will overwrite the existing file. To append tags see append(Tag) and appendAll(List)

Specified by:

save in interface ODSInternal

Parameters:

tags - The list of tags to save.

append

public void append(Tag<?> tag)

Append tags to the end of the file.

Specified by:

append in interface ODSInternal

Parameters:

tag - The tag to be appended.

appendAll

public void appendAll(java.util.List<Tag<?>> tags)

Append a list of tags to the end of the file.

Specified by:

appendAll in interface ODSInternal

Parameters:

tags - The list of tags.

find

public boolean find(java.lang.String key)

Find if a key exists within the file.

This will not throw ODSException if an IOException occurs.

Specified by:

find in interface ODSInternal

Parameters:

key - They key to find

Returns:

If the key exists.

delete

public boolean delete(java.lang.String key)

Remove a tag from the list.

Specified by:

delete in interface ODSInternal

Parameters:

key - The key to remove.

Returns:

If the deletion was successfully done.

replaceData

public boolean replaceData(java.lang.String key,
                           Tag<?> replacement)

Replace a key with another tag.

Specified by:

replaceData in interface ODSInternal

Parameters:

key - The key

replacement - The data to replace

Returns:

If the replacement was successful. ODSException is not thrown.

set

public void set(java.lang.String key,
                Tag<?> value)

This method can append, delete, and set tags.

A note on keys when appending:
ObjectOne.ObjectTwo.tagName
When appending data tagName will not be the actual tag name. The tag name written to the file is the name of the specified tag in the value parameter. Any parent objects that do not exist will be created. For example:
ObjectOne.ObjectTwo.NewObject.tagName
If in the example above NewObject does not exist, than the object will be created with the value tag inside of it. Please see the wiki for a more detailed explanation on this.

When value is null, the specified key is deleted. The key MUST exist or an ODSException will be thrown.

Specified by:

set in interface ODSInternal

Parameters:

key - The key of the tag to append, delete, or set.

When appending the key does not need to exist. ObjectTags that don't exist will be created automatically.

When the key is set to "" (An empty string) than it is assumed you want to append to the parent file.

Valid Tags:

ObjectOne.tagToDelete
ObjectOne.NewObject.tagToAppend
ObjectOne.tagToSet


value - The tag to append or replace the key with.

If this parameter is null than the key is deleted.

export

public byte[] export(Compressor compressor)

Specified by:

export in interface ODSInternal

importFile

public void importFile(java.io.File file,
                       Compressor compressor)

Import a file into this file.

This basically copies one file to another.

This will overwrite the current file.

Specified by:

importFile in interface ODSInternal

Parameters:

file - The file to copy from.

compressor - The compression of the other file.

saveToFile

public void saveToFile(java.io.File file,
                       Compressor compressor)

Export to another file.

This basically copies the current file into another one.

Specified by:

saveToFile in interface ODSInternal

Parameters:

file - The other file to copy to.

compressor - The desired compression of the copy file.

clear

public void clear()

Clears all the data from a file.

This works internally by overwriting a file.

Specified by:

clear in interface ODSInternal