View Javadoc

1   /***
2    * Cecilia ADL Compiler
3    * Copyright (C) 2006-2007 STMicroelectronics
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: fractal@objectweb.org
20   *
21   * Author:Ali Erdem Ozcan
22   */
23  
24  package org.objectweb.fractal.cecilia.adl.idl.ast;
25  
26  /**
27   * AST node interface for <code>parameter</code> elements.
28   */
29  public interface Parameter extends TypeContainer {
30  
31    /** The parameter qualifier for constant parameters. */
32    String CONST  = "const";
33    /** The parameter qualifier for in parameters. */
34    String IN     = "in";
35    /** The parameter qualifier for out parameters. */
36    String OUT    = "out";
37    /** The parameter qualifier for in and out parameters. */
38    String IN_OUT = "inout";
39  
40    /**
41     * Returns the name of the parameter.
42     * 
43     * @return the name of the parameter.
44     */
45    String getName();
46  
47    /**
48     * Set the name of the parameter.
49     * 
50     * @param name the name of the parameter to be set.
51     */
52    void setName(String name);
53  
54    /**
55     * Returns the parameter qualifier. can be {@link #CONST}, {@link #IN},
56     * {@link #OUT} or {@link #IN_OUT}.
57     * 
58     * @return the parameter qualifier.
59     */
60    String getQualifier();
61  
62    /**
63     * Sets the parameter qualifier.
64     * 
65     * @param qualifier can be {@link #CONST}, {@link #IN}, {@link #OUT} or
66     *          {@link #IN_OUT}.
67     */
68    void setQualifier(String qualifier);
69  }