Mercurial > hg > truffle

comparison jvmci/com.oracle.jvmci.meta/src/com/oracle/jvmci/meta/JavaField.java @ 21798:395ac43a8578

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
moved JVMCI sources from graal/ to jvmci/ directory
author Doug Simon <doug.simon@oracle.com>
date Tue, 09 Jun 2015 00:22:49 +0200
parents graal/com.oracle.jvmci.meta/src/com/oracle/jvmci/meta/JavaField.java@48c1ebd24120
children
comparison
equal deleted inserted replaced
21797:42452d2dfbec 21798:395ac43a8578
1 /*
2 * Copyright (c) 2009, 2012, 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.
8 *
9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 * version 2 for more details (a copy is included in the LICENSE file that
13 * accompanied this code).
14 *
15 * You should have received a copy of the GNU General Public License version
16 * 2 along with this work; if not, write to the Free Software Foundation,
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 *
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 * or visit www.oracle.com if you need additional information or have any
21 * questions.
22 */
23 package com.oracle.jvmci.meta;
24
25 import java.util.*;
26
27 /**
28 * Represents a reference to a Java field, either resolved or unresolved fields. Fields, like
29 * methods and types, are resolved through {@link ConstantPool constant pools}.
30 */
31 public interface JavaField extends TrustedInterface {
32
33 /**
34 * Returns the name of this field.
35 */
36 String getName();
37
38 /**
39 * Returns a {@link JavaType} object that identifies the declared type for this field.
40 */
41 JavaType getType();
42
43 /**
44 * Returns the kind of this field. This is the same as calling {@link #getType}.
45 * {@link JavaType#getKind getKind}.
46 */
47 default Kind getKind() {
48 return getType().getKind();
49 }
50
51 /**
52 * Returns the {@link JavaType} object representing the class or interface that declares this
53 * field.
54 */
55 JavaType getDeclaringClass();
56
57 /**
58 * Gets a string for this field formatted according to a given format specification. A format
59 * specification is composed of characters that are to be copied verbatim to the result and
60 * specifiers that denote an attribute of this field that is to be copied to the result. A
61 * specifier is a single character preceded by a '%' character. The accepted specifiers and the
62 * field attributes they denote are described below:
63 *
64 * <pre>
65 * Specifier | Description | Example(s)
66 * ----------+------------------------------------------------------------------------------------------
67 * 'T' | Qualified type | "int" "java.lang.String"
68 * 't' | Unqualified type | "int" "String"
69 * 'H' | Qualified holder | "java.util.Map.Entry"
70 * 'h' | Unqualified holder | "Entry"
71 * 'n' | Field name | "age"
72 * 'f' | Indicator if field is unresolved, static or instance | "unresolved" "static" "instance"
73 * '%' | A '%' character | "%"
74 * </pre>
75 *
76 * @param format a format specification
77 * @return the result of formatting this field according to {@code format}
78 * @throws IllegalFormatException if an illegal specifier is encountered in {@code format}
79 */
80 default String format(String format) throws IllegalFormatException {
81 StringBuilder sb = new StringBuilder();
82 int index = 0;
83 JavaType type = getType();
84 while (index < format.length()) {
85 char ch = format.charAt(index++);
86 if (ch == '%') {
87 if (index >= format.length()) {
88 throw new UnknownFormatConversionException("An unquoted '%' character cannot terminate a field format specification");
89 }
90 char specifier = format.charAt(index++);
91 boolean qualified = false;
92 switch (specifier) {
93 case 'T':
94 qualified = true;
95 // fall through
96 case 't': {
97 sb.append(type.toJavaName(qualified));
98 break;
99 }
100 case 'H':
101 qualified = true;
102 // fall through
103 case 'h': {
104 sb.append(getDeclaringClass().toJavaName(qualified));
105 break;
106 }
107 case 'n': {
108 sb.append(getName());
109 break;
110 }
111 case 'f': {
112 sb.append(!(this instanceof ResolvedJavaField) ? "unresolved" : ((ResolvedJavaField) this).isStatic() ? "static" : "instance");
113 break;
114 }
115 case '%': {
116 sb.append('%');
117 break;
118 }
119 default: {
120 throw new UnknownFormatConversionException(String.valueOf(specifier));
121 }
122 }
123 } else {
124 sb.append(ch);
125 }
126 }
127 return sb.toString();
128 }
129 }