com.google.typography.font.sfntly.table.core

Class NameTable

java.lang.Object

com.google.typography.font.sfntly.table.FontDataTable

com.google.typography.font.sfntly.table.Table

com.google.typography.font.sfntly.table.SubTableContainerTable

com.google.typography.font.sfntly.table.core.NameTable

All Implemented Interfaces:

java.lang.Iterable<NameTable.NameEntry>

public final class NameTable
extends SubTableContainerTable
implements java.lang.Iterable<NameTable.NameEntry>

A Name table.

Author:

Stuart Gill

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NameTable.Builder
static class	NameTable.MacintoshLanguageId Macinstosh Language IDs (platform ID = 1)
static class	NameTable.NameEntry Class to represent a name entry in the name table.
static class	NameTable.NameEntryBuilder
static interface	NameTable.NameEntryFilter An interface for a filter to use with the name entry iterator.
static class	NameTable.NameId
static class	NameTable.Offset Offsets to specific elements in the underlying data.
static class	NameTable.UnicodeLanguageId
static class	NameTable.WindowsLanguageId Windows Language IDs (platform ID = 3)

Method Summary

Modifier and Type	Method and Description
int	encodingId(int index) Get the encoding id for the given name record.
int	format()
java.util.Iterator<NameTable.NameEntry>	iterator()
java.util.Iterator<NameTable.NameEntry>	iterator(NameTable.NameEntryFilter filter) Get an iterator over name entries in the name table.
int	languageId(int index) Get the language id for the given name record.
java.lang.String	name(int index) Get the name as a String for the given name record.
java.lang.String	name(int platformId, int encodingId, int languageId, int nameId) Get the name as a String for the specified name.
byte[]	nameAsBytes(int index) Get the name as bytes for the given name record.
byte[]	nameAsBytes(int platformId, int encodingId, int languageId, int nameId) Get the name as bytes for the specified name.
int	nameCount() Get the number of names in the name table.
NameTable.NameEntry	nameEntry(int index) Get the name entry record for the given name entry.
NameTable.NameEntry	nameEntry(int platformId, int encodingId, int languageId, int nameId) Get the name entry record for the specified name.
int	nameId(int index) Get the name id for given name record.
java.util.Set<NameTable.NameEntry>	names() Get all the name entry records.
int	platformId(int index) Get the platform id for the given name record.

Methods inherited from class com.google.typography.font.sfntly.table.Table

calculatedChecksum, header, headerChecksum, headerLength, headerOffset, headerTag, toString

Methods inherited from class com.google.typography.font.sfntly.table.FontDataTable

dataLength, readFontData, serialize

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

format

public int format()

nameCount

public int nameCount()

Get the number of names in the name table.

Returns:

the number of names

platformId

public int platformId(int index)

Get the platform id for the given name record.

Parameters:

index - the index of the name record

Returns:

the platform id

See Also:

Font.PlatformId

encodingId

public int encodingId(int index)

Get the encoding id for the given name record.

Parameters:

index - the index of the name record

Returns:

the encoding id

See Also:

Font.MacintoshEncodingId, Font.WindowsEncodingId, Font.UnicodeEncodingId

languageId

public int languageId(int index)

Get the language id for the given name record.

Parameters:

index - the index of the name record

Returns:

the language id

nameId

public int nameId(int index)

Get the name id for given name record.

Parameters:

index - the index of the name record

Returns:

the name id

nameAsBytes

public byte[] nameAsBytes(int index)

Get the name as bytes for the given name record.

Parameters:

index - the index of the name record

Returns:

the bytes for the name

nameAsBytes

public byte[] nameAsBytes(int platformId,
                          int encodingId,
                          int languageId,
                          int nameId)

Get the name as bytes for the specified name. If there is no entry for the requested name then null is returned.

Parameters:

platformId - the platform id

encodingId - the encoding id

languageId - the language id

nameId - the name id

Returns:

the bytes for the name

name

public java.lang.String name(int index)

Get the name as a String for the given name record. If there is no encoding conversion available for the name record then a best attempt String will be returned.

Parameters:

index - the index of the name record

Returns:

the name

name

public java.lang.String name(int platformId,
                             int encodingId,
                             int languageId,
                             int nameId)

Get the name as a String for the specified name. If there is no entry for the requested name then null is returned. If there is no encoding conversion available for the name then a best attempt String will be returned.

Parameters:

platformId - the platform id

encodingId - the encoding id

languageId - the language id

nameId - the name id

Returns:

the name

nameEntry

public NameTable.NameEntry nameEntry(int index)

Get the name entry record for the given name entry.

Parameters:

index - the index of the name record

Returns:

the name entry

nameEntry

public NameTable.NameEntry nameEntry(int platformId,
                                     int encodingId,
                                     int languageId,
                                     int nameId)

Get the name entry record for the specified name. If there is no entry for the requested name then null is returned.

Parameters:

platformId - the platform id

encodingId - the encoding id

languageId - the language id

nameId - the name id

Returns:

the name entry

names

public java.util.Set<NameTable.NameEntry> names()

Get all the name entry records.

Returns:

the set of all name entry records

iterator

public java.util.Iterator<NameTable.NameEntry> iterator()

Specified by:

iterator in interface java.lang.Iterable<NameTable.NameEntry>

iterator

public java.util.Iterator<NameTable.NameEntry> iterator(NameTable.NameEntryFilter filter)

Get an iterator over name entries in the name table.

Parameters:

filter - a filter to select acceptable name entries

Returns:

an iterator over name entries