Interface org.as2lib.env.reflect.Cache

Description

Cache chaches classes and packages.

The caching of classes and packages leads to better performance. You also must cache them because for example the parent of two classes residing in the same package should be the same PackageInfo instance.

The cache is mostly used internally. But you can also use it to add ClassInfo or PackageInfo instances directly so that they do not have to be searched for. This can improve the performance dramatically with classes or packages that are needed quite often.

Method Index

addClass(), addPackage(), getClass(), getClassByClass(), getClassByInstance(), getPackage(), getRoot(), releaseAll()

Inherited from BasicInterface

toString()

Method Detail

getClass

public function getClass():ClassInfo

getClassByClass

public function getClassByClass(clazz:Function):ClassInfo

Returns the class info representing the passed-in clazz.

null will be returned if:

  • There is no corresponding ClassInfo instance cached.
  • The passed-in clazz is null or undefined.

Parameters

clazzthe class to return the class info for

Return

the class info representing the passed-in clazz

getClassByInstance

public function getClassByInstance(instance):ClassInfo

Returns the class info representing the class the instance was instantiated of.

null will be returned if:

  • There is no corresponding ClassInfo instance cached.
  • The passed-in instance is null or undefined.

Parameters

instancethe instance to return the appropriate class info for

Return

the class info representing the instance's class

addClass

public function addClass(classInfo:ClassInfo):ClassInfo

Adds the passed-in classInfo to the list of cached class infos and returns this classInfo.

Parameters

classInfothe class info to add

Return

the passed-in and added classInfo

getPackage

public function getPackage(package):PackageInfo

Returns the package info representing the passed-in package.

null will be returned if:

  • There is no corresponding PackageInfo instance cached.
  • The passed-in package is null or undefined.

Parameters

packagethe package to return the appropriate package info for

Return

the pakcage info representing the passed-in package

addPackage

public function addPackage(packageInfo:PackageInfo):PackageInfo

Adds the passed-in packageInfo to this cache and returns this added packageInfo.

Parameters

packageInfothe package info to add

Return

the passed-in and added packageInfo

getRoot

public function getRoot(Void):PackageInfo

Returns the root package of the whole package hierarchy.

The root package is also refered to as the default package.

The root/default package determines where the ClassAlgorithm and PackageAlgorithm classes start their search.

Return

the root/default package

releaseAll

public function releaseAll(Void):Void

Releases all cached class and package infos.

as2api