Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.nntp
Class NewsGroupName

java.lang.Object
  extended by com.jivesoftware.forum.nntp.NewsGroupName

public class NewsGroupName
extends java.lang.Object

Understands the dot separated name of news groups, along with wildcarding as specified in some NNTP commands.

News groups are dot separated plain alphanumeric names with no whitespace: major.minor.name where the same prefix names are reused to sort groups into a heirarchy. Some news commands use an astrisk (*) to indicate any groups with the given prefix name.


Constructor Summary
NewsGroupName(java.lang.String groupName)
          Create a name based on the group's name string.
 
Method Summary
 int hashCode()
           
 boolean isInDistribution(NewsGroupName distribution)
          Determines if this name is in the given distribution.
 java.lang.String toString()
           
 java.lang.String[] toStringParts()
          Breaks a name into it's string parts (split along the dots in the name).
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

NewsGroupName

public NewsGroupName(java.lang.String groupName)
Create a name based on the group's name string.

Parameters:
groupName - the name of the group.
Method Detail

isInDistribution

public boolean isInDistribution(NewsGroupName distribution)
Determines if this name is in the given distribution. A distribution describes the prefix heirarchical name that the group name must contained. For example, "a.b.c" is in the distribution "a.b" but is not in the distribution "a.d".

Parameters:
distribution - the distribution.
Returns:
true if this name is in the given distribution.

toStringParts

public java.lang.String[] toStringParts()
Breaks a name into it's string parts (split along the dots in the name).

Returns:
a list of the name broken by dots.

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.