Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface JournalsLibrary.JournalMetaData

Enclosing interface:

JournalsLibrary

public static interface JournalsLibrary.JournalMetaData

ForumJournals are journals accessed via the web, and are typically threaded in their messages. They have a special journal entry containing metadata and stats about the journal that changes periodically. This structure manages that metadata.

Method Summary

Modifier and Type	Method	Description
java.lang.String	imagePath()	Returns path to the journal images
JournalsLibrary.JournalMetaData	imagePath(java.lang.String intro)	Builder method for setting images path
java.lang.String	introKey()	Returns message key to an intro or something?
JournalsLibrary.JournalMetaData	introKey(java.lang.String key)	Builder method for setting intro
java.lang.String	latestKey()	Returns message key to latest message
JournalsLibrary.JournalMetaData	latestKey(java.lang.String key)	Builder method for setting latest message
java.lang.String	longIntro()	Returns long description of the journal
JournalsLibrary.JournalMetaData	longIntro(java.lang.String intro)	Builder method for setting description
java.lang.String	name()	Return the journal name
JournalsLibrary.JournalMetaData	name(java.lang.String intro)	Builder method for setting name
int	posts()	Returns the number of messages
JournalsLibrary.JournalMetaData	posts(int num)	Builder method for setting number of messages
java.lang.String	shortIntro()	Returns short description of the journal
JournalsLibrary.JournalMetaData	shortIntro(java.lang.String intro)	Builder method for setting short desc
java.util.List<java.lang.String>	stuckyKeys()	Returns message keys to stucky messages
JournalsLibrary.JournalMetaData	stuckyKeys(java.util.List<java.lang.String> keys)	Builder method for setting stucky messages
int	threads()	Returns the number of threads
JournalsLibrary.JournalMetaData	threads(int num)	Builder method for setting number of thread

Method Detail

name

java.lang.String name()

Return the journal name

Returns:

the journal name

name

JournalsLibrary.JournalMetaData name(java.lang.String intro)

Builder method for setting name

Parameters:

intro - the name

Returns:

this same object

threads

int threads()

Returns the number of threads

Returns:

the number of threads

threads

JournalsLibrary.JournalMetaData threads(int num)

Builder method for setting number of thread

Parameters:

num - number of thread

Returns:

this same object

posts

int posts()

Returns the number of messages

Returns:

the number of messages

posts

JournalsLibrary.JournalMetaData posts(int num)

Builder method for setting number of messages

Parameters:

num - number of messages

Returns:

this same object

imagePath

java.lang.String imagePath()

Returns path to the journal images

Returns:

path to the journal images

imagePath

JournalsLibrary.JournalMetaData imagePath(java.lang.String intro)

Builder method for setting images path

Parameters:

intro - images path

Returns:

this same object

shortIntro

java.lang.String shortIntro()

Returns short description of the journal

Returns:

short description of the journal

shortIntro

JournalsLibrary.JournalMetaData shortIntro(java.lang.String intro)

Builder method for setting short desc

Parameters:

intro - short desc

Returns:

this same object

longIntro

java.lang.String longIntro()

Returns long description of the journal

Returns:

long description of the journal

longIntro

JournalsLibrary.JournalMetaData longIntro(java.lang.String intro)

Builder method for setting description

Parameters:

intro - description

Returns:

this same object

introKey

java.lang.String introKey()

Returns message key to an intro or something?

Returns:

message key to an intro or something?

introKey

JournalsLibrary.JournalMetaData introKey(java.lang.String key)

Builder method for setting intro

Parameters:

key - intro

Returns:

this same object

latestKey

java.lang.String latestKey()

Returns message key to latest message

Returns:

message key to latest message

latestKey

JournalsLibrary.JournalMetaData latestKey(java.lang.String key)

Builder method for setting latest message

Parameters:

key - latest message

Returns:

this same object

stuckyKeys

java.util.List<java.lang.String> stuckyKeys()

Returns message keys to stucky messages

Returns:

message keys to stucky messages

stuckyKeys

JournalsLibrary.JournalMetaData stuckyKeys(java.util.List<java.lang.String> keys)

Builder method for setting stucky messages

Parameters:

keys - stucky messages

Returns:

this same object