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

public Class CitationStyle

extends Object
Class Inheritance
Imports
java.io.IOException, .StringReader, java.net.URI, .URISyntaxException, .URL, java.nio.charset.StandardCharsets, java.nio.file.Files, .NoSuchFileException, .Path, java.util.ArrayList, .Collections, .List, .Objects, .Optional, java.util.stream.Collectors, .Stream, javax.xml.parsers.DocumentBuilderFactory, .ParserConfigurationException, org.jabref.logic.util.StandardFileType, de.undercouch.citeproc.helper.CSLUtils, org.slf4j.Logger, .LoggerFactory, org.w3c.dom.CharacterData, .Document, .Element, .NodeList, org.xml.sax.InputSource, .SAXException
Representation of a CitationStyle. Stores its name, the file path and the style itself

Field Summary

Modifier and TypeField and Description
public static final String
DEFAULT

private static final DocumentBuilderFactory
FACTORY

private final String
filePath

private static final Logger
LOGGER

private final String
source

private static final List<CitationStyle>
STYLES

private static final String
STYLES_ROOT

private final String
title

Constructor Summary

AccessConstructor and Description
private
CitationStyle(final String filename, final String title, final String source)

Method Summary

Modifier and TypeMethod and Description
public static Optional<CitationStyle>
createCitationStyleFromFile(final String styleFile)

Loads the CitationStyle from the given file

private static Optional<CitationStyle>
createCitationStyleFromSource(final String source, final String filename)

Creates an CitationStyle instance out of the style string

public static List<CitationStyle>

Returns:

list of available citation styles
discoverCitationStyles()

Provides the citation styles that come with JabRef.

private static List<CitationStyle>
discoverCitationStylesInPath(Path path)

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 static CitationStyle

Returns:

default citation style
getDefault()

Provides the default citation style which is currently IEEE

public String
getFilePath()

public String
getSource()

public String
getTitle()

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public static boolean
isCitationStyleFile(String styleFile)

Checks if the given style file is a CitationStyle

private static String
stripInvalidProlog(String source)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

DEFAULTback to summary
public static final String DEFAULT
FACTORYback to summary
private static final DocumentBuilderFactory FACTORY
filePathback to summary
private final String filePath
LOGGERback to summary
private static final Logger LOGGER
sourceback to summary
private final String source
STYLESback to summary
private static final List<CitationStyle> STYLES
STYLES_ROOTback to summary
private static final String STYLES_ROOT
titleback to summary
private final String title

Constructor Detail

CitationStyleback to summary
private CitationStyle(final String filename, final String title, final String source)

Method Detail

createCitationStyleFromFileback to summary
public static Optional<CitationStyle> createCitationStyleFromFile(final String styleFile)

Loads the CitationStyle from the given file

createCitationStyleFromSourceback to summary
private static Optional<CitationStyle> createCitationStyleFromSource(final String source, final String filename)

Creates an CitationStyle instance out of the style string

discoverCitationStylesback to summary
public static List<CitationStyle> discoverCitationStyles()

Provides the citation styles that come with JabRef.

Returns:List<CitationStyle>

list of available citation styles

discoverCitationStylesInPathback to summary
private static List<CitationStyle> discoverCitationStylesInPath(Path path) throws IOException
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
getDefaultback to summary
public static CitationStyle getDefault()

Provides the default citation style which is currently IEEE

Returns:CitationStyle

default citation style

getFilePathback to summary
public String getFilePath()
getSourceback to summary
public String getSource()
getTitleback to summary
public String getTitle()
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
isCitationStyleFileback to summary
public static boolean isCitationStyleFile(String styleFile)

Checks if the given style file is a CitationStyle

stripInvalidPrologback to summary
private static String stripInvalidProlog(String source)
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