me.ryandw11.ods

Class ODS

java.lang.Object

me.ryandw11.ods.ODS

public class ODS
extends java.lang.Object

This is a utility class that provided wrappers for the different tags. All wrappers exclude a name.

This class also contains overall settings for ODS.

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	ignoreInvalidCustomTags

Method Summary

Modifier and Type	Method and Description
static void	allowUndefinedTags(boolean value) Informs ods whether or not to thrown an error when it comes across an undefined custom tag.
static <T> T	deserialize(Tag<?> tag, java.lang.Class<T> mainClazz) Deserialize back into an object
static Compressor	getCompressor(java.lang.String name) Get the compressor registered with a name.
static java.lang.String	getCompressorName(Compressor compressor) Get the name of a compressor.
static java.util.List<Tag<?>>	getCustomTags() Get the list of custom tags.
static void	registerCompression(java.lang.String name, Compressor compressor) Add a custom compression type by name.
static void	registerCustomTag(Tag<?> tag) Register a custom tag into the system.
static ObjectTag	serialize(java.lang.String key, java.lang.Object obj) Serialize an object.
static <T> T	unwrap(Tag<T> tag) Unwrap a tag and turn it back into it's original value.
static <T> java.util.List<T>	unwrapList(java.util.List<Tag<T>> tags) Unwrap a list full of tags.
static <T> java.util.List<T>	unwrapListTag(ListTag<? extends Tag<T>> list) Unwrap a ListTag into a list.
static <T> java.util.List<Tag<?>>	wrap(java.util.List<T> list) Wrap all of the objects inside of the list.
static Tag<?>	wrap(java.lang.Object o) Wrap an object to a tag.
static <T> ListTag<?>	wrap(java.lang.String name, java.util.List<T> list) Wrap a list into a list tag.
static Tag<?>	wrap(java.lang.String name, java.lang.Object o) Wrap an object to a tag.

Methods inherited from class java.lang.Object

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

Field Detail

ignoreInvalidCustomTags

protected static boolean ignoreInvalidCustomTags

Method Detail

wrap

public static Tag<?> wrap(java.lang.Object o)

Wrap an object to a tag.

The name is not set by this method.

This method cannot wrap Lists, Maps. Objects are automatically serialized.

Parameters:

o - The object to wrap.

Returns:

The tag equivalent.

wrap

public static Tag<?> wrap(java.lang.String name,
                          java.lang.Object o)

Wrap an object to a tag.

This method cannot wrap Lists, Maps. Objects are automatically serialized.

Parameters:

name - The name of the tag to wrap.

o - The object to wrap.

Returns:

The tag equivalent.

unwrap

public static <T> T unwrap(Tag<T> tag)

Unwrap a tag and turn it back into it's original value.

This method will not work for Lists, Maps, and Objects.

Type Parameters:

T - The data type of the tag.

Parameters:

tag - The tag to unwrap.

Returns:

The unwrapped tag.

wrap

public static <T> ListTag<?> wrap(java.lang.String name,
                                  java.util.List<T> list)

Wrap a list into a list tag.

Type Parameters:

T - The data type of the list.

Parameters:

name - The name of the list tag.

list - The list to turn into a list tag.

The list can only contain objects that can be converted into tags. The contents of the list are automatically wrapped. Note: This list cannot contain Objects, Lists, or Maps.

Returns:

The wrapped list.

wrap

public static <T> java.util.List<Tag<?>> wrap(java.util.List<T> list)

Wrap all of the objects inside of the list.

The same limitations apply as with the wrap(Object) method.

Type Parameters:

T - The data type of the list.

Parameters:

list - The list to wrap.

Returns:

The wrapped list.

unwrapList

public static <T> java.util.List<T> unwrapList(java.util.List<Tag<T>> tags)

Unwrap a list full of tags.

This method is not for unwrapping the LinkList to a normal list.

Type Parameters:

T - The data type of the tags.

The list must be a uniform data type.

Parameters:

tags - The list of tags.

Returns:

The unwrapped list.

unwrapListTag

public static <T> java.util.List<T> unwrapListTag(ListTag<? extends Tag<T>> list)

Unwrap a ListTag into a list.

Type Parameters:

T - The data type of the list.

Parameters:

list - The ListTag to convert back into a list.

The contents of the list are automatically unwrapped.

Returns:

The unwrapped list.

serialize

public static ObjectTag serialize(java.lang.String key,
                                  java.lang.Object obj)

Serialize an object.

Parameters:

key - The key

obj - The object

Returns:

The object tag.

deserialize

public static <T> T deserialize(Tag<?> tag,
                                java.lang.Class<T> mainClazz)

Deserialize back into an object

Type Parameters:

T - The deserialized class.

Parameters:

tag - The tag.

mainClazz - The main class.

Returns:

The object.

registerCustomTag

public static void registerCustomTag(Tag<?> tag)

Register a custom tag into the system. (This tag must respect the reserved tag ids).

Parameters:

tag - The tag class to add.

registerCompression

public static void registerCompression(java.lang.String name,
                                       Compressor compressor)

Add a custom compression type by name.

This exists so objects that rely on compression, like the CompressedObjectTag, are able to be cross language. So if you have a ZSTD compressed object made in C# you can still read it in Java by registering a Compressor with the same name.

Parameters:

name - The name.

compressor - The compressor.

getCompressor

public static Compressor getCompressor(java.lang.String name)

Get the compressor registered with a name.

Parameters:

name - The name of the compressor.

Returns:

The retrieved compressor. (Null if not found.)

getCompressorName

public static java.lang.String getCompressorName(Compressor compressor)

Get the name of a compressor.

Parameters:

compressor - The compressor.

Returns:

The retrieved name of the compressor. (Null if not found.)

getCustomTags

public static java.util.List<Tag<?>> getCustomTags()

Get the list of custom tags.

Returns:

The list of custom tags.

allowUndefinedTags

public static void allowUndefinedTags(boolean value)

Informs ods whether or not to thrown an error when it comes across an undefined custom tag.

Only enable this when developing something like a visualizer program.

Parameters:

value - Whether or not to thrown an error when it comes across an undefined custom tag.