de.hpi.fgis.dude.util.bibtex.expander
Class AbstractExpander

java.lang.Object
  de.hpi.fgis.dude.util.bibtex.expander.AbstractExpander

Direct Known Subclasses:

CrossReferenceExpander, MacroReferenceExpander, PersonListExpander

public abstract class AbstractExpander
extends Object

Author:

henkel

Constructor Summary

protected

AbstractExpander(boolean throwAllExpansionExceptions)

Method Summary

protected void	finishExpansion() Call this at the end of your expand(BibtexFile) implementation.
ExpansionException[]	getExceptions()
protected void	throwExpansionException(Exception cause) Call this whenever you want to throw an ExpansionException.
protected void	throwExpansionException(String message) Call this whenever you want to throw an ExpansionException.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractExpander

protected AbstractExpander(boolean throwAllExpansionExceptions)

Parameters:

throwAllExpansionExceptions - Setting this to true means that all exceptions will be thrown immediately. Otherwise, the expander will skip over things it can't expand and you can use getExceptions to retrieve the exceptions later

Method Detail

getExceptions

public ExpansionException[] getExceptions()

finishExpansion

protected void finishExpansion()

Call this at the end of your expand(BibtexFile) implementation.

throwExpansionException

protected void throwExpansionException(String message)
                                throws ExpansionException

Call this whenever you want to throw an ExpansionException. This method may or may not throw the exception, depending on the throwAllExpansionExceptions flag.

Parameters:

message -

Throws:

ExpansionException

throwExpansionException

protected void throwExpansionException(Exception cause)
                                throws ExpansionException

Call this whenever you want to throw an ExpansionException. This method may or may not throw the exception, depending on the throwAllExpansionExceptions flag.

Parameters:

cause -

Throws:

ExpansionException