citeproc-java 3.3.0 · de.undercouch.citeproc.csl.internal.helper.NumberElement

Modifier and Type	Field and Description
private final CSLLabel	label
private final boolean	plural
private final String	text

Access	Constructor and Description
public	NumberElement(String the element's string text) Construct the element without a label
public	NumberElement(String the element's string text, CSLLabel the element's label (may be `null`) label, boolean specifies whether the string contains multiple numbers or a range (i.e. if the plural form of the label should be selected) or if it does not. plural) Construct the element

Modifier and Type	Method and Description
public boolean	equals(Object o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public CSLLabel	Returns: the label getLabel() Get the element's label
public String	Returns: the text getText() Get the element's text
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	Returns: `true` if the string contains multiple numbers isPlural() Determine whether the string contains multiple numbers or a range (i.e. if the plural form of the label should be selected) or if it does not.

Field Detail

label	back to summary
private final CSLLabel label

plural	back to summary
private final boolean plural

text	back to summary
private final String text

Constructor Detail

NumberElement	back to summary
public NumberElement(String text) Construct the element without a label Parameters text:String the element's string

NumberElement

back to summary

public NumberElement(String text)

Construct the element without a label

Parameters

text:String: the element's string

NumberElement back to summary

NumberElement	back to summary
public NumberElement(String text, CSLLabel label, boolean plural) Construct the element Parameters text:String the element's string label:CSLLabel the element's label (may be `null`) plural:boolean specifies whether the string contains multiple numbers or a range (i.e. if the plural form of the label should be selected) or if it does not.

public NumberElement(String text, CSLLabel label, boolean plural)

Construct the element

Parameters

text:String: the element's string
label:CSLLabel: the element's label (may be null)
plural:boolean: specifies whether the string contains multiple numbers or a range (i.e. if the plural form of the label should be selected) or if it does not.

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object o) 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 o)

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

getLabel	back to summary
public CSLLabel getLabel() Get the element's label Returns:CSLLabel the label

getLabel

back to summary

public CSLLabel getLabel()

Get the element's label

Returns:CSLLabel: the label

getText	back to summary
public String getText() Get the element's text Returns:String the text

getText

back to summary

public String getText()

Get the element's text

Returns:String: the text

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

isPlural back to summary

isPlural	back to summary
public boolean isPlural() Determine whether the string contains multiple numbers or a range (i.e. if the plural form of the label should be selected) or if it does not. Returns:boolean `true` if the string contains multiple numbers

public boolean isPlural()

Determine whether the string contains multiple numbers or a range (i.e. if the plural form of the label should be selected) or if it does not.

Returns:boolean: true if the string contains multiple numbers

public Class NumberElement

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail