com.hcl.domino.misc

Enum StructureSupport

java.lang.Object

java.lang.Enum<StructureSupport>

com.hcl.domino.misc.StructureSupport

All Implemented Interfaces:

Serializable, Comparable<StructureSupport>

public enum StructureSupport
extends Enum<StructureSupport>

Since:

1.0.24

Author:

Jesse Gallagher

Method Summary

Modifier and Type	Method and Description
static String	extractCompiledFormula(ResizableMemoryStructure struct, long preLen, long len)
static String	extractStringValue(ResizableMemoryStructure struct, long preLen, long len) Extracts a "packed" string value from the structure.
static String	extractStringValueUnpacked(ResizableMemoryStructure struct, long preLen, long len) Extracts an "unpacked" string value from the structure.
static String	extractStringValueWordPadded(ResizableMemoryStructure struct, long preLen, long len) Extracts a "padded" string value from the structure.
static StructureSupport	valueOf(String name) Returns the enum constant of this type with the specified name.
static StructureSupport[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
static <T extends ResizableMemoryStructure> T	writeCompiledFormula(T struct, int preLen, int currentLen, String formula, IntConsumer sizeWriter)
static <T extends ResizableMemoryStructure> T	writeCompiledFormula(T struct, long preLen, long currentLen, String formula, LongConsumer sizeWriter)
static <T extends ResizableMemoryStructure> T	writeStringValue(T struct, int preLen, int currentLen, String value, IntConsumer sizeWriter)
static <T extends ResizableMemoryStructure> T	writeStringValue(T struct, long preLen, long currentLen, String value, LongConsumer sizeWriter)
static <T extends ResizableMemoryStructure> T	writeStringValueShort(T struct, int preLen, int currentLen, String value, Consumer<Short> sizeWriter)
static <T extends ResizableMemoryStructure> T	writeStringValueUnpacked(T struct, int preLen, int currentLen, String value, IntConsumer sizeWriter) Writes an "unpacked" string value to the provided structure, using the provided IntConsumer to update an associated length value.
static <T extends ResizableMemoryStructure> T	writeStringValueWordPadded(T struct, int preLen, int currentLen, String value, IntConsumer sizeWriter) Writes a "padded" string value to the provided structure, using the provided IntConsumer to update an associated length value.

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

Method Detail

values

public static StructureSupport[] 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 (StructureSupport c : StructureSupport.values())
    System.out.println(c);

Returns:

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

valueOf

public static StructureSupport valueOf(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:

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

NullPointerException - if the argument is null

extractStringValue

public static String extractStringValue(ResizableMemoryStructure struct,
                                        long preLen,
                                        long len)

Extracts a "packed" string value from the structure. For this use, "packed" means that the string data is exactly as long as len, with no null terminator or WORD-size padding.

Parameters:

struct - the structure to extract from

preLen - the number of bytes before the value to extract

len - the size of the stored value

Returns:

the extracted string value

extractStringValueWordPadded

public static String extractStringValueWordPadded(ResizableMemoryStructure struct,
                                                  long preLen,
                                                  long len)

Extracts a "padded" string value from the structure. For this use, "padded" means that:

• The string is not null-terminated
• If the length of the string is odd, there is another packing null value at the end

Parameters:

struct - the structure to extract from

preLen - the number of bytes before the value to extract

len - the size of the stored value

Returns:

the extracted string value

extractStringValueUnpacked

public static String extractStringValueUnpacked(ResizableMemoryStructure struct,
                                                long preLen,
                                                long len)

Extracts an "unpacked" string value from the structure. For this use, "unpacked" means that:

• The string is null-terminated
• If the length of the string plus its terminator is odd, there is another packing null value at the end

Parameters:

struct - the structure to extract from

preLen - the number of bytes before the value to extract

len - the size of the stored value

Returns:

the extracted string value

extractCompiledFormula

public static String extractCompiledFormula(ResizableMemoryStructure struct,
                                            long preLen,
                                            long len)

writeStringValue

public static <T extends ResizableMemoryStructure> T writeStringValue(T struct,
                                                                      long preLen,
                                                                      long currentLen,
                                                                      String value,
                                                                      LongConsumer sizeWriter)

writeStringValue

public static <T extends ResizableMemoryStructure> T writeStringValue(T struct,
                                                                      int preLen,
                                                                      int currentLen,
                                                                      String value,
                                                                      IntConsumer sizeWriter)

writeStringValueShort

public static <T extends ResizableMemoryStructure> T writeStringValueShort(T struct,
                                                                           int preLen,
                                                                           int currentLen,
                                                                           String value,
                                                                           Consumer<Short> sizeWriter)

writeStringValueWordPadded

public static <T extends ResizableMemoryStructure> T writeStringValueWordPadded(T struct,
                                                                                int preLen,
                                                                                int currentLen,
                                                                                String value,
                                                                                IntConsumer sizeWriter)

Writes a "padded" string value to the provided structure, using the provided IntConsumer to update an associated length value. For this use, "unpacked" means that:

• The string is not null-terminated
• If the length of the string plus its terminator is odd, there is another packing null value at the end

Type Parameters:

T - the class of the structure

Parameters:

struct - the structure to modify

preLen - the amount of variable data in bytes before the place to write

currentLen - the current length of the variable data to overwrite

value - the value to write

sizeWriter - a callback to modify an associated length field, if applicable

Returns:

the provided structure

writeStringValueUnpacked

public static <T extends ResizableMemoryStructure> T writeStringValueUnpacked(T struct,
                                                                              int preLen,
                                                                              int currentLen,
                                                                              String value,
                                                                              IntConsumer sizeWriter)

Writes an "unpacked" string value to the provided structure, using the provided IntConsumer to update an associated length value. For this use, "unpacked" means that:

• The string is null-terminated
• If the length of the string plus its terminator is odd, there is another packing null value at the end

Type Parameters:

T - the class of the structure

Parameters:

struct - the structure to modify

preLen - the amount of variable data in bytes before the place to write

currentLen - the current length of the variable data to overwrite

value - the value to write

sizeWriter - a callback to modify an associated length field, if applicable

Returns:

the provided structure

writeCompiledFormula

public static <T extends ResizableMemoryStructure> T writeCompiledFormula(T struct,
                                                                          long preLen,
                                                                          long currentLen,
                                                                          String formula,
                                                                          LongConsumer sizeWriter)

writeCompiledFormula

public static <T extends ResizableMemoryStructure> T writeCompiledFormula(T struct,
                                                                          int preLen,
                                                                          int currentLen,
                                                                          String formula,
                                                                          IntConsumer sizeWriter)