Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters

other:OOBibStyle

the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations

@Override

Format the marker for the in-text citation according to this BIB style. Uniquefier letters are added as provided by the citationMarkerEntries argument. If successive entries within the citation are uniquefied from each other, this method will perform a grouping of these entries. If successive entries within the citation are uniquefied from each other, this method will perform a grouping of these entries.

Parameters

citationMarkerEntries:List<CitationMarkerEntry>

The list of entries providing the data.

inParenthesis:boolean

Signals whether a parenthesized citation or an in-text citation is wanted.

nonUniqueCitationMarkerHandling:NonUniqueCitationMarker

THROWS : Should throw if finds that uniqueLetters provided do not make the entries unique. FORGIVEN : is needed to allow preliminary markers for freshly inserted citations without going throw the uniquefication process.

Returns:OOText

The formatted citation. The result does not include the standard wrappers: OOFormat.setLocaleNone() and OOFormat.setCharStyle(). These are added by decorateCitationMarker()

Add setLocaleNone and optionally setCharStyle(CitationCharacterFormat) around citationText. Called in fillCitationMarkInCursor, so these are also applied to "Unresolved()" entries and numeric styles.

If this style was initialized from a file on disk, reload the style if the file has been modified since it was read.

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.

Parameters

object:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

Author names. Excludes Author separators

Author list, excluding " et al."

Author list, including " et al."

Get boolean property.

Parameters

key:String

The property key

Returns:boolean

the value

Should citation markers be italicized?

The String to represent authors that are not mentioned, e.g. " et al."

Used in number ranges like "10-13" in numbered citations.

Minimal number of consecutive citation numbers needed to start replacing with an range like "10-13".

Format a number-based citation marker for the given entries.

Returns:OOText

The text for the citation.

For some tests we need to override minGroupingCount.

Format a number-based bibliography label for the given number.

Get a style property.

Parameters

propName:String

The property name.

Returns:Object

The property value, or null if it doesn't exist.

Name of paragraph format (within OO/LO) to be used for the title of the bibliography.

Title for the bibliography.

Name of paragraph format (within OO/LO) to be used for the entries in the bibliography.

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.

Returns:int

a hash code value for this object

Annotations

@Override

Convenience method for checking whether citation markers should be bold. Will only be relevant if isFormatCitations() returns true.

Returns:boolean

true to indicate that citations should be in bold.

Convenience method for checking whether citation markers formatted according to the results of the isItalicCitations() and isBoldCitations() methods.

Returns:boolean

true to indicate that citations should be in italics.

Indicate if it is an internal style

Returns:boolean

True if an internal style

Convenience method for checking whether citation markers should be italicized. Will only be relevant if isFormatCitations() returns true.

Returns:boolean

true to indicate that citations should be in italics.

Convenience method for checking the property for whether we use number citations or author-year citations.

Returns:boolean

true if we use numbered citations, false otherwise.

Convenience method for checking the property for whether we sort the bibliography according to their order of appearance in the text.

Returns:boolean

true to sort by appearance, false to sort alphabetically.

After initializing this style from a file, this method can be used to check whether the file appeared to be a proper style file.

Returns:boolean

true if the file could be parsed as a style file, false otherwise.