org.castor.cpa.query.object.literal
Class EnumLiteral

java.lang.Object
  org.castor.cpa.query.object.AbstractQueryObject
      org.castor.cpa.query.object.expression.AbstractExpression
          org.castor.cpa.query.object.literal.AbstractLiteral
              org.castor.cpa.query.object.literal.EnumLiteral

All Implemented Interfaces:

Expression, Literal, QueryObject

public final class EnumLiteral
extends AbstractLiteral

Final immutable class that represents a enum expression.

Since:

1.3

Version:

$Revision: 7121 $ $Date: 2006-04-25 16:09:10 -0600 (Tue, 25 Apr 2006) $

Author:

Udai Gupta, Ralf Joachim

Constructor Summary

EnumLiteral(Enum<?> value)
Construct enum literal for given enum constant.

EnumLiteral(String value)
Construct enum literal for given string value.

Method Summary

Enum<?>	getValue() Get enum constant represented by this enum literal.
StringBuilder	toString(StringBuilder sb) Append a string representation of the object to the given StringBuilder.

Methods inherited from class org.castor.cpa.query.object.expression.AbstractExpression

abs, add, add, add, add, between, between, between, between, between, between, between, concat, concat, divide, divide, divide, divide, equal, equal, equal, equal, equal, equal, equal, equal, greaterEqual, greaterEqual, greaterEqual, greaterEqual, greaterEqual, greaterEqual, greaterEqual, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, length, lessEqual, lessEqual, lessEqual, lessEqual, lessEqual, lessEqual, lessEqual, lessThan, lessThan, lessThan, lessThan, lessThan, lessThan, lessThan, like, like, like, like, like, like, locate, locate, locate, locate, locate, locate, lower, multiply, multiply, multiply, multiply, negate, notBetween, notBetween, notBetween, notBetween, notBetween, notBetween, notBetween, notEqual, notEqual, notEqual, notEqual, notEqual, notEqual, notEqual, notEqual, notLike, notLike, notLike, notLike, notLike, notLike, plus, remainder, remainder, remainder, remainder, sqrt, substring, substring, substring, substring, subtract, subtract, subtract, subtract, trim, trim, trim, trim, trim, trim, upper

Methods inherited from class org.castor.cpa.query.object.AbstractQueryObject

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.castor.cpa.query.Expression

abs, add, add, add, add, between, between, between, between, between, between, between, concat, concat, divide, divide, divide, divide, equal, equal, equal, equal, equal, equal, equal, equal, greaterEqual, greaterEqual, greaterEqual, greaterEqual, greaterEqual, greaterEqual, greaterEqual, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, greaterThan, length, lessEqual, lessEqual, lessEqual, lessEqual, lessEqual, lessEqual, lessEqual, lessThan, lessThan, lessThan, lessThan, lessThan, lessThan, lessThan, like, like, like, like, like, like, locate, locate, locate, locate, locate, locate, lower, multiply, multiply, multiply, multiply, negate, notBetween, notBetween, notBetween, notBetween, notBetween, notBetween, notBetween, notEqual, notEqual, notEqual, notEqual, notEqual, notEqual, notEqual, notEqual, notLike, notLike, notLike, notLike, notLike, notLike, plus, remainder, remainder, remainder, remainder, sqrt, substring, substring, substring, substring, subtract, subtract, subtract, subtract, trim, trim, trim, trim, trim, trim, upper

Constructor Detail

EnumLiteral

public EnumLiteral(String value)

Construct enum literal for given string value. The string value has to contain the full class name of the enumeration including the name of the constant separated by dot. If an enum constant can not be found an IllegalArgumentException will be thrown.

Parameters:

value - String value with full name of the enum constant.

EnumLiteral

public EnumLiteral(Enum<?> value)

Construct enum literal for given enum constant.

Parameters:

value - Enum constant to represent by the enum literal.

Method Detail

getValue

public Enum<?> getValue()

Get enum constant represented by this enum literal.

Returns:

Enum constant represented by this enum literal.

toString

public StringBuilder toString(StringBuilder sb)

Append a string representation of the object to the given StringBuilder. In general, the toString method for query objects appends a string that textually represents this object. The result should be a query string that complies to EJB QL specification as long as the query object represents a syntay element of it. It is required that all subclasses override this method. The toString method defined at class Object is overwritten and calls this method.

Parameters:

sb - StringBuilder to append the string representation of this object to.

Returns:

Same instance of StringBuilder given as parameter.