aboutsummaryrefslogtreecommitdiff
path: root/src/share/classes/sun/rmi/rmic/newrmic/jrmp/Util.java
blob: a5e5f6926b423f2f2be254d375cabe591d820076 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
/*
 * Copyright 2003 Sun Microsystems, Inc.  All Rights Reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Sun designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Sun in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
 * CA 95054 USA or visit www.sun.com if you need additional information or
 * have any questions.
 */

package sun.rmi.rmic.newrmic.jrmp;

import com.sun.javadoc.ClassDoc;
import com.sun.javadoc.MethodDoc;
import com.sun.javadoc.Parameter;
import com.sun.javadoc.Type;

/**
 * Provides static utility methods.
 *
 * WARNING: The contents of this source file are not part of any
 * supported API.  Code that depends on them does so at its own risk:
 * they are subject to change or removal without notice.
 *
 * @author Peter Jones
 **/
final class Util {

    private Util() { throw new AssertionError(); }

    /**
     * Returns the binary name of the class or interface represented
     * by the specified ClassDoc.
     **/
    static String binaryNameOf(ClassDoc cl) {
        String flat = cl.name().replace('.', '$');
        String packageName = cl.containingPackage().name();
        return packageName.equals("") ? flat : packageName + "." + flat;
    }

    /**
     * Returns the method descriptor for the specified method.
     *
     * See section 4.3.3 of The Java Virtual Machine Specification
     * Second Edition for the definition of a "method descriptor".
     **/
    static String methodDescriptorOf(MethodDoc method) {
        String desc = "(";
        Parameter[] parameters = method.parameters();
        for (int i = 0; i < parameters.length; i++) {
            desc += typeDescriptorOf(parameters[i].type());
        }
        desc += ")" + typeDescriptorOf(method.returnType());
        return desc;
    }

    /**
     * Returns the descriptor for the specified type, as appropriate
     * for either a parameter or return type in a method descriptor.
     **/
    private static String typeDescriptorOf(Type type) {
        String desc;
        ClassDoc classDoc = type.asClassDoc();
        if (classDoc == null) {
            /*
             * Handle primitive types.
             */
            String name = type.typeName();
            if (name.equals("boolean")) {
                desc = "Z";
            } else if (name.equals("byte")) {
                desc = "B";
            } else if (name.equals("char")) {
                desc = "C";
            } else if (name.equals("short")) {
                desc = "S";
            } else if (name.equals("int")) {
                desc = "I";
            } else if (name.equals("long")) {
                desc = "J";
            } else if (name.equals("float")) {
                desc = "F";
            } else if (name.equals("double")) {
                desc = "D";
            } else if (name.equals("void")) {
                desc = "V";
            } else {
                throw new AssertionError(
                    "unrecognized primitive type: " + name);
            }
        } else {
            /*
             * Handle non-array reference types.
             */
            desc = "L" + binaryNameOf(classDoc).replace('.', '/') + ";";
        }

        /*
         * Handle array types.
         */
        int dimensions = type.dimension().length() / 2;
        for (int i = 0; i < dimensions; i++) {
            desc = "[" + desc;
        }

        return desc;
    }

    /**
     * Returns a reader-friendly string representation of the
     * specified method's signature.  Names of reference types are not
     * package-qualified.
     **/
    static String getFriendlyUnqualifiedSignature(MethodDoc method) {
        String sig = method.name() + "(";
        Parameter[] parameters = method.parameters();
        for (int i = 0; i < parameters.length; i++) {
            if (i > 0) {
                sig += ", ";
            }
            Type paramType = parameters[i].type();
            sig += paramType.typeName() + paramType.dimension();
        }
        sig += ")";
        return sig;
    }

    /**
     * Returns true if the specified type is void.
     **/
    static boolean isVoid(Type type) {
        return type.asClassDoc() == null && type.typeName().equals("void");
    }
}