Top Description Fields Constructors Methods
org.jabref.gui.preferences.journals

public Class AbbreviationsFileViewModel

extends Object
Class Inheritance
Imports
java.io.FileNotFoundException, .IOException, java.nio.file.Files, .Path, java.util.Collection, .List, .Objects, .Optional, java.util.stream.Collectors, javafx.beans.property.ReadOnlyBooleanProperty, .SimpleBooleanProperty, .SimpleListProperty, javafx.collections.FXCollections, org.jabref.logic.journals.Abbreviation, .AbbreviationWriter, .JournalAbbreviationLoader
This class provides a model for abbreviation files. It actually doesn't save the files as objects but rather saves their paths. This also allows to specify pseudo files as placeholder objects.

Field Summary

Modifier and TypeField and Description
private final SimpleListProperty<AbbreviationViewModel>
abbreviations

private final ReadOnlyBooleanProperty
isBuiltInList

private final String
name

private final Optional<Path>
path

Constructor Summary

AccessConstructor and Description
public
AbbreviationsFileViewModel(Path filePath)

public
AbbreviationsFileViewModel(List<AbbreviationViewModel> abbreviations, String name)

This constructor should only be called to create a pseudo abbreviation file for built in lists.

Method Summary

Modifier and TypeMethod and Description
public SimpleListProperty<AbbreviationViewModel>
abbreviationsProperty()

public boolean
equals(Object
the reference object with which to compare.
obj)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public boolean
exists()

public Optional<Path>
getAbsolutePath()

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public ReadOnlyBooleanProperty
isBuiltInListProperty()

public void
readAbbreviations()

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

public void
writeOrCreate()

This method will write all abbreviations of this abbreviation file to the file on the file system.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

abbreviationsback to summary
private final SimpleListProperty<AbbreviationViewModel> abbreviations
isBuiltInListback to summary
private final ReadOnlyBooleanProperty isBuiltInList
nameback to summary
private final String name
pathback to summary
private final Optional<Path> path

Constructor Detail

AbbreviationsFileViewModelback to summary
public AbbreviationsFileViewModel(Path filePath)
AbbreviationsFileViewModelback to summary
public AbbreviationsFileViewModel(List<AbbreviationViewModel> abbreviations, String name)

This constructor should only be called to create a pseudo abbreviation file for built in lists. This means it is a placeholder and its path will be null meaning it has no place on the filesystem. Its isPseudoFile property will therefore be set to true.

Method Detail

abbreviationsPropertyback to summary
public SimpleListProperty<AbbreviationViewModel> abbreviationsProperty()
equalsback 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.

Parameters
obj: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
existsback to summary
public boolean exists()
getAbsolutePathback to summary
public Optional<Path> getAbsolutePath()
hashCodeback 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
isBuiltInListPropertyback to summary
public ReadOnlyBooleanProperty isBuiltInListProperty()
readAbbreviationsback to summary
public void readAbbreviations() throws IOException
toStringback 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.

Returns:String

a string representation of the object

Annotations
@Override
writeOrCreateback to summary
public void writeOrCreate() throws IOException

This method will write all abbreviations of this abbreviation file to the file on the file system. It essentially will check if the current file is a builtin list and if not it will call AbbreviationWriter#writeOrCreate.