JabRef 6.0-beta.1 · org.jabref.model.entry.LinkedFile

Field Summary

Modifier and Type	Field and Description
private transient StringProperty	description
private transient StringProperty	fileType
private transient StringProperty	link
private static final LinkedFile	NULL_OBJECT
private static final String	REGEX_URL
private transient StringProperty	sourceURL
private static final Pattern	URL_PATTERN

Constructor Summary

Access	Constructor and Description
public	LinkedFile(String The description of the linked file description, String The path or URL to the linked file link, FileType The file type of the linked file. See `org.jabref.logic.util.StandardFileType` for common file types. fileType)
public	LinkedFile(String description, Path link, String fileType) Better use `LinkedFile(String description, String link, FileType fileType)` constructor
public	LinkedFile(String description, Path link, String fileType, String sourceUrl)
public	LinkedFile(String description, String link, String fileType, String sourceUrl) Constructor can also be used for non-valid paths.
public	LinkedFile(String description, String link, String fileType)
public	LinkedFile(URL link, String fileType)
public	LinkedFile(String description, URL link, String fileType)
public	LinkedFile(String description, URL link, String fileType, String sourceUrl)
public	LinkedFile(Path link) Constructs a new LinkedFile with an empty file type and an empty description

Method Summary

Modifier and Type	Method and Description
public StringProperty	descriptionProperty()
public boolean	equals(@Nullable Object o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public StringProperty	fileTypeProperty()
public Optional<Path>	findIn(BibDatabaseContext databaseContext, FilePreferences filePreferences)
public Optional<Path>	Returns: absolute path if found. findIn(List<Path> directories) Tries to locate the file.
public String	getDescription()
public Optional<String>	Returns: extracted file name getFileName() Extracts the file name, including basename and extension, from the link.
public String	getFileType()
public String	getLink()
public Observable[]	getObservables()
public String	getSourceUrl()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isEmpty()
public static boolean	Returns: `true`, if it starts with "http://", "https://", "ftp://", "ftps://" or contains "www."; `false` otherwise isOnlineLink(String The String to check toCheck) Checks if the given String is an online link Recognizes http://, https://, ftp://, ftps://, and www.
public boolean	isOnlineLink()
public StringProperty	linkProperty()
private void	readObject(ObjectInputStream in) Reads serialized object from `ObjectInputStream`, automatically called
public void	setDescription(String description)
public void	setFileType(String fileType)
public void	setFileType(FileType fileType)
public void	setLink(String link)
public void	setSourceURL(String url)
public StringProperty	sourceUrlProperty()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
private void	writeObject(ObjectOutputStream out) Writes serialized object to ObjectOutputStream, automatically called

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

Field Detail

description	back to summary
private transient StringProperty description

fileType	back to summary
private transient StringProperty fileType

link	back to summary
private transient StringProperty link

NULL_OBJECT	back to summary
private static final LinkedFile NULL_OBJECT

REGEX_URL	back to summary
private static final String REGEX_URL

sourceURL	back to summary
private transient StringProperty sourceURL

URL_PATTERN	back to summary
private static final Pattern URL_PATTERN

Constructor Detail

LinkedFile	back to summary
public LinkedFile(String description, String link, FileType fileType) Parameters description:String The description of the linked file link:String The path or URL to the linked file fileType:FileType The file type of the linked file. See `org.jabref.logic.util.StandardFileType` for common file types.

LinkedFile	back to summary
public LinkedFile(String description, Path link, String fileType) Better use `LinkedFile(String description, String link, FileType fileType)` constructor

LinkedFile	back to summary
public LinkedFile(String description, Path link, String fileType, String sourceUrl)

LinkedFile	back to summary
public LinkedFile(String description, String link, String fileType, String sourceUrl) Constructor can also be used for non-valid paths. We need to parse them, because the GUI needs to render it.

LinkedFile	back to summary
public LinkedFile(String description, String link, String fileType)

LinkedFile	back to summary
public LinkedFile(URL link, String fileType)

LinkedFile	back to summary
public LinkedFile(String description, URL link, String fileType)

LinkedFile	back to summary
public LinkedFile(String description, URL link, String fileType, String sourceUrl)

LinkedFile	back to summary
public LinkedFile(Path link) Constructs a new LinkedFile with an empty file type and an empty description

Method Detail

descriptionProperty	back to summary
public StringProperty descriptionProperty()

equals back to summary

equals	back to summary
public boolean equals(@Nullable 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. Annotations @Override

public boolean equals(@Nullable 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.

Annotations

@Override

fileTypeProperty	back to summary
public StringProperty fileTypeProperty()

findIn	back to summary
public Optional<Path> findIn(BibDatabaseContext databaseContext, FilePreferences filePreferences)

findIn	back to summary
public Optional<Path> findIn(List<Path> directories) Tries to locate the file. In case the path is absolute, the path is checked. In case the path is relative, the given directories are used as base directories. Returns:Optional<Path> absolute path if found.

findIn

back to summary

public Optional<Path> findIn(List<Path> directories)

Tries to locate the file. In case the path is absolute, the path is checked. In case the path is relative, the given directories are used as base directories.

Returns:Optional<Path>: absolute path if found.

getDescription	back to summary
public String getDescription()

getFileName	back to summary
public Optional<String> getFileName() Extracts the file name, including basename and extension, from the link. Returns:Optional<String> extracted file name

getFileName

back to summary

public Optional<String> getFileName()

Extracts the file name, including basename and extension, from the link.

Returns:Optional<String>: extracted file name

getFileType	back to summary
public String getFileType()

getLink	back to summary
public String getLink()

getObservables	back to summary
public Observable[] getObservables()

getSourceUrl	back to summary
public String getSourceUrl()

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

isEmpty	back to summary
public boolean isEmpty()

isOnlineLink back to summary

isOnlineLink	back to summary
public static boolean isOnlineLink(String toCheck) Checks if the given String is an online link Recognizes http://, https://, ftp://, ftps://, and www. prefixes. Parameters toCheck:String The String to check Returns:boolean `true`, if it starts with "http://", "https://", "ftp://", "ftps://" or contains "www."; `false` otherwise

public static boolean isOnlineLink(String toCheck)

Checks if the given String is an online link Recognizes http://, https://, ftp://, ftps://, and www. prefixes.

Parameters

toCheck:String: The String to check

Returns:boolean

true, if it starts with "http://", "https://", "ftp://", "ftps://" or contains "www."; false otherwise

isOnlineLink	back to summary
public boolean isOnlineLink()

linkProperty	back to summary
public StringProperty linkProperty()

readObject back to summary

readObject	back to summary
private void readObject(ObjectInputStream in) throws IOException Reads serialized object from `ObjectInputStream`, automatically called Annotations @Serial

private void readObject(ObjectInputStream in) throws IOException

Reads serialized object from ObjectInputStream, automatically called

Annotations

@Serial

setDescription	back to summary
public void setDescription(String description)

setFileType	back to summary
public void setFileType(String fileType)

setFileType	back to summary
public void setFileType(FileType fileType)

setLink	back to summary
public void setLink(String link)

setSourceURL	back to summary
public void setSourceURL(String url)

sourceUrlProperty	back to summary
public StringProperty sourceUrlProperty()

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

writeObject	back to summary
private void writeObject(ObjectOutputStream out) throws IOException Writes serialized object to ObjectOutputStream, automatically called Annotations @Serial

writeObject

back to summary

private void writeObject(ObjectOutputStream out) throws IOException

Writes serialized object to ObjectOutputStream, automatically called

Annotations

@Serial

public Class LinkedFile

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail