org.apache.commons.net.nntp

Class Article

Implemented Interfaces:
Threadable

public class Article
extends java.lang.Object
implements Threadable

This is a class that contains the basic state needed for message retrieval and threading. With thanks to Jamie Zawinski <jwz@jwz.org>

Nested Class Summary

Field Summary

Article
kid, next

Constructor Summary

Article()

Method Summary

void
addHeaderField(String name, String val)
Adds an arbitrary header key and value to this message's header.
void
addReference(String msgId)
Adds a message-id to the list of messages that this message references (i.e.
String
getArticleId()
int
getArticleNumber()
String
getDate()
String
getFrom()
String[]
getReferences()
Returns the MessageId references as an array of Strings
String
getSubject()
boolean
isDummy()
Threadable
makeDummy()
String
messageThreadId()
String[]
messageThreadReferences()
static void
printThread(Article article, int depth)
Recursive method that traverses a pre-threaded graph (or tree) of connected Article objects and prints them out.
void
setArticleId(String string)
void
setArticleNumber(int i)
void
setChild(Threadable child)
void
setDate(String string)
void
setFrom(String string)
void
setNext(Threadable next)
void
setSubject(String string)
String
simplifiedSubject()
boolean
subjectIsReply()

Field Details

kid, next

public Article kid, next

Constructor Details

Article

public Article()

Method Details

addHeaderField

public void addHeaderField(String name,
                           String val)
Adds an arbitrary header key and value to this message's header.

Parameters:
name - the header name
val - the header value


addReference

public void addReference(String msgId)
Adds a message-id to the list of messages that this message references (i.e. replies to)

Parameters:
msgId -


getArticleId

public String getArticleId()


getArticleNumber

public int getArticleNumber()


getDate

public String getDate()


getFrom

public String getFrom()


getReferences

public String[] getReferences()
Returns the MessageId references as an array of Strings

Returns:
an array of message-ids


getSubject

public String getSubject()


isDummy

public boolean isDummy()
Specified by:
isDummy in interface Threadable


makeDummy

public Threadable makeDummy()
Specified by:
makeDummy in interface Threadable


messageThreadId

public String messageThreadId()
Specified by:
messageThreadId in interface Threadable


messageThreadReferences

public String[] messageThreadReferences()
Specified by:
messageThreadReferences in interface Threadable


printThread

public static void printThread(Article article,
                               int depth)
Recursive method that traverses a pre-threaded graph (or tree) of connected Article objects and prints them out.

Parameters:
article - the root of the article 'tree'
depth - the current tree depth


setArticleId

public void setArticleId(String string)


setArticleNumber

public void setArticleNumber(int i)


setChild

public void setChild(Threadable child)
Specified by:
setChild in interface Threadable


setDate

public void setDate(String string)


setFrom

public void setFrom(String string)


setNext

public void setNext(Threadable next)
Specified by:
setNext in interface Threadable


setSubject

public void setSubject(String string)


simplifiedSubject

public String simplifiedSubject()
Specified by:
simplifiedSubject in interface Threadable


subjectIsReply

public boolean subjectIsReply()
Specified by:
subjectIsReply in interface Threadable