JabRef 6.0-beta.1 · org.jabref.logic.citationkeypattern.AbstractCitationKeyPatterns

Modifier and Type	Field and Description
protected Map<EntryType, CitationKeyPattern>	data
protected CitationKeyPattern	defaultPattern

Access	Constructor and Description
public	AbstractCitationKeyPatterns()

Method Summary

Modifier and Type	Method and Description
public void	addCitationKeyPattern(EntryType type, String pattern)
public boolean	equals(Object o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public Set<EntryType>	getAllKeys()
public CitationKeyPattern	Returns: null if not available. getDefaultValue() This method is called "...Value" to be in line with the other methods
public abstract CitationKeyPattern	getLastLevelCitationKeyPattern(EntryType key)
public Map<EntryType, CitationKeyPattern>	getPatterns()
public CitationKeyPattern	Returns: the list of Strings for the given key. First entry: the complete key getValue(EntryType a `String` entryType) Gets an object for a desired key from this CitationKeyPattern or one of it's parents (in the case of DatabaseCitationKeyPattern).
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public final boolean	isDefaultValue(EntryType entryType) Checks whether this pattern is customized or the default value.
public void	setDefaultValue(@NonNull String the pattern to store bibtexKeyPattern) Sets the DEFAULT PATTERN for this key pattern
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

data	back to summary
protected Map<EntryType, CitationKeyPattern> data

defaultPattern	back to summary
protected CitationKeyPattern defaultPattern

AbstractCitationKeyPatterns	back to summary
public AbstractCitationKeyPatterns()

Method Detail

addCitationKeyPattern	back to summary
public void addCitationKeyPattern(EntryType type, String pattern)

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

getAllKeys	back to summary
public Set<EntryType> getAllKeys()

getDefaultValue	back to summary
public CitationKeyPattern getDefaultValue() This method is called "...Value" to be in line with the other methods Returns:CitationKeyPattern null if not available.

getDefaultValue

back to summary

public CitationKeyPattern getDefaultValue()

This method is called "...Value" to be in line with the other methods

Returns:CitationKeyPattern: null if not available.

getLastLevelCitationKeyPattern	back to summary
public abstract CitationKeyPattern getLastLevelCitationKeyPattern(EntryType key)

getPatterns	back to summary
public Map<EntryType, CitationKeyPattern> getPatterns()

getValue back to summary

getValue	back to summary
public CitationKeyPattern getValue(EntryType entryType) Gets an object for a desired key from this CitationKeyPattern or one of it's parents (in the case of DatabaseCitationKeyPattern). This method first tries to obtain the object from this CitationKeyPattern via the `get` method of `Hashtable`. If this fails, we try the default. If that fails, we try the parent. If that fails, we return the DEFAULT_LABELPATTERN Parameters entryType:EntryType a `String` Returns:CitationKeyPattern the list of Strings for the given key. First entry: the complete key

public CitationKeyPattern getValue(EntryType entryType)

Gets an object for a desired key from this CitationKeyPattern or one of it's parents (in the case of DatabaseCitationKeyPattern). This method first tries to obtain the object from this CitationKeyPattern via the get method of Hashtable. If this fails, we try the default. If that fails, we try the parent. If that fails, we return the DEFAULT_LABELPATTERN

Parameters

entryType:EntryType: a String

Returns:CitationKeyPattern

the list of Strings for the given key. First entry: the complete key

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

isDefaultValue	back to summary
public final boolean isDefaultValue(EntryType entryType) Checks whether this pattern is customized or the default value.

setDefaultValue	back to summary
public void setDefaultValue(@NonNull String bibtexKeyPattern) Sets the DEFAULT PATTERN for this key pattern Parameters bibtexKeyPattern:@NonNull String the pattern to store

setDefaultValue

back to summary

public void setDefaultValue(@NonNull String bibtexKeyPattern)

Sets the DEFAULT PATTERN for this key pattern

Parameters

bibtexKeyPattern:@NonNull String: the pattern to store

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

public abstract Class AbstractCitationKeyPatterns

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail