com.caucho.quercus.program

Class ClassDef

java.lang.Object

com.caucho.quercus.program.ClassDef

All Implemented Interfaces:

InstanceInitializer

Direct Known Subclasses:

CompiledClassDef, InterpretedClassDef, JavaClassDef

public abstract class ClassDef
extends java.lang.Object
implements InstanceInitializer

Represents a Quercus class definition

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClassDef.FieldEntry
static class	ClassDef.StaticFieldEntry

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String[]	NULL_STRING_ARRAY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClassDef(Location location, java.lang.String name, java.lang.String parentName)
protected	ClassDef(Location location, java.lang.String name, java.lang.String parentName, java.lang.String[] ifaceList)
protected	ClassDef(Location location, java.lang.String name, java.lang.String parentName, java.lang.String[] ifaceList, java.lang.String[] traitList)

Method Summary

Modifier and Type	Method and Description
protected void	addInterface(java.lang.String iface)
void	addInterfaces(java.util.HashSet<java.lang.String> interfaceSet) Adds the interfaces to the set
void	addTrait(java.lang.String trait) Adds a PHP 5.4 trait.
void	addTraitAlias(StringValue funName, StringValue funNameAlias, java.lang.String traitName)
void	addTraitInsteadOf(StringValue funName, java.lang.String traitName, java.lang.String insteadofTraitName)
void	addTraits(java.util.HashSet<java.lang.String> traitSet) Adds the interfaces to the set
Value	callNew(Env env, Expr[] args) Creates a new instance.
Value	callNew(Env env, Value[] args) Creates a new instance.
ObjectValue	createObject(Env env, QuercusClass cls) Creates a new object.
java.util.Set<java.util.Map.Entry<StringValue,ClassField>>	fieldSet()
Expr	findConstant(java.lang.String name) Finds the matching constant
abstract AbstractFunction	findConstructor() Returns the constructor
java.util.Set<java.util.Map.Entry<StringValue,AbstractFunction>>	functionSet()
AbstractFunction	getCall()
AbstractFunction	getCallStatic()
java.lang.String	getComment() Returns the documentation for this class.
java.lang.String	getExtension() Returns the name of the extension that this class is part of.
ClassField	getField(StringValue name)
java.lang.String	getFieldComment(StringValue name) Returns the comment for the specified field.
java.lang.String[]	getInterfaces() Returns the interfaces.
Location	getLocation() Returns the location for where the class was defined, null if it is unknown.
java.lang.String	getName() Returns the name.
java.lang.String	getParentName() Returns the parent name.
AbstractFunction	getSerialize()
java.lang.String	getStaticFieldComment(StringValue name) Returns the comment for the specified static field.
TraitAliasMap	getTraitAliasMap()
TraitInsteadofMap	getTraitInsteadofMap()
java.lang.String[]	getTraits() Returns the interfaces.
AbstractFunction	getUnserialize()
boolean	hasNonPublicMethods() Returns true if the class has private/protected methods.
boolean	hasTrait(java.lang.String traitName) Returns true if this class locally declares usage of this trait.
void	init()
void	init(QuercusClass cl)
void	initClassFields(QuercusClass cl, java.lang.String bindingClassName) Initialize the quercus class fields.
void	initClassMethods(QuercusClass cl, java.lang.String bindingClassName) Initialize the quercus class methods.
boolean	isA(Env env, java.lang.String name) Returns value for instanceof.
boolean	isAbstract() Return true for an abstract class.
boolean	isFinal() Returns true for a final class.
boolean	isInterface() Return true for an interface class.
boolean	isTrait() True for an trait class.
ClassDef	loadClassDef() forces a load of any lazy ClassDef
java.util.Set<java.util.Map.Entry<StringValue,ClassDef.StaticFieldEntry>>	staticFieldSet()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.caucho.quercus.program.InstanceInitializer

initInstance

Field Detail

NULL_STRING_ARRAY

protected static final java.lang.String[] NULL_STRING_ARRAY

Constructor Detail

ClassDef

protected ClassDef(Location location,
                   java.lang.String name,
                   java.lang.String parentName)

ClassDef

protected ClassDef(Location location,
                   java.lang.String name,
                   java.lang.String parentName,
                   java.lang.String[] ifaceList)

ClassDef

protected ClassDef(Location location,
                   java.lang.String name,
                   java.lang.String parentName,
                   java.lang.String[] ifaceList,
                   java.lang.String[] traitList)

Method Detail

getLocation

public Location getLocation()

Returns the location for where the class was defined, null if it is unknown.

getName

public java.lang.String getName()

Returns the name.

getParentName

public java.lang.String getParentName()

Returns the parent name.

getExtension

public java.lang.String getExtension()

Returns the name of the extension that this class is part of.

addInterface

protected void addInterface(java.lang.String iface)

addTrait

public void addTrait(java.lang.String trait)

Adds a PHP 5.4 trait.

hasTrait

public boolean hasTrait(java.lang.String traitName)

Returns true if this class locally declares usage of this trait.

getTraitInsteadofMap

public final TraitInsteadofMap getTraitInsteadofMap()

getTraitAliasMap

public final TraitAliasMap getTraitAliasMap()

addTraitInsteadOf

public void addTraitInsteadOf(StringValue funName,
                              java.lang.String traitName,
                              java.lang.String insteadofTraitName)

addTraitAlias

public void addTraitAlias(StringValue funName,
                          StringValue funNameAlias,
                          java.lang.String traitName)

loadClassDef

public ClassDef loadClassDef()

forces a load of any lazy ClassDef

getCall

public AbstractFunction getCall()

getCallStatic

public AbstractFunction getCallStatic()

getSerialize

public AbstractFunction getSerialize()

getUnserialize

public AbstractFunction getUnserialize()

init

public void init()

init

public void init(QuercusClass cl)

getInterfaces

public java.lang.String[] getInterfaces()

Returns the interfaces.

getTraits

public java.lang.String[] getTraits()

Returns the interfaces.

addInterfaces

public void addInterfaces(java.util.HashSet<java.lang.String> interfaceSet)

Adds the interfaces to the set

addTraits

public void addTraits(java.util.HashSet<java.lang.String> traitSet)

Adds the interfaces to the set

isAbstract

public boolean isAbstract()

Return true for an abstract class.

isInterface

public boolean isInterface()

Return true for an interface class.

isTrait

public boolean isTrait()

True for an trait class.

isFinal

public boolean isFinal()

Returns true for a final class.

hasNonPublicMethods

public boolean hasNonPublicMethods()

Returns true if the class has private/protected methods.

initClassMethods

public void initClassMethods(QuercusClass cl,
                             java.lang.String bindingClassName)

Initialize the quercus class methods.

Parameters:

cl - add methods to this QuercusClass

bindingClassName - name of the owning class (for __CLASS__ resolution)

initClassFields

public void initClassFields(QuercusClass cl,
                            java.lang.String bindingClassName)

Initialize the quercus class fields.

Parameters:

cl - add fields to this QuercusClass

bindingClassName - name of the owning class (for static fields)

createObject

public ObjectValue createObject(Env env,
                                QuercusClass cls)

Creates a new object.

callNew

public Value callNew(Env env,
                     Expr[] args)

Creates a new instance.

callNew

public Value callNew(Env env,
                     Value[] args)

Creates a new instance.

isA

public boolean isA(Env env,
                   java.lang.String name)

Returns value for instanceof.

findConstructor

public abstract AbstractFunction findConstructor()

Returns the constructor

findConstant

public Expr findConstant(java.lang.String name)

Finds the matching constant

getComment

public java.lang.String getComment()

Returns the documentation for this class.

getFieldComment

public java.lang.String getFieldComment(StringValue name)

Returns the comment for the specified field.

getStaticFieldComment

public java.lang.String getStaticFieldComment(StringValue name)

Returns the comment for the specified static field.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

fieldSet

public java.util.Set<java.util.Map.Entry<StringValue,ClassField>> fieldSet()

getField

public ClassField getField(StringValue name)

staticFieldSet

public java.util.Set<java.util.Map.Entry<StringValue,ClassDef.StaticFieldEntry>> staticFieldSet()

functionSet

public java.util.Set<java.util.Map.Entry<StringValue,AbstractFunction>> functionSet()