de.undercouch.citeproc.csl

Class CitationIDIndexPair

java.lang.Object

de.undercouch.citeproc.csl.CitationIDIndexPair

All Implemented Interfaces:

JsonObject

public class CitationIDIndexPair
extends Object
implements JsonObject

A pair containing a CSLCitation's citation ID and an note index from a CSLCitation's CSLProperties

Author:

Michel Kraemer

Constructor Summary

Constructors

Constructor and Description
CitationIDIndexPair(CSLCitation citation) Constructs a new pair with the values from the given citation object
CitationIDIndexPair(String citationId, int noteIndex) Constructs a new pair

Method Summary

Modifier and Type	Method and Description
static CitationIDIndexPair	fromJson(List<?> arr) Converts a JSON array to a CitationIDIndexPair object.
String	getCitationId()
int	getNoteIndex()
Object	toJson(JsonBuilder builder) Converts this object to a JSON object

Methods inherited from class java.lang.Object

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

Constructor Detail

CitationIDIndexPair

public CitationIDIndexPair(String citationId,
                           int noteIndex)

Constructs a new pair

Parameters:

citationId - the citation ID

noteIndex - the index

CitationIDIndexPair

public CitationIDIndexPair(CSLCitation citation)

Constructs a new pair with the values from the given citation object

Parameters:

citation - the citation object

Method Detail

getCitationId

public String getCitationId()

Returns:

the citation ID

getNoteIndex

public int getNoteIndex()

Returns:

the note index

toJson

public Object toJson(JsonBuilder builder)

Description copied from interface: JsonObject

Converts this object to a JSON object

Specified by:

toJson in interface JsonObject

Parameters:

builder - a builder that can be used to perform the conversion

Returns:

the JSON object

fromJson

public static CitationIDIndexPair fromJson(List<?> arr)

Converts a JSON array to a CitationIDIndexPair object.

Parameters:

arr - the JSON array to convert

Returns:

the converted CitationIDIndexPair object