com.google.typography.font.sfntly

Class FontFactory

java.lang.Object

com.google.typography.font.sfntly.FontFactory

public final class FontFactory
extends java.lang.Object

The font factory. This is the root class for the creation and loading of fonts.

Author:

Stuart Gill

Method Summary

Modifier and Type	Method and Description
boolean	fingerprintFont() Get the state of the fingerprinting option for fonts that are loaded.
void	fingerprintFont(boolean fingerprint) Toggle whether fonts that are loaded are fingerprinted with a SHA-1 hash.
static FontFactory	getInstance() Factory method for the construction of a font factory.
Font[]	loadFonts(byte[] b) Load the font(s) from the byte array.
Font[]	loadFonts(java.io.InputStream is) Load the font(s) from the input stream.
Font.Builder[]	loadFontsForBuilding(byte[] b) Load the font(s) from the byte array into font builders.
Font.Builder[]	loadFontsForBuilding(java.io.InputStream is) Load the font(s) from the input stream into font builders.
Font.Builder	newFontBuilder() Get an empty font builder for creating a new font from scratch.
void	serializeFont(Font font, java.io.OutputStream os) Serialize the font to the output stream.
void	setSerializationTableOrdering(java.util.List<java.lang.Integer> tableOrdering) Set the table ordering to be used in serializing a font.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static FontFactory getInstance()

Factory method for the construction of a font factory.

Returns:

a new font factory

fingerprintFont

public void fingerprintFont(boolean fingerprint)

Toggle whether fonts that are loaded are fingerprinted with a SHA-1 hash. If a font is fingerprinted then a SHA-1 hash is generated at load time and stored in the font. This is useful for uniquely identifying fonts. By default this is turned on.

Parameters:

fingerprint - whether fingerprinting should be turned on or off

See Also:

fingerprintFont(), Font.digest()

fingerprintFont

public boolean fingerprintFont()

Get the state of the fingerprinting option for fonts that are loaded.

Returns:

true if fingerprinting is turned on; false otherwise

See Also:

fingerprintFont(boolean), Font.digest()

loadFonts

public Font[] loadFonts(java.io.InputStream is)
                 throws java.io.IOException

Load the font(s) from the input stream. The current settings on the factory are used during the loading process. One or more fonts are returned if the stream contains valid font data. Some font container formats may have more than one font and in this case multiple font objects will be returned. If the data in the stream cannot be parsed or is invalid an array of size zero will be returned.

Parameters:

is - the input stream font data

Returns:

one or more fonts

Throws:

java.io.IOException

loadFontsForBuilding

public Font.Builder[] loadFontsForBuilding(java.io.InputStream is)
                                    throws java.io.IOException

Load the font(s) from the input stream into font builders. The current settings on the factory are used during the loading process. One or more font builders are returned if the stream contains valid font data. Some font container formats may have more than one font and in this case multiple font builder objects will be returned. If the data in the stream cannot be parsed or is invalid an array of size zero will be returned.

Parameters:

is - the input stream font data

Returns:

one or more font builders

Throws:

java.io.IOException

loadFonts

public Font[] loadFonts(byte[] b)
                 throws java.io.IOException

Load the font(s) from the byte array. The current settings on the factory are used during the loading process. One or more fonts are returned if the stream contains valid font data. Some font container formats may have more than one font and in this case multiple font objects will be returned. If the data in the stream cannot be parsed or is invalid an array of size zero will be returned.

Parameters:

b - the font data

Returns:

one or more fonts

Throws:

java.io.IOException

loadFontsForBuilding

public Font.Builder[] loadFontsForBuilding(byte[] b)
                                    throws java.io.IOException

Load the font(s) from the byte array into font builders. The current settings on the factory are used during the loading process. One or more font builders are returned if the stream contains valid font data. Some font container formats may have more than one font and in this case multiple font builder objects will be returned. If the data in the stream cannot be parsed or is invalid an array of size zero will be returned.

Parameters:

b - the byte array font data

Returns:

one or more font builders

Throws:

java.io.IOException

serializeFont

public void serializeFont(Font font,
                          java.io.OutputStream os)
                   throws java.io.IOException

Serialize the font to the output stream.

Parameters:

font - the font to serialize

os - the destination stream for the font

Throws:

java.io.IOException

setSerializationTableOrdering

public void setSerializationTableOrdering(java.util.List<java.lang.Integer> tableOrdering)

Set the table ordering to be used in serializing a font. The table ordering is an ordered list of table ids and tables will be serialized in the order given. Any tables whose id is not listed in the ordering will be placed in an unspecified order following those listed.

Parameters:

tableOrdering - the table ordering

newFontBuilder

public Font.Builder newFontBuilder()

Get an empty font builder for creating a new font from scratch.

Returns:

an empty font builder