Class NNTPRootFolder


  • public final class NNTPRootFolder
    extends Folder
    The "root" folder of the NNTP newsgroup list. The NNTP folder namespace is taken to be a flat namespace. This object allows us to retrieve folders corresponding to each newsgroup in that space.
    Version:
    2.0
    Author:
    Chris Burdess, Cedric Hyppolite
    • Method Detail

      • getName

        public java.lang.String getName()
        Description copied from class: Folder
        Returns the name of this folder.

        This method can be invoked on a closed folder.

        Specified by:
        getName in class Folder
      • getFullName

        public java.lang.String getFullName()
        Description copied from class: Folder
        Returns the full name of this folder. If the folder resides under the root hierarchy of its store, the returned name is relative to the root. Otherwise an absolute name, starting with the hierarchy delimiter, is returned.

        This method can be invoked on a closed folder.

        Specified by:
        getFullName in class Folder
      • list

        public Folder[] list​(java.lang.String pattern,
                             ListFolderListener listener)
                      throws MessagingException
        Returns the list of folders matching the specified pattern.
        Parameters:
        pattern - the JavaMail pattern
        listener - the listener that will be called for each folder name as soon as it is known
        Throws:
        MessagingException
      • getParent

        public Folder getParent()
                         throws MessagingException
        Description copied from class: Folder
        Returns the parent folder of this folder, or null if this folder is the root of a folder hierarchy.

        This method can be invoked on a closed folder.

        Specified by:
        getParent in class Folder
        Throws:
        MessagingException
      • getType

        public int getType()
        This folder contains only folders.
        Specified by:
        getType in class Folder
      • open

        public void open​(int mode)
                  throws MessagingException
        Description copied from class: Folder
        Opens this folder. This method can only be invoked on a closed folder that can contain messages.
        Specified by:
        open in class Folder
        Parameters:
        mode - open the Folder READ_ONLY or READ_WRITE
        Throws:
        FolderNotFoundException - if this folder does not exist
        MessagingException
      • close

        public void close​(boolean expunge)
                   throws MessagingException
        Description copied from class: Folder
        Closes this folder. This method can only be invoked on an open folder.
        Specified by:
        close in class Folder
        Parameters:
        expunge - if true, expunge all deleted messages
        Throws:
        MessagingException
      • expunge

        public Message[] expunge()
                          throws MessagingException
        Description copied from class: Folder
        Expunges (permanently removing) all the messages marked DELETED. Returns an array containing the expunged messages.

        Expunge causes the renumbering of any messages with numbers higher than the message number of the lowest-numbered expunged message.

        After a message has been expunged, only the isExpunged and getMessageNumber methods are still valid on the corresponding Message object; other methods may throw MessageRemovedException.

        Specified by:
        expunge in class Folder
        Throws:
        FolderNotFoundException - if this folder does not exist
        MessagingException
      • isOpen

        public boolean isOpen()
        Description copied from class: Folder
        Indicates whether this folder is open.
        Specified by:
        isOpen in class Folder
      • getPermanentFlags

        public Flags getPermanentFlags()
        Description copied from class: Folder
        Returns the permanent flags supported by this folder.
        Specified by:
        getPermanentFlags in class Folder
      • getMessageCount

        public int getMessageCount()
                            throws MessagingException
        Description copied from class: Folder
        Returns the number of messages in this folder.

        This method can be invoked on a closed folder; however, note that for some stores, getting the message count can be an expensive operation involving actually opening the folder. In such cases, a provider can choose to return -1 here when the folder is closed.

        Specified by:
        getMessageCount in class Folder
        Throws:
        MessagingException
      • getMessage

        public Message getMessage​(int msgnum)
                           throws MessagingException
        Description copied from class: Folder
        Returns the message with the given number. The message number is the relative position of a message in its folder, starting at 1.

        Note that message numbers can change within a session if the folder is expunged, therefore the use of message numbers as references to messages is inadvisable.

        Specified by:
        getMessage in class Folder
        Parameters:
        msgnum - the message number
        Throws:
        FolderNotFoundException - if this folder does not exist
        MessagingException
      • hasNewMessages

        public boolean hasNewMessages()
                               throws MessagingException
        Description copied from class: Folder
        Indicates whether this folder has new messages.

        This method can be invoked on a closed folder that can contain messages.

        Specified by:
        hasNewMessages in class Folder
        Throws:
        MessagingException
      • create

        public boolean create​(int type)
                       throws MessagingException
        Description copied from class: Folder
        Create this folder in the store. When this folder is created, any folders in its path that do not exist are also created.

        If the creation is successful, a CREATED FolderEvent is delivered to any FolderListeners registered on this Folder and this Store.

        Specified by:
        create in class Folder
        Parameters:
        type - the desired type of the folder
        Throws:
        MessagingException
      • delete

        public boolean delete​(boolean flag)
                       throws MessagingException
        Description copied from class: Folder
        Deletes this folder. This method can only be invoked on a closed folder.
        Specified by:
        delete in class Folder
        Parameters:
        flag - delete any subfolders
        Returns:
        true if the folder is deleted successfully, false otherwise
        Throws:
        FolderNotFoundException - if this folder does not exist
        MessagingException
      • renameTo

        public boolean renameTo​(Folder folder)
                         throws MessagingException
        Description copied from class: Folder
        Renames this folder. This method can only be invoked on a closed folder.
        Specified by:
        renameTo in class Folder
        Parameters:
        folder - a folder representing the new name for this folder
        Returns:
        true if the folder is renamed successfully, false otherwise
        Throws:
        FolderNotFoundException - if this folder does not exist
        MessagingException