Modifier and Type	Class and Description
public static enum	SaveOrder.OrderType
public static record	SaveOrder.SortCriterion

Modifier and Type	Field and Description
private static final Logger	LOGGER
private final SaveOrder.OrderType	orderType
private final List<SaveOrder.SortCriterion>	sortCriteria

Access	Constructor and Description
public	SaveOrder(SaveOrder.OrderType orderType, List<SaveOrder.SortCriterion> sortCriteria)
private	SaveOrder(@NonNull List<String> data)

Modifier and Type	Method and Description
public boolean	equals(Object o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public List<String>	getAsStringList() Outputs the current configuration to be consumed later by the constructor
public static SelfContainedSaveOrder	getDefaultSaveOrder()
public SaveOrder.OrderType	getOrderType()
public List<SaveOrder.SortCriterion>	getSortCriteria()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public static SaveOrder	parse(List<String> orderedData)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

LOGGER	back to summary
private static final Logger LOGGER

orderType	back to summary
private final SaveOrder.OrderType orderType

sortCriteria	back to summary
private final List<SaveOrder.SortCriterion> sortCriteria

SaveOrder	back to summary
private SaveOrder(@NonNull List<String> data)

Method Detail

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)

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

getAsStringList	back to summary
public List<String> getAsStringList() Outputs the current configuration to be consumed later by the constructor

getDefaultSaveOrder	back to summary
public static SelfContainedSaveOrder getDefaultSaveOrder()

getOrderType	back to summary
public SaveOrder.OrderType getOrderType()

getSortCriteria	back to summary
public List<SaveOrder.SortCriterion> getSortCriteria()

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

parse	back to summary
public static SaveOrder parse(List<String> orderedData)

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

org.jabref.model.metadata back to summary

public final Enum SaveOrder.OrderType

Class Inheritance

extends Enum<SaveOrder.OrderType>

java.lang.Object
java.lang.Enum
org.jabref.model.metadata.SaveOrder.OrderType

Field Summary

Modifier and Type	Field and Description
private final String	name Hides java.lang.Enum.name.
public static final SaveOrder.OrderType	ORIGINAL
public static final SaveOrder.OrderType	SPECIFIED
public static final SaveOrder.OrderType	TABLE

Constructor Summary

Access	Constructor and Description
private	OrderType(String name)

Method Summary

Modifier and Type	Method and Description
public static SaveOrder.OrderType	fromBooleans(boolean saveInSpecifiedOrder, boolean saveInOriginalOrder)
public String	toString() Overrides java.lang.Enum.toString. Returns the name of this enum constant, as contained in the declaration.
public static SaveOrder.OrderType	valueOf(String name)
public static SaveOrder.OrderType[]	values()

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

Field Detail

name	back to summary
private final String name Hides java.lang.Enum.name.

ORIGINAL	back to summary
public static final SaveOrder.OrderType ORIGINAL

SPECIFIED	back to summary
public static final SaveOrder.OrderType SPECIFIED

TABLE	back to summary
public static final SaveOrder.OrderType TABLE

Constructor Detail

OrderType	back to summary
private OrderType(String name)

Method Detail

fromBooleans	back to summary
public static SaveOrder.OrderType fromBooleans(boolean saveInSpecifiedOrder, boolean saveInOriginalOrder)

toString	back to summary
public String toString() Overrides java.lang.Enum.toString. Doc from java.lang.Enum.toString. Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Enum.toString.

Doc from java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists.

Annotations

@Override

valueOf	back to summary
public static SaveOrder.OrderType valueOf(String name)

values	back to summary
public static SaveOrder.OrderType[] values()

org.jabref.model.metadata back to summary

public final Record SaveOrder.SortCriterion

Class Inheritance

extends Record

java.lang.Object
java.lang.Record
org.jabref.model.metadata.SaveOrder.SortCriterion

Record Components

field:Field
descending:boolean

Field Summary

Modifier and Type	Field and Description
private final boolean	descending Record Component accessed by descending().
private final Field	field Record Component accessed by field().

Constructor Summary

Access	Constructor and Description
public	SortCriterion(Field field) Given field sorted ascending
public	SortCriterion(Field The field field, String Must be a boolean value as string, e.g. "true", "false" descending)
public	SortCriterion(Field field, boolean descending)

Method Summary

Modifier and Type	Method and Description
public boolean	descending() Record Component getter of descending.
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public Field	field() Record Component getter of field.
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public @NonNull String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

descending	back to summary
private final boolean descending Record Component accessed by descending().

field	back to summary
private final Field field Record Component accessed by field().

Constructor Detail

SortCriterion	back to summary
public SortCriterion(Field field) Given field sorted ascending

SortCriterion	back to summary
public SortCriterion(Field field, String descending) Parameters field:Field The field descending:String Must be a boolean value as string, e.g. "true", "false"

SortCriterion	back to summary
public SortCriterion(Field field, boolean descending)

Method Detail

descending	back to summary
public boolean descending() Record Component getter of descending.

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

field	back to summary
public Field field() Record Component getter of field.

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.

toString back to summary

toString	back to summary
public @NonNull 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. Annotations @Override

public @NonNull 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.

Annotations

@Override

public Class SaveOrder

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Enum SaveOrder.OrderType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Record SaveOrder.SortCriterion

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail