Top Description Fields Constructors Methods
de.undercouch.citeproc.csl

public Class CSLProperties

extends Object
implements JsonObject
Class Inheritance
All Implemented Interfaces
de.undercouch.citeproc.helper.json.JsonObject
Imports
java.util.Arrays, .Map, .Objects, .Collection, de.undercouch.citeproc.helper.json.JsonBuilder, .JsonObject

Citation cluster properties.
Author
Michel Kraemer

Field Summary

Modifier and TypeField and Description
private final Integer
private final Boolean

Constructor Summary

AccessConstructor and Description
public
public
CSLProperties(Integer noteIndex, Boolean unsorted)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object obj)

Overrides java.lang.Object.equals.

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

public static CSLProperties

Returns:

the converted CSLProperties object
fromJson
(Map<String, Object>
the JSON object to convert
obj
)

Converts a JSON object to a CSLProperties object.

public Integer

Returns:

the noteIndex
getNoteIndex
()

public Boolean

Returns:

the unsorted
getUnsorted
()

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

private static boolean
private static boolean
private static int
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:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

noteIndexback to summary
private final Integer noteIndex
unsortedback to summary
private final Boolean unsorted

Constructor Detail

CSLPropertiesback to summary
public CSLProperties()
CSLPropertiesback to summary
public CSLProperties(Integer noteIndex, Boolean unsorted)

Method Detail

equalsback 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
fromJsonback to summary
public static CSLProperties fromJson(Map<String, Object> obj)

Converts a JSON object to a CSLProperties object.

Parameters
obj:Map<String, Object>

the JSON object to convert

Returns:CSLProperties

the converted CSLProperties object

Annotations
@SuppressWarnings:unchecked
getNoteIndexback to summary
public Integer getNoteIndex()
Returns:Integer

the noteIndex

getUnsortedback to summary
public Boolean getUnsorted()
Returns:Boolean

the unsorted

hashCodeback 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
isFalsyback to summary
private static boolean isFalsy(Object o)
toBoolback to summary
private static boolean toBool(Object o)
toIntback to summary
private static int toInt(Object o)
toJsonback 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