Packageorg.pranaframework.utils
Classpublic class ClassUtils

Provides utilities for working with Class objects.


Public Methods
 MethodDefined by
  
convertFullyQualifiedName(className:String):String
[static] Converts the double colon (::) in a fully qualified class name to a dot (.)
ClassUtils
  
forInstance(instance:*, applicationDomain:ApplicationDomain = null):Class
[static] Returns a Class object that corresponds with the given instance.
ClassUtils
  
forName(name:String, applicationDomain:ApplicationDomain = null):Class
[static] Returns a Class object that corresponds with the given name.
ClassUtils
  
getFullyQualifiedImplementedInterfaceNames(clazz:Class, replaceColons:Boolean = false):Array
[static] Returns an array of all fully qualified interface names that the given class implements.
ClassUtils
  
getFullyQualifiedName(clazz:Class, replaceColons:Boolean = false):String
[static] Returns the fully qualified name of the given class.
ClassUtils
  
getFullyQualifiedSuperClassName(clazz:Class, replaceColons:Boolean = false):String
[static] Returns the fully qualified name of the given class' superclass.
ClassUtils
  
getImplementedInterfaceNames(clazz:Class):Array
[static] Returns an array of all interface names that the given class implements.
ClassUtils
  
getImplementedInterfaces(clazz:Class):Array
[static] Returns an array of all interface names that the given class implements.
ClassUtils
  
getName(clazz:Class):String
[static] Returns the name of the given class.
ClassUtils
  
getNameFromFullyQualifiedName(fullyQualifiedName:String):String
[static] Returns the name of the class or interface, based on the given fully qualified class or interface name.
ClassUtils
  
getSuperClass(clazz:Class):Class
[static] Returns the class that the passed in clazz extends.
ClassUtils
  
getSuperClassName(clazz:Class):String
[static] Returns the name of the given class' superclass.
ClassUtils
  
isImplementationOf(clazz:Class, interfaze:Class):Boolean
[static] Returns whether the passed in Class object implements the given interface.
ClassUtils
  
isSubclassOf(clazz:Class, parentClass:Class):Boolean
[static] Returns whether the passed in Class object is a subclass of the passed in parent Class.
ClassUtils
  
newInstance(clazz:Class, args:Array = null):*
[static] Creates an instance of the given class and passes the arguments to the constructor.
ClassUtils
Method detail
convertFullyQualifiedName()method
public static function convertFullyQualifiedName(className:String):String

Converts the double colon (::) in a fully qualified class name to a dot (.)

Parameters
className:String

Returns
String
forInstance()method 
public static function forInstance(instance:*, applicationDomain:ApplicationDomain = null):Class

Returns a Class object that corresponds with the given instance. If no correspoding class was found, a ClassNotFoundError will be thrown.

Parameters
instance:* — the instance from which to return the class
 
applicationDomain:ApplicationDomain (default = null) — the optional applicationdomain where the instance's class resides

Returns
Class — the Class that corresponds with the given instance

See also

org.pranaframework.errors.ClassNotFoundError
forName()method 
public static function forName(name:String, applicationDomain:ApplicationDomain = null):Class

Returns a Class object that corresponds with the given name. If no correspoding class was found in the applicationdomain tree, a ClassNotFoundError will be thrown.

Parameters
name:String — the name from which to return the class
 
applicationDomain:ApplicationDomain (default = null) — the optional applicationdomain where the instance's class resides

Returns
Class — the Class that corresponds with the given name

See also

org.pranaframework.errors.ClassNotFoundError
getFullyQualifiedImplementedInterfaceNames()method 
public static function getFullyQualifiedImplementedInterfaceNames(clazz:Class, replaceColons:Boolean = false):Array

Returns an array of all fully qualified interface names that the given class implements.

Parameters
clazz:Class
 
replaceColons:Boolean (default = false)

Returns
Array
getFullyQualifiedName()method 
public static function getFullyQualifiedName(clazz:Class, replaceColons:Boolean = false):String

Returns the fully qualified name of the given class.

Parameters
clazz:Class — the class to get the name from
 
replaceColons:Boolean (default = false) — whether the double colons "::" should be replaced by a dot "." the default is false

Returns
String — the fully qualified name of the class
getFullyQualifiedSuperClassName()method 
public static function getFullyQualifiedSuperClassName(clazz:Class, replaceColons:Boolean = false):String

Returns the fully qualified name of the given class' superclass.

Parameters
clazz:Class — the class to get its superclass' name from
 
replaceColons:Boolean (default = false) — whether the double colons "::" should be replaced by a dot "." the default is false

Returns
String — the fully qualified name of the class' superclass
getImplementedInterfaceNames()method 
public static function getImplementedInterfaceNames(clazz:Class):Array

Returns an array of all interface names that the given class implements.

Parameters
clazz:Class

Returns
Array
getImplementedInterfaces()method 
public static function getImplementedInterfaces(clazz:Class):Array

Returns an array of all interface names that the given class implements.

Parameters
clazz:Class

Returns
Array
getName()method 
public static function getName(clazz:Class):String

Returns the name of the given class.

Parameters
clazz:Class — the class to get the name from

Returns
String — the name of the class
getNameFromFullyQualifiedName()method 
public static function getNameFromFullyQualifiedName(fullyQualifiedName:String):String

Returns the name of the class or interface, based on the given fully qualified class or interface name.

Parameters
fullyQualifiedName:String — the fully qualified name of the class or interface

Returns
String — the name of the class or interface
getSuperClass()method 
public static function getSuperClass(clazz:Class):Class

Returns the class that the passed in clazz extends. If no super class was found, in case of Object, null is returned.

Parameters
clazz:Class — the class to get the super class from

Returns
Class
getSuperClassName()method 
public static function getSuperClassName(clazz:Class):String

Returns the name of the given class' superclass.

Parameters
clazz:Class — the class to get the name of its superclass' from

Returns
String — the name of the class' superclass
isImplementationOf()method 
public static function isImplementationOf(clazz:Class, interfaze:Class):Boolean

Returns whether the passed in Class object implements the given interface.

Parameters
clazz:Class — the class to check for an implemented interface
 
interfaze:Class — the interface that the clazz argument should implement

Returns
Boolean — true if the clazz object implements the given interface; false if not
isSubclassOf()method 
public static function isSubclassOf(clazz:Class, parentClass:Class):Boolean

Returns whether the passed in Class object is a subclass of the passed in parent Class.

Parameters
clazz:Class
 
parentClass:Class

Returns
Boolean
newInstance()method 
public static function newInstance(clazz:Class, args:Array = null):*

Creates an instance of the given class and passes the arguments to the constructor. TODO find a generic solution for this. Currently we support constructors with a maximum of 10 arguments.

Parameters
clazz:Class — the class from which an instance will be created
 
args:Array (default = null) — the arguments that need to be passed to the constructor

Returns
*



Prana Framework 0.6 - 2008