de.undercouch.citeproc

Interface VariableWrapper

public interface VariableWrapper

Decorates individual items in citations and bibliographies

Author:

Michel Kraemer

Method Summary

Modifier and Type	Method and Description
String	wrap(VariableWrapperParams params, String prePunct, String str, String postPunct) This method will be called by the citation processor when an item in a citation or bibliography is about to be rendered.

Method Detail

wrap

String wrap(VariableWrapperParams params,
            String prePunct,
            String str,
            String postPunct)

This method will be called by the citation processor when an item in a citation or bibliography is about to be rendered. The method may change the way the item is rendered, for example, by prepending or appending strings, or by completely replacing the item. The default implementation of this method always returns prePunct + str + postPunct.

Parameters:

params - a number of parameters that specify the context in which rendering happens, the citation item that is currently being rendered, and additional information.

prePunct - the text that precedes the item to render

str - the item to render

postPunct - the text that follows the item to render

Returns:

the string to be rendered