citeproc-java 3.3.0 · de.undercouch.citeproc.csl.CSLCitation

Modifier and Type	Field and Description
private final String	citationID
private final CSLCitationItem[]	citationItems
private final CSLProperties	properties

Access	Constructor and Description
public	CSLCitation(CSLCitationItem... citationItems)
public	CSLCitation(CSLCitationItem[] citationItems, String citationID, CSLProperties properties)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public static CSLCitation	Returns: the converted CSLCitation object fromJson(Map<String, Object> the JSON object to convert obj) Converts a JSON object to a CSLCitation object.
public String	Returns: the citation's citationID getCitationID()
public CSLCitationItem[]	Returns: the citation's citationItems getCitationItems()
public CSLProperties	Returns: the citation's properties getProperties()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
private static boolean	isFalsy(Object o)
private static boolean	toBool(Object o)
private static int	toInt(Object o)
public Object	toJson(JsonBuilder builder) Implements de.undercouch.citeproc.helper.json.JsonObject.toJson. Converts this object to a JSON object

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll toString wait wait wait

citationID	back to summary
private final String citationID

citationItems	back to summary
private final CSLCitationItem[] citationItems

properties	back to summary
private final CSLProperties properties

CSLCitation	back to summary
public CSLCitation(CSLCitationItem... citationItems)

CSLCitation	back to summary
public CSLCitation(CSLCitationItem[] citationItems, String citationID, CSLProperties properties)

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations

@Override

fromJson back to summary

fromJson	back to summary
public static CSLCitation fromJson(Map<String, Object> obj) Converts a JSON object to a CSLCitation object. The JSON object must at least contain the following required properties: `citationItems` Parameters obj:Map<String, Object> the JSON object to convert Returns:CSLCitation the converted CSLCitation object Annotations @SuppressWarnings:unchecked

public static CSLCitation fromJson(Map<String, Object> obj)

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

Parameters

obj:Map<String, Object>: the JSON object to convert

Returns:CSLCitation

the converted CSLCitation object

Annotations

@SuppressWarnings:unchecked

getCitationID	back to summary
public String getCitationID() Returns:String the citation's citationID

getCitationItems	back to summary
public CSLCitationItem[] getCitationItems() Returns:CSLCitationItem[] the citation's citationItems

getProperties	back to summary
public CSLProperties getProperties() Returns:CSLProperties the citation's properties

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Annotations

@Override

isFalsy	back to summary
private static boolean isFalsy(Object o)

toBool	back to summary
private static boolean toBool(Object o)

toInt	back to summary
private static int toInt(Object o)

toJson	back to summary
public Object toJson(JsonBuilder builder) Implements de.undercouch.citeproc.helper.json.JsonObject.toJson. Doc from de.undercouch.citeproc.helper.json.JsonObject.toJson. Converts this object to a JSON object Annotations @Override

toJson

back to summary

public Object toJson(JsonBuilder builder)

Implements de.undercouch.citeproc.helper.json.JsonObject.toJson.

Doc from de.undercouch.citeproc.helper.json.JsonObject.toJson.

Converts this object to a JSON object

Annotations

@Override

public Class CSLCitation

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail