JabRef 6.0-beta.1 · org.jabref.logic.openoffice.style.BstStyle

Modifier and Type	Field and Description
private final BstVM	bstVM Parsed executable program for this specific `.bst` style.
private final @Nullable Path	filePath Filesystem path for external styles; `null` for internal styles.
private final boolean	hasSortCommand
private final boolean	internal
public static final String	INTERNAL_ABBRV_PATH
public static final String	INTERNAL_APA_PATH
public static final String	INTERNAL_IEEETRAN_PATH Classpath resource paths for the built-in BST styles.
private final String	name
private final @Nullable String	resourcePath Classpath resource path for internal styles; `null` for external styles.
private final String	source

Access	Constructor and Description
private	BstStyle(@Nullable String resourcePath, @Nullable Path filePath, boolean internal, String source, BstVM bstVM)

Method Summary

Modifier and Type	Method and Description
public BstVM	createBstVM() Returns the parsed `BstVM` for this style.
public static BstStyle	createInternal(String resourcePath) Creates an internal style loaded from a classpath resource (e.g. `/resource/openoffice/IEEEtran.bst`).
public boolean	equals(Object o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public @Nullable Path	getFilePath() Returns the filesystem `Path` for external styles, or `null` for internal styles.
public String	getName() Implements org.jabref.logic.openoffice.style.OOStyle.getName.
public String	getPath() Implements org.jabref.logic.openoffice.style.OOStyle.getPath. For external styles returns the absolute filesystem path.
public String	getSource()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	hasSortCommand()
public boolean	isInternalStyle() Implements org.jabref.logic.openoffice.style.OOStyle.isInternalStyle.
public static BstStyle	loadExternal(Path path) Creates an external (user-supplied) style backed by a filesystem path.
private static String	stripBstExtension(String filename)
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

Field Detail

bstVM back to summary

bstVM	back to summary
private final BstVM bstVM Parsed executable program for this specific `.bst` style. `BstVM` is not style-agnostic: it represents the parsed program of one concrete `.bst` file. We keep it on the style so repeated preview/citation/bibliography operations can reuse the parsed program and avoid reparsing and reallocating a new `BstVM` on each operation.

private final BstVM bstVM

Parsed executable program for this specific .bst style.

BstVM is not style-agnostic: it represents the parsed program of one concrete .bst file. We keep it on the style so repeated preview/citation/bibliography operations can reuse the parsed program and avoid reparsing and reallocating a new BstVM on each operation.

filePath	back to summary
private final @Nullable Path filePath Filesystem path for external styles; `null` for internal styles.

hasSortCommand	back to summary
private final boolean hasSortCommand

internal	back to summary
private final boolean internal

INTERNAL_ABBRV_PATH	back to summary
public static final String INTERNAL_ABBRV_PATH

INTERNAL_APA_PATH	back to summary
public static final String INTERNAL_APA_PATH

INTERNAL_IEEETRAN_PATH	back to summary
public static final String INTERNAL_IEEETRAN_PATH Classpath resource paths for the built-in BST styles.

name	back to summary
private final String name

resourcePath	back to summary
private final @Nullable String resourcePath Classpath resource path for internal styles; `null` for external styles.

source	back to summary
private final String source

Constructor Detail

BstStyle	back to summary
private BstStyle(@Nullable String resourcePath, @Nullable Path filePath, boolean internal, String source, BstVM bstVM)

Method Detail

createBstVM	back to summary
public BstVM createBstVM() Returns the parsed `BstVM` for this style.

createInternal	back to summary
public static BstStyle createInternal(String resourcePath) throws IOException Creates an internal style loaded from a classpath resource (e.g. `/resource/openoffice/IEEEtran.bst`).

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

getFilePath	back to summary
public @Nullable Path getFilePath() Returns the filesystem `Path` for external styles, or `null` for internal styles.

getName	back to summary
public String getName() Implements org.jabref.logic.openoffice.style.OOStyle.getName. Annotations @Override

getName

back to summary

public String getName()

Implements org.jabref.logic.openoffice.style.OOStyle.getName.

Annotations

@Override

getPath back to summary

getPath	back to summary
public String getPath() Implements org.jabref.logic.openoffice.style.OOStyle.getPath. For external styles returns the absolute filesystem path. For internal styles returns the classpath resource path (starts with `/resource/openoffice/`). This value is persisted by `JabRefCliPreferences` and used to reconstruct the style on startup. Annotations @Override

public String getPath()

Implements org.jabref.logic.openoffice.style.OOStyle.getPath.

For external styles returns the absolute filesystem path. For internal styles returns the classpath resource path (starts with /resource/openoffice/). This value is persisted by JabRefCliPreferences and used to reconstruct the style on startup.

Annotations

@Override

getSource	back to summary
public String getSource()

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

hasSortCommand	back to summary
public boolean hasSortCommand()

isInternalStyle	back to summary
public boolean isInternalStyle() Implements org.jabref.logic.openoffice.style.OOStyle.isInternalStyle. Annotations @Override

isInternalStyle

back to summary

public boolean isInternalStyle()

Implements org.jabref.logic.openoffice.style.OOStyle.isInternalStyle.

Annotations

@Override

loadExternal	back to summary
public static BstStyle loadExternal(Path path) throws IOException Creates an external (user-supplied) style backed by a filesystem path.

stripBstExtension	back to summary
private static String stripBstExtension(String filename)

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 Class BstStyle

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail