corba/src/java.corba/share/classes/com/sun/tools/corba/se/idl/StructEntry.java
author avstepan
Tue, 05 May 2015 15:17:13 +0400
changeset 30383 45960fdbe465
parent 25862 a5e25d68f971
permissions -rw-r--r--
8079075: some docs cleanup for CORBA - part 1 Summary: some fix for CORBA docs Reviewed-by: rriggs
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
4
02bb8761fcce Initial load
duke
parents:
diff changeset
     1
/*
5555
b2b5ed3f0d0d 6943119: Rebrand source copyright notices
ohair
parents: 4
diff changeset
     2
 * Copyright (c) 1999, Oracle and/or its affiliates. All rights reserved.
4
02bb8761fcce Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
02bb8761fcce Initial load
duke
parents:
diff changeset
     4
 *
02bb8761fcce Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
02bb8761fcce Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5555
b2b5ed3f0d0d 6943119: Rebrand source copyright notices
ohair
parents: 4
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
4
02bb8761fcce Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5555
b2b5ed3f0d0d 6943119: Rebrand source copyright notices
ohair
parents: 4
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
4
02bb8761fcce Initial load
duke
parents:
diff changeset
    10
 *
02bb8761fcce Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
02bb8761fcce Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
02bb8761fcce Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
02bb8761fcce Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
02bb8761fcce Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
02bb8761fcce Initial load
duke
parents:
diff changeset
    16
 *
02bb8761fcce Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
02bb8761fcce Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
02bb8761fcce Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
02bb8761fcce Initial load
duke
parents:
diff changeset
    20
 *
5555
b2b5ed3f0d0d 6943119: Rebrand source copyright notices
ohair
parents: 4
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
b2b5ed3f0d0d 6943119: Rebrand source copyright notices
ohair
parents: 4
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
b2b5ed3f0d0d 6943119: Rebrand source copyright notices
ohair
parents: 4
diff changeset
    23
 * questions.
4
02bb8761fcce Initial load
duke
parents:
diff changeset
    24
 */
02bb8761fcce Initial load
duke
parents:
diff changeset
    25
/*
02bb8761fcce Initial load
duke
parents:
diff changeset
    26
 * COMPONENT_NAME: idl.parser
02bb8761fcce Initial load
duke
parents:
diff changeset
    27
 *
02bb8761fcce Initial load
duke
parents:
diff changeset
    28
 * ORIGINS: 27
02bb8761fcce Initial load
duke
parents:
diff changeset
    29
 *
02bb8761fcce Initial load
duke
parents:
diff changeset
    30
 * Licensed Materials - Property of IBM
02bb8761fcce Initial load
duke
parents:
diff changeset
    31
 * 5639-D57 (C) COPYRIGHT International Business Machines Corp. 1997, 1999
02bb8761fcce Initial load
duke
parents:
diff changeset
    32
 * RMI-IIOP v1.0
02bb8761fcce Initial load
duke
parents:
diff changeset
    33
 *
02bb8761fcce Initial load
duke
parents:
diff changeset
    34
 */
02bb8761fcce Initial load
duke
parents:
diff changeset
    35
02bb8761fcce Initial load
duke
parents:
diff changeset
    36
package com.sun.tools.corba.se.idl;
02bb8761fcce Initial load
duke
parents:
diff changeset
    37
02bb8761fcce Initial load
duke
parents:
diff changeset
    38
// NOTES:
02bb8761fcce Initial load
duke
parents:
diff changeset
    39
02bb8761fcce Initial load
duke
parents:
diff changeset
    40
import java.io.PrintWriter;
02bb8761fcce Initial load
duke
parents:
diff changeset
    41
import java.util.Enumeration;
02bb8761fcce Initial load
duke
parents:
diff changeset
    42
import java.util.Hashtable;
02bb8761fcce Initial load
duke
parents:
diff changeset
    43
import java.util.Vector;
02bb8761fcce Initial load
duke
parents:
diff changeset
    44
02bb8761fcce Initial load
duke
parents:
diff changeset
    45
/**
02bb8761fcce Initial load
duke
parents:
diff changeset
    46
 * This is the symbol table entry for structs.
02bb8761fcce Initial load
duke
parents:
diff changeset
    47
 **/
02bb8761fcce Initial load
duke
parents:
diff changeset
    48
public class StructEntry extends SymtabEntry
02bb8761fcce Initial load
duke
parents:
diff changeset
    49
{
02bb8761fcce Initial load
duke
parents:
diff changeset
    50
  protected StructEntry ()
02bb8761fcce Initial load
duke
parents:
diff changeset
    51
  {
02bb8761fcce Initial load
duke
parents:
diff changeset
    52
    super ();
02bb8761fcce Initial load
duke
parents:
diff changeset
    53
  } // ctor
02bb8761fcce Initial load
duke
parents:
diff changeset
    54
02bb8761fcce Initial load
duke
parents:
diff changeset
    55
  protected StructEntry (StructEntry that)
02bb8761fcce Initial load
duke
parents:
diff changeset
    56
  {
02bb8761fcce Initial load
duke
parents:
diff changeset
    57
    super (that);
02bb8761fcce Initial load
duke
parents:
diff changeset
    58
    if (!name ().equals (""))
02bb8761fcce Initial load
duke
parents:
diff changeset
    59
    {
02bb8761fcce Initial load
duke
parents:
diff changeset
    60
      module (module () + name ());
02bb8761fcce Initial load
duke
parents:
diff changeset
    61
      name ("");
02bb8761fcce Initial load
duke
parents:
diff changeset
    62
    }
02bb8761fcce Initial load
duke
parents:
diff changeset
    63
    _members   = (Vector)that._members.clone ();
02bb8761fcce Initial load
duke
parents:
diff changeset
    64
    _contained = (Vector)that._contained.clone ();
02bb8761fcce Initial load
duke
parents:
diff changeset
    65
  } // ctor
02bb8761fcce Initial load
duke
parents:
diff changeset
    66
02bb8761fcce Initial load
duke
parents:
diff changeset
    67
  protected StructEntry (SymtabEntry that, IDLID clone)
02bb8761fcce Initial load
duke
parents:
diff changeset
    68
  {
02bb8761fcce Initial load
duke
parents:
diff changeset
    69
    super (that, clone);
02bb8761fcce Initial load
duke
parents:
diff changeset
    70
    if (module ().equals (""))
02bb8761fcce Initial load
duke
parents:
diff changeset
    71
      module (name ());
02bb8761fcce Initial load
duke
parents:
diff changeset
    72
    else if (!name ().equals (""))
02bb8761fcce Initial load
duke
parents:
diff changeset
    73
      module (module () + "/" + name ());
02bb8761fcce Initial load
duke
parents:
diff changeset
    74
  } // ctor
02bb8761fcce Initial load
duke
parents:
diff changeset
    75
02bb8761fcce Initial load
duke
parents:
diff changeset
    76
  public Object clone ()
02bb8761fcce Initial load
duke
parents:
diff changeset
    77
  {
02bb8761fcce Initial load
duke
parents:
diff changeset
    78
    return new StructEntry (this);
02bb8761fcce Initial load
duke
parents:
diff changeset
    79
  } // clone
02bb8761fcce Initial load
duke
parents:
diff changeset
    80
02bb8761fcce Initial load
duke
parents:
diff changeset
    81
  /** Invoke the struct generator.
02bb8761fcce Initial load
duke
parents:
diff changeset
    82
      @param symbolTable the symbol table is a hash table whose key is
02bb8761fcce Initial load
duke
parents:
diff changeset
    83
       a fully qualified type name and whose value is a SymtabEntry or
02bb8761fcce Initial load
duke
parents:
diff changeset
    84
       a subclass of SymtabEntry.
02bb8761fcce Initial load
duke
parents:
diff changeset
    85
      @param stream the stream to which the generator should sent its output.
02bb8761fcce Initial load
duke
parents:
diff changeset
    86
      @see SymtabEntry */
02bb8761fcce Initial load
duke
parents:
diff changeset
    87
  public void generate (Hashtable symbolTable, PrintWriter stream)
02bb8761fcce Initial load
duke
parents:
diff changeset
    88
  {
02bb8761fcce Initial load
duke
parents:
diff changeset
    89
    structGen.generate (symbolTable, this, stream);
02bb8761fcce Initial load
duke
parents:
diff changeset
    90
  } // generate
02bb8761fcce Initial load
duke
parents:
diff changeset
    91
02bb8761fcce Initial load
duke
parents:
diff changeset
    92
  /** Access the struct generator.
30383
45960fdbe465 8079075: some docs cleanup for CORBA - part 1
avstepan
parents: 25862
diff changeset
    93
      @return an object which implements the StructGen interface.
4
02bb8761fcce Initial load
duke
parents:
diff changeset
    94
      @see StructGen */
02bb8761fcce Initial load
duke
parents:
diff changeset
    95
  public Generator generator ()
02bb8761fcce Initial load
duke
parents:
diff changeset
    96
  {
02bb8761fcce Initial load
duke
parents:
diff changeset
    97
    return structGen;
02bb8761fcce Initial load
duke
parents:
diff changeset
    98
  } // generator
02bb8761fcce Initial load
duke
parents:
diff changeset
    99
02bb8761fcce Initial load
duke
parents:
diff changeset
   100
  /** Add a member to the member list. */
02bb8761fcce Initial load
duke
parents:
diff changeset
   101
  public void addMember (TypedefEntry member)
02bb8761fcce Initial load
duke
parents:
diff changeset
   102
  {
02bb8761fcce Initial load
duke
parents:
diff changeset
   103
    _members.addElement (member);
02bb8761fcce Initial load
duke
parents:
diff changeset
   104
  } // addMember
02bb8761fcce Initial load
duke
parents:
diff changeset
   105
02bb8761fcce Initial load
duke
parents:
diff changeset
   106
  /** This is a vector of TypedefEntry's.  In this context, only the name,
02bb8761fcce Initial load
duke
parents:
diff changeset
   107
      type, and arrayInfo fields hold any meaning. */
02bb8761fcce Initial load
duke
parents:
diff changeset
   108
  public Vector members ()
02bb8761fcce Initial load
duke
parents:
diff changeset
   109
  {
02bb8761fcce Initial load
duke
parents:
diff changeset
   110
    return _members;
02bb8761fcce Initial load
duke
parents:
diff changeset
   111
  } // members
02bb8761fcce Initial load
duke
parents:
diff changeset
   112
02bb8761fcce Initial load
duke
parents:
diff changeset
   113
  public void addContained (SymtabEntry entry)
02bb8761fcce Initial load
duke
parents:
diff changeset
   114
  {
02bb8761fcce Initial load
duke
parents:
diff changeset
   115
    _contained.addElement (entry);
02bb8761fcce Initial load
duke
parents:
diff changeset
   116
  } // addContained
02bb8761fcce Initial load
duke
parents:
diff changeset
   117
02bb8761fcce Initial load
duke
parents:
diff changeset
   118
  /** This is a vector of SymtabEntry's.  It itemizes any types which
02bb8761fcce Initial load
duke
parents:
diff changeset
   119
      this struct contains.  It is different than the member list.
02bb8761fcce Initial load
duke
parents:
diff changeset
   120
      For example:
02bb8761fcce Initial load
duke
parents:
diff changeset
   121
      <pre>
02bb8761fcce Initial load
duke
parents:
diff changeset
   122
      struct A
02bb8761fcce Initial load
duke
parents:
diff changeset
   123
      {
02bb8761fcce Initial load
duke
parents:
diff changeset
   124
        long x;
02bb8761fcce Initial load
duke
parents:
diff changeset
   125
        Struct B
02bb8761fcce Initial load
duke
parents:
diff changeset
   126
        {
02bb8761fcce Initial load
duke
parents:
diff changeset
   127
          long a;
02bb8761fcce Initial load
duke
parents:
diff changeset
   128
          long b;
02bb8761fcce Initial load
duke
parents:
diff changeset
   129
        } y;
02bb8761fcce Initial load
duke
parents:
diff changeset
   130
      }
02bb8761fcce Initial load
duke
parents:
diff changeset
   131
      </pre>
02bb8761fcce Initial load
duke
parents:
diff changeset
   132
      Struct B is contained within struct A.
02bb8761fcce Initial load
duke
parents:
diff changeset
   133
      The members vector will contain entries for x and y. */
02bb8761fcce Initial load
duke
parents:
diff changeset
   134
  public Vector contained ()
02bb8761fcce Initial load
duke
parents:
diff changeset
   135
  {
02bb8761fcce Initial load
duke
parents:
diff changeset
   136
    return _contained;
02bb8761fcce Initial load
duke
parents:
diff changeset
   137
  } // contained
02bb8761fcce Initial load
duke
parents:
diff changeset
   138
02bb8761fcce Initial load
duke
parents:
diff changeset
   139
  private Vector _members   = new Vector ();
02bb8761fcce Initial load
duke
parents:
diff changeset
   140
  private Vector _contained = new Vector ();
02bb8761fcce Initial load
duke
parents:
diff changeset
   141
02bb8761fcce Initial load
duke
parents:
diff changeset
   142
  static StructGen structGen;
02bb8761fcce Initial load
duke
parents:
diff changeset
   143
} // class StructEntry