JabRef 5.15 · org.jabref.http.dto.BibEntryDTO · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
private final String	bibtex Record Component accessed by bibtex(). the BibEntry as BibTeX string (see ADR-0027 for more information, why we don't use a HashMap / JSON)
private final String	citationKey Record Component accessed by citationKey(). the citation key (duplicated from BibEntry to ease processing by the client)
public static final Logger	LOGGER
private final SharedBibEntryData	sharingMetadata Record Component accessed by sharingMetadata(). the data used for sharing
private final String	userComments Record Component accessed by userComments(). the comments before the BibTeX entry

Constructor Summary

Access	Constructor and Description
public	BibEntryDTO(BibEntry bibEntry, BibDatabaseMode bibDatabaseMode, FieldPreferences fieldWriterPreferences, BibEntryTypesManager bibEntryTypesManager)
public	BibEntryDTO(SharedBibEntryData sharingMetadata, String userComments, String citationKey, String bibtex)

Method Summary

Modifier and Type	Method and Description
public String	bibtex() Record Component getter of bibtex. Record Component the BibEntry as BibTeX string (see ADR-0027 for more information, why we don't use a HashMap / JSON)
public String	citationKey() Record Component getter of citationKey. Record Component the citation key (duplicated from BibEntry to ease processing by the client)
public int	compareTo(BibEntryDTO the object to be compared. o) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
private static String	convertToString(BibEntry entry, BibDatabaseMode bibDatabaseMode, FieldPreferences fieldWriterPreferences, BibEntryTypesManager bibEntryTypesManager)
public final boolean	equals(Object the reference object with which to compare. o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public SharedBibEntryData	sharingMetadata() Record Component getter of sharingMetadata. Record Component the data used for sharing
public String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.
public String	userComments() Record Component getter of userComments. Record Component the comments before the BibTeX entry

Field Detail

bibtex	back to summary
private final String bibtex Record Component accessed by bibtex(). the BibEntry as BibTeX string (see ADR-0027 for more information, why we don't use a HashMap / JSON)

bibtex

back to summary

private final String bibtex

Record Component accessed by bibtex().

the BibEntry as BibTeX string (see ADR-0027 for more information, why we don't use a HashMap / JSON)

citationKey	back to summary
private final String citationKey Record Component accessed by citationKey(). the citation key (duplicated from BibEntry to ease processing by the client)

citationKey

back to summary

private final String citationKey

Record Component accessed by citationKey().

the citation key (duplicated from BibEntry to ease processing by the client)

LOGGER	back to summary
public static final Logger LOGGER

sharingMetadata

back to summary

private final SharedBibEntryData sharingMetadata

Record Component accessed by sharingMetadata().

the data used for sharing

userComments	back to summary
private final String userComments Record Component accessed by userComments(). the comments before the BibTeX entry

userComments

back to summary

private final String userComments

Record Component accessed by userComments().

the comments before the BibTeX entry

Constructor Detail

BibEntryDTO	back to summary
public BibEntryDTO(BibEntry bibEntry, BibDatabaseMode bibDatabaseMode, FieldPreferences fieldWriterPreferences, BibEntryTypesManager bibEntryTypesManager)

BibEntryDTO	back to summary
public BibEntryDTO(SharedBibEntryData sharingMetadata, String userComments, String citationKey, String bibtex)

Method Detail

bibtex	back to summary
public String bibtex() Record Component getter of bibtex. Record Component the BibEntry as BibTeX string (see ADR-0027 for more information, why we don't use a HashMap / JSON)

bibtex

back to summary

public String bibtex()

Record Component getter of bibtex.

Record Component: the BibEntry as BibTeX string (see ADR-0027 for more information, why we don't use a HashMap / JSON)

citationKey	back to summary
public String citationKey() Record Component getter of citationKey. Record Component the citation key (duplicated from BibEntry to ease processing by the client)

citationKey

back to summary

public String citationKey()

Record Component getter of citationKey.

Record Component: the citation key (duplicated from BibEntry to ease processing by the client)

compareTo back to summary

compareTo	back to summary
public int compareTo(BibEntryDTO o) 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 o:BibEntryDTO 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

public int compareTo(BibEntryDTO o)

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

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

convertToString	back to summary
private static String convertToString(BibEntry entry, BibDatabaseMode bibDatabaseMode, FieldPreferences fieldWriterPreferences, BibEntryTypesManager bibEntryTypesManager)

equals back to summary

equals	back to summary
public final boolean equals(Object o) Implements abstract java.lang.Record.equals. Doc from java.lang.Record.equals. Indicates whether some other object is "equal to" this one. In addition to the general contract of `Object.equals`, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: R copy = new R(r.c1(), r.c2(), ..., r.cn()); then it must be the case that `r.equals(copy)`. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this record is equal to the argument; `false` otherwise.

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this record is equal to the argument; false otherwise.

hashCode back to summary

hashCode	back to summary
public final int hashCode() Implements abstract java.lang.Record.hashCode. Doc from java.lang.Record.hashCode. Returns a hash code value for the record. Obeys the general contract of `Object.hashCode`. For records, hashing behavior is constrained by the refined contract of `Record.equals`, so that any two records created from the same components must have the same hash code. Returns:int a hash code value for this record.

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

Returns:int: a hash code value for this record.

sharingMetadata

back to summary

public SharedBibEntryData sharingMetadata()

Record Component getter of sharingMetadata.

Record Component: the data used for sharing

toString back to summary

toString	back to summary
public String toString() Implements abstract java.lang.Record.toString. Doc from java.lang.Record.toString. Returns a string representation of the record. In accordance with the general contract of `Object#toString()`, the `toString` method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read. In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves. Returns:String a string representation of the object. Annotations @Override

public String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

Returns:String

a string representation of the object.

Annotations

@Override

userComments	back to summary
public String userComments() Record Component getter of userComments. Record Component the comments before the BibTeX entry

userComments

back to summary

public String userComments()

Record Component getter of userComments.

Record Component: the comments before the BibTeX entry

public final Record BibEntryDTO

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail