Verified Owner
Top Description Fields Constructors Methods
org.jabref.logic.citationstyle

public Class CitationStyle

extends Object
implements OOStyle
Class Inheritance
All Implemented Interfaces
org.jabref.logic.openoffice.style.OOStyle
Imports
java.nio.file.Path, java.util.Objects, .Optional, java.util.function.Supplier, org.jabref.logic.openoffice.style.OOStyle, org.jspecify.annotations.NonNull, .Nullable

Representation of a CitationStyle. Stores its name, the file path and the style itself. This is a pure model class. For loading/parsing functionality, see CSLStyleUtils and CSLStyleLoader.

Field Summary

Modifier and TypeField and Description
private static final String
private final String
private final boolean
private final boolean
private final boolean
private final boolean
private final String
private volatile @Nullable String
private final Supplier<String>
private final String
private final String
private final String
private final boolean

Constructor Summary

AccessConstructor and Description
public
CitationStyle(@NonNull String filePath, @NonNull String styleId, @NonNull String styleClass, @NonNull String title, @NonNull String shortTitle, boolean isNumericStyle, boolean hasBibliography, boolean hasBibliographySortOrder, boolean usesHangingIndent, @NonNull String source, boolean isInternalStyle)

pack-priv
CitationStyle(@NonNull String filePath, @NonNull String styleId, @NonNull String styleClass, @NonNull String title, @NonNull String shortTitle, boolean isNumericStyle, boolean hasBibliography, boolean hasBibliographySortOrder, boolean usesHangingIndent, @NonNull Supplier<String> sourceLoader, boolean isInternalStyle)

private
CitationStyle(@NonNull String filePath, @NonNull String styleId, @NonNull String styleClass, @NonNull String title, @NonNull String shortTitle, boolean isNumericStyle, boolean hasBibliography, boolean hasBibliographySortOrder, boolean usesHangingIndent, @NonNull Supplier<String> sourceLoader, @Nullable String source, boolean isInternalStyle)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object o)

Overrides java.lang.Object.equals.

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

public String
public String
public String
public String
public String
public String
public String
public String
public boolean
public boolean
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public boolean
isAlphanumericStyle()

Currently, we have support for one alphanumeric CSL style.

public boolean
public boolean
private synchronized String
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

public boolean
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

ALPHANUMERIC_STYLEback to summary
private static final String ALPHANUMERIC_STYLE
filePathback to summary
private final String filePath
hasBibliographyback to summary
private final boolean hasBibliography
hasBibliographySortOrderback to summary
private final boolean hasBibliographySortOrder
isInternalStyleback to summary
private final boolean isInternalStyle
isNumericStyleback to summary
private final boolean isNumericStyle
shortTitleback to summary
private final String shortTitle
sourceback to summary
private volatile @Nullable String source
sourceLoaderback to summary
private final Supplier<String> sourceLoader
styleClassback to summary
private final String styleClass
styleIdback to summary
private final String styleId
titleback to summary
private final String title
usesHangingIndentback to summary
private final boolean usesHangingIndent

Constructor Detail

CitationStyleback to summary
public CitationStyle(@NonNull String filePath, @NonNull String styleId, @NonNull String styleClass, @NonNull String title, @NonNull String shortTitle, boolean isNumericStyle, boolean hasBibliography, boolean hasBibliographySortOrder, boolean usesHangingIndent, @NonNull String source, boolean isInternalStyle)
CitationStyleback to summary
pack-priv CitationStyle(@NonNull String filePath, @NonNull String styleId, @NonNull String styleClass, @NonNull String title, @NonNull String shortTitle, boolean isNumericStyle, boolean hasBibliography, boolean hasBibliographySortOrder, boolean usesHangingIndent, @NonNull Supplier<String> sourceLoader, boolean isInternalStyle)
CitationStyleback to summary
private CitationStyle(@NonNull String filePath, @NonNull String styleId, @NonNull String styleClass, @NonNull String title, @NonNull String shortTitle, boolean isNumericStyle, boolean hasBibliography, boolean hasBibliographySortOrder, boolean usesHangingIndent, @NonNull Supplier<String> sourceLoader, @Nullable String source, boolean isInternalStyle)

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.

Annotations
@Override
getFilePathback to summary
public String getFilePath()
getNameback to summary
public String getName()

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

Annotations
@Override
getPathback to summary
public String getPath()

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

Annotations
@Override
getShortTitleback to summary
public String getShortTitle()
getSourceback to summary
public String getSource()
getStyleClassback to summary
public String getStyleClass()
getStyleIdback to summary
public String getStyleId()
getTitleback to summary
public String getTitle()
hasBibliographyback to summary
public boolean hasBibliography()
hasBibliographySortOrderback to summary
public boolean hasBibliographySortOrder()
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.
Annotations
@Override
isAlphanumericStyleback to summary
public boolean isAlphanumericStyle()

Currently, we have support for one alphanumeric CSL style. There is no tag or field in .csl style files that can be parsed to determine if it is an alphanumeric style. Thus, to determine alphanumeric nature, we currently manually check for equality with "DIN 1505-2".

isInternalStyleback to summary
public boolean isInternalStyle()

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

Annotations
@Override
isNumericStyleback to summary
public boolean isNumericStyle()
loadSourceback to summary
private synchronized String loadSource()
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.

Annotations
@Override
usesHangingIndentback to summary
public boolean usesHangingIndent()