MessageTypeNC


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 MessageType interface and allows sub message types to be
31   * retrieved using the sub message's name.
32   * 
33   * @see org.objectweb.dream.message.MessageNC
34   */
35  public interface MessageTypeNC extends MessageType
36  {
37  
38    /**
39     * Returns the type of the sub message having the specified name.
40     * 
41     * @param name the name of one of the message types returned by
42     *          {@link #getSubMessageNames()}.
43     * @return the type of the sub message having the specified name or
44     *         <code>null</code> if no sub message with the specified name
45     *         exists.
46     */
47    MessageType getSubMessageType(String   name);
48  
49    /**
50     * Returns an (eventually empty) array containing the sub message's names of
51     * messages of this type.
52     * 
53     * @return an array containing the sub message's names of messages of this
54     *         type.
55     */
56    String  [] getSubMessageNames();
57  
58    /**
59     * Returns an iterator over the sub message's names of messages of this type.
60     * 
61     * @return an iterator over the sub message's names of messages of this type.
62     */
63    Iterator   getSubMessageNamesIterator();
64  
65    /**
66     * Returns an (eventually empty) array containing the types of the unnamed sub
67     * messages of messages of this type.
68     * 
69     * @return an array containing the types of the unnamed sub messages of
70     *         messages of this type.
71     */
72    MessageType[] getUnnamedSubMessageTypes();
73  
74    /**
75     * Returns an iterator over the types of the unnamed sub messages of messages
76     * of this type.
77     * 
78     * @return an iterator over the types of the unnamed sub messages of messages
79     *         of this type.
80     */
81    Iterator   getUnnamedSubMessageTypesIterator();
82  
83  }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags