Verified Owner
Top Fields Constructors Methods
org.jabref.model.groups

public Class TexGroup

extends AbstractGroup
implements FileUpdateListener
Class Inheritance
All Implemented Interfaces
org.jabref.model.util.FileUpdateListener
Annotations
@AllowedToUseLogic:because it needs access to aux parser
@NullMarked
Imports
java.io.IOException, java.nio.file.Path, java.util.List, .Objects, .Set, org.jabref.architecture.AllowedToUseLogic, org.jabref.logic.auxparser.AuxParser, .AuxParserResult, org.jabref.logic.util.io.FileUtil, org.jabref.model.entry.BibEntry, org.jabref.model.metadata.MetaData, org.jabref.model.util.DummyFileUpdateMonitor, .FileUpdateListener, .FileUpdateMonitor, org.jspecify.annotations.NullMarked, .Nullable

Field Summary

Modifier and TypeField and Description
private final AuxParser
private final FileUpdateMonitor
private final Path
private @Nullable Set<String>
private final MetaData
private final String
Inherited from org.jabref.model.groups.AbstractGroup:
colorcontextdescriptioniconNameisExpandedname

Constructor Summary

AccessConstructor and Description
pack-priv
TexGroup(String name, GroupHierarchyType context, Path filePath, AuxParser auxParser, FileUpdateMonitor fileMonitor, MetaData metaData, String user)

Method Summary

Modifier and TypeMethod and Description
public boolean
public static TexGroup
create(String name, GroupHierarchyType context, Path filePath, AuxParser auxParser, FileUpdateMonitor fileMonitor, MetaData metaData, String userAndHost)

public static TexGroup
create(String name, GroupHierarchyType context, Path filePath, AuxParser auxParser, MetaData metaData, String userAndHost)

public AbstractGroup
public boolean
equals(@Nullable Object o)

Overrides org.jabref.model.groups.AbstractGroup.equals.

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

private Path
public void
fileUpdated()

Implements org.jabref.model.util.FileUpdateListener.fileUpdated.

The file has been updated.

private List<Path>
public Path
public Path
public int
hashCode()

Overrides org.jabref.model.groups.AbstractGroup.hashCode.

Returns a hash code value for this object.

public boolean
isDynamic()

Implements abstract org.jabref.model.groups.AbstractGroup.isDynamic.

Returns true if this group is dynamic, i.e. uses a search definition or equiv.

private Path

Returns:

A relative path or the original one if it could not be made relative
relativize
(Path
The path to relativize
path
)

Relativizes the given path to the file directories.

public String
toString()

Overrides org.jabref.model.groups.AbstractGroup.toString.

Returns a string representation of the object.

Inherited from org.jabref.model.groups.AbstractGroup:
containsAllcontainsAnygetColorgetDescriptiongetHierarchicalContextgetIconNamegetNameisExpandedisMatchnamePropertysetColorsetDescriptionsetExpandedsetIconName

Field Detail

auxParserback to summary
private final AuxParser auxParser
fileMonitorback to summary
private final FileUpdateMonitor fileMonitor
filePathback to summary
private final Path filePath
keysUsedInAuxback to summary
private @Nullable Set<String> keysUsedInAux
metaDataback to summary
private final MetaData metaData
userback to summary
private final String user

Constructor Detail

TexGroupback to summary
pack-priv TexGroup(String name, GroupHierarchyType context, Path filePath, AuxParser auxParser, FileUpdateMonitor fileMonitor, MetaData metaData, String user)

Method Detail

containsback to summary
public boolean contains(BibEntry entry)

Implements abstract org.jabref.model.groups.AbstractGroup.contains.

Annotations
@Override
createback to summary
public static TexGroup create(String name, GroupHierarchyType context, Path filePath, AuxParser auxParser, FileUpdateMonitor fileMonitor, MetaData metaData, String userAndHost) throws IOException
createback to summary
public static TexGroup create(String name, GroupHierarchyType context, Path filePath, AuxParser auxParser, MetaData metaData, String userAndHost) throws IOException
deepCopyback to summary
public AbstractGroup deepCopy()

Implements abstract org.jabref.model.groups.AbstractGroup.deepCopy.

Annotations
@Override
equalsback to summary
public boolean equals(@Nullable Object o)

Overrides org.jabref.model.groups.AbstractGroup.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
expandPathback to summary
private Path expandPath(Path path)
fileUpdatedback to summary
public void fileUpdated()

Implements org.jabref.model.util.FileUpdateListener.fileUpdated.

Doc from org.jabref.model.util.FileUpdateListener.fileUpdated.

The file has been updated. A new call will not result until the file has been modified again.

Annotations
@Override
getFileDirectoriesAsPathsback to summary
private List<Path> getFileDirectoriesAsPaths()
getFilePathback to summary
public Path getFilePath()
getFilePathResolvedback to summary
public Path getFilePathResolved()
hashCodeback to summary
public int hashCode()

Overrides org.jabref.model.groups.AbstractGroup.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
isDynamicback to summary
public boolean isDynamic()

Implements abstract org.jabref.model.groups.AbstractGroup.isDynamic.

Doc from org.jabref.model.groups.AbstractGroup.isDynamic.

Returns true if this group is dynamic, i.e. uses a search definition or equiv. that might match new entries, or false if this group contains a fixed set of entries and thus will never match a new entry that was not explicitly added to it.

Annotations
@Override
relativizeback to summary
private Path relativize(Path path)

Relativizes the given path to the file directories. The getLatexFileDirectory must be absolute to correctly relativize because we do not have a bibdatabasecontext

Parameters
path:Path

The path to relativize

Returns:Path

A relative path or the original one if it could not be made relative

toStringback to summary
public String toString()

Overrides org.jabref.model.groups.AbstractGroup.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