JBibTeX 1.0.20 · org.jbibtex.BibTeXParser · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
private static class	BibTeXParser.Field
pack-priv static class	BibTeXParser.JJCalls
private static class	BibTeXParser.LookaheadSuccess

Field Summary

Modifier and Type	Field and Description
private BibTeXDatabase	database
private List<Exception>	exceptions
private long	id
private final BibTeXParser.JJCalls[]	jj_2_rtns
private int	jj_endpos
private List<int[]>	jj_expentries
private int[]	jj_expentry
private int	jj_gc
private int	jj_gen
pack-priv SimpleCharStream	jj_input_stream
private int	jj_kind
private int	jj_la
private final int[]	jj_la1
private static int[]	jj_la1_0
private static int[]	jj_la1_1
private Token	jj_lastpos
private int[]	jj_lasttokens
private static final BibTeXParser.LookaheadSuccess	jj_ls
public Token	jj_nt Next token.
private int	jj_ntk
private boolean	jj_rescan
private Token	jj_scanpos
private KeyMap<BibTeXString>	macros
public Token	token Current token.
public BibTeXParserTokenManager	token_source Generated Token Manager.
private boolean	trace_enabled

Constructor Summary

Access	Constructor and Description
public	BibTeXParser()
public	BibTeXParser(Provider stream) Constructor.
public	BibTeXParser(String dsl) Constructor.
public	BibTeXParser(BibTeXParserTokenManager tm) Constructor with generated Token Manager.

Method Summary

Modifier and Type	Method and Description
public void	addMacro(String key, String value)
public void	addMacro(BibTeXString macro)
private final BibTeXParser.Field	Assignment()
private final List<BibTeXParser.Field>	AssignmentList()
public void	checkCrossReferenceResolution(Key key, BibTeXEntry entry) Checks the `entry` argument before constructing a new `CrossReferenceValue` instance.
public void	checkStringResolution(Key key, BibTeXString string) Checks the `string` argument before constructing a new `ReferenceValue` instance.
private final BibTeXComment	Comment()
private final BibTeXDatabase	Database(boolean performErrorRecovery)
public final void	disable_tracing() Disable tracing.
public final void	enable_tracing() Enable tracing.
private final BibTeXEntry	Entry()
public ParseException	generateParseException() Generate ParseException.
public BibTeXDatabase	getDatabase()
public List<Exception>	getExceptions()
public KeyMap<BibTeXString>	getMacros()
public final Token	getNextToken() Get the next Token.
public final Token	getToken(int index) Get the specific Token.
private <E extends Exception> void	handleException(E e, boolean performErrorRecovery)
private final Token	Identifier()
private final BibTeXInclude	Include()
private static boolean	isDigitString(String string)
private boolean	jj_2_1(int xla)
private boolean	jj_2_2(int xla)
private boolean	jj_2_3(int xla)
private boolean	jj_2_4(int xla)
private boolean	jj_2_5(int xla)
private boolean	jj_2_6(int xla)
private boolean	jj_2_7(int xla)
private boolean	jj_2_8(int xla)
private boolean	jj_2_9(int xla)
private boolean	jj_3_1()
private boolean	jj_3_2()
private boolean	jj_3_3()
private boolean	jj_3_4()
private boolean	jj_3_5()
private boolean	jj_3_6()
private boolean	jj_3_7()
private boolean	jj_3_8()
private boolean	jj_3_9()
private boolean	jj_3R_Identifier_602_9_3()
private boolean	jj_3R_Name_580_9_4()
private void	jj_add_error_token(int kind, int pos)
private Token	jj_consume_token(int kind)
private static void	jj_la1_init_0()
private static void	jj_la1_init_1()
private int	jj_ntk_f()
private void	jj_rescan_token()
private void	jj_save(int index, int xla)
private boolean	jj_scan_token(int kind)
private final Key	Key()
private String	Literal(int braceLevel, String delimiter)
private final Token	Name()
public String	nextKey() Generates a key value for an anonymous BibTeX bibliography database entry.
private final BibTeXObject	Object()
public BibTeXDatabase	parse(Reader reader) Parses the BibTeX document in "normal" mode.
private static BibTeXDatabase	parseBibTeXDatabase(File file)
public BibTeXDatabase	parseFully(Reader reader) Parses the BibTeX document in "error recovery" mode.
private final BibTeXPreamble	Preamble()
public void	ReInit(String s)
public void	ReInit(Provider stream) Reinitialise.
public void	ReInit(BibTeXParserTokenManager tm) Reinitialise.
public void	removeMacro(String key)
public void	removeMacro(BibTeXString macro)
private void	resolveCrossReferences()
private void	setDatabase(BibTeXDatabase database)
private void	SetState(int state)
private final Value	SimpleValue()
private void	SkipTo(String symbol)
private final BibTeXString	String()
public final boolean	trace_enabled() Trace enabled.
private final Value	Value()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

database	back to summary
private BibTeXDatabase database

exceptions	back to summary
private List<Exception> exceptions

id	back to summary
private long id

jj_2_rtns	back to summary
private final BibTeXParser.JJCalls[] jj_2_rtns

jj_endpos	back to summary
private int jj_endpos

jj_expentries	back to summary
private List<int[]> jj_expentries

jj_expentry	back to summary
private int[] jj_expentry

jj_gc	back to summary
private int jj_gc

jj_gen	back to summary
private int jj_gen

jj_input_stream	back to summary
pack-priv SimpleCharStream jj_input_stream

jj_kind	back to summary
private int jj_kind

jj_la	back to summary
private int jj_la

jj_la1	back to summary
private final int[] jj_la1

jj_la1_0	back to summary
private static int[] jj_la1_0

jj_la1_1	back to summary
private static int[] jj_la1_1

jj_lastpos	back to summary
private Token jj_lastpos

jj_lasttokens	back to summary
private int[] jj_lasttokens

jj_ls	back to summary
private static final BibTeXParser.LookaheadSuccess jj_ls

jj_nt	back to summary
public Token jj_nt Next token.

jj_ntk	back to summary
private int jj_ntk

jj_rescan	back to summary
private boolean jj_rescan

jj_scanpos	back to summary
private Token jj_scanpos

macros	back to summary
private KeyMap<BibTeXString> macros

token	back to summary
public Token token Current token.

token_source	back to summary
public BibTeXParserTokenManager token_source Generated Token Manager.

trace_enabled	back to summary
private boolean trace_enabled

Constructor Detail

BibTeXParser	back to summary
public BibTeXParser() throws ParseException, TokenMgrException

BibTeXParser	back to summary
public BibTeXParser(Provider stream) Constructor.

BibTeXParser	back to summary
public BibTeXParser(String dsl) throws ParseException, TokenMgrException Constructor.

BibTeXParser	back to summary
public BibTeXParser(BibTeXParserTokenManager tm) Constructor with generated Token Manager.

Method Detail

addMacro	back to summary
public void addMacro(String key, String value)

addMacro	back to summary
public void addMacro(BibTeXString macro)

Assignment	back to summary
private final BibTeXParser.Field Assignment() throws ParseException

AssignmentList	back to summary
private final List<BibTeXParser.Field> AssignmentList() throws ParseException

checkCrossReferenceResolution back to summary

checkCrossReferenceResolution	back to summary
public void checkCrossReferenceResolution(Key key, BibTeXEntry entry) Checks the `entry` argument before constructing a new `CrossReferenceValue` instance. The default behaviour is to prohibit unresolved references. Exceptions ObjectResolutionException: If the `entry` is `null`. See Also `BibTeXDatabase#resolveEntry(Key)`

public void checkCrossReferenceResolution(Key key, BibTeXEntry entry)

Checks the entry argument before constructing a new CrossReferenceValue instance. The default behaviour is to prohibit unresolved references.

Exceptions

ObjectResolutionException:: If the entry is null.

See Also

BibTeXDatabase#resolveEntry(Key)

checkStringResolution back to summary

checkStringResolution	back to summary
public void checkStringResolution(Key key, BibTeXString string) Checks the `string` argument before constructing a new `ReferenceValue` instance. The default behaviour is to prohibit unresolved references. Exceptions ObjectResolutionException: If the `string` is `null`. See Also `BibTeXDatabase#resolveString(Key)`, `BibTeXParser#getMacros()`

public void checkStringResolution(Key key, BibTeXString string)

Checks the string argument before constructing a new ReferenceValue instance. The default behaviour is to prohibit unresolved references.

Exceptions

ObjectResolutionException:: If the string is null.

Comment	back to summary
private final BibTeXComment Comment() throws ParseException

Database	back to summary
private final BibTeXDatabase Database(boolean performErrorRecovery) throws ParseException

disable_tracing	back to summary
public final void disable_tracing() Disable tracing.

enable_tracing	back to summary
public final void enable_tracing() Enable tracing.

Entry	back to summary
private final BibTeXEntry Entry() throws ParseException

generateParseException	back to summary
public ParseException generateParseException() Generate ParseException.

getDatabase	back to summary
public BibTeXDatabase getDatabase()

getExceptions	back to summary
public List<Exception> getExceptions()

getMacros	back to summary
public KeyMap<BibTeXString> getMacros()

getNextToken	back to summary
public final Token getNextToken() Get the next Token.

getToken	back to summary
public final Token getToken(int index) Get the specific Token.

handleException	back to summary
private <E extends Exception> void handleException(E e, boolean performErrorRecovery) throws handleException-E-boolean-:E

Identifier	back to summary
private final Token Identifier() throws ParseException

Include	back to summary
private final BibTeXInclude Include() throws ParseException

isDigitString	back to summary
private static boolean isDigitString(String string)

jj_2_1	back to summary
private boolean jj_2_1(int xla)

jj_2_2	back to summary
private boolean jj_2_2(int xla)

jj_2_3	back to summary
private boolean jj_2_3(int xla)

jj_2_4	back to summary
private boolean jj_2_4(int xla)

jj_2_5	back to summary
private boolean jj_2_5(int xla)

jj_2_6	back to summary
private boolean jj_2_6(int xla)

jj_2_7	back to summary
private boolean jj_2_7(int xla)

jj_2_8	back to summary
private boolean jj_2_8(int xla)

jj_2_9	back to summary
private boolean jj_2_9(int xla)

jj_3_1	back to summary
private boolean jj_3_1()

jj_3_2	back to summary
private boolean jj_3_2()

jj_3_3	back to summary
private boolean jj_3_3()

jj_3_4	back to summary
private boolean jj_3_4()

jj_3_5	back to summary
private boolean jj_3_5()

jj_3_6	back to summary
private boolean jj_3_6()

jj_3_7	back to summary
private boolean jj_3_7()

jj_3_8	back to summary
private boolean jj_3_8()

jj_3_9	back to summary
private boolean jj_3_9()

jj_3R_Identifier_602_9_3	back to summary
private boolean jj_3R_Identifier_602_9_3()

jj_3R_Name_580_9_4	back to summary
private boolean jj_3R_Name_580_9_4()

jj_add_error_token	back to summary
private void jj_add_error_token(int kind, int pos)

jj_consume_token	back to summary
private Token jj_consume_token(int kind) throws ParseException

jj_la1_init_0	back to summary
private static void jj_la1_init_0()

jj_la1_init_1	back to summary
private static void jj_la1_init_1()

jj_ntk_f	back to summary
private int jj_ntk_f()

jj_rescan_token	back to summary
private void jj_rescan_token()

jj_save	back to summary
private void jj_save(int index, int xla)

jj_scan_token	back to summary
private boolean jj_scan_token(int kind)

Key	back to summary
private final Key Key() throws ParseException

Literal	back to summary
private String Literal(int braceLevel, String delimiter) throws ParseException, ParseException

Name	back to summary
private final Token Name() throws ParseException

nextKey back to summary

public String nextKey()

Generates a key value for an anonymous BibTeX bibliography database entry.

See Also: BibTeXEntry#getKey, BibTeXDatabase#resolveEntry(Key)

Object	back to summary
private final BibTeXObject Object() throws ParseException

parse back to summary

public BibTeXDatabase parse(Reader reader) throws ObjectResolutionException, ParseException, TokenMgrException

Parses the BibTeX document in "normal" mode. The parser throws an exception is an error condition is detected.

Exceptions

ObjectResolutionException:: If the database is inconsistent.
ParseException:: If the produced sequence of tokens cannot be consumed.
TokenMgrException:: If a token cannot be produced.

See Also

CharacterFilterReader

parseBibTeXDatabase	back to summary
private static BibTeXDatabase parseBibTeXDatabase(File file) throws ParseException

parseFully back to summary

public BibTeXDatabase parseFully(Reader reader) throws ObjectResolutionException

Parses the BibTeX document in "error recovery" mode. The parser does its best to recover from typical error conditions by skipping the problematic object definition. The parser maintains a list of exceptions. This list is cleared when a parse method is invoked again.

Exceptions

ObjectResolutionException:: If the database is inconsistent.

See Also

CharacterFilterReader

Preamble	back to summary
private final BibTeXPreamble Preamble() throws ParseException

ReInit	back to summary
public void ReInit(String s)

ReInit	back to summary
public void ReInit(Provider stream) Reinitialise.

ReInit	back to summary
public void ReInit(BibTeXParserTokenManager tm) Reinitialise.

removeMacro	back to summary
public void removeMacro(String key)

removeMacro	back to summary
public void removeMacro(BibTeXString macro)

resolveCrossReferences	back to summary
private void resolveCrossReferences()

setDatabase	back to summary
private void setDatabase(BibTeXDatabase database)

SetState	back to summary
private void SetState(int state) throws ParseException

SimpleValue	back to summary
private final Value SimpleValue() throws ParseException

SkipTo	back to summary
private void SkipTo(String symbol) throws ParseException, ParseException

String	back to summary
private final BibTeXString String() throws ParseException

trace_enabled	back to summary
public final boolean trace_enabled() Trace enabled.

Value	back to summary
private final Value Value() throws ParseException

public Class BibTeXParser

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class BibTeXParser.Field

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class BibTeXParser.JJCalls

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

private final Class BibTeXParser.LookaheadSuccess

Constructor Summary

Method Summary

Constructor Detail

Method Detail

Modifier and Type	Method and Description
public Key	getKey()
public Value	getValue()
private void	setKey(Key key)
private void	setValue(Value value)

Modifier and Type	Field and Description
pack-priv int	arg
pack-priv Token	first
pack-priv int	gen
pack-priv BibTeXParser.JJCalls	next