Packageorg.swizframework.reflection
Classpublic class ClassConstant
InheritanceClassConstant Inheritance Object



Public Methods
 MethodDefined By
  
getClass(domain:ApplicationDomain, constant:String, packageNames:Array = null):Class
[static] Gets the class referenced by the specified relative or fully qualified class constant.
ClassConstant
  
getClassName(constant:String):String
[static] Gets the class name portion of a class constant.
ClassConstant
  
getConstantName(constant:String):String
[static] Gets the constant name portion of a class constant.
ClassConstant
  
getConstantValue(domain:ApplicationDomain, definition:Class, constantName:String, constantType:String = String):*
[static] Gets the associated value for the specified class and class constant name.
ClassConstant
  
isClassConstant(value:String):Boolean
[static] Evaluates whether the specified value defines a class constant.
ClassConstant
Protected Methods
 MethodDefined By
  
findClassDefinition(domain:ApplicationDomain, className:String, packageNames:Array):Class
[static] Finds the class definition given a class name and set of potential package names.
ClassConstant
  
getClassDefinition(domain:ApplicationDomain, name:String):Class
[static] Safely returns a reference to the class object of the class specified by the name parameter.
ClassConstant
Protected Constants
 ConstantDefined By
  CLASS_CONSTANT_PATTERN : RegExp
[static] Class constant regular expression.
ClassConstant
  CLASS_PACKAGE_CONSTANT_PATTERN : RegExp
[static] Class package constant regular expression.
ClassConstant
Method Detail
findClassDefinition()method
protected static function findClassDefinition(domain:ApplicationDomain, className:String, packageNames:Array):Class

Finds the class definition given a class name and set of potential package names.

Parameters

domain:ApplicationDomain — The class name.
 
className:String — The set of potential package names to search.
 
packageNames:Array

Returns
Class
getClass()method 
public static function getClass(domain:ApplicationDomain, constant:String, packageNames:Array = null):Class

Gets the class referenced by the specified relative or fully qualified class constant.

Parameters

domain:ApplicationDomain — A relative or fully qualified class constant.
 
constant:String — A set of package names to search to for a relative class constant. (Optional)
 
packageNames:Array (default = null)

Returns
Class
getClassDefinition()method 
protected static function getClassDefinition(domain:ApplicationDomain, name:String):Class

Safely returns a reference to the class object of the class specified by the name parameter.

Parameters

domain:ApplicationDomain — The fully qualified name of a class.
 
name:String

Returns
Class
getClassName()method 
public static function getClassName(constant:String):String

Gets the class name portion of a class constant.

Parameters

constant:String — A String that defines a class constant. (Ex. 'Class.CONSTANT')

Returns
String
getConstantName()method 
public static function getConstantName(constant:String):String

Gets the constant name portion of a class constant.

Parameters

constant:String — A String that defines a class constant. (Ex. 'Class.CONSTANT')

Returns
String
getConstantValue()method 
public static function getConstantValue(domain:ApplicationDomain, definition:Class, constantName:String, constantType:String = String):*

Gets the associated value for the specified class and class constant name.

Parameters

domain:ApplicationDomain — The ApplicationDomain.
 
definition:Class — The class definition.
 
constantName:String — The constant name.
 
constantType:String (default = String) — The expected constant type.

Returns
* — Returns the associated value for the specified class constant.
isClassConstant()method 
public static function isClassConstant(value:String):Boolean

Evaluates whether the specified value defines a class constant. (Ex. 'Class.CONSTANT')

Parameters

value:String — A text value that potentially defines a class constant.

Returns
Boolean
Constant Detail
CLASS_CONSTANT_PATTERNConstant
protected static const CLASS_CONSTANT_PATTERN:RegExp

Class constant regular expression. Matches: Class.CONSTANT or package.Class.CONSTANT Captures: class, constant name

CLASS_PACKAGE_CONSTANT_PATTERNConstant 
protected static const CLASS_PACKAGE_CONSTANT_PATTERN:RegExp

Class package constant regular expression. Matches: package.Class.CONSTANT Captures: package, class, constant name