JabRef 5.15 · org.jabref.model.entry.Keyword · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
public static Character	DEFAULT_HIERARCHICAL_DELIMITER
private final String	keyword

Access	Constructor and Description
public	Keyword(String keyword)

Modifier and Type	Method and Description
private void	addAtEnd(String keyword) Overrides org.jabref.model.ChainNode.addAtEnd. Adds the given keyword at the end of the chain.
public int	compareTo(Keyword the object to be compared. o) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public Set<Keyword>	flatten() Returns all nodes in this chain as separate keywords.
public String	get() Gets the keyword of this node in the chain.
public Set<String>	getAllSubchainsAsString(Character hierarchicalDelimiter) Returns all subchains starting at this node.
public String	getPathFromRootAsString(Character hierarchicalDelimiter) Returns a text representation of the path from the root to this item.
private String	getSubchainAsString(Character hierarchicalDelimiter) Returns a text representation of the subchain starting at this item.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public static Keyword	of(String... keywords) Connects all the given keywords into one chain and returns its root, e.g. "A", "B", "C" is transformed into "A > B > C".
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

DEFAULT_HIERARCHICAL_DELIMITER	back to summary
public static Character DEFAULT_HIERARCHICAL_DELIMITER

keyword	back to summary
private final String keyword

Keyword	back to summary
public Keyword(String keyword)

Method Detail

addAtEnd	back to summary
private void addAtEnd(String keyword) Overrides org.jabref.model.ChainNode.addAtEnd. Adds the given keyword at the end of the chain. E.g., "A > B > C" + "D" -> "A > B > C > D".

addAtEnd

back to summary

private void addAtEnd(String keyword)

Overrides org.jabref.model.ChainNode.addAtEnd.

Adds the given keyword at the end of the chain. E.g., "A > B > C" + "D" -> "A > B > C > D".

compareTo back to summary

compareTo	back to summary
public int compareTo(Keyword o) Implements java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `y.compareTo(x)` throws an exception.) The implementor must also ensure that the relation is transitive: `(x.compareTo(y) > 0 && y.compareTo(z) > 0)` implies `x.compareTo(z) > 0`. Finally, the implementor must ensure that `x.compareTo(y)==0` implies that `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`. Parameters o:Keyword the object to be compared. Returns:int a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Annotations @Override

public int compareTo(Keyword o)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Parameters

o:Keyword: the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(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. Parameters o: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 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.

Parameters

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

flatten	back to summary
public Set<Keyword> flatten() Returns all nodes in this chain as separate keywords. E.g, for "A > B > C" we get {"A", "B", "C"}.

get	back to summary
public String get() Gets the keyword of this node in the chain.

getAllSubchainsAsString	back to summary
public Set<String> getAllSubchainsAsString(Character hierarchicalDelimiter) Returns all subchains starting at this node. E.g., for the chain "A > B > C" the subchains {"A", "A > B", "A > B > C"} are returned.

getPathFromRootAsString	back to summary
public String getPathFromRootAsString(Character hierarchicalDelimiter) Returns a text representation of the path from the root to this item. E.g., calling `getPathFromRootAsString(Character)` on the node "B" in "A > B > C" returns "A > B".

getSubchainAsString	back to summary
private String getSubchainAsString(Character hierarchicalDelimiter) Returns a text representation of the subchain starting at this item. E.g., calling `getSubchainAsString(Character)` on the node "B" in "A > B > C" returns "B > C".

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

of	back to summary
public static Keyword of(String... keywords) Connects all the given keywords into one chain and returns its root, e.g. "A", "B", "C" is transformed into "A > B > C".

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 Keyword

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail