org.torweg.pulse.bundle
Class ActionConfiguration

java.lang.Object
  org.torweg.pulse.bundle.ActionConfiguration

All Implemented Interfaces:

java.io.Serializable

public final class ActionConfiguration
extends java.lang.Object
implements java.io.Serializable

contains the method configurations for an action.

Version:

$Revision: 1954 $

Author:

Thomas Weber

See Also:

Serialized Form

Constructor Summary

ActionConfiguration(java.lang.String a)
creates a new ActionConfiguration for the given action.

Method Summary

void	add(ControllerMethodConfiguration conf) adds a method configuration to the action configuration.
boolean	equals(java.lang.Object obj) returns whether the given object is equal to this ActionConfiguration.
java.lang.String	getAction() returns the name of the action.
java.util.Set<ControllerMethodConfiguration>	getMethodConfigurations() returns the method configurations.
Action.Security	getSecurity() returns the required level of security.
int	hashCode() returns the hash code of the ActionConfiguration, which is based upon the action's name.
boolean	isGenerate() returns whether the actions is to be generated.
boolean	isStripSitemapId() returns whether the sitemap-id shall be stripped from generated actions.
boolean	isStripSuffix() returns whether the suffix shall be stripped from generated actions.
boolean	isUploadAllowed() returns whether uploads are allowed for the action.

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionConfiguration

public ActionConfiguration(java.lang.String a)

creates a new ActionConfiguration for the given action.

Parameters:

a - the action

Method Detail

add

public void add(ControllerMethodConfiguration conf)

adds a method configuration to the action configuration.

Parameters:

conf - the method configuration to add

getAction

public java.lang.String getAction()

returns the name of the action.

Returns:

the name of the action

getMethodConfigurations

public java.util.Set<ControllerMethodConfiguration> getMethodConfigurations()

returns the method configurations.

Returns:

an unmodifiable view of the method configurations

isGenerate

public boolean isGenerate()

returns whether the actions is to be generated.

Returns:

whether the actions is to be generated

isStripSitemapId

public boolean isStripSitemapId()

returns whether the sitemap-id shall be stripped from generated actions.

Returns:

whether the sitemap-id shall be stripped from generated actions

isStripSuffix

public boolean isStripSuffix()

returns whether the suffix shall be stripped from generated actions.

Returns:

whether the suffix shall be stripped from generated actions

isUploadAllowed

public boolean isUploadAllowed()

returns whether uploads are allowed for the action.

Returns:

whether uploads are allowed for the action

getSecurity

public Action.Security getSecurity()

returns the required level of security.

Returns:

the level of security

hashCode

public int hashCode()

returns the hash code of the ActionConfiguration, which is based upon the action's name.

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code

See Also:

Object.hashCode()

equals

public boolean equals(java.lang.Object obj)

returns whether the given object is equal to this ActionConfiguration.

Two ActionConfigurations are considered equal, if they belong to the same action.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to check against

Returns:

true, if and only if the given object is a ActionConfiguration and the action matches this action.

See Also:

Object.equals(java.lang.Object)