JabRef 6.0-beta.1 · org.jabref.model.entry.Month · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
public static final Month	APRIL
public static final Month	AUGUST
public static final Month	DECEMBER
public static final Month	FEBRUARY
private final String	fullName
public static final Month	JANUARY
public static final Month	JULY
public static final Month	JUNE
public static final Month	MARCH
public static final Month	MAY
public static final Month	NOVEMBER
private final int	number
public static final Month	OCTOBER
public static final Month	SEPTEMBER
private final String	shortName
private final String	twoDigitNumber

Access	Constructor and Description
private	Month(String fullName, String shortName, int number)

Method Summary

Modifier and Type	Method and Description
public String	Returns: Month getFullName() Returns the name of the long in unabbreviated English.
public String	Returns: Month in JabRef format getJabRefFormat() Returns the month in JabRef format.
public static Optional<Month>	getMonthByNumber(int 1-12 is valid number) Find month by one-based number.
public static Optional<Month>	getMonthByShortName(String "jan", "feb", ... shortName) Find month by shortName (3 letters) case-insensitive.
public int	Returns: number of the month in the Year getNumber() Returns the number of the Month in a 1-indexed fashion: 1 -> January, 2 -> February etc.
public String	Returns: 3-letter identifier for a Month getShortName() Returns the name of a Month in a short (3-letter) format.
public String	Returns: number of the month in the Year with two digits getTwoDigitNumber() Returns the number of the Month in a 1-indexed fashion using exactly two digits: 01 -> January, 02 -> February...
public static boolean	Returns: true if the value matches the strict format criteria isStrictFormat(String the string value to check value) Checks if the value is in a strict BibTeX format.
public static Optional<Month>	Returns: the corresponding Month instance parse(String the given value value) This method accepts three types of months: Single and Double Digit months from 1 to 12 (01 to 12) 3 Digit BibTeX strings (jan, feb, mar...) possibly with # prepended Full English month identifiers.
pack-priv static Optional<Month>	Returns: the corresponding month instance, empty if input is not in German form parseGermanShortMonth(String a String that represents a month in German form value) Parses a month having the string in German standard form such as "Oktober" or in German short form such as "Okt"
public static Month	valueOf(String name)
public static Month[]	values()

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

Field Detail

APRIL	back to summary
public static final Month APRIL

AUGUST	back to summary
public static final Month AUGUST

DECEMBER	back to summary
public static final Month DECEMBER

FEBRUARY	back to summary
public static final Month FEBRUARY

fullName	back to summary
private final String fullName

JANUARY	back to summary
public static final Month JANUARY

JULY	back to summary
public static final Month JULY

JUNE	back to summary
public static final Month JUNE

MARCH	back to summary
public static final Month MARCH

MAY	back to summary
public static final Month MAY

NOVEMBER	back to summary
public static final Month NOVEMBER

number	back to summary
private final int number

OCTOBER	back to summary
public static final Month OCTOBER

SEPTEMBER	back to summary
public static final Month SEPTEMBER

shortName	back to summary
private final String shortName

twoDigitNumber	back to summary
private final String twoDigitNumber

Constructor Detail

Month	back to summary
private Month(String fullName, String shortName, int number)

Method Detail

getFullName	back to summary
public String getFullName() Returns the name of the long in unabbreviated English. Returns:String Month

getFullName

back to summary

public String getFullName()

Returns the name of the long in unabbreviated English.

Returns:String: Month

getJabRefFormat	back to summary
public String getJabRefFormat() Returns the month in JabRef format. The format is the short 3-digit name surrounded by a '#' (FieldWriter.BIBTEX_STRING_START_END_SYMBOL). Example: #jan#, #feb#, etc. See Issue 263 for a discussion on that thing. This seems to be an invalid format in terms of plain BiBTeX, but a valid format in the case of JabRef. The documentation is available at the Strings help of JabRef. Returns:String Month in JabRef format

getJabRefFormat

back to summary

public String getJabRefFormat()

Returns the month in JabRef format. The format is the short 3-digit name surrounded by a '#' (FieldWriter.BIBTEX_STRING_START_END_SYMBOL). Example: #jan#, #feb#, etc.

See Issue 263 for a discussion on that thing. This seems to be an invalid format in terms of plain BiBTeX, but a valid format in the case of JabRef. The documentation is available at the Strings help of JabRef.

Returns:String: Month in JabRef format

getMonthByNumber	back to summary
public static Optional<Month> getMonthByNumber(int number) Find month by one-based number. If the number is not in the valid range, then an empty Optional is returned. Parameters number:int 1-12 is valid

getMonthByNumber

back to summary

public static Optional<Month> getMonthByNumber(int number)

Find month by one-based number. If the number is not in the valid range, then an empty Optional is returned.

Parameters

number:int: 1-12 is valid

getMonthByShortName	back to summary
public static Optional<Month> getMonthByShortName(String shortName) Find month by shortName (3 letters) case-insensitive. If no matching month is found, then an empty Optional is returned. Parameters shortName:String "jan", "feb", ...

getMonthByShortName

back to summary

public static Optional<Month> getMonthByShortName(String shortName)

Find month by shortName (3 letters) case-insensitive. If no matching month is found, then an empty Optional is returned.

Parameters

shortName:String: "jan", "feb", ...

getNumber	back to summary
public int getNumber() Returns the number of the Month in a 1-indexed fashion: 1 -> January, 2 -> February etc. Returns:int number of the month in the Year

getNumber

back to summary

public int getNumber()

Returns the number of the Month in a 1-indexed fashion: 1 -> January, 2 -> February etc.

Returns:int: number of the month in the Year

getShortName	back to summary
public String getShortName() Returns the name of a Month in a short (3-letter) format. (jan, feb, mar, ...) Returns:String 3-letter identifier for a Month

getShortName

back to summary

public String getShortName()

Returns the name of a Month in a short (3-letter) format. (jan, feb, mar, ...)

Returns:String: 3-letter identifier for a Month

getTwoDigitNumber	back to summary
public String getTwoDigitNumber() Returns the number of the Month in a 1-indexed fashion using exactly two digits: 01 -> January, 02 -> February... Returns:String number of the month in the Year with two digits

getTwoDigitNumber

back to summary

public String getTwoDigitNumber()

Returns the number of the Month in a 1-indexed fashion using exactly two digits: 01 -> January, 02 -> February...

Returns:String: number of the month in the Year with two digits

isStrictFormat back to summary

isStrictFormat	back to summary
public static boolean isStrictFormat(String value) Checks if the value is in a strict BibTeX format. A strict format is either a BibTeX string (e.g. `#jun#`) or an integer (e.g. `6`). Plain text months (e.g. `June`) are considered non-strict. Parameters value:String the string value to check Returns:boolean true if the value matches the strict format criteria

public static boolean isStrictFormat(String value)

Checks if the value is in a strict BibTeX format.

A strict format is either a BibTeX string (e.g. #jun#) or an integer (e.g. 6). Plain text months (e.g. June) are considered non-strict.

Parameters

value:String: the string value to check

Returns:boolean

true if the value matches the strict format criteria

parse	back to summary
public static Optional<Month> parse(String value) This method accepts three types of months: Single and Double Digit months from 1 to 12 (01 to 12) 3 Digit BibTeX strings (jan, feb, mar...) possibly with # prepended Full English month identifiers. Parameters value:String the given value Returns:Optional<Month> the corresponding Month instance

parse

back to summary

public static Optional<Month> parse(String value)

This method accepts three types of months:

Single and Double Digit months from 1 to 12 (01 to 12)
3 Digit BibTeX strings (jan, feb, mar...) possibly with # prepended
Full English month identifiers.

Parameters

value:String: the given value

Returns:Optional<Month>

the corresponding Month instance

parseGermanShortMonth	back to summary
pack-priv static Optional<Month> parseGermanShortMonth(String value) Parses a month having the string in German standard form such as "Oktober" or in German short form such as "Okt" Parameters value:String a String that represents a month in German form Returns:Optional<Month> the corresponding month instance, empty if input is not in German form

parseGermanShortMonth

back to summary

pack-priv static Optional<Month> parseGermanShortMonth(String value)

Parses a month having the string in German standard form such as "Oktober" or in German short form such as "Okt"

Parameters

value:String: a String that represents a month in German form

Returns:Optional<Month>

the corresponding month instance, empty if input is not in German form

valueOf	back to summary
public static Month valueOf(String name)

values	back to summary
public static Month[] values()

public final Enum Month

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail