javawebparts.ajaxparts.taglib.config
Class AjaxHandlerConfig

java.lang.Object
  |
  +--javawebparts.ajaxparts.taglib.config.AjaxHandlerConfig

public class AjaxHandlerConfig

extends java.lang.Object

This class holds configuration information on a handler, standard or custom.

Author:

Frank W. Zammetti

Field Summary

private boolean	frozen Flag: Is the configuration frozen?
private java.lang.String	function The Javascript function name this handler will be called as.
private java.lang.String	location Location of Javascript for this handler (local if the developer will include the script himself, or the path to an external .js file)
private static org.apache.commons.logging.Log	log Log instance.
private java.lang.String	name The name this handler will be known and reference by.
private java.lang.String	stdOrCustom Is this a standard or custom handler?
private java.lang.String	type The type of the handler (request or response).

Constructor Summary

AjaxHandlerConfig()

Method Summary

void	freeze() Freezes the configuration of this object.
java.lang.String	getFunction() name accessor.
java.lang.String	getLocation() name accessor.
java.lang.String	getName() name accessor.
java.lang.String	getType() type accessor.
boolean	isCustom() Indicates if the handler instance is a custom type.
boolean	isFrozen() Returns true if this onject's config is frozen, false otherwise.
boolean	isSTD() Indicates if the handler instance is a standard type.
void	setCustom() Flags that the handler instance is a custom type.
void	setFunction(java.lang.String inFunction) function mutator.
void	setLocation(java.lang.String inLocation) location mutator.
void	setName(java.lang.String inName) name mutator.
void	setSTD() Flags that the handler instance is a standard type.
void	setType(java.lang.String inType) type mutator.
java.lang.String	toString() Overriden toString method.
private boolean	validate() This method is called when the object is frozen to ensure it is configured in a legal way.

Methods inherited from class java.lang.Object

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

Field Detail

log

private static org.apache.commons.logging.Log log

Log instance.

name

private java.lang.String name

The name this handler will be known and reference by.

type

private java.lang.String type

The type of the handler (request or response).

function

private java.lang.String function

The Javascript function name this handler will be called as.

location

private java.lang.String location

Location of Javascript for this handler (local if the developer will include the script himself, or the path to an external .js file)

stdOrCustom

private java.lang.String stdOrCustom

Is this a standard or custom handler?

frozen

private boolean frozen

Flag: Is the configuration frozen?

Constructor Detail

AjaxHandlerConfig

public AjaxHandlerConfig()

Method Detail

setName

public void setName(java.lang.String inName)

name mutator.

Parameters:

inName - Name to set.

getName

public java.lang.String getName()

name accessor.

Returns:

The name.

setType

public void setType(java.lang.String inType)

type mutator.

Parameters:

inType - Type to set.

getType

public java.lang.String getType()

type accessor.

Returns:

The type.

setFunction

public void setFunction(java.lang.String inFunction)

function mutator.

Parameters:

inFunction - Function to set.

getFunction

public java.lang.String getFunction()

name accessor.

Returns:

The function.

setLocation

public void setLocation(java.lang.String inLocation)

location mutator.

Parameters:

inLocation - Location to set.

getLocation

public java.lang.String getLocation()

name accessor.

Returns:

The location.

setSTD

public void setSTD()

Flags that the handler instance is a standard type.

setCustom

public void setCustom()

Flags that the handler instance is a custom type.

isSTD

public boolean isSTD()

Indicates if the handler instance is a standard type.

Returns:

True if it is a standard type, false if not.

isCustom

public boolean isCustom()

Indicates if the handler instance is a custom type.

Returns:

True if it is a custom type, false if not.

freeze

public void freeze()

Freezes the configuration of this object.

isFrozen

public boolean isFrozen()

Returns true if this onject's config is frozen, false otherwise.

Returns:

True if frozen, false if not.

validate

private boolean validate()

This method is called when the object is frozen to ensure it is configured in a legal way.

Returns:

True if validation passes, false if not.

toString

public java.lang.String toString()

Overriden toString method.

Overrides:

toString in class java.lang.Object

Returns:

A reflexively-built string representation of this bean