ClassMetaClass (Jace Core Java 1.2.22 API)

java.lang.Object
- org.jace.metaclass.ClassMetaClass

All Implemented Interfaces:

MetaClass
```
public class ClassMetaClass
extends Object
implements MetaClass
```
Represents meta-data for class types. This helps prevent any sort of naming clashes caused by using other tools that work with standard java class libraries.

Author:

Toby Reyelts, Gili Tzabari

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`beginGuard()` Returns a string which begins an include guard.
`String`	`endGuard()` Returns a String which ends an include guard.
`boolean`	`equals(Object o)` Compares this MetaClass to another.
`String`	`forwardDeclare()` Returns a String which is a forward declaration for this class.
`String`	`getFileName()` Returns the C++ file name that should be used for this MetaClass.
`String`	`getFullyQualifiedName(String separator)` Returns the fully-qualified name of the class.
`String`	`getFullyQualifiedTrueName(String separator)`
`String`	`getJniType()` Returns the JNI type for this MetaClass.
`ClassPackage`	`getPackage()` Returns the ClassPackage for this MetaClass.
`String`	`getSimpleName()` Returns the name of the class that this MetaClass represents.
`String`	`getTrueName()` Returns the name of the class, without the keyword mangling that occurs to make it compatible with C++.
`int`	`hashCode()`
`String`	`include()` Returns a String which generates an include of the header file for this class.
`boolean`	`isPrimitive()` Indicates if the underlying class is a primitive.
`static void`	`main(String[] args)` Tests ClassMetaClass.
`ClassMetaClass`	`proxy()` Return a version of this MetaClass with a pre-pended `JaceConstants.getProxyPackage()` package.
`ClassMetaClass`	`toPeer()`
`String`	`toString()`
`ClassMetaClass`	`unProxy()` Return a version of this MetaClass without a pre-pended `JaceConstants.getProxyPackage()` package.
`String`	`using()` Returns a String which is a using declaration for this class.

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

- Method Detail
  - getSimpleName
```
public String getSimpleName()
```
    Description copied from interface: MetaClass
    
    Returns the name of the class that this MetaClass represents. This is the simple name of the class, unadorned by any package prefixes. For example: String
    
    Specified by:
    
    getSimpleName in interface MetaClass
    
    Returns:
    the name of the class that this MetaClass represents
  - getFileName
```
public String getFileName()
```
    Returns the C++ file name that should be used for this MetaClass. For example, for java.lang.String, this would return String. For java.util.Map.EntrySet, this would return Map_EntrySet.
    
    Returns:
    the file name that should be used for this MetaClass
  - getTrueName
```
public String getTrueName()
```
    Returns the name of the class, without the keyword mangling that occurs to make it compatible with C++.
    
    Returns:
    the name of the class, without the keyword mangling that occurs to make it compatible with C++
  - getFullyQualifiedName
```
public String getFullyQualifiedName(String separator)
```
    Description copied from interface: MetaClass
    
    Returns the fully-qualified name of the class. This name includes both the package-prefix and the class name. For example: java.lang.String
    
    Specified by:
    
    getFullyQualifiedName in interface MetaClass
    
    Parameters:
    separator - The string used to separate the packages and the class name.
    
    Returns:
    the fully-qualified name of the class.
  - getFullyQualifiedTrueName
```
public String getFullyQualifiedTrueName(String separator)
```
  - getPackage
```
public ClassPackage getPackage()
```
    Returns the ClassPackage for this MetaClass.
    
    Specified by:
    
    getPackage in interface MetaClass
    
    Returns:
    the ClassPackage for this MetaClass
  - beginGuard
```
public String beginGuard()
```
    Description copied from interface: MetaClass
    
    Returns a string which begins an include guard. For example: #ifndef JACE_JAVA_LANG_STRING_H #define JACE_JAVA_LANG_STRING_H
    
    Specified by:
    
    beginGuard in interface MetaClass
    
    Returns:
    a string which begins an include guard
  - endGuard
```
public String endGuard()
```
    Description copied from interface: MetaClass
    
    Returns a String which ends an include guard. For example: #endif // #ifndef JACE_JAVA_LANG_STRING_H
    
    Specified by:
    
    endGuard in interface MetaClass
    
    Returns:
    a String which ends an include guard
  - include
```
public String include()
```
    Description copied from interface: MetaClass
    
    Returns a String which generates an include of the header file for this class. For example: #include "jace/java/lang/String.h"
    
    Specified by:
    
    include in interface MetaClass
    
    Returns:
    a String which generates an include of the header file for this class
  - using
```
public String using()
```
    Description copied from interface: MetaClass
    
    Returns a String which is a using declaration for this class. For example, "using jace::java::lang::String;".
    
    Specified by:
    
    using in interface MetaClass
    
    Returns:
    a String which is a using declaration for this class
  - forwardDeclare
```
public String forwardDeclare()
```
    Description copied from interface: MetaClass
    
    Returns a String which is a forward declaration for this class. For example: BEGIN_NAMESPACE_3(jace, java, lang) class String; END_NAMESPACE_3(jace, java, lang)
    
    Specified by:
    
    forwardDeclare in interface MetaClass
    
    Returns:
    a String which is a forward declaration for this class
  - proxy
```
public ClassMetaClass proxy()
```
    Description copied from interface: MetaClass
    
    Return a version of this MetaClass with a pre-pended JaceConstants.getProxyPackage() package.
    
    Specified by:
    
    proxy in interface MetaClass
    
    Returns:
    a version of this MetaClass with a pre-pended JaceConstants.getProxyPackage() package
  - unProxy
```
public ClassMetaClass unProxy()
```
    Description copied from interface: MetaClass
    
    Return a version of this MetaClass without a pre-pended JaceConstants.getProxyPackage() package.
    
    Specified by:
    
    unProxy in interface MetaClass
    
    Returns:
    a version of this MetaClass without a pre-pended JaceConstants.getProxyPackage() package
  - toPeer
```
public ClassMetaClass toPeer()
```
  - isPrimitive
```
public boolean isPrimitive()
```
    Description copied from interface: MetaClass
    
    Indicates if the underlying class is a primitive.
    
    Specified by:
    
    isPrimitive in interface MetaClass
    
    Returns:
    true if the underlying class is a primitive
  - getJniType
```
public String getJniType()
```
    Description copied from interface: MetaClass
    
    Returns the JNI type for this MetaClass. For example, jstring for java.lang.String or jbooleanArray for boolean[].
    
    Specified by:
    
    getJniType in interface MetaClass
    
    Returns:
    the JNI type for this MetaClass
  - equals
```
public boolean equals(Object o)
```
    Compares this MetaClass to another. Two MetaClasses are equal if they have the same name and belong to the same package.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    o - the object to compare to
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - main
```
public static void main(String[] args)
```
    Tests ClassMetaClass.
    
    Parameters:
    args - the command-line argument

Class ClassMetaClass

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getSimpleName

getFileName

getTrueName

getFullyQualifiedName

getFullyQualifiedTrueName

getPackage

beginGuard

endGuard

include

using

forwardDeclare

proxy

unProxy

toPeer

isPrimitive

getJniType

equals

hashCode

toString

main