org.jboss.shrinkwrap.descriptor.api.webcommon30
Interface ErrorPageType<T>

All Superinterfaces:
org.jboss.shrinkwrap.descriptor.api.Child<T>
All Known Implementing Classes:
ErrorPageTypeImpl

public interface ErrorPageType<T>
extends org.jboss.shrinkwrap.descriptor.api.Child<T>

This interface defines the contract for the error-pageType xsd type

Original Documentation:



The error-pageType contains a mapping between an error code
or exception type to the path of a resource in the web
application.

Error-page declarations using the exception-type element in
the deployment descriptor must be unique up to the class name of
the exception-type. Similarly, error-page declarations using the
status-code element must be unique in the deployment descriptor
up to the status code.

Used in: web-app


Since:
Generation date :2011-07-19T22:55:02.759+02:00
Author:
Ralf Battenfeld

Method Summary
 java.lang.Integer getErrorCode()
          Returns the error-code element
 java.lang.String getExceptionType()
          Returns the exception-type element
 java.lang.String getLocation()
          Returns the location element
 ErrorPageType<T> removeErrorCode()
          Removes the error-code element
 ErrorPageType<T> removeExceptionType()
          Removes the exception-type element
 ErrorPageType<T> removeLocation()
          Removes the location element
 ErrorPageType<T> setErrorCode(java.lang.Integer errorCode)
          If not already created, a new error-code element with the given value will be created.
 ErrorPageType<T> setExceptionType(java.lang.String exceptionType)
          If not already created, a new exception-type element with the given value will be created.
 ErrorPageType<T> setLocation(java.lang.String location)
          If not already created, a new location element with the given value will be created.
 
Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child
up
 

Method Detail

setLocation

ErrorPageType<T> setLocation(java.lang.String location)
If not already created, a new location element with the given value will be created. Otherwise, the existing location element will be updated with the given value.

Returns:
the current instance of ErrorPageType

removeLocation

ErrorPageType<T> removeLocation()
Removes the location element

Returns:
the current instance of ErrorPageType

getLocation

java.lang.String getLocation()
Returns the location element

Returns:
the node defined for the element location

setErrorCode

ErrorPageType<T> setErrorCode(java.lang.Integer errorCode)
If not already created, a new error-code element with the given value will be created. Otherwise, the existing error-code element will be updated with the given value.

Returns:
the current instance of ErrorPageType

removeErrorCode

ErrorPageType<T> removeErrorCode()
Removes the error-code element

Returns:
the current instance of ErrorPageType

getErrorCode

java.lang.Integer getErrorCode()
Returns the error-code element

Returns:
the node defined for the element error-code

setExceptionType

ErrorPageType<T> setExceptionType(java.lang.String exceptionType)
If not already created, a new exception-type element with the given value will be created. Otherwise, the existing exception-type element will be updated with the given value.

Returns:
the current instance of ErrorPageType

removeExceptionType

ErrorPageType<T> removeExceptionType()
Removes the exception-type element

Returns:
the current instance of ErrorPageType

getExceptionType

java.lang.String getExceptionType()
Returns the exception-type element

Returns:
the node defined for the element exception-type