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

Modifier and Type	Field and Description
private static final char	CLOSING_BRACE
private static final Character	DEFAULT_KEYWORD_DELIMITER
private final List<Keyword>	keywordChains
private static final Character	NO_KEYWORD_DELIMITER
private static final char	OPENING_BRACE

Access	Constructor and Description
public	KeywordList()
public	KeywordList(Collection<Keyword> keywordChains)
public	KeywordList(List<String> keywordChains)
public	KeywordList(String... keywordChains)
public	KeywordList(Keyword... keywordChains)

Method Summary

Modifier and Type	Method and Description
public boolean	add(Keyword keyword)
public void	add(String keywordsString)
public void	addAll(KeywordList keywordsToAdd)
private static void	addTokenIfNotBlank(List<String> keywordTokens, StringBuilder currentToken)
public void	clear()
public boolean	contains(Keyword o)
public boolean	contains(String keywordString)
public static long	countEffectiveDelimiters(@NonNull String keywordString, @NonNull Character delimiter) Counts how often the delimiter occurs as an effective delimiter, i.e., at top level: not escaped and not inside braces.
public KeywordList	createClone()
public boolean	equals(Object o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public Keyword	get(int index)
public String	getAsString(Character delimiter) Keywords are separated by the given delimiter and an additional space, i.e. "one, two".
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isEmpty()
public Iterator<Keyword>	iterator() Implements java.lang.Iterable.iterator. Returns an iterator over elements of type `T`.
public static KeywordList	merge(String keywordStringA, String keywordStringB, Character delimiter)
public static KeywordList	Returns: a parsed list containing the keywordChains parse(@NonNull String a String of keywordChains keywordString, @NonNull Character The delimiter used for separating the keywords delimiter) Parses the keyword list and uses `Keyword#DEFAULT_HIERARCHICAL_DELIMITER` as hierarchical delimiter.
public static KeywordList	Returns: a parsed list containing the keywordChains parseWithMultipleDelimiters(@NonNull String a String of keywordChains keywordString, @NonNull List<Character> a List of delimiters used for separating the keywords delimiters) Parses the keyword list using multiple candidate delimiters.
public static KeywordList	parseWithPrioritizedDelimiters(@NonNull String keywordString, @NonNull List<Character> delimiters) Parses the keyword list by inferring a single delimiter using the given priority order.
public boolean	remove(Keyword o)
public boolean	remove(String keywordsString)
public void	removeAll(KeywordList keywordsToRemove)
public void	replaceAll(KeywordList keywordsToReplace, @NonNull Keyword newValue)
public void	retainAll(KeywordList keywordToRetain)
private static void	scanTopLevel(@NonNull String keywordString, @NonNull List<Character> delimiters, @NonNull Consumer<Character> onContent, @NonNull Runnable onDelimiter) Walks the string, reporting each character either as content or as an effective (top-level, unescaped) delimiter.
public static String	serialize(List<Keyword> keywords, Character delimiter)
private static String	serialize(List<Keyword> keywords, Character delimiter, String keywordSeparator)
public static String	serializeWithSpaces(List<Keyword> keywords, Character delimiter)
public int	size()
private static List<String>	splitByDelimiters(@NonNull String keywordString, @NonNull List<Character> delimiters)
public Stream<Keyword>	stream()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public Set<String>	toStringList()

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

CLOSING_BRACE	back to summary
private static final char CLOSING_BRACE

DEFAULT_KEYWORD_DELIMITER	back to summary
private static final Character DEFAULT_KEYWORD_DELIMITER

keywordChains	back to summary
private final List<Keyword> keywordChains

NO_KEYWORD_DELIMITER	back to summary
private static final Character NO_KEYWORD_DELIMITER

OPENING_BRACE	back to summary
private static final char OPENING_BRACE

KeywordList	back to summary
public KeywordList()

KeywordList	back to summary
public KeywordList(Collection<Keyword> keywordChains)

KeywordList	back to summary
public KeywordList(List<String> keywordChains)

KeywordList	back to summary
public KeywordList(String... keywordChains)

KeywordList	back to summary
public KeywordList(Keyword... keywordChains)

Method Detail

add	back to summary
public boolean add(Keyword keyword)

add	back to summary
public void add(String keywordsString)

addAll	back to summary
public void addAll(KeywordList keywordsToAdd)

addTokenIfNotBlank	back to summary
private static void addTokenIfNotBlank(List<String> keywordTokens, StringBuilder currentToken)

clear	back to summary
public void clear()

contains	back to summary
public boolean contains(Keyword o)

contains	back to summary
public boolean contains(String keywordString)

countEffectiveDelimiters	back to summary
public static long countEffectiveDelimiters(@NonNull String keywordString, @NonNull Character delimiter) Counts how often the delimiter occurs as an effective delimiter, i.e., at top level: not escaped and not inside braces. Uses the same recognition rules as `parseWithMultipleDelimiters(String, List)`.

createClone	back to summary
public KeywordList createClone()

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. 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.

Annotations

@Override

get	back to summary
public Keyword get(int index)

getAsString	back to summary
public String getAsString(Character delimiter) Keywords are separated by the given delimiter and an additional space, i.e. "one, two".

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()

iterator back to summary

iterator	back to summary
public Iterator<Keyword> iterator() Implements java.lang.Iterable.iterator. Doc from java.lang.Iterable.iterator. Returns an iterator over elements of type `T`. Annotations @Override

public Iterator<Keyword> iterator()

Implements java.lang.Iterable.iterator.

Doc from java.lang.Iterable.iterator.

Returns an iterator over elements of type T.

Annotations

@Override

merge	back to summary
public static KeywordList merge(String keywordStringA, String keywordStringB, Character delimiter)

parse back to summary

parse	back to summary
public static KeywordList parse(@NonNull String keywordString, @NonNull Character delimiter) Parses the keyword list and uses `Keyword#DEFAULT_HIERARCHICAL_DELIMITER` as hierarchical delimiter. Parameters keywordString:@NonNull String a String of keywordChains delimiter:@NonNull Character The delimiter used for separating the keywords Returns:KeywordList a parsed list containing the keywordChains

public static KeywordList parse(@NonNull String keywordString, @NonNull Character delimiter)

Parses the keyword list and uses Keyword#DEFAULT_HIERARCHICAL_DELIMITER as hierarchical delimiter.

Parameters

keywordString:@NonNull String: a String of keywordChains
delimiter:@NonNull Character: The delimiter used for separating the keywords

Returns:KeywordList

a parsed list containing the keywordChains

parseWithMultipleDelimiters	back to summary
public static KeywordList parseWithMultipleDelimiters(@NonNull String keywordString, @NonNull List<Character> delimiters) Parses the keyword list using multiple candidate delimiters. Delimiters are recognized only at top level, not when escaped or inside braces. Parameters keywordString:@NonNull String a String of keywordChains delimiters:@NonNull List<Character> a List of delimiters used for separating the keywords Returns:KeywordList a parsed list containing the keywordChains

parseWithMultipleDelimiters

back to summary

public static KeywordList parseWithMultipleDelimiters(@NonNull String keywordString, @NonNull List<Character> delimiters)

Parses the keyword list using multiple candidate delimiters. Delimiters are recognized only at top level, not when escaped or inside braces.

Parameters

keywordString:@NonNull String: a String of keywordChains
delimiters:@NonNull List<Character>: a List of delimiters used for separating the keywords

Returns:KeywordList

a parsed list containing the keywordChains

parseWithPrioritizedDelimiters	back to summary
public static KeywordList parseWithPrioritizedDelimiters(@NonNull String keywordString, @NonNull List<Character> delimiters) Parses the keyword list by inferring a single delimiter using the given priority order.

remove	back to summary
public boolean remove(Keyword o)

remove	back to summary
public boolean remove(String keywordsString)

removeAll	back to summary
public void removeAll(KeywordList keywordsToRemove)

replaceAll	back to summary
public void replaceAll(KeywordList keywordsToReplace, @NonNull Keyword newValue)

retainAll	back to summary
public void retainAll(KeywordList keywordToRetain)

scanTopLevel	back to summary
private static void scanTopLevel(@NonNull String keywordString, @NonNull List<Character> delimiters, @NonNull Consumer<Character> onContent, @NonNull Runnable onDelimiter) Walks the string, reporting each character either as content or as an effective (top-level, unescaped) delimiter.

serialize	back to summary
public static String serialize(List<Keyword> keywords, Character delimiter)

serialize	back to summary
private static String serialize(List<Keyword> keywords, Character delimiter, String keywordSeparator)

serializeWithSpaces	back to summary
public static String serializeWithSpaces(List<Keyword> keywords, Character delimiter)

size	back to summary
public int size()

splitByDelimiters	back to summary
private static List<String> splitByDelimiters(@NonNull String keywordString, @NonNull List<Character> delimiters)

stream	back to summary
public Stream<Keyword> stream()

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

toStringList	back to summary
public Set<String> toStringList()

public Class KeywordList

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail