com.gargoylesoftware.htmlunit.javascript.configuration

Class ClassConfiguration

java.lang.Object

com.gargoylesoftware.htmlunit.javascript.configuration.ClassConfiguration

public final class ClassConfiguration
extends Object

A container for all the JavaScript configuration information for one class.

Version:

$Revision: 10726 $

Author:

Mike Bowler, Chris Erskine, Ahmed Ashour, Ronald Brill

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClassConfiguration.PropertyInfo Class used to contain the property information if the property is readable, writable and the methods that implement the get and set functions.

Constructor Summary

Constructors

Constructor and Description
ClassConfiguration(Class<? extends SimpleScriptable> hostClass, Class<?>[] domClasses, boolean jsObject, boolean definedInStandardsMode, String className) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addConstant(String name) Add the constant to the configuration.
void	addFunction(Method method) Add the function to the configuration.
void	addProperty(String name, Method getter, Method setter) Add the property to the configuration.
void	addStaticFunction(Method method) Add the static function to the configuration.
void	addStaticProperty(String name, Method getter, Method setter) Add the static property to the configuration.
String	getClassName() Returns the class name.
List<String>	getConstants() Returns the constant list.
Class<?>[]	getDomClasses() Returns the DOM classes.
String	getExtendedClassName()
Set<Map.Entry<String,Method>>	getFunctionEntries() Returns the set of entries for the defined functions.
Set<String>	getFunctionKeys() Returns the set of keys for the defined functions.
Class<? extends SimpleScriptable>	getHostClass() Gets the class of the JavaScript host object.
Member	getJsConstructor() Gets the JavaScript constructor method in getHostClass().
Set<Map.Entry<String,ClassConfiguration.PropertyInfo>>	getPropertyEntries() Returns the set of entries for the defined properties.
Set<Map.Entry<String,Method>>	getStaticFunctionEntries() Returns the set of entries for the defined static functions.
Set<Map.Entry<String,ClassConfiguration.PropertyInfo>>	getStaticPropertyEntries() Returns the set of entries for the defined static properties.
boolean	isDefinedInStandardsMode() Returns whether the class should be defined in only Standards Mode.
boolean	isJsObject()

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassConfiguration

public ClassConfiguration(Class<? extends SimpleScriptable> hostClass,
                  Class<?>[] domClasses,
                  boolean jsObject,
                  boolean definedInStandardsMode,
                  String className)

Constructor.

Parameters:

hostClass - - the class implementing this functionality

domClasses - the DOM classes that this object supports

jsObject - boolean flag for if this object is a JavaScript object

definedInStandardsMode - should be defined in only Standards Mode

className - the class name, can be null

Method Detail

addProperty

public void addProperty(String name,
               Method getter,
               Method setter)

Add the property to the configuration.

Parameters:

name - name of the property

getter - the getter method

setter - the setter method

addStaticProperty

public void addStaticProperty(String name,
                     Method getter,
                     Method setter)

Add the static property to the configuration.

Parameters:

name - name of the static property

getter - the static getter method

setter - the static setter method

addConstant

public void addConstant(String name)

Add the constant to the configuration.

Parameters:

name - - Name of the configuration

getPropertyEntries

public Set<Map.Entry<String,ClassConfiguration.PropertyInfo>> getPropertyEntries()

Returns the set of entries for the defined properties.

Returns:

a set

getStaticPropertyEntries

public Set<Map.Entry<String,ClassConfiguration.PropertyInfo>> getStaticPropertyEntries()

Returns the set of entries for the defined static properties.

Returns:

a set

getFunctionEntries

public Set<Map.Entry<String,Method>> getFunctionEntries()

Returns the set of entries for the defined functions.

Returns:

a set

getStaticFunctionEntries

public Set<Map.Entry<String,Method>> getStaticFunctionEntries()

Returns the set of entries for the defined static functions.

Returns:

a set

getFunctionKeys

public Set<String> getFunctionKeys()

Returns the set of keys for the defined functions.

Returns:

a set

getConstants

public List<String> getConstants()

Returns the constant list.

Returns:

a list

addFunction

public void addFunction(Method method)

Add the function to the configuration.

Parameters:

method - the method

addStaticFunction

public void addStaticFunction(Method method)

Add the static function to the configuration.

Parameters:

method - the method

getExtendedClassName

public String getExtendedClassName()

Returns:

the extendedClass

getHostClass

public Class<? extends SimpleScriptable> getHostClass()

Gets the class of the JavaScript host object.

Returns:

the class of the JavaScript host object

getJsConstructor

public Member getJsConstructor()

Gets the JavaScript constructor method in getHostClass().

Returns:

the JavaScript constructor method in getHostClass()

getDomClasses

public Class<?>[] getDomClasses()

Returns the DOM classes.

Returns:

the DOM classes

isJsObject

public boolean isJsObject()

Returns:

the jsObject

isDefinedInStandardsMode

public boolean isDefinedInStandardsMode()

Returns whether the class should be defined in only Standards Mode.

Returns:

defineInStandardsMode

getClassName

public String getClassName()

Returns the class name.

Returns:

the class name