JabRef 5.15 · org.jabref.model.pdf.FileAnnotation · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private static final int	ABBREVIATED_ANNOTATION_NAME_LENGTH
private static final String	ANNOTATION_DATE_FORMAT
private final FileAnnotationType	annotationType
private final String	author
private final String	content
private static final String	DATE_TIME_STRING
private static final String	DATE_TIME_STRING_WITH_TIME_ZONE
private final Optional<FileAnnotation>	linkedFileAnnotation
private static final Logger	LOGGER
private final int	page
private final LocalDateTime	timeModified

Access	Constructor and Description
public	FileAnnotation(final String The authors of the annotation author, final LocalDateTime The last time this annotation was modified timeModified, final int The page of the pdf where the annotation occurs pageNumber, final String the actual content of the annotation content, final FileAnnotationType the type of the annotation annotationType, final Optional<FileAnnotation> linkedFileAnnotation) A flexible constructor, mainly used as dummy if there is actually no annotation.
public	FileAnnotation(final org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation The actual annotation that holds the information annotation, final int The page of the pdf where the annotation occurs pageNumber) Creating a normal FileAnnotation from a PDAnnotation.
public	FileAnnotation(final org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation The actual annotation that holds the information annotation, final int The page of the pdf where the annotation occurs pageNumber, FileAnnotation The corresponding note of a marked text area. linkedFileAnnotation) For creating a FileAnnotation that has a connection to another FileAnnotation.

Method Summary

Modifier and Type	Method and Description
private String	Returns: the abbreviated name abbreviateAnnotationName(final String annotation to be shortened annotationName) Abbreviate annotation names when they are longer than `ABBREVIATED_ANNOTATION_NAME_LENGTH` chars
public boolean	equals(Object the reference object with which to compare. other) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public static LocalDateTime	Returns: a LocalDateTime parsed from the dateTimeString extractModifiedTime(String In this case of format yyyyMMddHHmmss. dateTimeString) Parses a String into a LocalDateTime.
public FileAnnotationType	getAnnotationType()
public String	getAuthor()
public String	getContent()
public FileAnnotation	Returns: the note attached to the annotation getLinkedFileAnnotation() Before this getter is called the presence of the linked annotation must be checked via hasLinkedAnnotation()!
public int	getPage()
public LocalDateTime	getTimeModified()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	hasLinkedAnnotation()
private String	parseContent(final String content)
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

ABBREVIATED_ANNOTATION_NAME_LENGTH	back to summary
private static final int ABBREVIATED_ANNOTATION_NAME_LENGTH

ANNOTATION_DATE_FORMAT	back to summary
private static final String ANNOTATION_DATE_FORMAT

annotationType	back to summary
private final FileAnnotationType annotationType

author	back to summary
private final String author

content	back to summary
private final String content

DATE_TIME_STRING	back to summary
private static final String DATE_TIME_STRING

DATE_TIME_STRING_WITH_TIME_ZONE	back to summary
private static final String DATE_TIME_STRING_WITH_TIME_ZONE

linkedFileAnnotation	back to summary
private final Optional<FileAnnotation> linkedFileAnnotation

LOGGER	back to summary
private static final Logger LOGGER

page	back to summary
private final int page

timeModified	back to summary
private final LocalDateTime timeModified

Constructor Detail

FileAnnotation	back to summary
public FileAnnotation(final String author, final LocalDateTime timeModified, final int pageNumber, final String content, final FileAnnotationType annotationType, final Optional<FileAnnotation> linkedFileAnnotation) A flexible constructor, mainly used as dummy if there is actually no annotation. Parameters author:String The authors of the annotation timeModified:LocalDateTime The last time this annotation was modified pageNumber:int The page of the pdf where the annotation occurs content:String the actual content of the annotation annotationType:FileAnnotationType the type of the annotation

FileAnnotation

back to summary

public FileAnnotation(final String author, final LocalDateTime timeModified, final int pageNumber, final String content, final FileAnnotationType annotationType, final Optional<FileAnnotation> linkedFileAnnotation)

A flexible constructor, mainly used as dummy if there is actually no annotation.

Parameters

author:String: The authors of the annotation
timeModified:LocalDateTime: The last time this annotation was modified
pageNumber:int: The page of the pdf where the annotation occurs
content:String: the actual content of the annotation
annotationType:FileAnnotationType: the type of the annotation

FileAnnotation	back to summary
public FileAnnotation(final org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation annotation, final int pageNumber) Creating a normal FileAnnotation from a PDAnnotation. Parameters annotation:org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation The actual annotation that holds the information pageNumber:int The page of the pdf where the annotation occurs

FileAnnotation

back to summary

public FileAnnotation(final org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation annotation, final int pageNumber)

Creating a normal FileAnnotation from a PDAnnotation.

Parameters

annotation:org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation: The actual annotation that holds the information
pageNumber:int: The page of the pdf where the annotation occurs

FileAnnotation	back to summary
public FileAnnotation(final org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation annotation, final int pageNumber, FileAnnotation linkedFileAnnotation) For creating a FileAnnotation that has a connection to another FileAnnotation. Needed when creating a text highlighted or underlined annotation with a sticky note. Parameters annotation:org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation The actual annotation that holds the information pageNumber:int The page of the pdf where the annotation occurs linkedFileAnnotation:FileAnnotation The corresponding note of a marked text area.

FileAnnotation

back to summary

public FileAnnotation(final org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation annotation, final int pageNumber, FileAnnotation linkedFileAnnotation)

For creating a FileAnnotation that has a connection to another FileAnnotation. Needed when creating a text highlighted or underlined annotation with a sticky note.

Parameters

annotation:org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation: The actual annotation that holds the information
pageNumber:int: The page of the pdf where the annotation occurs
linkedFileAnnotation:FileAnnotation: The corresponding note of a marked text area.

Method Detail

abbreviateAnnotationName back to summary

abbreviateAnnotationName	back to summary
private String abbreviateAnnotationName(final String annotationName) Abbreviate annotation names when they are longer than `ABBREVIATED_ANNOTATION_NAME_LENGTH` chars Parameters annotationName:String annotation to be shortened Returns:String the abbreviated name

private String abbreviateAnnotationName(final String annotationName)

Abbreviate annotation names when they are longer than ABBREVIATED_ANNOTATION_NAME_LENGTH chars

Parameters

annotationName:String: annotation to be shortened

Returns:String

the abbreviated name

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

Parameters

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

extractModifiedTime	back to summary
public static LocalDateTime extractModifiedTime(String dateTimeString) Parses a String into a LocalDateTime. Parameters dateTimeString:String In this case of format yyyyMMddHHmmss. Returns:LocalDateTime a LocalDateTime parsed from the dateTimeString

extractModifiedTime

back to summary

public static LocalDateTime extractModifiedTime(String dateTimeString)

Parses a String into a LocalDateTime.

Parameters

dateTimeString:String: In this case of format yyyyMMddHHmmss.

Returns:LocalDateTime

a LocalDateTime parsed from the dateTimeString

getAnnotationType	back to summary
public FileAnnotationType getAnnotationType()

getAuthor	back to summary
public String getAuthor()

getContent	back to summary
public String getContent()

getLinkedFileAnnotation	back to summary
public FileAnnotation getLinkedFileAnnotation() Before this getter is called the presence of the linked annotation must be checked via hasLinkedAnnotation()! Returns:FileAnnotation the note attached to the annotation

getLinkedFileAnnotation

back to summary

public FileAnnotation getLinkedFileAnnotation()

Before this getter is called the presence of the linked annotation must be checked via hasLinkedAnnotation()!

Returns:FileAnnotation: the note attached to the annotation

getPage	back to summary
public int getPage()

getTimeModified	back to summary
public LocalDateTime getTimeModified()

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

hasLinkedAnnotation	back to summary
public boolean hasLinkedAnnotation()

parseContent	back to summary
private String parseContent(final String content)

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. Returns:String a string representation of the object 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.

Returns:String

a string representation of the object

Annotations

@Override

public Class FileAnnotation

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail