org.jcreme.filters
Class InclusionComparisonOperator

java.lang.Object
  org.jcreme.enumerations.Enumeration
      org.jcreme.filters.ComparisonOperator
          org.jcreme.filters.InclusionComparisonOperator

All Implemented Interfaces:

java.lang.Comparable, java.io.Serializable

public class InclusionComparisonOperator

extends ComparisonOperator

This enumeration contains the operators that can be used in a list context to test the inclusion. As a subclass of the ComparisonOperator enumeration, values of this class are also registered as elements of the ComparisonOperator enumeration.

Version:

$Revision: 1.3 $

Author:

$Author: dbregeon $

See Also:

Serialized Form

Field Summary

static InclusionComparisonOperator	IN The 'IN' enumeration value.
static InclusionComparisonOperator	NOT_IN The 'NOT IN' enumeration value.
static java.lang.String	S_IN The name for the 'IN' enumeration value.
static java.lang.String	S_NOT_IN The name for the 'NOT IN' enumeration value.
(package private) static long	serialVersionUID

Constructor Summary

protected

InclusionComparisonOperator(java.lang.String name) Creates new InclusionComparisonOperator

Method Summary

protected java.util.Hashtable	getFromName() This method is for internal use only.
static InclusionComparisonOperator	getInclusionComparisonOperator(java.lang.String name) This method retrieves an InclusionComparisonOperator instance from its name.
static InclusionComparisonOperator[]	getInclusionComparisonOperators() This methods gives the instances of this class.
static Enumeration[]	getValues() This method enables to retrieve all the possible values of an Enumeration class.

Methods inherited from class org.jcreme.filters.ComparisonOperator

addAsComparisonOperator, get, getComparisonOperators

Methods inherited from class org.jcreme.enumerations.Enumeration

compareTo, getName, readResolve, toString

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

S_IN

public static final java.lang.String S_IN

The name for the 'IN' enumeration value.

See Also:

Constant Field Values

IN

public static final InclusionComparisonOperator IN

The 'IN' enumeration value.

S_NOT_IN

public static final java.lang.String S_NOT_IN

The name for the 'NOT IN' enumeration value.

See Also:

Constant Field Values

NOT_IN

public static final InclusionComparisonOperator NOT_IN

The 'NOT IN' enumeration value.

Constructor Detail

InclusionComparisonOperator

protected InclusionComparisonOperator(java.lang.String name)
                               throws java.security.InvalidParameterException

Creates new InclusionComparisonOperator

Parameters:

name - the name of this enumerated value. It cannot be null.

Throws:

java.security.InvalidParameterException - if name is null.

Method Detail

getFromName

protected java.util.Hashtable getFromName()

This method is for internal use only.

Overrides:

getFromName in class ComparisonOperator

Returns:

the Hashtable that links the enumerated values names with the actual enumerated value.

getInclusionComparisonOperator

public static InclusionComparisonOperator getInclusionComparisonOperator(java.lang.String name)

This method retrieves an InclusionComparisonOperator instance from its name.

Parameters:

name - the name of the InclusionComparisonOperator instance.

Returns:

the InclusionComparisonOperator that has this name. Null if no value corresponding to this name was found.

getInclusionComparisonOperators

public static InclusionComparisonOperator[] getInclusionComparisonOperators()

This methods gives the instances of this class.

Returns:

all the instances of this class.

getValues

public static Enumeration[] getValues()

This method enables to retrieve all the possible values of an Enumeration class.

Returns:

the values for this class.