ParameterEntry.java revision 672:2bb058ce572e
1/*
2 * Copyright (c) 1999, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25/*
26 * COMPONENT_NAME: idl.parser
27 *
28 * ORIGINS: 27
29 *
30 * Licensed Materials - Property of IBM
31 * 5639-D57 (C) COPYRIGHT International Business Machines Corp. 1997, 1999
32 * RMI-IIOP v1.0
33 *
34 */
35
36package com.sun.tools.corba.se.idl;
37
38// NOTES:
39
40import java.io.PrintWriter;
41import java.util.Hashtable;
42
43/**
44 * This is the symbol table entry for parameters.
45 **/
46public class ParameterEntry extends SymtabEntry
47{
48  /** This is a set of class constants.  A parameter can be passed
49      as one of In, Out, or Inout. */
50  public static final int In    = 0,
51                          Inout = 1,
52                          Out   = 2;
53
54  protected ParameterEntry ()
55  {
56    super ();
57  } // ctor
58
59  protected ParameterEntry (ParameterEntry that)
60  {
61    super (that);
62    _passType = that._passType;
63  } // ctor
64
65  protected ParameterEntry (SymtabEntry that, IDLID clone)
66  {
67    super (that, clone);
68    if (module ().equals (""))
69      module (name ());
70    else if (!name ().equals (""))
71      module (module () + "/" + name ());
72  } // ctor
73
74  public Object clone ()
75  {
76    return new ParameterEntry (this);
77  } // clone
78
79  /** Invoke the paramter generator.
80      @param symbolTable the symbol table is a hash table whose key is
81       a fully qualified type name and whose value is a SymtabEntry or
82       a subclass of SymtabEntry.
83      @param stream the stream to which the generator should sent its output.
84      @see SymtabEntry */
85  public void generate (Hashtable symbolTable, PrintWriter stream)
86  {
87    parameterGen.generate (symbolTable, this, stream);
88  } // generate
89
90  /** Access the parameter generator.
91      @return an object which implements the ParameterGen interface.
92      @see ParameterGen */
93  public Generator generator ()
94  {
95    return parameterGen;
96  } // generator
97
98  /** This indicates the pass type of this parameter. */
99  public void passType (int passType)
100  {
101    if (passType >= In && passType <= Out)
102      _passType = passType;
103  } // passType
104
105  /** This indicates the pass type of this parameter. */
106  public int passType ()
107  {
108    return _passType;
109  } // passType
110
111  private int _passType = In;
112
113  static ParameterGen parameterGen;
114} // class ParameterEntry
115