com.opensymphony.xwork2.config.entities
Class PackageConfig

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

public class PackageConfig
extends Located
implements Comparable, Serializable, InterceptorLocator

Configuration for Package.

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

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

Nested Class Summary
static class PackageConfig.Builder
          The builder for this object.
 
Field Summary
private  Map<String,ActionConfig> actionConfigs
           
private  String defaultActionRef
           
private  String defaultClassRef
           
private  String defaultInterceptorRef
           
private  String defaultResultType
           
private  List<ExceptionMappingConfig> globalExceptionMappingConfigs
           
private  Map<String,ResultConfig> globalResultConfigs
           
private  Map<String,Object> interceptorConfigs
           
private  boolean isAbstract
           
private static Logger LOG
           
private  String name
           
private  String namespace
           
private  boolean needsRefresh
           
private  List<PackageConfig> parents
           
private  Map<String,ResultTypeConfig> resultTypeConfigs
           
 
Fields inherited from class com.opensymphony.xwork2.util.location.Located
location
 
Constructor Summary
protected PackageConfig(PackageConfig orig)
           
protected PackageConfig(String name)
           
 
Method Summary
 int compareTo(Object o)
           
 boolean equals(Object o)
           
 Map<String,ActionConfig> getActionConfigs()
           
 Map<String,ActionConfig> getAllActionConfigs()
          returns the Map of all the ActionConfigs available in the current package.
 List<ExceptionMappingConfig> getAllExceptionMappingConfigs()
          returns the List of all the ExceptionMappingConfigs available in the current package.
 Map<String,ResultConfig> getAllGlobalResults()
          returns the Map of all the global ResultConfigs available in the current package.
 Map<String,Object> getAllInterceptorConfigs()
          returns the Map of all InterceptorConfigs and InterceptorStackConfigs available in the current package.
 Map<String,ResultTypeConfig> getAllResultTypeConfigs()
          returns the Map of all the ResultTypeConfigs available in the current package.
 String getDefaultActionRef()
           
 String getDefaultClassRef()
           
 String getDefaultInterceptorRef()
           
 String getDefaultResultType()
          Returns the default result type 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<ExceptionMappingConfig> getGlobalExceptionMappingConfigs()
          gets the ExceptionMappingConfigs local to this package
 Map<String,ResultConfig> getGlobalResultConfigs()
          gets the global ResultConfigs local to this package
 Object getInterceptorConfig(String name)
          Gets an interceptor configuration object.
 Map<String,Object> getInterceptorConfigs()
          gets the InterceptorConfigs and InterceptorStackConfigs local to this package
 String getName()
           
 String getNamespace()
           
 List<PackageConfig> getParents()
           
 Map<String,ResultTypeConfig> getResultTypeConfigs()
          gets the ResultTypeConfigs local to this package
 int hashCode()
           
 boolean isAbstract()
           
 boolean isNeedsRefresh()
           
 String toString()
           
 
Methods inherited from class com.opensymphony.xwork2.util.location.Located
getLocation, setLocation
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

LOG

private static final Logger LOG

actionConfigs

private Map<String,ActionConfig> actionConfigs

globalResultConfigs

private Map<String,ResultConfig> globalResultConfigs

interceptorConfigs

private Map<String,Object> interceptorConfigs

resultTypeConfigs

private Map<String,ResultTypeConfig> resultTypeConfigs

globalExceptionMappingConfigs

private List<ExceptionMappingConfig> globalExceptionMappingConfigs

parents

private List<PackageConfig> parents

defaultInterceptorRef

private String defaultInterceptorRef

defaultActionRef

private String defaultActionRef

defaultResultType

private String defaultResultType

defaultClassRef

private String defaultClassRef

name

private String name

namespace

private String namespace

isAbstract

private boolean isAbstract

needsRefresh

private boolean needsRefresh
Constructor Detail

PackageConfig

protected PackageConfig(String name)

PackageConfig

protected PackageConfig(PackageConfig orig)
Method Detail

isAbstract

public boolean isAbstract()

getActionConfigs

public Map<String,ActionConfig> getActionConfigs()

getAllActionConfigs

public Map<String,ActionConfig> 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<String,ResultConfig> 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<String,Object> 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<String,ResultTypeConfig> 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<ExceptionMappingConfig> 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

getDefaultInterceptorRef

public String getDefaultInterceptorRef()

getDefaultActionRef

public String getDefaultActionRef()

getDefaultClassRef

public String getDefaultClassRef()

getDefaultResultType

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


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<String,ResultConfig> 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<String,Object> 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

getName

public String getName()

getNamespace

public String getNamespace()

getParents

public List<PackageConfig> getParents()

getResultTypeConfigs

public Map<String,ResultTypeConfig> getResultTypeConfigs()
gets the ResultTypeConfigs local to this package

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

isNeedsRefresh

public boolean isNeedsRefresh()

getGlobalExceptionMappingConfigs

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

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

equals

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

hashCode

public int hashCode()
Overrides:
hashCode in class Object

toString

public String toString()
Overrides:
toString in class Object

compareTo

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

getInterceptorConfig

public Object getInterceptorConfig(String name)
Description copied from interface: InterceptorLocator
Gets an interceptor configuration object.

Specified by:
getInterceptorConfig in interface InterceptorLocator
Parameters:
name - The interceptor or interceptor stack name
Returns:
Either an InterceptorConfig or InterceptorStackConfig object


Copyright © 2000-2009 Apache Software Foundation. All Rights Reserved.