Verified Owner
Top Description Fields Constructors Methods
org.jabref.logic.layout.format

public Class JournalAbbreviator

extends Object
implements LayoutFormatter
Class Inheritance
All Implemented Interfaces
org.jabref.logic.layout.LayoutFormatter
Imports
org.jabref.logic.journals.JournalAbbreviationRepository, org.jabref.logic.layout.LayoutFormatter, org.jspecify.annotations.NonNull
JournalAbbreviator formats the given text in an abbreviated form according to the journal abbreviation lists.

The given input text is abbreviated according to the journal abbreviation lists. If no abbreviation for input is found (e.g. not in list or already abbreviated), the input will be returned unmodified.

Usage: \formatJournalAbbreviator{\journal} Example result: "Phys. Rev. Lett." instead of "Physical Review Letters"

Field Summary

Modifier and TypeField and Description
private final JournalAbbreviationRepository
repository

Constructor Summary

AccessConstructor and Description
public
JournalAbbreviator(@NonNull JournalAbbreviationRepository repository)

Method Summary

Modifier and TypeMethod and Description
public String
format(String fieldText)

Implements org.jabref.logic.layout.LayoutFormatter.format.

Failure Mode:

Formatters should be robust in the sense that they always return some relevant string.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

repositoryback to summary
private final JournalAbbreviationRepository repository

Constructor Detail

JournalAbbreviatorback to summary
public JournalAbbreviator(@NonNull JournalAbbreviationRepository repository)

Method Detail

formatback to summary
public String format(String fieldText)

Implements org.jabref.logic.layout.LayoutFormatter.format.

Doc from org.jabref.logic.layout.LayoutFormatter.format.

Failure Mode:

Formatters should be robust in the sense that they always return some relevant string.

If the formatter can detect an invalid input it should return the original string otherwise it may simply return a wrong output.

Annotations
@Override