com.opensymphony.xwork.config.entities
Class PackageConfig

java.lang.Object
  extended by com.opensymphony.xwork.util.location.Located
      extended by com.opensymphony.xwork.config.entities.PackageConfig
All Implemented Interfaces:
Locatable, Serializable, Comparable

public class PackageConfig
extends Located
implements Comparable, Serializable

Configuration for Package.

In the xml configuration file this is defined as the package tag.

Version:
$Revision: 983 $
Author:
Rainer Hermanns
See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.opensymphony.xwork.util.location.Located
location
 
Constructor Summary
PackageConfig()
           
PackageConfig(String name)
           
PackageConfig(String name, String namespace, boolean isAbstract, ExternalReferenceResolver externalRefResolver)
           
PackageConfig(String name, String namespace, boolean isAbstract, ExternalReferenceResolver externalRefResolver, List parents)
           
 
Method Summary
 void addActionConfig(String name, ActionConfig action)
           
 void addAllParents(List parents)
           
 void addExceptionMappingConfig(ExceptionMappingConfig exceptionMappingConfig)
           
 void addGlobalExceptionMappingConfigs(List exceptionMappingConfigs)
           
 void addGlobalResultConfig(ResultConfig resultConfig)
           
 void addGlobalResultConfigs(Map resultConfigs)
           
 void addInterceptorConfig(InterceptorConfig config)
           
 void addInterceptorStackConfig(InterceptorStackConfig config)
           
 void addParent(PackageConfig parent)
           
 void addResultTypeConfig(ResultTypeConfig config)
           
 int compareTo(Object o)
           
 boolean equals(Object o)
           
 Map getActionConfigs()
           
 Map getAllActionConfigs()
          returns the Map of all the ActionConfigs available in the current package.
 List getAllExceptionMappingConfigs()
          returns the List of all the ExceptionMappingConfigs available in the current package.
 Map getAllGlobalResults()
          returns the Map of all the global ResultConfigs available in the current package.
 Map getAllInterceptorConfigs()
          returns the Map of all InterceptorConfigs and InterceptorStackConfigs available in the current package.
 Map getAllResultTypeConfigs()
          returns the Map of all the ResultTypeConfigs available in the current package.
 String getDefaultActionRef()
           
 String getDefaultInterceptorRef()
           
 String getDefaultResultType()
          Returns the default result type for this package.
 ExternalReferenceResolver getExternalRefResolver()
          Gets the Reference resolver for this package.
 String getFullDefaultActionRef()
          gets the default action-ref name.
 String getFullDefaultInterceptorRef()
          gets the default interceptor-ref name.
 String getFullDefaultResultType()
          Returns the default result type for this package.
 List getGlobalExceptionMappingConfigs()
          gets the ExceptionMappingConfigs local to this package
 Map getGlobalResultConfigs()
          gets the global ResultConfigs local to this package
 Map getInterceptorConfigs()
          gets the InterceptorConfigs and InterceptorStackConfigs local to this package
 String getName()
           
 String getNamespace()
           
 List getParents()
           
 Map getResultTypeConfigs()
          gets the ResultTypeConfigs local to this package
 int hashCode()
           
 boolean isAbstract()
           
 void removeParent(PackageConfig parent)
           
 void setAbstract(boolean isAbstract)
           
 void setDefaultActionRef(String name)
           
 void setDefaultInterceptorRef(String name)
           
 void setDefaultResultType(String defaultResultType)
          sets the default Result type for this package
 void setExternalRefResolver(ExternalReferenceResolver externalRefResolver)
           
 void setName(String name)
           
 void setNamespace(String namespace)
           
 String toString()
           
 
Methods inherited from class com.opensymphony.xwork.util.location.Located
getLocation, setLocation
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PackageConfig

public PackageConfig()

PackageConfig

public PackageConfig(String name)

PackageConfig

public PackageConfig(String name,
                     String namespace,
                     boolean isAbstract,
                     ExternalReferenceResolver externalRefResolver)

PackageConfig

public PackageConfig(String name,
                     String namespace,
                     boolean isAbstract,
                     ExternalReferenceResolver externalRefResolver,
                     List parents)
Method Detail

setAbstract

public void setAbstract(boolean isAbstract)

isAbstract

public boolean isAbstract()

getActionConfigs

public Map getActionConfigs()

getAllActionConfigs

public Map getAllActionConfigs()
returns the Map of all the ActionConfigs available in the current package. ActionConfigs defined in ancestor packages will be included in this Map.

Returns:
a Map of ActionConfig Objects with the action name as the key
See Also:
ActionConfig

getAllGlobalResults

public Map getAllGlobalResults()
returns the Map of all the global ResultConfigs available in the current package. Global ResultConfigs defined in ancestor packages will be included in this Map.

Returns:
a Map of Result Objects with the result name as the key
See Also:
ResultConfig

getAllInterceptorConfigs

public Map getAllInterceptorConfigs()
returns the Map of all InterceptorConfigs and InterceptorStackConfigs available in the current package. InterceptorConfigs defined in ancestor packages will be included in this Map.

Returns:
a Map of InterceptorConfig and InterceptorStackConfig Objects with the ref-name as the key
See Also:
InterceptorConfig, InterceptorStackConfig

getAllResultTypeConfigs

public Map getAllResultTypeConfigs()
returns the Map of all the ResultTypeConfigs available in the current package. ResultTypeConfigs defined in ancestor packages will be included in this Map.

Returns:
a Map of ResultTypeConfig Objects with the result type name as the key
See Also:
ResultTypeConfig

getAllExceptionMappingConfigs

public List getAllExceptionMappingConfigs()
returns the List of all the ExceptionMappingConfigs available in the current package. ExceptionMappingConfigs defined in ancestor packages will be included in this list.

Returns:
a List of ExceptionMappingConfigs Objects with the result type name as the key
See Also:
ExceptionMappingConfig

setDefaultInterceptorRef

public void setDefaultInterceptorRef(String name)

getDefaultInterceptorRef

public String getDefaultInterceptorRef()

setDefaultActionRef

public void setDefaultActionRef(String name)

getDefaultActionRef

public String getDefaultActionRef()

setDefaultResultType

public void setDefaultResultType(String defaultResultType)
sets the default Result type for this package

Parameters:
defaultResultType -

getDefaultResultType

public String getDefaultResultType()
Returns the default result type for this package.


setExternalRefResolver

public void setExternalRefResolver(ExternalReferenceResolver externalRefResolver)
Parameters:
externalRefResolver - The externalRefResolver to set.

getExternalRefResolver

public ExternalReferenceResolver getExternalRefResolver()
Gets the Reference resolver for this package. If the resolver for this package is not specified, the method will try and find one on one of the parent packages

Returns:
Returns the externalRefResolver.

getFullDefaultInterceptorRef

public String getFullDefaultInterceptorRef()
gets the default interceptor-ref name. If this is not set on this PackageConfig, it searches the parent PackageConfigs in order until it finds one.


getFullDefaultActionRef

public String getFullDefaultActionRef()
gets the default action-ref name. If this is not set on this PackageConfig, it searches the parent PackageConfigs in order until it finds one.


getFullDefaultResultType

public String getFullDefaultResultType()
Returns the default result type for this package.

If there is no default result type, but this package has parents - we will try to look up the default result type of a parent.


getGlobalResultConfigs

public Map getGlobalResultConfigs()
gets the global ResultConfigs local to this package

Returns:
a Map of ResultConfig objects keyed by result name
See Also:
ResultConfig

getInterceptorConfigs

public Map getInterceptorConfigs()
gets the InterceptorConfigs and InterceptorStackConfigs local to this package

Returns:
a Map of InterceptorConfig and InterceptorStackConfig objects keyed by ref-name
See Also:
InterceptorConfig, InterceptorStackConfig

setName

public void setName(String name)

getName

public String getName()

setNamespace

public void setNamespace(String namespace)

getNamespace

public String getNamespace()

getParents

public List getParents()

getResultTypeConfigs

public Map getResultTypeConfigs()
gets the ResultTypeConfigs local to this package

Returns:
a Map of ResultTypeConfig objects keyed by result name
See Also:
ResultTypeConfig

getGlobalExceptionMappingConfigs

public List getGlobalExceptionMappingConfigs()
gets the ExceptionMappingConfigs local to this package

Returns:
a Map of ExceptionMappingConfig objects keyed by result name
See Also:
ExceptionMappingConfig

addActionConfig

public void addActionConfig(String name,
                            ActionConfig action)

addAllParents

public void addAllParents(List parents)

addGlobalResultConfig

public void addGlobalResultConfig(ResultConfig resultConfig)

addGlobalResultConfigs

public void addGlobalResultConfigs(Map resultConfigs)

addExceptionMappingConfig

public void addExceptionMappingConfig(ExceptionMappingConfig exceptionMappingConfig)

addGlobalExceptionMappingConfigs

public void addGlobalExceptionMappingConfigs(List exceptionMappingConfigs)

addInterceptorConfig

public void addInterceptorConfig(InterceptorConfig config)

addInterceptorStackConfig

public void addInterceptorStackConfig(InterceptorStackConfig config)

addParent

public void addParent(PackageConfig parent)

addResultTypeConfig

public void addResultTypeConfig(ResultTypeConfig config)

equals

public boolean equals(Object o)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

removeParent

public void removeParent(PackageConfig parent)

toString

public String toString()
Overrides:
toString in class Object

compareTo

public int compareTo(Object o)
Specified by:
compareTo in interface Comparable

XWork Project Page