JabRef 6.0-beta.1 · org.jabref.model.entry.Author · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private final String	familyName
public static final RemoveWordEnclosingAndOuterEnclosingBracesFormatter	FORMATTER
private final String	givenName
private final String	givenNameAbbreviated
private Author	latexFreeAuthor
private final String	namePrefix
private final String	nameSuffix
public static final Author	OTHERS Object indicating the `others` author.

Access	Constructor and Description
public	Author(String the first name of the author (may consist of several tokens, like "Charles Louis Xavier Joseph" in "Charles Louis Xavier Joseph de la Vall{'e}e Poussin") givenName, String the abbreviated first name of the author (may consist of several tokens, like "C. L. X. J." in "Charles Louis Xavier Joseph de la Vall{'e}e Poussin"). It is a responsibility of the caller to create a reasonable abbreviation of the first name. givenNameAbbreviated, String the von part of the author's name (may consist of several tokens, like "de la" in "Charles Louis Xavier Joseph de la Vall{'e}e Poussin") namePrefix, String the last name of the author (may consist of several tokens, like "Vall{'e}e Poussin" in "Charles Louis Xavier Joseph de la Vall{'e}e Poussin") familyName, String the junior part of the author's name (may consist of several tokens, like "Jr. III" in "Smith, Jr. III, John") nameSuffix) Creates the Author object.

Method Summary

Modifier and Type	Method and Description
public static String	addDotIfAbbreviation(String name)
public boolean	Returns: `true` iff the other object is an Author and all fields are `Objects.equals`. equals(Object other) Overrides java.lang.Object.equals. Compare this object with the given one.
public String	Returns: 'von Last, Jr., First' (if `abbr==false`) or 'von Last, Jr., F.' (if `abbr==true`) getFamilyGiven(boolean `true` - abbreviate first name, `false` - do not abbreviate abbr) Returns the author's name in form 'von Last, Jr., First' with the first name full or abbreviated depending on parameter.
public Optional<String>	Returns: last name of the author (may consist of several tokens) getFamilyName() Returns the last name of the author stored in this object ("Last").
public String	Returns: 'First von Last, Jr.' (if `abbr==false`) or 'F. von Last, Jr.' (if `abbr==true`) getGivenFamily(boolean `true` - abbreviate first name, `false` - do not abbreviate abbr) Returns the author's name in form 'First von Last, Jr.' with the first name full or abbreviated depending on parameter.
public Optional<String>	Returns: first name of the author (may consist of several tokens) getGivenName() Returns the first name of the author stored in this object ("First").
public Optional<String>	Returns: abbreviated first name of the author (may consist of several tokens) getGivenNameAbbreviated() Returns the abbreviated first name of the author stored in this object ("F.").
public String	Returns: "Last, Jr, F." as described above or "" if all these parts are empty. getNameForAlphabetization() Returns the name as "Last, Jr, F." omitting the von-part and removing starting braces.
public Optional<String>	Returns: von part of the author's name (may consist of several tokens) getNamePrefix() Returns the von part of the author's name stored in this object ("von", "name prefix").
public String	Returns: 'von Last' getNamePrefixAndFamilyName() Returns von-part followed by last name ("von Last").
public Optional<String>	Returns: junior part of the author's name (may consist of several tokens) or null if the author does not have a Jr. Part getNameSuffix() Returns the name suffix ("junior") part of the author's name stored in this object ("Jr").
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public Author	latexFree() Returns a LaTeX-free version of this `Author`.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

Field Detail

familyName	back to summary
private final String familyName

FORMATTER	back to summary
public static final RemoveWordEnclosingAndOuterEnclosingBracesFormatter FORMATTER

givenName	back to summary
private final String givenName

givenNameAbbreviated	back to summary
private final String givenNameAbbreviated

latexFreeAuthor	back to summary
private Author latexFreeAuthor

namePrefix	back to summary
private final String namePrefix

nameSuffix	back to summary
private final String nameSuffix

OTHERS	back to summary
public static final Author OTHERS Object indicating the `others` author. This is a BibTeX feature mostly rendered in "et al." in LaTeX. Example: `authors = {Oliver Kopp and others}`. This is then appearing as "Oliver Kopp et al.". In the context of BibTeX key generation, this is "Kopp+" (`+` for "et al.") and not "KO".

Constructor Detail

Author back to summary

Author	back to summary
public Author(String givenName, String givenNameAbbreviated, String namePrefix, String familyName, String nameSuffix) Creates the Author object. If any part of the name is absent, `null` must be passed; otherwise other methods may return erroneous results. In case only the last part is passed, enclosing braces are Parameters givenName:String the first name of the author (may consist of several tokens, like "Charles Louis Xavier Joseph" in "Charles Louis Xavier Joseph de la Vall{'e}e Poussin") givenNameAbbreviated:String the abbreviated first name of the author (may consist of several tokens, like "C. L. X. J." in "Charles Louis Xavier Joseph de la Vall{'e}e Poussin"). It is a responsibility of the caller to create a reasonable abbreviation of the first name. namePrefix:String the von part of the author's name (may consist of several tokens, like "de la" in "Charles Louis Xavier Joseph de la Vall{'e}e Poussin") familyName:String the last name of the author (may consist of several tokens, like "Vall{'e}e Poussin" in "Charles Louis Xavier Joseph de la Vall{'e}e Poussin") nameSuffix:String the junior part of the author's name (may consist of several tokens, like "Jr. III" in "Smith, Jr. III, John")

public Author(String givenName, String givenNameAbbreviated, String namePrefix, String familyName, String nameSuffix)

Creates the Author object. If any part of the name is absent, null must be passed; otherwise other methods may return erroneous results.

In case only the last part is passed, enclosing braces are

Parameters

givenName:String: the first name of the author (may consist of several tokens, like "Charles Louis Xavier Joseph" in "Charles Louis Xavier Joseph de la Vall{'e}e Poussin")
givenNameAbbreviated:String: the abbreviated first name of the author (may consist of several tokens, like "C. L. X. J." in "Charles Louis Xavier Joseph de la Vall{'e}e Poussin"). It is a responsibility of the caller to create a reasonable abbreviation of the first name.
namePrefix:String: the von part of the author's name (may consist of several tokens, like "de la" in "Charles Louis Xavier Joseph de la Vall{'e}e Poussin")
familyName:String: the last name of the author (may consist of several tokens, like "Vall{'e}e Poussin" in "Charles Louis Xavier Joseph de la Vall{'e}e Poussin")
nameSuffix:String: the junior part of the author's name (may consist of several tokens, like "Jr. III" in "Smith, Jr. III, John")

Method Detail

addDotIfAbbreviation	back to summary
public static String addDotIfAbbreviation(String name)

equals back to summary

equals	back to summary
public boolean equals(Object other) Overrides java.lang.Object.equals. Compare this object with the given one. Returns:boolean `true` iff the other object is an Author and all fields are `Objects.equals`. Annotations @Override

public boolean equals(Object other)

Overrides java.lang.Object.equals.

Compare this object with the given one.

Returns:boolean

true iff the other object is an Author and all fields are Objects.equals.

Annotations

@Override

getFamilyGiven back to summary

getFamilyGiven	back to summary
public String getFamilyGiven(boolean abbr) Returns the author's name in form 'von Last, Jr., First' with the first name full or abbreviated depending on parameter. Parameters abbr:boolean `true` - abbreviate first name, `false` - do not abbreviate Returns:String 'von Last, Jr., First' (if `abbr==false`) or 'von Last, Jr., F.' (if `abbr==true`)

public String getFamilyGiven(boolean abbr)

Returns the author's name in form 'von Last, Jr., First' with the first name full or abbreviated depending on parameter.

Parameters

abbr:boolean: true - abbreviate first name, false - do not abbreviate

Returns:String

'von Last, Jr., First' (if abbr==false) or 'von Last, Jr., F.' (if abbr==true)

getFamilyName	back to summary
public Optional<String> getFamilyName() Returns the last name of the author stored in this object ("Last"). Returns:Optional<String> last name of the author (may consist of several tokens)

getFamilyName

back to summary

public Optional<String> getFamilyName()

Returns the last name of the author stored in this object ("Last").

Returns:Optional<String>: last name of the author (may consist of several tokens)

getGivenFamily back to summary

getGivenFamily	back to summary
public String getGivenFamily(boolean abbr) Returns the author's name in form 'First von Last, Jr.' with the first name full or abbreviated depending on parameter. Parameters abbr:boolean `true` - abbreviate first name, `false` - do not abbreviate Returns:String 'First von Last, Jr.' (if `abbr==false`) or 'F. von Last, Jr.' (if `abbr==true`)

public String getGivenFamily(boolean abbr)

Returns the author's name in form 'First von Last, Jr.' with the first name full or abbreviated depending on parameter.

Parameters

abbr:boolean: true - abbreviate first name, false - do not abbreviate

Returns:String

'First von Last, Jr.' (if abbr==false) or 'F. von Last, Jr.' (if abbr==true)

getGivenName	back to summary
public Optional<String> getGivenName() Returns the first name of the author stored in this object ("First"). Returns:Optional<String> first name of the author (may consist of several tokens)

getGivenName

back to summary

public Optional<String> getGivenName()

Returns the first name of the author stored in this object ("First").

Returns:Optional<String>: first name of the author (may consist of several tokens)

getGivenNameAbbreviated	back to summary
public Optional<String> getGivenNameAbbreviated() Returns the abbreviated first name of the author stored in this object ("F."). Returns:Optional<String> abbreviated first name of the author (may consist of several tokens)

getGivenNameAbbreviated

back to summary

public Optional<String> getGivenNameAbbreviated()

Returns the abbreviated first name of the author stored in this object ("F.").

Returns:Optional<String>: abbreviated first name of the author (may consist of several tokens)

getNameForAlphabetization	back to summary
public String getNameForAlphabetization() Returns the name as "Last, Jr, F." omitting the von-part and removing starting braces. Returns:String "Last, Jr, F." as described above or "" if all these parts are empty.

getNameForAlphabetization

back to summary

public String getNameForAlphabetization()

Returns the name as "Last, Jr, F." omitting the von-part and removing starting braces.

Returns:String: "Last, Jr, F." as described above or "" if all these parts are empty.

getNamePrefix	back to summary
public Optional<String> getNamePrefix() Returns the von part of the author's name stored in this object ("von", "name prefix"). Returns:Optional<String> von part of the author's name (may consist of several tokens)

getNamePrefix

back to summary

public Optional<String> getNamePrefix()

Returns the von part of the author's name stored in this object ("von", "name prefix").

Returns:Optional<String>: von part of the author's name (may consist of several tokens)

getNamePrefixAndFamilyName back to summary

getNamePrefixAndFamilyName	back to summary
public String getNamePrefixAndFamilyName() Returns von-part followed by last name ("von Last"). If both fields were specified as `null`, the empty string `""` is returned. Returns:String 'von Last'

public String getNamePrefixAndFamilyName()

Returns von-part followed by last name ("von Last"). If both fields were specified as null, the empty string "" is returned.

Returns:String: 'von Last'

getNameSuffix	back to summary
public Optional<String> getNameSuffix() Returns the name suffix ("junior") part of the author's name stored in this object ("Jr"). Returns:Optional<String> junior part of the author's name (may consist of several tokens) or null if the author does not have a Jr. Part

getNameSuffix

back to summary

public Optional<String> getNameSuffix()

Returns the name suffix ("junior") part of the author's name stored in this object ("Jr").

Returns:Optional<String>: junior part of the author's name (may consist of several tokens) or null if the author does not have a Jr. Part

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

latexFree	back to summary
public Author latexFree() Returns a LaTeX-free version of this `Author`.

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

public Class Author

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail