org.openimaj.citation.annotation.output

Enum StandardFormatters

java.lang.Object

java.lang.Enum<StandardFormatters>

org.openimaj.citation.annotation.output.StandardFormatters

All Implemented Interfaces:

Serializable, Comparable<StandardFormatters>, ReferenceFormatter

public enum StandardFormatters
extends Enum<StandardFormatters>
implements ReferenceFormatter

Standard reference formatters.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Enum Constant Summary

Enum Constants

Enum Constant and Description
BIBTEX Format references as BibTeX.
HTML Format as an HTML fragment
REFERENCE_ANNOTATION Format as a Reference annotation for inclusion in code
STRING Format as a pretty string

Method Summary

Modifier and Type	Method and Description
String	format(Collection<Reference> refs) Format a multiples references
abstract String	format(Reference ref) Format a single reference
protected abstract String	formatRefs(Iterable<Reference> refs)
static StandardFormatters	valueOf(String name) Returns the enum constant of this type with the specified name.
static StandardFormatters[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BIBTEX

public static final StandardFormatters BIBTEX

Format references as BibTeX.

REFERENCE_ANNOTATION

public static final StandardFormatters REFERENCE_ANNOTATION

Format as a Reference annotation for inclusion in code

STRING

public static final StandardFormatters STRING

Format as a pretty string

HTML

public static final StandardFormatters HTML

Format as an HTML fragment

Method Detail

values

public static StandardFormatters[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (StandardFormatters c : StandardFormatters.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static StandardFormatters valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

formatRefs

protected abstract String formatRefs(Iterable<Reference> refs)

format

public abstract String format(Reference ref)

Description copied from interface: ReferenceFormatter

Format a single reference

Specified by:

format in interface ReferenceFormatter

Parameters:

ref - the Reference to format

Returns:

formatted Reference

format

public String format(Collection<Reference> refs)

Description copied from interface: ReferenceFormatter

Format a multiples references

Specified by:

format in interface ReferenceFormatter

Parameters:

refs - the References to format

Returns:

formatted References