net.sourceforge.ccxjc.it.model.pub.collections.valueclass.portlet.app200
Class FilterType

java.lang.Object
  net.sourceforge.ccxjc.it.model.pub.collections.valueclass.portlet.app200.FilterType

All Implemented Interfaces:

Serializable, Cloneable

public class FilterType
extends Object
implements Serializable, Cloneable

The filter element specifies a filter that can transform the content of portlet requests and portlet responses. Filters can access the initialization parameters declared in the deployment descriptor at runtime via the FilterConfig interface. A filter can be restricted to one or more lifecycle phases of the portlet. Valid entries for lifecycle are: ACTION_PHASE, EVENT_PHASE, RENDER_PHASE, RESOURCE_PHASE Used in: portlet-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>
         <element name="description" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}descriptionType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="display-name" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}display-nameType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="filter-name" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}filter-nameType"/>
         <element name="filter-class" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}fully-qualified-classType"/>
         <element name="lifecycle" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}string" maxOccurs="unbounded"/>
         <element name="init-param" type="{http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd}init-paramType" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

See Also:

Serialized Form

Field Summary

protected List<DescriptionType>	description
protected List<DisplayNameType>	displayName
protected String	filterClass
protected String	filterName
protected List<InitParamType>	initParam
protected List<String>	lifecycle

Constructor Summary

FilterType()
Creates a new net.sourceforge.ccxjc.it.model.pub.collections.valueclass.portlet.app200.FilterType instance.

FilterType(FilterType o)
Creates a new net.sourceforge.ccxjc.it.model.pub.collections.valueclass.portlet.app200.FilterType instance by copying a given instance.

Method Summary

FilterType	clone() Creates and returns a copy of this object.
static void	copyDescription(List<DescriptionType> source, List<DescriptionType> target) Copies all values of property Description.
static void	copyDisplayName(List<DisplayNameType> source, List<DisplayNameType> target) Copies all values of property DisplayName.
static void	copyInitParam(List<InitParamType> source, List<InitParamType> target) Copies all values of property InitParam.
static void	copyLifecycle(List<String> source, List<String> target) Copies all values of property Lifecycle.
List<DescriptionType>	getDescription() Gets the value of the description property.
List<DisplayNameType>	getDisplayName() Gets the value of the displayName property.
String	getFilterClass() Gets the value of the filterClass property.
String	getFilterName() Gets the value of the filterName property.
List<InitParamType>	getInitParam() Gets the value of the initParam property.
List<String>	getLifecycle() Gets the value of the lifecycle property.
void	setFilterClass(String value) Sets the value of the filterClass property.
void	setFilterName(String value) Sets the value of the filterName property.

Methods inherited from class java.lang.Object

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

Field Detail

description

protected List<DescriptionType> description

displayName

protected List<DisplayNameType> displayName

filterName

protected String filterName

filterClass

protected String filterClass

lifecycle

protected List<String> lifecycle

initParam

protected List<InitParamType> initParam

Constructor Detail

FilterType

public FilterType()

Creates a new net.sourceforge.ccxjc.it.model.pub.collections.valueclass.portlet.app200.FilterType instance.

FilterType

public FilterType(FilterType o)

Creates a new net.sourceforge.ccxjc.it.model.pub.collections.valueclass.portlet.app200.FilterType instance by copying a given instance.

Parameters:

o - The instance to copy or null.

Method Detail

getDescription

public List<DescriptionType> getDescription()

Gets the value of the description property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the description property.

For example, to add a new item, do as follows:

    getDescription().add(newItem);
 

Objects of the following type(s) are allowed in the list DescriptionType

getDisplayName

public List<DisplayNameType> getDisplayName()

Gets the value of the displayName property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the displayName property.

For example, to add a new item, do as follows:

    getDisplayName().add(newItem);
 

Objects of the following type(s) are allowed in the list DisplayNameType

getFilterName

public String getFilterName()

Gets the value of the filterName property.

Returns:

possible object is String

setFilterName

public void setFilterName(String value)

Sets the value of the filterName property.

Parameters:

value - allowed object is String

getFilterClass

public String getFilterClass()

Gets the value of the filterClass property.

Returns:

possible object is String

setFilterClass

public void setFilterClass(String value)

Sets the value of the filterClass property.

Parameters:

value - allowed object is String

getLifecycle

public List<String> getLifecycle()

Gets the value of the lifecycle property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the lifecycle property.

For example, to add a new item, do as follows:

    getLifecycle().add(newItem);
 

Objects of the following type(s) are allowed in the list String

getInitParam

public List<InitParamType> getInitParam()

Gets the value of the initParam property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the initParam property.

For example, to add a new item, do as follows:

    getInitParam().add(newItem);
 

Objects of the following type(s) are allowed in the list InitParamType

copyDescription

public static void copyDescription(List<DescriptionType> source,
                                   List<DescriptionType> target)

Copies all values of property Description.

Parameters:

target - The target to copy source to.

source - The source to copy from.

Throws:

NullPointerException - if source or target is null.

copyDisplayName

public static void copyDisplayName(List<DisplayNameType> source,
                                   List<DisplayNameType> target)

Copies all values of property DisplayName.

Parameters:

target - The target to copy source to.

source - The source to copy from.

Throws:

NullPointerException - if source or target is null.

copyLifecycle

public static void copyLifecycle(List<String> source,
                                 List<String> target)

Copies all values of property Lifecycle.

Parameters:

target - The target to copy source to.

source - The source to copy from.

Throws:

NullPointerException - if source or target is null.

copyInitParam

public static void copyInitParam(List<InitParamType> source,
                                 List<InitParamType> target)

Copies all values of property InitParam.

Parameters:

target - The target to copy source to.

source - The source to copy from.

Throws:

NullPointerException - if source or target is null.

clone

public FilterType clone()

Creates and returns a copy of this object.

Overrides:

clone in class Object

Returns:

A clone of this instance.