+Show TOC
×Hide TOC

ClassUtils

Kind of class:	public class
Package:	com.bourre.utils
Inherits from:	none
Author:	Cédric Néhémie
Classpath:	com.bourre.utils.ClassUtils
File last modified:	Monday, 24 November 2008, 11:36:51

► View source

▼ Hide source

/*
 * Copyright the original author or authors.
 * 
 * Licensed under the MOZILLA PUBLIC LICENSE, Version 1.1 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.mozilla.org/MPL/MPL-1.1.html
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.bourre.utils 
{
    import flash.utils.describeType;
    import flash.utils.getQualifiedClassName;        

    /**
     * @author    C√©dric N√©h√©mie
     */
    public class ClassUtils
    {        
        /**
         * Verify that the passed-in <code>childClass</code> is a descendant of the 
         * specified <code>parentClass</code>.
         * 
         * @param childClass    class to check inheritance with the ascendant class
         * @param parentClass    class which is the ascendant
         */
        static public function inherit( childClass : Class, parentClass : Class) : Boolean 
        {
            var xml : XML = describeType(childClass);
            var parent : String = getQualifiedClassName(parentClass);
            return     (xml.factory.extendsClass.@type).contains( parent ) || (xml.factory.implementsInterface.@type).contains( parent );
        }
        
        /**
         * Use the <code>isImplemented</code> function to check if a virtual method of an abstract
         * class is really implemented by children classes.
         * 
         * @param     o    A reference to <code>this</code> in the abstract class constructor.    
         * @param     f    The name of the virtual method.    
         * @return     <code>true</code> if the method is implemented
         *             by the child class, either <code>false</code>
         * @example A concret example in the class <code>AbstractTween</code> : 
         * if( !ClassUtils.isImplementedAll( this, "com.bourre.transitions::AbstractTween", "isMotionFinished", "isReversedMotionFinished" ) )
         * {
         *    PixlibDebug.ERROR ( this + " have to implements virtual methods : isMotionFinished & isReversedMotionFinished " );
         *     throw new UnimplementedVirtualMethodException ( this + " have to implements virtual methods : isMotionFinished & isReversedMotionFinished" );
         * {}
         */
        static public function isImplemented ( o : Object, classPath : String, f : String ) : Boolean
        {
            var x : XML = describeType( o );
            var declaredBy : String = x..method.(@name == f).@declaredBy;
            return ( declaredBy != classPath );
        }
        
        /**
         * Check in one time if a set of function is implemented by the subclasses.
         * 
         * @param     o    A reference to <code>this</code> in the abstract class constructor.    
         * @param     c    A <code>Collection</code> object witch contains a list of function
         *                 names to verify.    
         * @return     <code>true</code> if all the methods are implemented
         *             by the child class, either <code>false</code>. When
         *             only one method isn't implemented then the function 
         *             failed and return immediatly.
         * @see        #isImplemented()
         */
        static public function isImplementedAll ( o : Object, classPath : String, ... rest ) : Boolean
        {
            var i : Number = rest.length-1;
            var x : XML = describeType( o );
            while ( --i -(-1) )
            {
                var declaredBy : String = x..method.(@name == rest[ i ] ).@declaredBy;
                if( declaredBy == classPath ) return false;
            }
            return true;
        } 
    }
}

Summary

Class methods

inherit (childClass:Class, parentClass:Class) : Boolean
- Verify that the passed-in childClass is a descendant of the
isImplemented (o:Object, classPath:String, f:String) : Boolean
- Use the isImplemented function to check if a virtual method of an abstract
isImplementedAll (o:Object, classPath:String, rest) : Boolean
- Check in one time if a set of function is implemented by the subclasses.

Class methods

inherit

public static function inherit (

childClass:Class, parentClass:Class) : Boolean

Verify that the passed-in childClass is a descendant of the
specified parentClass.

Parameters:

childClass :

class to check inheritance with the ascendant class

parentClass:

class which is the ascendant

isImplemented

public static function isImplemented (

o:Object, classPath:String, f:String) : Boolean

Use the isImplemented function to check if a virtual method of an abstract
class is really implemented by children classes.

Parameters:

A reference to this in the abstract class constructor.

The name of the virtual method.

Returns:

true if the method is implemented
by the child class, either false

Example:

A concret example in the class AbstractTween :
if( !ClassUtils.isImplementedAll( this, "com.bourre.transitions::AbstractTween", "isMotionFinished", "isReversedMotionFinished" ) )
{
PixlibDebug.ERROR ( this + " have to implements virtual methods : isMotionFinished & isReversedMotionFinished " );
throw new UnimplementedVirtualMethodException ( this + " have to implements virtual methods : isMotionFinished & isReversedMotionFinished" );
{}

isImplementedAll

public static function isImplementedAll (

o:Object, classPath:String, rest) : Boolean

Check in one time if a set of function is implemented by the subclasses.

Parameters:

A reference to this in the abstract class constructor.

A Collection object witch contains a list of function
names to verify.

Returns:

true if all the methods are implemented
by the child class, either false. When
only one method isn't implemented then the function
failed and return immediatly.