Package org.openjdk.jmc.common.util
Class MethodToolkit
- java.lang.Object
-
- org.openjdk.jmc.common.util.MethodToolkit
-
public class MethodToolkit extends Object
Helper class to supportIMCType
andIMCMethod
implementations and to handle conversion of reference types and field descriptors according to The Java Virtual Machine Specification, Section 4.4.1 and Section 4.3.2, respectively, into Java type formats according to The Java Language Specification, Sections 6.7 and 13.1.
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static String
binaryNameToCanonical(String binaryName)
Convert a binary name to a canonical name, as defined in The Java Language Specification, Sections 6.7 and 13.1, respectively.static int
fieldDescToBinaryJLS(CharSequence desc, int start, Appendable out)
Convert the field descriptor, according to The Java Virtual Machine Specification, Section 4.3.2, starting at positionstart
indesc
, into a binary Java type name according to The Java Language Specification, Section 13.1.static String
fieldDescToBinaryJLS(String fieldDesc)
Convert a field descriptor according to The Java Virtual Machine Specification, Section 4.3.2, into a binary Java type name according to The Java Language Specification, Section 13.1.static String
formatQualifiedName(IMCPackage mcPackage, String className)
Create a fully qualified class name based on a package.static Boolean
hasNestedTypes(String className)
Check if a class name denotes a nested class.static Boolean
isArray(String typeName)
Check if a type name denotes an array.static boolean
isDescOrRefArray(String fieldDesc)
Check if a field descriptor or a reference type according to The Java Virtual Machine Specification, Sections 4.3.2 and 4.4.1 respectively, designates an array.static boolean
isDescPrimitive(String fieldDesc)
Check if a field descriptor according to The Java Virtual Machine Specification, Section 4.3.2, designates a primitive type.static boolean
isPrimitive(String typeName)
Check if a type name denotes a primitive type.static String
nestedTypes(String className)
Get the nested type name of a class.static String
refTypeToBinaryJLS(String refType)
Convert a reference type according to The Java Virtual Machine Specification, Section 4.4.1, into a binary Java type name according to The Java Language Specification, Section 13.1.static String
refTypeToFieldDescriptor(String refType)
Convert a reference type according to The Java Virtual Machine Specification, Section 4.4.1, into a field descriptor according to The Java Virtual Machine Specification, Section 4.3.2.static String
topLevelType(String className)
Get the top level type of a class.static IMCType
typeFromBinaryJLS(String jlsType)
Convert a binary Java type name according to The Java Language Specification, Section 13.1, into anIMCType
.static IMCType
typeFromReference(String refType)
Convert a reference type according to The Java Virtual Machine Specification, Section 4.4.1, into anIMCType
.
-
-
-
Method Detail
-
isPrimitive
public static boolean isPrimitive(String typeName)
Check if a type name denotes a primitive type.- Parameters:
typeName
- type name to check- Returns:
true
if the type is primitive,false
if not
-
formatQualifiedName
public static String formatQualifiedName(IMCPackage mcPackage, String className)
Create a fully qualified class name based on a package.- Parameters:
mcPackage
- package for the classclassName
- class name- Returns:
- a fully qualified class name
-
hasNestedTypes
public static Boolean hasNestedTypes(String className)
Check if a class name denotes a nested class.- Parameters:
className
- class name to check- Returns:
true
if the class is nested,false
if not
-
topLevelType
public static String topLevelType(String className)
Get the top level type of a class. This is the class name without any nested components.- Parameters:
className
- class name with possible nested components- Returns:
- class name without nested components
-
nestedTypes
public static String nestedTypes(String className)
Get the nested type name of a class. This is the class name without the top level class name. If there are multiple nested levels then all levels will be returned.- Parameters:
className
- class name with possible nested components- Returns:
- nested class name part if present,
null
if there is no nested class
-
isArray
public static Boolean isArray(String typeName)
Check if a type name denotes an array.- Parameters:
typeName
- type name to check- Returns:
true
if the type is an array,false
if not
-
refTypeToFieldDescriptor
public static String refTypeToFieldDescriptor(String refType)
Convert a reference type according to The Java Virtual Machine Specification, Section 4.4.1, into a field descriptor according to The Java Virtual Machine Specification, Section 4.3.2.- Parameters:
refType
- the reference type to convert- Returns:
- the corresponding field descriptor
-
binaryNameToCanonical
public static String binaryNameToCanonical(String binaryName)
Convert a binary name to a canonical name, as defined in The Java Language Specification, Sections 6.7 and 13.1, respectively. These names only differ in that the former uses "$" as nested class separator while the latter uses ".".- Parameters:
binaryName
- the binary name to convert- Returns:
- the converted canonical name
-
refTypeToBinaryJLS
public static String refTypeToBinaryJLS(String refType) throws IllegalArgumentException
Convert a reference type according to The Java Virtual Machine Specification, Section 4.4.1, into a binary Java type name according to The Java Language Specification, Section 13.1.- Parameters:
refType
- the reference type to convert- Returns:
- the converted name
- Throws:
IllegalArgumentException
- ifrefType
is not a valid reference type
-
typeFromReference
public static IMCType typeFromReference(String refType) throws IllegalArgumentException
Convert a reference type according to The Java Virtual Machine Specification, Section 4.4.1, into anIMCType
.- Parameters:
refType
- the reference type to convert- Returns:
- the type object
- Throws:
IllegalArgumentException
- ifrefType
is not a valid reference type
-
typeFromBinaryJLS
public static IMCType typeFromBinaryJLS(String jlsType) throws IllegalArgumentException
Convert a binary Java type name according to The Java Language Specification, Section 13.1, into anIMCType
.- Parameters:
jlsType
- the JLS type name to convert- Returns:
- the type object
- Throws:
IllegalArgumentException
- ifrefType
is not a valid reference type
-
fieldDescToBinaryJLS
public static String fieldDescToBinaryJLS(String fieldDesc) throws IllegalArgumentException
Convert a field descriptor according to The Java Virtual Machine Specification, Section 4.3.2, into a binary Java type name according to The Java Language Specification, Section 13.1.- Parameters:
fieldDesc
- the field descriptor (according to the JVM Specification) to convert- Returns:
- the converted type name according to JLS
- Throws:
IllegalArgumentException
- iffieldDesc
is not a valid field descriptor
-
fieldDescToBinaryJLS
public static int fieldDescToBinaryJLS(CharSequence desc, int start, Appendable out) throws IllegalArgumentException, IOException
Convert the field descriptor, according to The Java Virtual Machine Specification, Section 4.3.2, starting at positionstart
indesc
, into a binary Java type name according to The Java Language Specification, Section 13.1. and appends it toout
.- Parameters:
desc
- aCharSequence
containing the field descriptor (according to the JVM Specification) to convertstart
- the position indesc
where the descriptor to convert startsout
- anAppendable
to which the result will be appended- Returns:
- the first position in
desc
not converted - Throws:
IllegalArgumentException
- ifdesc
is not a valid field descriptorIOException
- If an I/O error occurs when appending toout
. Note that this cannot happen when usingStringBuilder
orStringBuffer
.
-
isDescOrRefArray
public static boolean isDescOrRefArray(String fieldDesc)
Check if a field descriptor or a reference type according to The Java Virtual Machine Specification, Sections 4.3.2 and 4.4.1 respectively, designates an array.- Parameters:
fieldDesc
- a non-null field descriptor or reference type (according to the JVM Specification)- Returns:
- true iff the descriptor denotes an array type
-
isDescPrimitive
public static boolean isDescPrimitive(String fieldDesc)
Check if a field descriptor according to The Java Virtual Machine Specification, Section 4.3.2, designates a primitive type.- Parameters:
fieldDesc
- a non-null field descriptor (according to the JVM Specification)- Returns:
- true iff the descriptor denotes a primitive type
-
-