Modifier and Type	Class and Description
public static enum	ConversionOptions.MathMode Handling of math spans.
public static enum	ConversionOptions.UnknownCommandPolicy Handling of commands that neither the parser's vocabulary nor the conversion table covers.

Field Summary

Modifier and Type	Field and Description
private final boolean	convertScripts Record Component accessed by convertScripts(). whether `\textsuperscript{..}`, `\textsubscript{..}`, and math `^`/`_` are converted to Unicode super-/subscript characters.
private final ConversionOptions.MathMode	mathMode Record Component accessed by mathMode(). how $...$ / `\[...\]` spans are handled
private final ConversionOptions.UnknownCommandPolicy	unknownCommandPolicy Record Component accessed by unknownCommandPolicy(). how commands absent from the conversion table are handled

Constructor Summary

Access	Constructor and Description
public	ConversionOptions(boolean convertScripts, ConversionOptions.MathMode mathMode, ConversionOptions.UnknownCommandPolicy unknownCommandPolicy)

Method Summary

Modifier and Type	Method and Description
public boolean	convertScripts() Record Component getter of convertScripts. Record Component whether `\textsuperscript{..}`, `\textsubscript{..}`, and math `^`/`_` are converted to Unicode super-/subscript characters.
public static ConversionOptions	defaults() `convertScripts = true`, `MathMode#UNICODE`, `UnknownCommandPolicy#KEEP_COMMAND`.
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public ConversionOptions.MathMode	mathMode() Record Component getter of mathMode. Record Component how $...$ / `\[...\]` spans are handled
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.
public ConversionOptions.UnknownCommandPolicy	unknownCommandPolicy() Record Component getter of unknownCommandPolicy. Record Component how commands absent from the conversion table are handled
public ConversionOptions	withConvertScripts(boolean convertScripts)
public ConversionOptions	withMathMode(ConversionOptions.MathMode mathMode)
public ConversionOptions	withUnknownCommandPolicy(ConversionOptions.UnknownCommandPolicy unknownCommandPolicy)

Field Detail

convertScripts back to summary

convertScripts	back to summary
private final boolean convertScripts Record Component accessed by convertScripts(). whether `\textsuperscript{..}`, `\textsubscript{..}`, and math `^`/`_` are converted to Unicode super-/subscript characters. Disable to keep them verbatim so that a later Unicode→LaTeX conversion can round-trip (see JabRef issue 3644)

private final boolean convertScripts

Record Component accessed by convertScripts().

whether \textsuperscript{..}, \textsubscript{..}, and math ^/_ are converted to Unicode super-/subscript characters. Disable to keep them verbatim so that a later Unicode→LaTeX conversion can round-trip (see JabRef issue 3644)

mathMode back to summary

mathMode	back to summary
private final ConversionOptions.MathMode mathMode Record Component accessed by mathMode(). how $...$ / `\[...\]` spans are handled

private final ConversionOptions.MathMode mathMode

Record Component accessed by mathMode().

how $...$ / \[...\] spans are handled

unknownCommandPolicy	back to summary
private final ConversionOptions.UnknownCommandPolicy unknownCommandPolicy Record Component accessed by unknownCommandPolicy(). how commands absent from the conversion table are handled

unknownCommandPolicy

back to summary

private final ConversionOptions.UnknownCommandPolicy unknownCommandPolicy

Record Component accessed by unknownCommandPolicy().

how commands absent from the conversion table are handled

Constructor Detail

ConversionOptions	back to summary
public ConversionOptions(boolean convertScripts, ConversionOptions.MathMode mathMode, ConversionOptions.UnknownCommandPolicy unknownCommandPolicy)

Method Detail

convertScripts back to summary

convertScripts	back to summary
public boolean convertScripts() Record Component getter of convertScripts. Record Component whether `\textsuperscript{..}`, `\textsubscript{..}`, and math `^`/`_` are converted to Unicode super-/subscript characters. Disable to keep them verbatim so that a later Unicode→LaTeX conversion can round-trip (see JabRef issue 3644)

public boolean convertScripts()

Record Component getter of convertScripts.

Record Component: whether \textsuperscript{..}, \textsubscript{..}, and math ^/_ are converted to Unicode super-/subscript characters. Disable to keep them verbatim so that a later Unicode→LaTeX conversion can round-trip (see JabRef issue 3644)

defaults	back to summary
public static ConversionOptions defaults() `convertScripts = true`, `MathMode#UNICODE`, `UnknownCommandPolicy#KEEP_COMMAND`.

equals back to summary

equals	back to summary
public final boolean equals(Object o) Implements abstract java.lang.Record.equals. Doc from java.lang.Record.equals. Indicates whether some other object is "equal to" this one. In addition to the general contract of `Object.equals`, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: R copy = new R(r.c1(), r.c2(), ..., r.cn()); then it must be the case that `r.equals(copy)`.

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

hashCode back to summary

hashCode	back to summary
public final int hashCode() Implements abstract java.lang.Record.hashCode. Doc from java.lang.Record.hashCode. Returns a hash code value for the record. Obeys the general contract of `Object.hashCode`. For records, hashing behavior is constrained by the refined contract of `Record.equals`, so that any two records created from the same components must have the same hash code.

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

mathMode back to summary

mathMode	back to summary
public ConversionOptions.MathMode mathMode() Record Component getter of mathMode. Record Component how $...$ / `\[...\]` spans are handled

public ConversionOptions.MathMode mathMode()

Record Component getter of mathMode.

Record Component: how $...$ / \[...\] spans are handled

toString back to summary

toString	back to summary
public final String toString() Implements abstract java.lang.Record.toString. Doc from java.lang.Record.toString. Returns a string representation of the record. In accordance with the general contract of `Object#toString()`, the `toString` method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read. In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

unknownCommandPolicy	back to summary
public ConversionOptions.UnknownCommandPolicy unknownCommandPolicy() Record Component getter of unknownCommandPolicy. Record Component how commands absent from the conversion table are handled

unknownCommandPolicy

back to summary

public ConversionOptions.UnknownCommandPolicy unknownCommandPolicy()

Record Component getter of unknownCommandPolicy.

Record Component: how commands absent from the conversion table are handled

withConvertScripts	back to summary
public ConversionOptions withConvertScripts(boolean convertScripts)

withMathMode	back to summary
public ConversionOptions withMathMode(ConversionOptions.MathMode mathMode)

withUnknownCommandPolicy	back to summary
public ConversionOptions withUnknownCommandPolicy(ConversionOptions.UnknownCommandPolicy unknownCommandPolicy)

org.jabref.latexconv back to summary

public final Enum ConversionOptions.MathMode

Class Inheritance

extends Enum<ConversionOptions.MathMode>

java.lang.Object
java.lang.Enum
org.jabref.latexconv.ConversionOptions.MathMode

Handling of math spans.

Field Summary

Modifier and Type	Field and Description
public static final ConversionOptions.MathMode	PASSTHROUGH Math spans are emitted verbatim, delimiters included, for a downstream math renderer
public static final ConversionOptions.MathMode	UNICODE Best-effort conversion of math content to Unicode ( $\pi$ → `π`)

Constructor Summary

Access	Constructor and Description
private	MathMode()

Method Summary

Modifier and Type	Method and Description
public static ConversionOptions.MathMode	valueOf(String name)
public static ConversionOptions.MathMode[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

PASSTHROUGH	back to summary
public static final ConversionOptions.MathMode PASSTHROUGH Math spans are emitted verbatim, delimiters included, for a downstream math renderer

UNICODE	back to summary
public static final ConversionOptions.MathMode UNICODE Best-effort conversion of math content to Unicode ( $\pi$ → `π`)

Constructor Detail

MathMode	back to summary
private MathMode()

Method Detail

valueOf	back to summary
public static ConversionOptions.MathMode valueOf(String name)

values	back to summary
public static ConversionOptions.MathMode[] values()

org.jabref.latexconv back to summary

public final Enum ConversionOptions.UnknownCommandPolicy

Class Inheritance

extends Enum<ConversionOptions.UnknownCommandPolicy>

java.lang.Object
java.lang.Enum
org.jabref.latexconv.ConversionOptions.UnknownCommandPolicy

Handling of commands that neither the parser's vocabulary nor the conversion table covers.

Field Summary

Modifier and Type	Field and Description
public static final ConversionOptions.UnknownCommandPolicy	DROP Drop the command including its arguments
public static final ConversionOptions.UnknownCommandPolicy	KEEP_COMMAND Emit the command and its brace arguments exactly as written (`\aaaa{bbbb}`)
public static final ConversionOptions.UnknownCommandPolicy	UNWRAP Drop the command but keep its argument content (`\aaaa{bbbb}` → `bbbb`)

Constructor Summary

Access	Constructor and Description
private	UnknownCommandPolicy()

Method Summary

Modifier and Type	Method and Description
public static ConversionOptions.UnknownCommandPolicy	valueOf(String name)
public static ConversionOptions.UnknownCommandPolicy[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

DROP	back to summary
public static final ConversionOptions.UnknownCommandPolicy DROP Drop the command including its arguments

KEEP_COMMAND	back to summary
public static final ConversionOptions.UnknownCommandPolicy KEEP_COMMAND Emit the command and its brace arguments exactly as written (`\aaaa{bbbb}`)

UNWRAP	back to summary
public static final ConversionOptions.UnknownCommandPolicy UNWRAP Drop the command but keep its argument content (`\aaaa{bbbb}` → `bbbb`)

Constructor Detail

UnknownCommandPolicy	back to summary
private UnknownCommandPolicy()

Method Detail

valueOf	back to summary
public static ConversionOptions.UnknownCommandPolicy valueOf(String name)

values	back to summary
public static ConversionOptions.UnknownCommandPolicy[] values()

public final Record ConversionOptions

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum ConversionOptions.MathMode

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum ConversionOptions.UnknownCommandPolicy

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail