JavaTypeName (JOMC ⁑ Model 1.9)

java.lang.Object
- org.jomc.model.JavaTypeName

All Implemented Interfaces:

Serializable
```
public final class JavaTypeName
extends Object
implements Serializable
```
Data type of a Java type name.
This class supports parsing of Java type names as specified in the Java Language Specification - Java SE 7 Edition - Chapters 3.8ff, 6.5 and 18.

Please note that this class will move to package org.jomc.util in JOMC 2.0.

Since:

1.4

Version:

$JOMC: JavaTypeName.java 5043 2015-05-27 07:03:39Z schulte $

Author:

Christian Schulte

See Also:
parse(java.lang.String), valueOf(java.lang.String), Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class JavaTypeName.Argument
Data type of an argument of a parameterized Java type name.

Nested Classes
Modifier and Type	Class and Description
`static class`	`JavaTypeName.Argument` Data type of an argument of a parameterized Java type name.

Field Summary

Fields
Modifier and Type	Field and Description
`static JavaTypeName`	`BOOLEAN` Java type name of class `Boolean`.
`static JavaTypeName`	`BOOLEAN_TYPE` Java type name of basic type `boolean`.
`static JavaTypeName`	`BYTE` Java type name of class `Byte`.
`static JavaTypeName`	`BYTE_TYPE` Java type name of basic type `byte`.
`static JavaTypeName`	`CHARACTER` Java type name of class `Character`.
`static JavaTypeName`	`CHARACTER_TYPE` Java type name of basic type `char`.
`static JavaTypeName`	`DOUBLE` Java type name of class `Double`.
`static JavaTypeName`	`DOUBLE_TYPE` Java type name of basic type `double`.
`static JavaTypeName`	`FLOAT` Java type name of class `Float`.
`static JavaTypeName`	`FLOAT_TYPE` Java type name of basic type `float`.
`static JavaTypeName`	`INTEGER` Java type name of class `Integer`.
`static JavaTypeName`	`INTEGER_TYPE` Java type name of basic type `int`.
`static JavaTypeName`	`LONG` Java type name of class `Long`.
`static JavaTypeName`	`LONG_TYPE` Java type name of basic type `long`.
`static JavaTypeName`	`SHORT` Java type name of class `Short`.
`static JavaTypeName`	`SHORT_TYPE` Java type name of basic type `short`.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)` Tests whether another object is compile-time equal to this object.
`List<JavaTypeName.Argument>`	`getArguments()` Gets the arguments of the type name.
`JavaTypeName`	`getBoxedName()` Gets the type name applying a boxing conversion.
`Class<?>`	`getClass(ClassLoader classLoader, boolean initialize)` Gets the `Class` object of the type using a given class loader.
`String`	`getClassName()` Gets the class name of the type name.
`String`	`getName(boolean qualified)` Gets the type name.
`String`	`getPackageName()` Gets the fully qualified package name of the type name.
`String`	`getQualifiedName()` Gets the fully qualified name of the type name.
`String`	`getSimpleName()` Gets the simple name of the type name.
`JavaTypeName`	`getUnboxedName()` Gets the type name applying an unboxing conversion.
`int`	`hashCode()` Gets the hash code value of the object.
`boolean`	`isArray()` Gets a flag indicating the type name denotes an array type.
`boolean`	`isPrimitive()` Gets a flag indicating the type name denotes a primitive type.
`boolean`	`isUnboxable()` Gets a flag indicating the type name denotes a wrapper type of a primitive type.
`boolean`	`isUnnamedPackage()` Gets a flag indicating the type name denotes a type located in an unnamed package.
`static JavaTypeName`	`parse(String text)` Parses text from the beginning of the given string to produce a `JavaTypeName` instance.
`boolean`	`runtimeEquals(Object o)` Tests whether another object is runtime equal to this object.
`String`	`toString()` Creates a string representation of the instance.
`static JavaTypeName`	`valueOf(String text)` Parses text from the beginning of the given string to produce a `JavaTypeName` instance.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - BOOLEAN
```
public static final JavaTypeName BOOLEAN
```
    Java type name of class Boolean.
    
    See Also:
    Boolean
  - BOOLEAN_TYPE
```
public static final JavaTypeName BOOLEAN_TYPE
```
    Java type name of basic type boolean.
    
    See Also:
    Boolean.TYPE
  - BYTE
```
public static final JavaTypeName BYTE
```
    Java type name of class Byte.
    
    See Also:
    Byte
  - BYTE_TYPE
```
public static final JavaTypeName BYTE_TYPE
```
    Java type name of basic type byte.
    
    See Also:
    Byte.TYPE
  - CHARACTER
```
public static final JavaTypeName CHARACTER
```
    Java type name of class Character.
    
    See Also:
    Character
  - CHARACTER_TYPE
```
public static final JavaTypeName CHARACTER_TYPE
```
    Java type name of basic type char.
    
    See Also:
    Character.TYPE
  - DOUBLE
```
public static final JavaTypeName DOUBLE
```
    Java type name of class Double.
    
    See Also:
    Double
  - DOUBLE_TYPE
```
public static final JavaTypeName DOUBLE_TYPE
```
    Java type name of basic type double.
    
    See Also:
    Double.TYPE
  - FLOAT
```
public static final JavaTypeName FLOAT
```
    Java type name of class Float.
    
    See Also:
    Float
  - FLOAT_TYPE
```
public static final JavaTypeName FLOAT_TYPE
```
    Java type name of basic type float.
    
    See Also:
    Float.TYPE
  - INTEGER
```
public static final JavaTypeName INTEGER
```
    Java type name of class Integer.
    
    See Also:
    Integer
  - INTEGER_TYPE
```
public static final JavaTypeName INTEGER_TYPE
```
    Java type name of basic type int.
    
    See Also:
    Integer.TYPE
  - LONG
```
public static final JavaTypeName LONG
```
    Java type name of class Long.
    
    See Also:
    Long
  - LONG_TYPE
```
public static final JavaTypeName LONG_TYPE
```
    Java type name of basic type long.
    
    See Also:
    Long.TYPE
  - SHORT
```
public static final JavaTypeName SHORT
```
    Java type name of class Short.
    
    See Also:
    Short
  - SHORT_TYPE
```
public static final JavaTypeName SHORT_TYPE
```
    Java type name of basic type short.
    
    See Also:
    Short.TYPE
- Method Detail
  - getClass
```
public Class<?> getClass(ClassLoader classLoader,
                boolean initialize)
                  throws ClassNotFoundException
```
    Gets the Class object of the type using a given class loader.
    
    Parameters:
    classLoader - The class loader to use for loading the Class object to return or null, to load that Class object using the platform's bootstrap class loader.
    initialize - Flag indicating initialization to be performed on the loaded Class object.
    
    Returns:
    The Class object of the type.
    
    Throws:
    
    ClassNotFoundException - if the Class object of the type is not found searching classLoader.
    See Also:
    Class.forName(java.lang.String, boolean, java.lang.ClassLoader)
  - getArguments
```
public List<JavaTypeName.Argument> getArguments()
```
    Gets the arguments of the type name.
    
    Returns:
    An unmodifiable list holding the arguments of the type name.
  - isArray
```
public boolean isArray()
```
    Gets a flag indicating the type name denotes an array type.
    
    Returns:
    true, if the type name denotes an array type; false, else.
    See Also:
    Class.isArray()
  - isPrimitive
```
public boolean isPrimitive()
```
    Gets a flag indicating the type name denotes a primitive type.
    
    Returns:
    true, if the type name denotes a primitive type; false, else.
    See Also:
    Class.isPrimitive()
  - isUnboxable
```
public boolean isUnboxable()
```
    Gets a flag indicating the type name denotes a wrapper type of a primitive type.
    
    Returns:
    true, if the type name denotes a wrapper type of a primitive type; false, else.
  - getName
```
public String getName(boolean qualified)
```
    Gets the type name.
    
    Parameters:
    qualified - true, to return a qualified name; false, to return a simple name.
    
    Returns:
    The type name.
  - getClassName
```
public String getClassName()
```
    Gets the class name of the type name.
    
    Returns:
    The class name of the type name.
    See Also:
    Class.getName(), Class.forName(java.lang.String)
  - getPackageName
```
public String getPackageName()
```
    Gets the fully qualified package name of the type name.
    
    Returns:
    The fully qualified package name of the type name or an empty string, if the type name denotes a type located in an unnamed package.
    See Also:
    isUnnamedPackage()
  - isUnnamedPackage
```
public boolean isUnnamedPackage()
```
    Gets a flag indicating the type name denotes a type located in an unnamed package.
    
    Returns:
    true, if the type name denotes a type located in an unnamed package; false, else.
    See Also:
    getPackageName()
  - getQualifiedName
```
public String getQualifiedName()
```
    Gets the fully qualified name of the type name.
    
    Returns:
    The fully qualified name of the type name.
  - getSimpleName
```
public String getSimpleName()
```
    Gets the simple name of the type name.
    
    Returns:
    The simple name of the type name.
  - getBoxedName
```
public JavaTypeName getBoxedName()
```
    Gets the type name applying a boxing conversion.
    
    Returns:
    The converted type name or null, if the instance cannot be converted.
    See Also:
    isArray(), isPrimitive()
  - getUnboxedName
```
public JavaTypeName getUnboxedName()
```
    Gets the type name applying an unboxing conversion.
    
    Returns:
    The converted type name or null, if the instance cannot be converted.
    See Also:
    isUnboxable()
  - toString
```
public String toString()
```
    Creates a string representation of the instance.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string representation of the instance.
  - hashCode
```
public int hashCode()
```
    Gets the hash code value of the object.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    The hash code value of the object.
  - equals
```
public boolean equals(Object o)
```
    Tests whether another object is compile-time equal to this object.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    o - The object to compare.
    
    Returns:
    true, if o denotes the same compile-time type name than the object; false, else.
  - runtimeEquals
```
public boolean runtimeEquals(Object o)
```
    Tests whether another object is runtime equal to this object.
    
    Parameters:
    o - The object to compare.
    
    Returns:
    true, if o denotes the same runtime type name than the object; false, else.
  - parse
```
public static JavaTypeName parse(String text)
                          throws ParseException
```
    Parses text from the beginning of the given string to produce a JavaTypeName instance.
    
    Parameters:
    text - The text to parse.
    
    Returns:
    A JavaTypeName instance corresponding to text.
    
    Throws:
    
    NullPointerException - if text is null.
    
    ParseException - if parsing fails.
    See Also:
    valueOf(java.lang.String)
  - valueOf
```
public static JavaTypeName valueOf(String text)
                            throws IllegalArgumentException
```
    Parses text from the beginning of the given string to produce a JavaTypeName instance.
    Unlike the parse(String) method, this method throws an IllegalArgumentException if parsing fails.
    
    Parameters:
    text - The text to parse.
    
    Returns:
    A JavaTypeName instance corresponding to text.
    
    Throws:
    
    NullPointerException - if text is null.
    
    IllegalArgumentException - if parsing fails.
    See Also:
    parse(java.lang.String)

Class JavaTypeName

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BOOLEAN

BOOLEAN_TYPE

BYTE

BYTE_TYPE

CHARACTER

CHARACTER_TYPE

DOUBLE

DOUBLE_TYPE

FLOAT

FLOAT_TYPE

INTEGER

INTEGER_TYPE

LONG

LONG_TYPE

SHORT

SHORT_TYPE

Method Detail

getClass

getArguments

isArray

isPrimitive

isUnboxable

getName

getClassName

getPackageName

isUnnamedPackage

getQualifiedName

getSimpleName

getBoxedName

getUnboxedName

toString

hashCode

equals

runtimeEquals

parse

valueOf