JabRef 5.15 · org.jabref.model.entry.BibEntryType · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private final SequencedSet<BibField>	allFields
private final SequencedSet<OrFields>	requiredFields
private final EntryType	type

Access	Constructor and Description
public	BibEntryType(EntryType The EntryType this BibEntryType is wrapped around. type, Collection<BibField> A BibFields list of all fields, including the required fields allFields, Collection<OrFields> A OrFields list of just the required fields requiredFields) Provides an enriched EntryType with information about defined standards as mandatory fields etc. A builder is available at `BibEntryTypeBuilder`

Method Summary

Modifier and Type	Method and Description
public int	compareTo(BibEntryType the object to be compared. o) Implements java.lang.Comparable.compareTo. Warning This does not follow the equals contract.
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public SequencedSet<BibField>	getAllBibFields() Returns all defined fields.
public Set<Field>	getAllFields()
public Set<Field>	getDeprecatedFields(BibDatabaseMode mode)
public SequencedSet<Field>	getDetailOptionalFields()
public SequencedSet<Field>	getDetailOptionalNotDeprecatedFields(BibDatabaseMode mode)
public SequencedSet<Field>	getImportantOptionalFields()
public SequencedSet<BibField>	getOptionalFields()
private SequencedSet<Field>	getOptionalFieldsAndAliases() Get list of all optional fields of this entry and all fields being source for a BibTeX to BibLaTeX conversion.
public SequencedSet<OrFields>	Returns: a Set of required field name Strings getRequiredFields() Returns all required field names.
public EntryType	getType()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isRequired(Field field)
public String	toString() Overrides java.lang.Object.toString. Generates a single line string containing the information.

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

allFields	back to summary
private final SequencedSet<BibField> allFields

requiredFields	back to summary
private final SequencedSet<OrFields> requiredFields

type	back to summary
private final EntryType type

BibEntryType	back to summary
public BibEntryType(EntryType type, Collection<BibField> allFields, Collection<OrFields> requiredFields) Provides an enriched EntryType with information about defined standards as mandatory fields etc. A builder is available at `BibEntryTypeBuilder` Parameters type:EntryType The EntryType this BibEntryType is wrapped around. allFields:Collection<BibField> A BibFields list of all fields, including the required fields requiredFields:Collection<OrFields> A OrFields list of just the required fields

Method Detail

compareTo	back to summary
public int compareTo(BibEntryType o) Implements java.lang.Comparable.compareTo. Warning This does not follow the equals contract. Even if this here returns 0, the objects can be different. Parameters o:BibEntryType Doc from java.lang.Comparable.compareTo. the object to be compared. Returns:int Doc from java.lang.Comparable.compareTo. a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Annotations @Override

compareTo

back to summary

public int compareTo(BibEntryType o)

Implements java.lang.Comparable.compareTo.

Warning

This does not follow the equals contract. Even if this here returns 0, the objects can be different.

Parameters

o:BibEntryType

Doc from java.lang.Comparable.compareTo.

the object to be compared.

Returns:int

Doc from java.lang.Comparable.compareTo.

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

Annotations

@Override

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. Parameters o: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

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.

Parameters

o: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

getAllBibFields	back to summary
public SequencedSet<BibField> getAllBibFields() Returns all defined fields.

getAllFields	back to summary
public Set<Field> getAllFields()

getDeprecatedFields	back to summary
public Set<Field> getDeprecatedFields(BibDatabaseMode mode)

getDetailOptionalFields	back to summary
public SequencedSet<Field> getDetailOptionalFields()

getDetailOptionalNotDeprecatedFields	back to summary
public SequencedSet<Field> getDetailOptionalNotDeprecatedFields(BibDatabaseMode mode)

getImportantOptionalFields	back to summary
public SequencedSet<Field> getImportantOptionalFields()

getOptionalFields	back to summary
public SequencedSet<BibField> getOptionalFields()

getOptionalFieldsAndAliases	back to summary
private SequencedSet<Field> getOptionalFieldsAndAliases() Get list of all optional fields of this entry and all fields being source for a BibTeX to BibLaTeX conversion.

getRequiredFields	back to summary
public SequencedSet<OrFields> getRequiredFields() Returns all required field names. If fields have an OR relationship the name includes both field names divided by /, e.g. author/editor. If you need all required fields as sole entities use @see{getRequiredFieldsFlat} . Returns:SequencedSet<OrFields> a Set of required field name Strings

getRequiredFields

back to summary

public SequencedSet<OrFields> getRequiredFields()

Returns all required field names. If fields have an OR relationship the name includes both field names divided by /, e.g. author/editor. If you need all required fields as sole entities use @see{getRequiredFieldsFlat} .

Returns:SequencedSet<OrFields>: a Set of required field name Strings

getType	back to summary
public EntryType getType()

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. Returns:int a hash code value for this object 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.

Returns:int

a hash code value for this object

Annotations

@Override

isRequired	back to summary
public boolean isRequired(Field field)

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Generates a single line string containing the information. This is used for debugging purposes. See "Effective Java, Item 10" for a discussion on contracts. We are sure, we are using this method in a) logs (which should use single lines for output) and b) in the UI. For the UI, we use `BibEntryTypePrefsAndFileViewModel`, which in turn uses `MetaDataSerializer#serializeCustomEntryTypes(BibEntryType)` Returns:String Doc from java.lang.Object.toString. a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Generates a **single line** string containing the information. This is used for debugging purposes. See "Effective Java, Item 10" for a discussion on contracts. We are sure, we are using this method in a) logs (which should use single lines for output) and b) in the UI. For the UI, we use BibEntryTypePrefsAndFileViewModel, which in turn uses MetaDataSerializer#serializeCustomEntryTypes(BibEntryType)

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object

Annotations

@Override

public Class BibEntryType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail