org.carewebframework.maven.plugin.help.chm

Class BinaryTransform

java.lang.Object

org.carewebframework.maven.plugin.transform.AbstractTransform

org.carewebframework.maven.plugin.help.chm.BaseTransform

org.carewebframework.maven.plugin.help.chm.BinaryTransform

Direct Known Subclasses:

SystemTransform, TopicTransform

public abstract class BinaryTransform
extends BaseTransform

Base transform for accessing structured data from a binary source.

Field Summary

Fields inherited from class org.carewebframework.maven.plugin.help.chm.BaseTransform

CS_UTF8, CS_WIN1252, type, UTF8, WIN1252

Fields inherited from class org.carewebframework.maven.plugin.transform.AbstractTransform

mojo

Constructor Summary

Constructors

Constructor and Description
BinaryTransform(BaseMojo mojo, String type)

Method Summary

Modifier and Type	Method and Description
protected String	getString(byte[] data) Returns a string value from a zero-terminated byte array.
protected String	getString(byte[] data, int offset) Returns a string value from a zero-terminated byte array at the specified offset.
protected String	getString(byte[] data, int offset, int length) Returns a string value from the byte array.
protected byte[]	loadBinaryFile(String file) Loads the entire contents of a binary file into a byte array.
protected int	readDWord(byte[] data, int offset) Reads a four-byte integer from a byte array at the specified offset.
protected int	readDWord(InputStream inputStream) Reads a four-byte integer from the input stream.
protected int	readWord(byte[] data, int offset) Reads a two-byte integer from a byte array at the specified offset.
protected int	readWord(InputStream inputStream) Reads a two-byte integer from the input stream.
void	transform(IResource resource, OutputStream outputStream)

Methods inherited from class org.carewebframework.maven.plugin.help.chm.BaseTransform

extractAttribute, getTargetPath, write, write, writeAttribute, writeSetting

Methods inherited from class org.carewebframework.maven.plugin.transform.AbstractTransform

transform

Methods inherited from class java.lang.Object

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

Constructor Detail

BinaryTransform

public BinaryTransform(BaseMojo mojo,
                       String type)

Method Detail

transform

public void transform(IResource resource,
                      OutputStream outputStream)
               throws Exception

Overrides:

transform in class BaseTransform

Throws:

Exception

readDWord

protected int readDWord(InputStream inputStream)
                 throws IOException

Reads a four-byte integer from the input stream.

Parameters:

inputStream - The input stream.

Returns:

A four-byte integer value.

Throws:

IOException

readWord

protected int readWord(InputStream inputStream)
                throws IOException

Reads a two-byte integer from the input stream.

Parameters:

inputStream - The input stream.

Returns:

A two-byte integer value.

Throws:

IOException - Exception while reading from input stream.

readDWord

protected int readDWord(byte[] data,
                        int offset)

Reads a four-byte integer from a byte array at the specified offset.

Parameters:

data - The source data.

offset - The byte offset.

Returns:

A four-byte integer value.

readWord

protected int readWord(byte[] data,
                       int offset)

Reads a two-byte integer from a byte array at the specified offset.

Parameters:

data - The source data.

offset - The byte offset.

Returns:

A two-byte integer value.

getString

protected String getString(byte[] data)

Returns a string value from a zero-terminated byte array.

Parameters:

data - The source data.

Returns:

A string.

getString

protected String getString(byte[] data,
                           int offset)

Returns a string value from a zero-terminated byte array at the specified offset.

Parameters:

data - The source data.

offset - The byte offset.

Returns:

A string.

getString

protected String getString(byte[] data,
                           int offset,
                           int length)

Returns a string value from the byte array.

Parameters:

data - The source data.

offset - The byte offset.

length - The string length.

Returns:

A string

loadBinaryFile

protected byte[] loadBinaryFile(String file)
                         throws IOException

Loads the entire contents of a binary file into a byte array.

Parameters:

file - The path to the binary file.

Returns:

The contents of the input file as a byte array

Throws:

IOException - Exception while reading from file.