com.lexmark.saperion

Class Properties

java.lang.Object

com.lexmark.saperion.Properties

public final class Properties
extends Object

This utility class holds convenience factories for properties.

Author:

jschwarz

Property Summary

Type	Property and Description
static PropertyType	emptyList This factory method creates a new property representing the empty list.

Method Summary

Modifier and Type	Method and Description
static PropertyType	delete() This factory creates a new property that marks a property in an index data map as to delete.
static PropertyType	emptyListProperty() This factory method creates a new property representing the empty list.
static PropertyType	listPropertyFromValue(Collection<?> value) This factory method creates a new list property by determining the element type from the first list element.
static PropertyType	newListPropertyType(Object value, FieldTypeEnum memberType) This factory method for property types creates list properties.
static PropertyType	newPropertyType(Boolean value) This factory method creates a new property of type FieldTypeEnum.BOOLEAN with the given value.
static PropertyType	newPropertyType(Collection<?> value) This factory method creates a new property of type FieldTypeEnum.LIST with the given value.
static PropertyType	newPropertyType(Date value) This factory method creates a new property of type FieldTypeEnum.DATETIME with the given value.
static PropertyType	newPropertyType(Date value) This factory method creates a new property of type FieldTypeEnum.DATE with the given value.
static PropertyType	newPropertyType(Number value) This factory method creates a new property with the given value.
static PropertyType	newPropertyType(Object value, FieldTypeEnum type) This is the literal factory method for property types.
static PropertyType	newPropertyType(String value) This factory method creates a new property of type FieldTypeEnum.STRING with the given value.
static PropertyType	newPropertyType(Time value) This factory method creates a new property of type FieldTypeEnum.TIME with the given value.
static PropertyType	propertyTypeFromValue(Object value) This convenience factory method analyzes the class of given value and returns a PropertyType with the given value and an appropriate type.

Methods inherited from class java.lang.Object

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

Property Detail

emptyList

public static PropertyType emptyListProperty

This factory method creates a new property representing the empty list.

Method Detail

newPropertyType

public static PropertyType newPropertyType(Object value,
                                           FieldTypeEnum type)

This is the literal factory method for property types.

Parameters:

value - the value of the property

type - the field type of the property

Returns:

a property type with the given value and type

newListPropertyType

public static PropertyType newListPropertyType(Object value,
                                               FieldTypeEnum memberType)

This factory method for property types creates list properties.

Parameters:

value - the value of the property

memberType - the field type of the elements of the property

Returns:

a property type with the given value and type

propertyTypeFromValue

public static PropertyType propertyTypeFromValue(Object value)

This convenience factory method analyzes the class of given value and returns a PropertyType with the given value and an appropriate type. If the given value is null, null is returned. Note that since the only indication of the field type is the class of the given value there are field types that will never be generated by this method. For example a java double will always result in a property with the type FieldTypeEnum.FLOAT and never in FieldTypeEnum.CURRENCY. See newPropertyType(Object, FieldTypeEnum) for a more specific factory.

Parameters:

value - the value of the property

Returns:

a property corresponding to the given value

listPropertyFromValue

public static PropertyType listPropertyFromValue(Collection<?> value)

This factory method creates a new list property by determining the element type from the first list element. If the first element does not exist emptyListProperty() will be called.

Parameters:

value - the list to create a property from

Returns:

new list property by determining the element type from the first list element

emptyListProperty

public static PropertyType emptyListProperty()

This factory method creates a new property representing the empty list.

newPropertyType

public static PropertyType newPropertyType(Collection<?> value)

This factory method creates a new property of type FieldTypeEnum.LIST with the given value.

Parameters:

value - the value of the property

Returns:

a property with the given value

newPropertyType

public static PropertyType newPropertyType(Date value)

This factory method creates a new property of type FieldTypeEnum.DATETIME with the given value.

Parameters:

value - the value of the property

Returns:

a property with the given value

newPropertyType

public static PropertyType newPropertyType(Boolean value)

This factory method creates a new property of type FieldTypeEnum.BOOLEAN with the given value.

Parameters:

value - the value of the property

Returns:

a property with the given value

newPropertyType

public static PropertyType newPropertyType(Number value)

This factory method creates a new property with the given value. If given number is a float or double then the field type of the property will be FieldTypeEnum.FLOAT otherwise it will be FieldTypeEnum.INTEGER.

Parameters:

value - the value of the property

Returns:

a property with the given value

newPropertyType

public static PropertyType newPropertyType(String value)

This factory method creates a new property of type FieldTypeEnum.STRING with the given value.

Parameters:

value - the value of the property

Returns:

a property with the given value

newPropertyType

public static PropertyType newPropertyType(Date value)

This factory method creates a new property of type FieldTypeEnum.DATE with the given value.

Parameters:

value - the value of the property

Returns:

a property with the given value

newPropertyType

public static PropertyType newPropertyType(Time value)

This factory method creates a new property of type FieldTypeEnum.TIME with the given value.

Parameters:

value - the value of the property

Returns:

a property with the given value

delete

public static PropertyType delete()

This factory creates a new property that marks a property in an index data map as to delete.

Returns:

a new property that marks a property in an index data map as to delete