ehcache

net.sf.ehcache.search.attribute
Enum AttributeType

java.lang.Object
  extended by java.lang.Enum<AttributeType>
      extended by net.sf.ehcache.search.attribute.AttributeType
All Implemented Interfaces:
Serializable, Comparable<AttributeType>

public enum AttributeType
extends Enum<AttributeType>

Defines the legal set of runtime types for search attributes

Author:
teck

Enum Constant Summary
BOOLEAN
          Boolean type
BYTE
          Byte type
CHAR
          Character type
DATE
          Date type
DOUBLE
          Double type
ENUM
          Enum type
FLOAT
          Float type
INT
          Integer type
LONG
          Long type
SHORT
          Short type
SQL_DATE
          SQL Date type
STRING
          String type
 
Method Summary
static Set<Class<?>> getSupportedJavaTypes()
           
 boolean isComparable()
          Is this type comparable?
static boolean isSupportedType(Object value)
          Test the given value to see if it is a legal type
static AttributeType typeFor(Class<?> c)
          Get the appropriate @{link AttributeType enum for the given Java Class
static AttributeType typeFor(String name, Object value)
          Get the appropriate @{link AttributeType enum for the given object value.
abstract  void validateValue(String name, Object value)
          Validate that the given value is in fact of the correct type
static AttributeType valueOf(String name)
          Returns the enum constant of this type with the specified name.
static AttributeType[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

BOOLEAN

public static final AttributeType BOOLEAN
Boolean type


BYTE

public static final AttributeType BYTE
Byte type


CHAR

public static final AttributeType CHAR
Character type


DOUBLE

public static final AttributeType DOUBLE
Double type


FLOAT

public static final AttributeType FLOAT
Float type


INT

public static final AttributeType INT
Integer type


LONG

public static final AttributeType LONG
Long type


SHORT

public static final AttributeType SHORT
Short type


DATE

public static final AttributeType DATE
Date type


SQL_DATE

public static final AttributeType SQL_DATE
SQL Date type


ENUM

public static final AttributeType ENUM
Enum type


STRING

public static final AttributeType STRING
String type

Method Detail

values

public static AttributeType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (AttributeType c : AttributeType.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static AttributeType valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

typeFor

public static AttributeType typeFor(String name,
                                    Object value)
                             throws SearchException
Get the appropriate @{link AttributeType enum for the given object value.

Parameters:
name - the attribute name (only meaningful to message if exception thrown)
value - the value to lookup the type for
Returns:
the attribute type for this value
Throws:
SearchException - if the given value is not valid for a search attribute

typeFor

public static AttributeType typeFor(Class<?> c)
Get the appropriate @{link AttributeType enum for the given Java Class

Parameters:
c -
Returns:
the attribute type for this value

isSupportedType

public static boolean isSupportedType(Object value)
Test the given value to see if it is a legal type

Parameters:
value -
Returns:
true if the given value is valid as a search attribute

validateValue

public abstract void validateValue(String name,
                                   Object value)
                            throws SearchException
Validate that the given value is in fact of the correct type

Parameters:
name - the attribute name (only meaningful to message if exception thrown)
value - the value to validate against this type
Throws:
SearchException - if the given value is not a valid instance of this type

isComparable

public boolean isComparable()
Is this type comparable?

Returns:
true if this type is comparable

getSupportedJavaTypes

public static Set<Class<?>> getSupportedJavaTypes()
Returns:
all supported built-in types

ehcache

Copyright 2001-2014, Terracotta, Inc.