Top Description Inners Fields Constructors Methods
org.jabref.model.metadata

public Class SaveOrder

extends Object
Class Inheritance
Known Direct Subclasses
org.jabref.model.metadata.SelfContainedSaveOrder
Imports
java.util.ArrayList, .List, .Objects, org.jabref.model.entry.field.Field, .FieldFactory, org.slf4j.Logger, .LoggerFactory

Stores the save order config for a library

Format: <choice> (OrderType, a pair of Field + descending (boolean)

Note that OrderType#TABLE can only be used as "intermediate" setting. When passing SaveOrder to org.jabref.logic.exporter.BibDatabaseWriter, the orderType must be different. Reason: The writer does not have access to the UI.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
public static class

Field Summary

Modifier and TypeField and Description
private static final Logger
private final SaveOrder.OrderType
private final List<SaveOrder.SortCriterion>

Constructor Summary

AccessConstructor and Description
public
private

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
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
public SaveOrder.OrderType
public List<SaveOrder.SortCriterion>
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.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

LOGGERback to summary
private static final Logger LOGGER
orderTypeback to summary
private final SaveOrder.OrderType orderType
sortCriteriaback to summary
private final List<SaveOrder.SortCriterion> sortCriteria

Constructor Detail

SaveOrderback to summary
public SaveOrder(SaveOrder.OrderType orderType, List<SaveOrder.SortCriterion> sortCriteria)
SaveOrderback to summary
private SaveOrder(List<String> data)

Method Detail

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

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getAsStringListback to summary
public List<String> getAsStringList()

Outputs the current configuration to be consumed later by the constructor

getDefaultSaveOrderback to summary
public static SelfContainedSaveOrder getDefaultSaveOrder()
getOrderTypeback to summary
public SaveOrder.OrderType getOrderType()
getSortCriteriaback to summary
public List<SaveOrder.SortCriterion> getSortCriteria()
hashCodeback 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.
Returns:int

a hash code value for this object

Annotations
@Override
parseback to summary
public static SaveOrder parse(List<String> orderedData)
toStringback 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.

Returns:String

a string representation of the object

Annotations
@Override
org.jabref.model.metadata back to summary

public final Enum SaveOrder.OrderType

extends Enum<SaveOrder.OrderType>
Class Inheritance

Field Summary

Modifier and TypeField and Description
private final String
public static final SaveOrder.OrderType
public static final SaveOrder.OrderType
public static final SaveOrder.OrderType

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod 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
public static SaveOrder.OrderType[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinalvalueOf

Field Detail

nameback to summary
private final String name

Hides java.lang.Enum.name.

ORIGINALback to summary
public static final SaveOrder.OrderType ORIGINAL
SPECIFIEDback to summary
public static final SaveOrder.OrderType SPECIFIED
TABLEback to summary
public static final SaveOrder.OrderType TABLE

Constructor Detail

OrderTypeback to summary
private OrderType(String name)

Method Detail

fromBooleansback to summary
public static SaveOrder.OrderType fromBooleans(boolean saveInSpecifiedOrder, boolean saveInOriginalOrder)
toStringback 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.

Returns:String

the name of this enum constant

Annotations
@Override
valueOfback to summary
public static SaveOrder.OrderType valueOf(String name)
valuesback to summary
public static SaveOrder.OrderType[] values()
org.jabref.model.metadata back to summary

public Class SaveOrder.SortCriterion

extends Object
Class Inheritance

Field Summary

Modifier and TypeField and Description
public final boolean
public final Field

Constructor Summary

AccessConstructor 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 TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

descendingback to summary
public final boolean descending
fieldback to summary
public final Field field

Constructor Detail

SortCriterionback to summary
public SortCriterion(Field field)

Given field sorted ascending

SortCriterionback 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"

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

Method Detail

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

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
hashCodeback 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.
Returns:int

a hash code value for this object

Annotations
@Override
toStringback 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.

Returns:String

a string representation of the object

Annotations
@Override