net.sourceforge.ccxjc.it.model.priv.indexed.valueclass.javaee
Class FilterType

java.lang.Object
  net.sourceforge.ccxjc.it.model.priv.indexed.valueclass.javaee.FilterType

All Implemented Interfaces:

Serializable, Cloneable

public class FilterType
extends Object
implements Serializable, Cloneable

The filterType is used to declare a filter in the web application. The filter is mapped to either a servlet or a URL pattern in the filter-mapping element, using the filter-name value to reference. Filters can access the initialization parameters declared in the deployment descriptor at runtime via the FilterConfig interface. Used in: web-app

Java class for filterType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="filterType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <group ref="{http://java.sun.com/xml/ns/javaee}descriptionGroup"/>
         <element name="filter-name" type="{http://java.sun.com/xml/ns/javaee}filter-nameType"/>
         <element name="filter-class" type="{http://java.sun.com/xml/ns/javaee}fully-qualified-classType"/>
         <element name="init-param" type="{http://java.sun.com/xml/ns/javaee}param-valueType" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="id" type="{http://www.w3.org/2001/XMLSchema}ID" />
     </restriction>
   </complexContent>
 </complexType>
 

See Also:

Serialized Form

Field Summary

protected DescriptionType[]	description
protected DisplayNameType[]	displayName
protected FullyQualifiedClassType	filterClass
protected FilterNameType	filterName
protected IconType[]	icon
protected String	id
protected ParamValueType[]	initParam

Constructor Summary

FilterType()
Creates a new net.sourceforge.ccxjc.it.model.priv.indexed.valueclass.javaee.FilterType instance.

FilterType(FilterType o)
Creates a new net.sourceforge.ccxjc.it.model.priv.indexed.valueclass.javaee.FilterType instance by copying a given instance.

Method Summary

FilterType	clone() Creates and returns a copy of this object.
DescriptionType[]	getDescription()
DescriptionType	getDescription(int idx)
int	getDescriptionLength()
DisplayNameType[]	getDisplayName()
DisplayNameType	getDisplayName(int idx)
int	getDisplayNameLength()
FullyQualifiedClassType	getFilterClass() Gets the value of the filterClass property.
FilterNameType	getFilterName() Gets the value of the filterName property.
IconType[]	getIcon()
IconType	getIcon(int idx)
int	getIconLength()
String	getId() Gets the value of the id property.
ParamValueType[]	getInitParam()
ParamValueType	getInitParam(int idx)
int	getInitParamLength()
void	setDescription(DescriptionType[] values)
DescriptionType	setDescription(int idx, DescriptionType value)
void	setDisplayName(DisplayNameType[] values)
DisplayNameType	setDisplayName(int idx, DisplayNameType value)
void	setFilterClass(FullyQualifiedClassType value) Sets the value of the filterClass property.
void	setFilterName(FilterNameType value) Sets the value of the filterName property.
void	setIcon(IconType[] values)
IconType	setIcon(int idx, IconType value)
void	setId(String value) Sets the value of the id property.
ParamValueType	setInitParam(int idx, ParamValueType value)
void	setInitParam(ParamValueType[] values)

Methods inherited from class java.lang.Object

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

Field Detail

description

protected DescriptionType[] description

displayName

protected DisplayNameType[] displayName

icon

protected IconType[] icon

filterName

protected FilterNameType filterName

filterClass

protected FullyQualifiedClassType filterClass

initParam

protected ParamValueType[] initParam

id

protected String id

Constructor Detail

FilterType

public FilterType()

Creates a new net.sourceforge.ccxjc.it.model.priv.indexed.valueclass.javaee.FilterType instance.

FilterType

public FilterType(FilterType o)

Creates a new net.sourceforge.ccxjc.it.model.priv.indexed.valueclass.javaee.FilterType instance by copying a given instance.

Parameters:

o - The instance to copy or null.

Method Detail

getDescription

public DescriptionType[] getDescription()

Returns:

array of DescriptionType

getDescription

public DescriptionType getDescription(int idx)

Returns:

one of DescriptionType

getDescriptionLength

public int getDescriptionLength()

setDescription

public void setDescription(DescriptionType[] values)

Parameters:

values - allowed objects are DescriptionType

setDescription

public DescriptionType setDescription(int idx,
                                      DescriptionType value)

Parameters:

value - allowed object is DescriptionType

getDisplayName

public DisplayNameType[] getDisplayName()

Returns:

array of DisplayNameType

getDisplayName

public DisplayNameType getDisplayName(int idx)

Returns:

one of DisplayNameType

getDisplayNameLength

public int getDisplayNameLength()

setDisplayName

public void setDisplayName(DisplayNameType[] values)

Parameters:

values - allowed objects are DisplayNameType

setDisplayName

public DisplayNameType setDisplayName(int idx,
                                      DisplayNameType value)

Parameters:

value - allowed object is DisplayNameType

getIcon

public IconType[] getIcon()

Returns:

array of IconType

getIcon

public IconType getIcon(int idx)

Returns:

one of IconType

getIconLength

public int getIconLength()

setIcon

public void setIcon(IconType[] values)

Parameters:

values - allowed objects are IconType

setIcon

public IconType setIcon(int idx,
                        IconType value)

Parameters:

value - allowed object is IconType

getFilterName

public FilterNameType getFilterName()

Gets the value of the filterName property.

Returns:

possible object is FilterNameType

setFilterName

public void setFilterName(FilterNameType value)

Sets the value of the filterName property.

Parameters:

value - allowed object is FilterNameType

getFilterClass

public FullyQualifiedClassType getFilterClass()

Gets the value of the filterClass property.

Returns:

possible object is FullyQualifiedClassType

setFilterClass

public void setFilterClass(FullyQualifiedClassType value)

Sets the value of the filterClass property.

Parameters:

value - allowed object is FullyQualifiedClassType

getInitParam

public ParamValueType[] getInitParam()

Returns:

array of ParamValueType

getInitParam

public ParamValueType getInitParam(int idx)

Returns:

one of ParamValueType

getInitParamLength

public int getInitParamLength()

setInitParam

public void setInitParam(ParamValueType[] values)

Parameters:

values - allowed objects are ParamValueType

setInitParam

public ParamValueType setInitParam(int idx,
                                   ParamValueType value)

Parameters:

value - allowed object is ParamValueType

getId

public String getId()

Gets the value of the id property.

Returns:

possible object is String

setId

public void setId(String value)

Sets the value of the id property.

Parameters:

value - allowed object is String

clone

public FilterType clone()

Creates and returns a copy of this object.

Overrides:

clone in class Object

Returns:

A clone of this instance.