Verified Owner
Top Fields Constructors Methods
org.jabref.model.entry.field

public final Enum SpecialField

extends Enum<SpecialField>
implements Field
Class Inheritance
All Implemented Interfaces
org.jabref.model.entry.field.Field
Imports
java.util.ArrayList, .Arrays, .EnumSet, .HashMap, .List, .Optional, org.jabref.model.entry.KeywordList

Field Summary

Modifier and TypeField and Description
private final String
private final KeywordList
private final HashMap<String, SpecialFieldValue>
public static final SpecialField
public static final SpecialField
public static final SpecialField
public static final SpecialField
public static final SpecialField
public static final SpecialField
private final List<SpecialFieldValue>

Constructor Summary

AccessConstructor and Description
private
SpecialField(String fieldName, SpecialFieldValue... values)

Method Summary

Modifier and TypeMethod and Description
public static Optional<SpecialField>
public KeywordList
public String
getName()

Implements org.jabref.model.entry.field.Field.getName.

Name used for writing to .bib (or as XMP data)

However, BibEntryWriter converts to lower case.

public EnumSet<FieldProperty>
getProperties()

Implements org.jabref.model.entry.field.Field.getProperties.

properties contains mappings to tell the EntryEditor to add a specific function to this field, for instance a dropdown for selecting the month for the month field.

public List<SpecialFieldValue>
public boolean
public boolean
public Optional<SpecialFieldValue>
public static SpecialField
public static SpecialField[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

fieldNameback to summary
private final String fieldName
keywordsback to summary
private final KeywordList keywords
mapback to summary
private final HashMap<String, SpecialFieldValue> map
PRINTEDback to summary
public static final SpecialField PRINTED
PRIORITYback to summary
public static final SpecialField PRIORITY
QUALITYback to summary
public static final SpecialField QUALITY
RANKINGback to summary
public static final SpecialField RANKING
READ_STATUSback to summary
public static final SpecialField READ_STATUS
RELEVANCEback to summary
public static final SpecialField RELEVANCE
valuesback to summary
private final List<SpecialFieldValue> values

Constructor Detail

SpecialFieldback to summary
private SpecialField(String fieldName, SpecialFieldValue... values)

Method Detail

fromNameback to summary
public static Optional<SpecialField> fromName(String name)
getKeyWordsback to summary
public KeywordList getKeyWords()
getNameback to summary
public String getName()

Implements org.jabref.model.entry.field.Field.getName.

Doc from org.jabref.model.entry.field.Field.getName.

Name used for writing to .bib (or as XMP data)

However, BibEntryWriter converts to lower case. See org.jabref.logic.bibtex.BibEntryWriter#getFormattedFieldName

Annotations
@Override
getPropertiesback to summary
public EnumSet<FieldProperty> getProperties()

Implements org.jabref.model.entry.field.Field.getProperties.

Doc from org.jabref.model.entry.field.Field.getProperties.

properties contains mappings to tell the EntryEditor to add a specific function to this field, for instance a dropdown for selecting the month for the month field.

Note that this set needs to be mutable. This is required, because we allow standard fields to be modifiable via the UI.

Annotations
@Override
getValuesback to summary
public List<SpecialFieldValue> getValues()
isSingleValueFieldback to summary
public boolean isSingleValueField()
isStandardFieldback to summary
public boolean isStandardField()

Implements org.jabref.model.entry.field.Field.isStandardField.

Annotations
@Override
parseValueback to summary
public Optional<SpecialFieldValue> parseValue(String value)
valueOfback to summary
public static SpecialField valueOf(String name)
valuesback to summary
public static SpecialField[] values()