JabRef 6.0-beta.1 · org.jabref.model.study.Study · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
private List<String>	authors
private List<StudyCatalog>	catalogs
public static final String	CURRENT_SCHEMA_VERSION
private Integer	maxResultsPerCatalog
private List<StudyQuery>	queries
private List<String>	researchQuestions
private String	title
private String	version

Constructor Summary

Access	Constructor and Description
public	Study(List<String> authors, String title, List<String> researchQuestions, List<StudyQuery> queryEntries, List<StudyCatalog> catalogs)
private	Study() Used for Jackson deserialization

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object other) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public List<String>	getAuthors()
public List<StudyCatalog>	getCatalogs()
public @Nullable Integer	getMaxResultsPerCatalog()
public List<StudyQuery>	getQueries()
public List<String>	getResearchQuestions()
public String	getTitle()
public String	getVersion()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	setAuthors(List<String> authors)
public void	setCatalogs(List<StudyCatalog> catalogs)
public void	setMaxResultsPerCatalog(@Nullable Integer maxResultsPerCatalog)
public void	setQueries(List<StudyQuery> queries)
public void	setResearchQuestions(List<String> researchQuestions)
public void	setTitle(String title)
public void	setVersion(@NonNull String version)
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

authors	back to summary
private List<String> authors

catalogs	back to summary
private List<StudyCatalog> catalogs Annotations @JsonProperty:catalogs

CURRENT_SCHEMA_VERSION	back to summary
public static final String CURRENT_SCHEMA_VERSION

maxResultsPerCatalog	back to summary
private Integer maxResultsPerCatalog Annotations @JsonProperty:max-results-per-catalog @JsonInclude:NON_NULL

queries	back to summary
private List<StudyQuery> queries

researchQuestions	back to summary
private List<String> researchQuestions Annotations @JsonProperty:research-questions

title	back to summary
private String title

version	back to summary
private String version Annotations @JsonProperty:version

Constructor Detail

Study	back to summary
public Study(List<String> authors, String title, List<String> researchQuestions, List<StudyQuery> queryEntries, List<StudyCatalog> catalogs)

Study	back to summary
private Study() Used for Jackson deserialization

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object other) 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 other)

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

getAuthors	back to summary
public List<String> getAuthors()

getCatalogs	back to summary
public List<StudyCatalog> getCatalogs()

getMaxResultsPerCatalog	back to summary
public @Nullable Integer getMaxResultsPerCatalog()

getQueries	back to summary
public List<StudyQuery> getQueries()

getResearchQuestions	back to summary
public List<String> getResearchQuestions()

getTitle	back to summary
public String getTitle()

getVersion	back to summary
public String getVersion()

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

setAuthors	back to summary
public void setAuthors(List<String> authors)

setCatalogs	back to summary
public void setCatalogs(List<StudyCatalog> catalogs)

setMaxResultsPerCatalog	back to summary
public void setMaxResultsPerCatalog(@Nullable Integer maxResultsPerCatalog)

setQueries	back to summary
public void setQueries(List<StudyQuery> queries)

setResearchQuestions	back to summary
public void setResearchQuestions(List<String> researchQuestions)

setTitle	back to summary
public void setTitle(String title)

setVersion	back to summary
public void setVersion(@NonNull String version)

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 Study

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail