Package de.undercouch.citeproc

Class DefaultAbbreviationProvider

java.lang.Object

de.undercouch.citeproc.DefaultAbbreviationProvider

All Implemented Interfaces:

AbbreviationProvider

public class DefaultAbbreviationProvider
extends java.lang.Object
implements AbbreviationProvider

Default implementation of AbbreviationProvider

Author:

Michel Kraemer

Constructor Summary

Constructors

Constructor	Description
DefaultAbbreviationProvider()

Method Summary

Modifier and Type	Method	Description
void	addAbbreviation(java.lang.String variable, java.lang.String original, java.lang.String abbreviation)
java.lang.String	getAbbreviation(java.lang.String variable, java.lang.String original, CSLItemData item)	Retrieves an abbreviation for a given variable

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultAbbreviationProvider

public DefaultAbbreviationProvider()

Method Detail

addAbbreviation

public void addAbbreviation(java.lang.String variable,
                            java.lang.String original,
                            java.lang.String abbreviation)

getAbbreviation

public java.lang.String getAbbreviation(java.lang.String variable,
                                        java.lang.String original,
                                        CSLItemData item)

Description copied from interface: AbbreviationProvider

Retrieves an abbreviation for a given variable

Specified by:

getAbbreviation in interface AbbreviationProvider

Parameters:

variable - the name of the variable

original - the original (unabbreviated) string

item - the current CSL item data

Returns:

the abbreviated string or null if the original string should not be abbreviated