JabRef 5.15 · org.jabref.logic.bibtex.FieldWriter · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
public static final char	BIBTEX_STRING_START_END_SYMBOL
private static final char	FIELD_END
private static final char	FIELD_START
private static final Logger	LOGGER
private final boolean	neverFailOnHashes
private final FieldPreferences	preferences

Access	Constructor and Description
public	FieldWriter(FieldPreferences preferences)
private	FieldWriter(boolean neverFailOnHashes, FieldPreferences preferences)

Method Summary

Modifier and Type	Method and Description
public static FieldWriter	buildIgnoreHashes(FieldPreferences prefs)
private static void	checkBraces(String text)
private String	formatAndResolveStrings(String content, Field field) This method handles # in the field content to get valid bibtex strings For instance, `#jan# - #feb#` gets `jan #{ - } # feb` (see @link{org.jabref.logic.bibtex.LatexFieldFormatterTests#makeHashEnclosedWordsRealStringsInMonthField()})
private String	formatWithoutResolvingStrings(String content, Field field)
private static int	getFirstOccurrenceOfStartEndSymbol(String content, int pivot) Finds the first occurrence of # from the pivot point
private boolean	shouldResolveStrings(Field field)
public String	Returns: a formatted string suitable for output write(Field the name of the field - used to trigger different serializations, e.g., turning off resolution for some strings field, String the content of the field content) Formats the content of a field.
private void	writeStringLabel(StringBuilder the StringBuilder to append the text to stringBuilder, String the text use as basis to get the text to append text, int the position in text where the text to add starts startPos, int the position in text where the text to add ends endPos, boolean true if the label to write is the first one to write isFirst, boolean true if the label to write is the last one to write isLast)
private void	writeText(StringBuilder the StringBuilder to append the text to stringBuilder, String the text to append text, int startPos, int endPos)

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

BIBTEX_STRING_START_END_SYMBOL	back to summary
public static final char BIBTEX_STRING_START_END_SYMBOL

FIELD_END	back to summary
private static final char FIELD_END

FIELD_START	back to summary
private static final char FIELD_START

LOGGER	back to summary
private static final Logger LOGGER

neverFailOnHashes	back to summary
private final boolean neverFailOnHashes

preferences	back to summary
private final FieldPreferences preferences

FieldWriter	back to summary
public FieldWriter(FieldPreferences preferences)

FieldWriter	back to summary
private FieldWriter(boolean neverFailOnHashes, FieldPreferences preferences)

Method Detail

buildIgnoreHashes	back to summary
public static FieldWriter buildIgnoreHashes(FieldPreferences prefs)

checkBraces	back to summary
private static void checkBraces(String text) throws InvalidFieldValueException

formatAndResolveStrings back to summary

formatAndResolveStrings	back to summary
private String formatAndResolveStrings(String content, Field field) throws InvalidFieldValueException This method handles # in the field content to get valid bibtex strings For instance, `#jan# - #feb#` gets `jan #{ - } # feb` (see @link{org.jabref.logic.bibtex.LatexFieldFormatterTests#makeHashEnclosedWordsRealStringsInMonthField()})

private String formatAndResolveStrings(String content, Field field) throws InvalidFieldValueException

This method handles # in the field content to get valid bibtex strings

For instance, #jan# - #feb# gets jan #{ - } # feb (see @link{org.jabref.logic.bibtex.LatexFieldFormatterTests#makeHashEnclosedWordsRealStringsInMonthField()})

formatWithoutResolvingStrings	back to summary
private String formatWithoutResolvingStrings(String content, Field field) throws InvalidFieldValueException

getFirstOccurrenceOfStartEndSymbol	back to summary
private static int getFirstOccurrenceOfStartEndSymbol(String content, int pivot) Finds the first occurrence of # from the pivot point

shouldResolveStrings	back to summary
private boolean shouldResolveStrings(Field field)

write	back to summary
public String write(Field field, String content) throws InvalidFieldValueException Formats the content of a field. Parameters field:Field the name of the field - used to trigger different serializations, e.g., turning off resolution for some strings content:String the content of the field Returns:String a formatted string suitable for output Exceptions InvalidFieldValueException: if content is not a correct bibtex string, e.g., because of improperly balanced braces or using # not paired

write

back to summary

public String write(Field field, String content) throws InvalidFieldValueException

Formats the content of a field.

Parameters

field:Field: the name of the field - used to trigger different serializations, e.g., turning off resolution for some strings
content:String: the content of the field

Returns:String

a formatted string suitable for output

Exceptions

InvalidFieldValueException:: if content is not a correct bibtex string, e.g., because of improperly balanced braces or using # not paired

writeStringLabel	back to summary
private void writeStringLabel(StringBuilder stringBuilder, String text, int startPos, int endPos, boolean isFirst, boolean isLast) Parameters stringBuilder:StringBuilder the StringBuilder to append the text to text:String the text use as basis to get the text to append startPos:int the position in text where the text to add starts endPos:int the position in text where the text to add ends isFirst:boolean true if the label to write is the first one to write isLast:boolean true if the label to write is the last one to write

writeStringLabel

back to summary

private void writeStringLabel(StringBuilder stringBuilder, String text, int startPos, int endPos, boolean isFirst, boolean isLast)

Parameters

stringBuilder:StringBuilder: the StringBuilder to append the text to
text:String: the text use as basis to get the text to append
startPos:int: the position in text where the text to add starts
endPos:int: the position in text where the text to add ends
isFirst:boolean: true if the label to write is the first one to write
isLast:boolean: true if the label to write is the last one to write

writeText	back to summary
private void writeText(StringBuilder stringBuilder, String text, int startPos, int endPos) Parameters stringBuilder:StringBuilder the StringBuilder to append the text to text:String the text to append

public Class FieldWriter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail