Package org.ctan.site.services.catalogue

Class BibtexService

java.lang.Object

org.ctan.site.services.catalogue.BibtexService

public class BibtexService
extends Object

This service provides special methods for dealing with BibTeX files.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BibtexService.BibtexConfig	The configuration for the BibTeX service.

Constructor Summary

Constructors

Constructor	Description
BibtexService(@NonNull PkgStore store)	This is the constructor for BibtexService.

Method Summary

Modifier and Type	Method	Description
String	toBibtex(BibtexService.BibtexConfig cfg)	Generate a BibTeX file for all packages.
String	toBibtex(BibtexService.BibtexConfig cfg, String... pkgNames)	Generate a BibTeX file for a list of packages.
String	toBibtex(BibtexService.BibtexConfig cfg, Pkg... packages)	Generate a BibTeX file for a list of packages.

Methods inherited from class java.lang.Object

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

Constructor Details

BibtexService

public BibtexService(@NonNull
 @NonNull PkgStore store)

This is the constructor for BibtexService.

Parameters:

store - the package store

Method Details

toBibtex

public String toBibtex(BibtexService.BibtexConfig cfg)

Generate a BibTeX file for all packages.

Parameters:

cfg - the configuration

Returns:

the content of the BibTeX file

toBibtex

public String toBibtex(BibtexService.BibtexConfig cfg,
 Pkg... packages)

Generate a BibTeX file for a list of packages.

Parameters:

cfg - the configuration

packages - the array of package names to include

Returns:

the content of the BibTeX file

toBibtex

public String toBibtex(BibtexService.BibtexConfig cfg,
 String... pkgNames)

Generate a BibTeX file for a list of packages.

Parameters:

cfg - the configuration

pkgNames - the array of package names to include

Returns:

the content of the BibTeX file