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

Field Summary

Modifier and Type	Field and Description
private final Boolean	commaPrefix
private final Boolean	commaSuffix
private final String	droppingParticle
private final String	family
private final String	given
private final Boolean	isInstitution
private final String	literal
private final String	nonDroppingParticle
private final Boolean	parseNames
private final Boolean	staticOrdering
private final Boolean	staticParticles
private final String	suffix

Constructor Summary

Access	Constructor and Description
public	CSLName()
public	CSLName(String family, String given, String droppingParticle, String nonDroppingParticle, String suffix, Boolean commaPrefix, Boolean commaSuffix, Boolean staticOrdering, Boolean staticParticles, String literal, Boolean parseNames, Boolean isInstitution)

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 CSLName	Returns: the converted CSLName object fromJson(Map<String, Object> the JSON object to convert obj) Converts a JSON object to a CSLName object.
public Boolean	Returns: the comma-prefix getCommaPrefix()
public Boolean	Returns: the comma-suffix getCommaSuffix()
public String	Returns: the dropping-particle getDroppingParticle()
public String	Returns: the family getFamily()
public String	Returns: the given getGiven()
public Boolean	Returns: the isInstitution getIsInstitution()
public String	Returns: the literal getLiteral()
public String	Returns: the non-dropping-particle getNonDroppingParticle()
public Boolean	Returns: the parse-names getParseNames()
public Boolean	Returns: the static-ordering getStaticOrdering()
public Boolean	Returns: the static-particles getStaticParticles()
public String	Returns: the suffix getSuffix()
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

commaPrefix	back to summary
private final Boolean commaPrefix

commaSuffix	back to summary
private final Boolean commaSuffix

droppingParticle	back to summary
private final String droppingParticle

family	back to summary
private final String family

given	back to summary
private final String given

isInstitution	back to summary
private final Boolean isInstitution

literal	back to summary
private final String literal

nonDroppingParticle	back to summary
private final String nonDroppingParticle

parseNames	back to summary
private final Boolean parseNames

staticOrdering	back to summary
private final Boolean staticOrdering

staticParticles	back to summary
private final Boolean staticParticles

suffix	back to summary
private final String suffix

Constructor Detail

CSLName	back to summary
public CSLName()

CSLName	back to summary
public CSLName(String family, String given, String droppingParticle, String nonDroppingParticle, String suffix, Boolean commaPrefix, Boolean commaSuffix, Boolean staticOrdering, Boolean staticParticles, String literal, Boolean parseNames, Boolean isInstitution)

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
public static CSLName fromJson(Map<String, Object> obj) Converts a JSON object to a CSLName object. Parameters obj:Map<String, Object> the JSON object to convert Returns:CSLName the converted CSLName object Annotations @SuppressWarnings:unchecked

fromJson

back to summary

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

Converts a JSON object to a CSLName object.

Parameters

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

Returns:CSLName

the converted CSLName object

Annotations

@SuppressWarnings:unchecked

getCommaPrefix	back to summary
public Boolean getCommaPrefix() Returns:Boolean the comma-prefix

getCommaSuffix	back to summary
public Boolean getCommaSuffix() Returns:Boolean the comma-suffix

getDroppingParticle	back to summary
public String getDroppingParticle() Returns:String the dropping-particle

getFamily	back to summary
public String getFamily() Returns:String the family

getGiven	back to summary
public String getGiven() Returns:String the given

getIsInstitution	back to summary
public Boolean getIsInstitution() Returns:Boolean the isInstitution

getLiteral	back to summary
public String getLiteral() Returns:String the literal

getNonDroppingParticle	back to summary
public String getNonDroppingParticle() Returns:String the non-dropping-particle

getParseNames	back to summary
public Boolean getParseNames() Returns:Boolean the parse-names

getStaticOrdering	back to summary
public Boolean getStaticOrdering() Returns:Boolean the static-ordering

getStaticParticles	back to summary
public Boolean getStaticParticles() Returns:Boolean the static-particles

getSuffix	back to summary
public String getSuffix() Returns:String the suffix

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 CSLName

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail