citeproc-java 3.3.0 · de.undercouch.citeproc.output.Bibliography

Modifier and Type	Field and Description
private final String	bibEnd
private final String	bibStart
private final Boolean	done
private final String[]	entries
private final String[]	entryIds
private final Integer	entrySpacing
private final Boolean	hangingIndent
private final Integer	lineSpacing
private final Integer	maxOffset
private final SecondFieldAlign	secondFieldAlign

Access	Constructor and Description
public	Bibliography(String... entries)
public	Bibliography(String[] entries, String bibStart, String bibEnd, String[] entryIds, Integer maxOffset, Integer entrySpacing, Integer lineSpacing, Boolean hangingIndent, Boolean done, SecondFieldAlign secondFieldAlign)

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 String	Returns: the bibliography's bibend getBibEnd()
public String	Returns: the bibliography's bibstart getBibStart()
public Boolean	Returns: the bibliography's done getDone()
public String[]	Returns: the bibliography's entries getEntries()
public String[]	Returns: the bibliography's entry_ids getEntryIds()
public Integer	Returns: the bibliography's entryspacing getEntrySpacing()
public Boolean	Returns: the bibliography's hangingindent getHangingIndent()
public Integer	Returns: the bibliography's linespacing getLineSpacing()
public Integer	Returns: the bibliography's maxoffset getMaxOffset()
public SecondFieldAlign	Returns: the bibliography's second-field-align getSecondFieldAlign()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public String	Returns: the String representing the bibliography makeString() Converts this bibliography to a String that can be inserted into the text

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll toString wait wait wait

bibEnd	back to summary
private final String bibEnd

bibStart	back to summary
private final String bibStart

done	back to summary
private final Boolean done

entries	back to summary
private final String[] entries

entryIds	back to summary
private final String[] entryIds

entrySpacing	back to summary
private final Integer entrySpacing

hangingIndent	back to summary
private final Boolean hangingIndent

lineSpacing	back to summary
private final Integer lineSpacing

maxOffset	back to summary
private final Integer maxOffset

secondFieldAlign	back to summary
private final SecondFieldAlign secondFieldAlign

Bibliography	back to summary
public Bibliography(String... entries)

Bibliography	back to summary
public Bibliography(String[] entries, String bibStart, String bibEnd, String[] entryIds, Integer maxOffset, Integer entrySpacing, Integer lineSpacing, Boolean hangingIndent, Boolean done, SecondFieldAlign secondFieldAlign)

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

getBibEnd	back to summary
public String getBibEnd() Returns:String the bibliography's bibend

getBibStart	back to summary
public String getBibStart() Returns:String the bibliography's bibstart

getDone	back to summary
public Boolean getDone() Returns:Boolean the bibliography's done

getEntries	back to summary
public String[] getEntries() Returns:String[] the bibliography's entries

getEntryIds	back to summary
public String[] getEntryIds() Returns:String[] the bibliography's entry_ids

getEntrySpacing	back to summary
public Integer getEntrySpacing() Returns:Integer the bibliography's entryspacing

getHangingIndent	back to summary
public Boolean getHangingIndent() Returns:Boolean the bibliography's hangingindent

getLineSpacing	back to summary
public Integer getLineSpacing() Returns:Integer the bibliography's linespacing

getMaxOffset	back to summary
public Integer getMaxOffset() Returns:Integer the bibliography's maxoffset

getSecondFieldAlign	back to summary
public SecondFieldAlign getSecondFieldAlign() Returns:SecondFieldAlign the bibliography's second-field-align

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

makeString	back to summary
public String makeString() Converts this bibliography to a String that can be inserted into the text Returns:String the String representing the bibliography

makeString

back to summary

public String makeString()

Converts this bibliography to a String that can be inserted into the text

Returns:String: the String representing the bibliography

public Class Bibliography

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail