com.github.pjfanning.xlsx

Enum CommentsImplementationType

java.lang.Object

java.lang.Enum<CommentsImplementationType>

com.github.pjfanning.xlsx.CommentsImplementationType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CommentsImplementationType>

public enum CommentsImplementationType
extends java.lang.Enum<CommentsImplementationType>

Enum Constant Summary

Enum Constants

Enum Constant and Description
CUSTOM_MAP_BACKED The concurrent map backed CommentsTable in poi-shared-strings.
POI_DEFAULT The default CommentsTable in POI
TEMP_FILE_BACKED The temp file backed CommentsTable in poi-shared-strings.

Method Summary

Modifier and Type	Method and Description
static CommentsImplementationType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CommentsImplementationType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

POI_DEFAULT

public static final CommentsImplementationType POI_DEFAULT

The default CommentsTable in POI

TEMP_FILE_BACKED

public static final CommentsImplementationType TEMP_FILE_BACKED

The temp file backed CommentsTable in poi-shared-strings. Saves on memory but still has good performance, especially if full-format text is set to false.

See Also:

StreamingReader.Builder.setFullFormatRichText(boolean), StreamingReader.Builder.setEncryptCommentsTempFile(boolean)

CUSTOM_MAP_BACKED

public static final CommentsImplementationType CUSTOM_MAP_BACKED

The concurrent map backed CommentsTable in poi-shared-strings. More performant if full-format text is set to false.

See Also:

StreamingReader.Builder.setFullFormatRichText(boolean)

Method Detail

values

public static CommentsImplementationType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CommentsImplementationType c : CommentsImplementationType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CommentsImplementationType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null