Apache POI - Common 5.3.0 · org.apache.poi.hpsf.VariantSupport

Modifier and Type	Field and Description
private static final Logger	LOG
private static boolean	logUnsupportedTypes
private static final byte[]	paddingBytes
public static final int[]	SUPPORTED_TYPES HPSF is able to read these `Variant` types.
private static List<Long>	unsupportedMessage Keeps a list of the variant types an "unsupported" message has already been issued for.

Access	Constructor and Description
public	VariantSupport()

Method Summary

Modifier and Type	Method and Description
public static boolean	Returns: `true` if logging is turned on, else `false`. isLogUnsupportedTypes() Checks whether logging of unsupported variant types warning is turned on or off.
public boolean	Returns: `true` if HPFS supports this type, else `false` isSupportedType(final int the variant type to check variantType) Checks whether HPSF supports the specified variant type.
public static Object	Returns: A Java object that corresponds best to the variant field. For example, a VT_I4 is returned as a `Long`, a VT_LPSTR as a `String`. read(final byte[] The byte array src, final int The offset in the byte array where the variant starts offset, final int The length of the variant including the variant type field length, final long The variant type to read type, final int The codepage to use for non-wide strings codepage) Reads a variant type from a byte array.
public static Object	read(LittleEndianByteArrayInputStream lei, final int length, final long type, final int codepage)
public static void	setLogUnsupportedTypes(final boolean If `true` warnings will be written, if `false` they won't. logUnsupportedTypes) Specifies whether warnings about unsupported variant types are to be written to `System.err` or not.
public static int	Returns: The number of entities that have been written. In many cases an "entity" is a byte but this is not always the case. write(final OutputStream The stream to write the value to. out, final long The variant's type. type, final Object The variant's value. value, final int The codepage to use to write non-wide strings codepage) Writes a variant value to an output stream.
protected static void	writeUnsupportedTypeMessage(final UnsupportedVariantTypeException The exception to log ex) Writes a warning to `System.err` that a variant type is unsupported by HPSF.

Inherited from org.apache.poi.hpsf.Variant:: getVariantLength getVariantName

LOG	back to summary
private static final Logger LOG

logUnsupportedTypes	back to summary
private static boolean logUnsupportedTypes

paddingBytes	back to summary
private static final byte[] paddingBytes

SUPPORTED_TYPES	back to summary
public static final int[] SUPPORTED_TYPES HPSF is able to read these `Variant` types.

unsupportedMessage	back to summary
private static List<Long> unsupportedMessage Keeps a list of the variant types an "unsupported" message has already been issued for.

VariantSupport	back to summary
public VariantSupport()

Method Detail

isLogUnsupportedTypes back to summary

isLogUnsupportedTypes	back to summary
public static boolean isLogUnsupportedTypes() Checks whether logging of unsupported variant types warning is turned on or off. Returns:boolean `true` if logging is turned on, else `false`.

public static boolean isLogUnsupportedTypes()

Checks whether logging of unsupported variant types warning is turned on or off.

Returns:boolean: true if logging is turned on, else false.

isSupportedType back to summary

isSupportedType	back to summary
public boolean isSupportedType(final int variantType) Checks whether HPSF supports the specified variant type. Unsupported types should be implemented included in the `SUPPORTED_TYPES` array. Parameters variantType:int the variant type to check Returns:boolean `true` if HPFS supports this type, else `false` See Also `Variant`

public boolean isSupportedType(final int variantType)

Checks whether HPSF supports the specified variant type. Unsupported types should be implemented included in the SUPPORTED_TYPES array.

Parameters

variantType:int: the variant type to check

Returns:boolean

true if HPFS supports this type, else false

See Also

Variant

read back to summary

read	back to summary
public static Object read(final byte[] src, final int offset, final int length, final long type, final int codepage) throws ReadingNotSupportedException, UnsupportedEncodingException Reads a variant type from a byte array. Parameters src:byte[] The byte array offset:int The offset in the byte array where the variant starts length:int The length of the variant including the variant type field type:long The variant type to read codepage:int The codepage to use for non-wide strings Returns:Object A Java object that corresponds best to the variant field. For example, a VT_I4 is returned as a `Long`, a VT_LPSTR as a `String`. Exceptions ReadingNotSupportedException: if a property is to be written who's variant type HPSF does not yet support UnsupportedEncodingException: if the specified codepage is not supported. See Also `Variant`

public static Object read(final byte[] src, final int offset, final int length, final long type, final int codepage) throws ReadingNotSupportedException, UnsupportedEncodingException

Reads a variant type from a byte array.

Parameters

src:byte[]: The byte array
offset:int: The offset in the byte array where the variant starts
length:int: The length of the variant including the variant type field
type:long: The variant type to read
codepage:int: The codepage to use for non-wide strings

Returns:Object

A Java object that corresponds best to the variant field. For example, a VT_I4 is returned as a Long, a VT_LPSTR as a String.

Exceptions

ReadingNotSupportedException:: if a property is to be written who's variant type HPSF does not yet support
UnsupportedEncodingException:: if the specified codepage is not supported.

See Also

Variant

read	back to summary
public static Object read(LittleEndianByteArrayInputStream lei, final int length, final long type, final int codepage) throws ReadingNotSupportedException, UnsupportedEncodingException

setLogUnsupportedTypes back to summary

setLogUnsupportedTypes	back to summary
public static void setLogUnsupportedTypes(final boolean logUnsupportedTypes) Specifies whether warnings about unsupported variant types are to be written to `System.err` or not. Parameters logUnsupportedTypes:boolean If `true` warnings will be written, if `false` they won't.

public static void setLogUnsupportedTypes(final boolean logUnsupportedTypes)

Specifies whether warnings about unsupported variant types are to be written to System.err or not.

Parameters

logUnsupportedTypes:boolean: If true warnings will be written, if false they won't.

write	back to summary
public static int write(final OutputStream out, final long type, final Object value, final int codepage) throws IOException, WritingNotSupportedException Writes a variant value to an output stream. This method ensures that always a multiple of 4 bytes is written. Parameters out:OutputStream The stream to write the value to. type:long The variant's type. value:Object The variant's value. codepage:int The codepage to use to write non-wide strings Returns:int The number of entities that have been written. In many cases an "entity" is a byte but this is not always the case. Exceptions IOException: if an I/O exceptions occurs WritingNotSupportedException: if a property is to be written who's variant type HPSF does not yet support

write

back to summary

public static int write(final OutputStream out, final long type, final Object value, final int codepage) throws IOException, WritingNotSupportedException

Writes a variant value to an output stream. This method ensures that always a multiple of 4 bytes is written.

Parameters

out:OutputStream: The stream to write the value to.
type:long: The variant's type.
value:Object: The variant's value.
codepage:int: The codepage to use to write non-wide strings

Returns:int

The number of entities that have been written. In many cases an "entity" is a byte but this is not always the case.

Exceptions

IOException:: if an I/O exceptions occurs
WritingNotSupportedException:: if a property is to be written who's variant type HPSF does not yet support

writeUnsupportedTypeMessage back to summary

writeUnsupportedTypeMessage	back to summary
protected static void writeUnsupportedTypeMessage(final UnsupportedVariantTypeException ex) Writes a warning to `System.err` that a variant type is unsupported by HPSF. Such a warning is written only once for each variant type. Log messages can be turned on or off by Parameters ex:UnsupportedVariantTypeException The exception to log

protected static void writeUnsupportedTypeMessage(final UnsupportedVariantTypeException ex)

Writes a warning to System.err that a variant type is unsupported by HPSF. Such a warning is written only once for each variant type. Log messages can be turned on or off by

Parameters

ex:UnsupportedVariantTypeException: The exception to log

public Class VariantSupport

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail