org.apache.commons.net.nntp

Class Article

java.lang.Object

org.apache.commons.net.nntp.Article

All 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

Author:

rwinston

Field Summary

Fields

Modifier and Type	Field and Description
Article	kid
Article	next

Constructor Summary

Constructors

Constructor and Description
Article()

Method Summary

Methods

Modifier and Type	Method and Description
void	addHeaderField(java.lang.String name, java.lang.String val) Adds an arbitrary header key and value to this message's header.
void	addReference(java.lang.String msgId) Adds a message-id to the list of messages that this message references (i.e.
java.lang.String	getArticleId()
int	getArticleNumber()
java.lang.String	getDate()
java.lang.String	getFrom()
java.lang.String[]	getReferences() Returns the MessageId references as an array of Strings
java.lang.String	getSubject()
boolean	isDummy()
Threadable	makeDummy()
java.lang.String	messageThreadId()
java.lang.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(java.lang.String string)
void	setArticleNumber(int i)
void	setChild(Threadable child)
void	setDate(java.lang.String string)
void	setFrom(java.lang.String string)
void	setNext(Threadable next)
void	setSubject(java.lang.String string)
java.lang.String	simplifiedSubject()
boolean	subjectIsReply()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

kid

public Article kid

next

public Article next

Constructor Detail

Article

public Article()

Method Detail

addHeaderField

public void addHeaderField(java.lang.String name,
                  java.lang.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(java.lang.String msgId)

Adds a message-id to the list of messages that this message references (i.e. replies to)

Parameters:

msgId -

getReferences

public java.lang.String[] getReferences()

Returns the MessageId references as an array of Strings

Returns:

an array of message-ids

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

getArticleId

public java.lang.String getArticleId()

getArticleNumber

public int getArticleNumber()

getDate

public java.lang.String getDate()

getFrom

public java.lang.String getFrom()

getSubject

public java.lang.String getSubject()

setArticleId

public void setArticleId(java.lang.String string)

setArticleNumber

public void setArticleNumber(int i)

setDate

public void setDate(java.lang.String string)

setFrom

public void setFrom(java.lang.String string)

setSubject

public void setSubject(java.lang.String string)

isDummy

public boolean isDummy()

Specified by:

isDummy in interface Threadable

messageThreadId

public java.lang.String messageThreadId()

Specified by:

messageThreadId in interface Threadable

messageThreadReferences

public java.lang.String[] messageThreadReferences()

Specified by:

messageThreadReferences in interface Threadable

simplifiedSubject

public java.lang.String simplifiedSubject()

Specified by:

simplifiedSubject in interface Threadable

subjectIsReply

public boolean subjectIsReply()

Specified by:

subjectIsReply in interface Threadable

setChild

public void setChild(Threadable child)

Specified by:

setChild in interface Threadable

setNext

public void setNext(Threadable next)

Specified by:

setNext in interface Threadable

makeDummy

public Threadable makeDummy()

Specified by:

makeDummy in interface Threadable