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

Field Summary

Modifier and Type	Field and Description
private final Boolean	authorOnly
private final Integer	firstReferenceNoteNumber
private final String	id
private final CSLItemData	itemData
private final CSLLabel	label
private final String	locator
private final Boolean	nearNote
private final Integer	noteNumber
private final Integer	position
private final String	prefix
private final String	suffix
private final Boolean	suppressAuthor
private final String[]	uris

Constructor Summary

Access	Constructor and Description
public	CSLCitationItem(String id)
public	CSLCitationItem(String id, CSLItemData itemData, String prefix, String suffix, String locator, Integer position, Boolean nearNote, Integer noteNumber, Integer firstReferenceNoteNumber, CSLLabel label, Boolean suppressAuthor, Boolean authorOnly, String[] uris)

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 CSLCitationItem	Returns: the converted CSLCitationItem object fromJson(Map<String, Object> the JSON object to convert obj) Converts a JSON object to a CSLCitationItem object.
public Boolean	Returns: the citation item's author-only getAuthorOnly()
public Integer	Returns: the citation item's first-reference-note-number getFirstReferenceNoteNumber()
public String	Returns: the citation item's id getId()
public CSLItemData	Returns: the citation item's itemData getItemData()
public CSLLabel	Returns: the citation item's label getLabel()
public String	Returns: the citation item's locator getLocator()
public Boolean	Returns: the citation item's near-note getNearNote()
public Integer	Returns: the citation item's note-number getNoteNumber()
public Integer	Returns: the citation item's position getPosition()
public String	Returns: the citation item's prefix getPrefix()
public String	Returns: the citation item's suffix getSuffix()
public Boolean	Returns: the citation item's suppress-author getSuppressAuthor()
public String[]	Returns: the citation item's uris getUris()
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

Field Detail

authorOnly	back to summary
private final Boolean authorOnly

firstReferenceNoteNumber	back to summary
private final Integer firstReferenceNoteNumber

id	back to summary
private final String id

itemData	back to summary
private final CSLItemData itemData

label	back to summary
private final CSLLabel label

locator	back to summary
private final String locator

nearNote	back to summary
private final Boolean nearNote

noteNumber	back to summary
private final Integer noteNumber

position	back to summary
private final Integer position

prefix	back to summary
private final String prefix

suffix	back to summary
private final String suffix

suppressAuthor	back to summary
private final Boolean suppressAuthor

uris	back to summary
private final String[] uris

Constructor Detail

CSLCitationItem	back to summary
public CSLCitationItem(String id)

CSLCitationItem	back to summary
public CSLCitationItem(String id, CSLItemData itemData, String prefix, String suffix, String locator, Integer position, Boolean nearNote, Integer noteNumber, Integer firstReferenceNoteNumber, CSLLabel label, Boolean suppressAuthor, Boolean authorOnly, String[] uris)

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 CSLCitationItem fromJson(Map<String, Object> obj) Converts a JSON object to a CSLCitationItem object. The JSON object must at least contain the following required properties: `id` Parameters obj:Map<String, Object> the JSON object to convert Returns:CSLCitationItem the converted CSLCitationItem object Annotations @SuppressWarnings:unchecked

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

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

Parameters

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

Returns:CSLCitationItem

the converted CSLCitationItem object

Annotations

@SuppressWarnings:unchecked

getAuthorOnly	back to summary
public Boolean getAuthorOnly() Returns:Boolean the citation item's author-only

getFirstReferenceNoteNumber	back to summary
public Integer getFirstReferenceNoteNumber() Returns:Integer the citation item's first-reference-note-number

getId	back to summary
public String getId() Returns:String the citation item's id

getItemData	back to summary
public CSLItemData getItemData() Returns:CSLItemData the citation item's itemData

getLabel	back to summary
public CSLLabel getLabel() Returns:CSLLabel the citation item's label

getLocator	back to summary
public String getLocator() Returns:String the citation item's locator

getNearNote	back to summary
public Boolean getNearNote() Returns:Boolean the citation item's near-note

getNoteNumber	back to summary
public Integer getNoteNumber() Returns:Integer the citation item's note-number

getPosition	back to summary
public Integer getPosition() Returns:Integer the citation item's position

getPrefix	back to summary
public String getPrefix() Returns:String the citation item's prefix

getSuffix	back to summary
public String getSuffix() Returns:String the citation item's suffix

getSuppressAuthor	back to summary
public Boolean getSuppressAuthor() Returns:Boolean the citation item's suppress-author

getUris	back to summary
public String[] getUris() Returns:String[] the citation item's uris

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 CSLCitationItem

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail