MessageNC


1   /**
2    * Dream
3    * Copyright (C) 2003-2004 INRIA Rhone-Alpes
4    *
5    * This library is free software; you can redistribute it and/or
6    * modify it under the terms of the GNU Lesser General Public
7    * License as published by the Free Software Foundation; either
8    * version 2 of the License, or (at your option) any later version.
9    *
10   * This library is distributed in the hope that it will be useful,
11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13   * Lesser General Public License for more details.
14   *
15   * You should have received a copy of the GNU Lesser General Public
16   * License along with this library; if not, write to the Free Software
17   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18   *
19   * Contact : dream@objectweb.org
20   *
21   * Initial developer(s): Matthieu Leclercq
22   * Contributor(s): Vivien Quema
23   */
24  
25  package org.objectweb.dream.message;
26  
27  import java.util.Iterator  ;
28  
29  /**
30   * Extends the Message interface and allows sub messages to be retrieved using a
31   * name. Note that it is optional to associate sub messages with names.
32   * <code>MessageNC</code> is a <i>naming context </i> for its sub messages
33   * having a name. This means that a message can not have two sub messages with
34   * the same name.
35   */
36  public interface MessageNC extends Message
37  {
38  
39    /**
40     * Returns a sub message of this message, or <code>null</code> if this
41     * message doesn't have a sub message with the specified name.
42     * 
43     * @param name the name of the sub message, as specified in the message type.
44     * @return a sub message of this message.
45     */
46    Message getSubMessage(String   name);
47  
48    /**
49     * Returns an <code>Iterator</code> that iterate over the unnamed sub
50     * messages of this message.
51     * 
52     * @return an iterator on the sub messages.
53     */
54    Iterator   getUnnamedSubMessageIterator();
55  
56    /**
57     * Returns an (eventually empty) array containing the unnamed sub messages of
58     * this message.
59     * 
60     * @return an array containing the sub messages of this message.
61     */
62    Message[] getUnnamedSubMessages();
63  
64  }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags