Package de.undercouch.citeproc.csl

Class CSLCitation

java.lang.Object

de.undercouch.citeproc.csl.CSLCitation

All Implemented Interfaces:

JsonObject

public class CSLCitation
extends java.lang.Object
implements JsonObject

A set of citation items. This class is used to register citations in the CSL processor.

Author:

Michel Kraemer

Constructor Summary

Constructors

Constructor	Description
CSLCitation(CSLCitationItem... citationItems)
CSLCitation(CSLCitationItem[] citationItems, java.lang.String citationID, CSLProperties properties)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
static CSLCitation	fromJson(java.util.Map<java.lang.String,java.lang.Object> obj)	Converts a JSON object to a CSLCitation object.
java.lang.String	getCitationID()
CSLCitationItem[]	getCitationItems()
CSLProperties	getProperties()
int	hashCode()
java.lang.Object	toJson(JsonBuilder builder)	Converts this object to a JSON object

Methods inherited from class java.lang.Object

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

Constructor Detail

CSLCitation

public CSLCitation(CSLCitationItem... citationItems)

CSLCitation

public CSLCitation(CSLCitationItem[] citationItems,
                   java.lang.String citationID,
                   CSLProperties properties)

Method Detail

getCitationItems

public CSLCitationItem[] getCitationItems()

Returns:

the citation's citationItems

getCitationID

public java.lang.String getCitationID()

Returns:

the citation's citationID

getProperties

public CSLProperties getProperties()

Returns:

the citation's properties

toJson

public java.lang.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 CSLCitation fromJson(java.util.Map<java.lang.String,java.lang.Object> obj)

Converts a JSON object to a CSLCitation object. The JSON object must at least contain the following required properties: citationItems

Parameters:

obj - the JSON object to convert

Returns:

the converted CSLCitation object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object