JabRef 5.15 · org.jabref.model.groups.AbstractGroup · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
protected Optional<Color>	color
protected final GroupHierarchyType	context The hierarchical context of the group.
protected Optional<String>	description
protected Optional<String>	iconName
protected boolean	isExpanded
protected final StringProperty	name The group's name.

Access	Constructor and Description
protected	AbstractGroup(String name, GroupHierarchyType context)

Method Summary

Modifier and Type	Method and Description
public abstract boolean	Returns: true if this group contains the specified entry, false otherwise. contains(BibEntry entry)
public boolean	Returns: true if this group contains all of the specified entries, false otherwise. containsAll(List<BibEntry> entries)
public boolean	Returns: true if this group contains any of the specified entries, false otherwise. containsAny(List<BibEntry> entries)
public abstract AbstractGroup	Returns: A deep copy of this object. deepCopy()
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 Optional<Color>	getColor()
public Optional<String>	getDescription()
public GroupHierarchyType	getHierarchicalContext() Returns the way this group relates to its sub- or supergroup.
public Optional<String>	getIconName()
public final String	getName() Returns this group's name, e.g. for display in a list/tree.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public abstract boolean	isDynamic() Returns true if this group is dynamic, i.e. uses a search definition or equiv.
public boolean	isExpanded()
public boolean	isMatch(BibEntry entry) Implements org.jabref.model.search.SearchMatcher.isMatch.
public StringProperty	nameProperty()
public void	setColor(Color color)
public void	setColor(String colorString)
public void	setDescription(String description)
public void	setExpanded(boolean expanded)
public void	setIconName(String iconName)
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

color	back to summary
protected Optional<Color> color

context	back to summary
protected final GroupHierarchyType context The hierarchical context of the group.

description	back to summary
protected Optional<String> description

iconName	back to summary
protected Optional<String> iconName

isExpanded	back to summary
protected boolean isExpanded

name	back to summary
protected final StringProperty name The group's name.

AbstractGroup	back to summary
protected AbstractGroup(String name, GroupHierarchyType context)

Method Detail

contains	back to summary
public abstract boolean contains(BibEntry entry) Returns:boolean true if this group contains the specified entry, false otherwise.

containsAll	back to summary
public boolean containsAll(List<BibEntry> entries) Returns:boolean true if this group contains all of the specified entries, false otherwise.

containsAny	back to summary
public boolean containsAny(List<BibEntry> entries) Returns:boolean true if this group contains any of the specified entries, false otherwise.

deepCopy	back to summary
public abstract AbstractGroup deepCopy() Returns:AbstractGroup A deep copy of this object.

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

getColor	back to summary
public Optional<Color> getColor()

getDescription	back to summary
public Optional<String> getDescription()

getHierarchicalContext	back to summary
public GroupHierarchyType getHierarchicalContext() Returns the way this group relates to its sub- or supergroup.

getIconName	back to summary
public Optional<String> getIconName()

getName	back to summary
public final String getName() Returns this group's name, e.g. for display in a list/tree.

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

isDynamic	back to summary
public abstract boolean 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.

isExpanded	back to summary
public boolean isExpanded()

isMatch	back to summary
public boolean isMatch(BibEntry entry) Implements org.jabref.model.search.SearchMatcher.isMatch. Annotations @Override

isMatch

back to summary

public boolean isMatch(BibEntry entry)

Implements org.jabref.model.search.SearchMatcher.isMatch.

Annotations

@Override

nameProperty	back to summary
public StringProperty nameProperty()

setColor	back to summary
public void setColor(Color color)

setColor	back to summary
public void setColor(String colorString)

setDescription	back to summary
public void setDescription(String description)

setExpanded	back to summary
public void setExpanded(boolean expanded)

setIconName	back to summary
public void setIconName(String iconName)

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 abstract Class AbstractGroup

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail