org.kohsuke.jnt
Class JNForums

java.lang.Object
  extended by org.kohsuke.jnt.JNForums

public final class JNForums
extends Object

java.net discussion forums in one project.

Author:
Bruno Souza, Kohsuke Kawaguchi

Method Summary
 JNForum createForum(String name, String description)
          Creats a new forum.
 JNForum getForum(String name)
          Returns the forum of the specified name.
 List<JNForum> getForums()
          Returns all the forums in this project as a List of JNForums.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getForums

public List<JNForum> getForums()
                        throws ProcessingException
Returns all the forums in this project as a List of JNForums.

Returns:
always non-null. Can be empty.
Throws:
ProcessingException

getForum

public JNForum getForum(String name)
                 throws ProcessingException
Returns the forum of the specified name.

This method returns the JNForum from getForums() such that JNForum.getName().equals(name).

Returns:
null if no such forum is found
Throws:
ProcessingException

createForum

public JNForum createForum(String name,
                           String description)
                    throws ProcessingException
Creats a new forum.

This is a priviledged operation.

Parameters:
name - The name of the forum to be created, such as "Wish List". Must not be null, must not be empty.
description - One-line description of the forum. Must not be null.
Returns:
always non-null valid JNForum object that represents the forum that was created.
Throws:
ProcessingException


Copyright © 2003-2009 Kohsuke Kawaguchi. All Rights Reserved.