com.google.typography.font.sfntly.data

Class WritableFontData

java.lang.Object

com.google.typography.font.sfntly.data.FontData

com.google.typography.font.sfntly.data.ReadableFontData

com.google.typography.font.sfntly.data.WritableFontData

public final class WritableFontData
extends ReadableFontData

Writable font data wrapper. Supports writing of data primitives in the TrueType / OpenType spec.

Author:

Stuart Gill

Nested Class Summary

Nested classes/interfaces inherited from class com.google.typography.font.sfntly.data.FontData

FontData.DataSize

Method Summary

Modifier and Type	Method and Description
void	copyFrom(java.io.InputStream is) Copy everything from the InputStream into this FontData.
void	copyFrom(java.io.InputStream is, int length) Copy from the InputStream into this FontData.
static WritableFontData	createWritableFontData(byte[] b) Constructs a writable font data object.
static WritableFontData	createWritableFontData(int length) Constructs a writable font data object.
static WritableFontData	createWritableFontData(ReadableFontData original) Constructs a writable font data object.
WritableFontData	slice(int offset) Makes a bottom bound only slice of this array.
WritableFontData	slice(int offset, int length) Makes a slice of this FontData.
int	writeByte(int index, byte b) Writes a byte at the given index.
int	writeBytes(int index, byte[] b) Writes the bytes from the array.
int	writeBytes(int index, byte[] b, int offset, int length) Writes the bytes from the array.
int	writeBytesPad(int index, byte[] b, int offset, int length, byte pad) Writes the bytes from the array and pad if necessary.
int	writeChar(int index, byte c) Writes the CHAR at the given index.
int	writeDateTime(int index, long date) Writes the LONGDATETIME at the given index.
int	writeFixed(int index, int f) Writes the Fixed at the given index.
int	writeLong(int index, long l) Writes the LONG at the given index.
int	writePadding(int index, int count) Writes padding to the FontData.
int	writePadding(int index, int count, byte pad) Writes padding to the FontData.
int	writeShort(int index, int s) Writes the SHORT at the given index.
int	writeUInt24(int index, int ui) Writes the UINT24 at the given index.
int	writeULong(int index, long ul) Writes the ULONG at the given index.
int	writeULongLE(int index, long ul) Writes the ULONG at the given index in little endian format.
int	writeUShort(int index, int us) Writes the USHORT at the given index.
int	writeUShortLE(int index, int us) Writes the USHORT at the given index in little endian format.

Methods inherited from class com.google.typography.font.sfntly.data.ReadableFontData

checksum, checkSumRange, copyTo, copyTo, createReadableFontData, readByte, readBytes, readChar, readDateTimeAsLong, readF2Dot14, readFixed, readFUnit, readFWord, readLong, readLongDateTime, readShort, readUByte, readUFWord, readUInt24, readULong, readULongAsInt, readULongLE, readUShort, searchULong, searchUShort, searchUShort, setCheckSumRanges, toString, toString

Methods inherited from class com.google.typography.font.sfntly.data.FontData

bound, bound, length, size

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

createWritableFontData

public static final WritableFontData createWritableFontData(int length)

Constructs a writable font data object. If the length is specified as positive then a fixed size font data object will be created. If the length is zero or less then a growable font data object will be created and the size will be used as an estimate to help in allocating the original space.

Parameters:

length - if length > 0 create a fixed length font data; otherwise create a growable font data

Returns:

a new writable font data

createWritableFontData

public static final WritableFontData createWritableFontData(byte[] b)

Constructs a writable font data object. The new font data object will wrap the bytes passed in to the factory and it will take ownership of those bytes. They should not be used again by the caller.

Parameters:

b - the byte array to wrap

Returns:

a new writable font data

createWritableFontData

public static final WritableFontData createWritableFontData(ReadableFontData original)

Constructs a writable font data object. The new font data object will wrap a copy of the the data used by the original writable font data object passed in.

Parameters:

original - the source font data

Returns:

a new writable font data

slice

public WritableFontData slice(int offset,
                              int length)

Makes a slice of this FontData. The returned slice will share the data with the original FontData.

Overrides:

slice in class ReadableFontData

Parameters:

offset - the start of the slice

length - the number of bytes in the slice

Returns:

a slice of the original FontData

slice

public WritableFontData slice(int offset)

Makes a bottom bound only slice of this array. The returned slice will share the data with the original FontData.

Overrides:

slice in class ReadableFontData

Parameters:

offset - the start of the slice

Returns:

a slice of the original FontData

writeByte

public int writeByte(int index,
                     byte b)

Writes a byte at the given index.

Parameters:

index - index into the font data

b - the byte to write

Returns:

the number of bytes written

writeBytes

public int writeBytes(int index,
                      byte[] b,
                      int offset,
                      int length)

Writes the bytes from the array.

Parameters:

index - index into the font data

b - the source for the bytes to be written

offset - offset in the byte array

length - the length of the bytes to be written

Returns:

the number of bytes actually written; -1 if the index is outside the FontData's range

writeBytesPad

public int writeBytesPad(int index,
                         byte[] b,
                         int offset,
                         int length,
                         byte pad)

Writes the bytes from the array and pad if necessary. Writes to the length given using the byte array provided and if there are not enough bytes in the array then pad to the requested length using the pad byte specified.

Parameters:

index - index into the font data

b - the source for the bytes to be written

offset - offset in the byte array

length - the length of the bytes to be written

pad - the padding byte to be used if necessary

Returns:

the number of bytes actually written

writePadding

public int writePadding(int index,
                        int count)

Writes padding to the FontData. The padding byte written is 0x00.

Parameters:

index - index into the font data

count - the number of pad bytes to write

Returns:

the number of pad bytes written

writePadding

public int writePadding(int index,
                        int count,
                        byte pad)

Writes padding to the FontData.

Parameters:

index - index into the font data

count - the number of pad bytes to write

pad - the byte value to use as padding

Returns:

the number of pad bytes written

writeBytes

public int writeBytes(int index,
                      byte[] b)

Writes the bytes from the array.

Parameters:

index - index into the font data

b - the source for the bytes to be written

Returns:

the number of bytes actually written; -1 if the index is outside the FontData's range

writeChar

public int writeChar(int index,
                     byte c)

Writes the CHAR at the given index.

Parameters:

index - index into the font data

c - the CHAR

Returns:

the number of bytes actually written

Throws:

java.lang.IndexOutOfBoundsException - if index is outside the FontData's range

writeUShort

public int writeUShort(int index,
                       int us)

Writes the USHORT at the given index.

Parameters:

index - index into the font data

us - the USHORT

Returns:

the number of bytes actually written

Throws:

java.lang.IndexOutOfBoundsException - if index is outside the FontData's range

writeUShortLE

public int writeUShortLE(int index,
                         int us)

Writes the USHORT at the given index in little endian format.

Parameters:

index - index into the font data

us - the USHORT

Returns:

the number of bytes actually written

Throws:

java.lang.IndexOutOfBoundsException - if index is outside the FontData's range

writeShort

public int writeShort(int index,
                      int s)

Writes the SHORT at the given index.

Parameters:

index - index into the font data

s - the SHORT

Returns:

the number of bytes actually written

Throws:

java.lang.IndexOutOfBoundsException - if index is outside the FontData's range

writeUInt24

public int writeUInt24(int index,
                       int ui)

Writes the UINT24 at the given index.

Parameters:

index - index into the font data

ui - the UINT24

Returns:

the number of bytes actually written

Throws:

java.lang.IndexOutOfBoundsException - if index is outside the FontData's range

writeULong

public int writeULong(int index,
                      long ul)

Writes the ULONG at the given index.

Parameters:

index - index into the font data

ul - the ULONG

Returns:

the number of bytes actually written

Throws:

java.lang.IndexOutOfBoundsException - if index is outside the FontData's range

writeULongLE

public int writeULongLE(int index,
                        long ul)

Writes the ULONG at the given index in little endian format.

Parameters:

index - index into the font data

ul - the ULONG

Returns:

the number of bytes actually written

Throws:

java.lang.IndexOutOfBoundsException - if index is outside the FontData's range

writeLong

public int writeLong(int index,
                     long l)

Writes the LONG at the given index.

Parameters:

index - index into the font data

l - the LONG

Returns:

the number of bytes actually written

Throws:

java.lang.IndexOutOfBoundsException - if index is outside the FontData's range

writeFixed

public int writeFixed(int index,
                      int f)

Writes the Fixed at the given index.

Parameters:

index - index into the font data

f - the Fixed

Returns:

the number of bytes actually written

Throws:

java.lang.IndexOutOfBoundsException - if index is outside the FontData's range

writeDateTime

public int writeDateTime(int index,
                         long date)

Writes the LONGDATETIME at the given index.

Parameters:

index - index into the font data

date - the LONGDATETIME

Returns:

the number of bytes actually written

Throws:

java.lang.IndexOutOfBoundsException - if index is outside the FontData's range

copyFrom

public void copyFrom(java.io.InputStream is,
                     int length)
              throws java.io.IOException

Copy from the InputStream into this FontData.

Parameters:

is - the source

length - the number of bytes to copy

Throws:

java.io.IOException

copyFrom

public void copyFrom(java.io.InputStream is)
              throws java.io.IOException

Copy everything from the InputStream into this FontData.

Parameters:

is - the source

Throws:

java.io.IOException