com.j256.ormlite.field.types.EnumStringType Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of ormlite-core Show documentation

Lightweight Object Relational Model (ORM) for persisting objects to SQL databases.

There is a newer version: 6.1

package com.j256.ormlite.field.types;

import java.sql.SQLException;
import java.util.HashMap;
import java.util.Map;

import com.j256.ormlite.field.FieldType;
import com.j256.ormlite.field.SqlType;
import com.j256.ormlite.support.DatabaseResults;

/**
 * Type that persists an enum as its name produced by call @{link {@link Enum#name()}. You can also use the
 * {@link EnumIntegerType} to persist it's enum ordinal value. If you want to use the {@link Enum#toString()} instead,
 * see the {@link EnumToStringType}.
 * 
 * @author graywatson
 */
public class EnumStringType extends BaseEnumType {

	public static int DEFAULT_WIDTH = 100;

	private static final EnumStringType singleTon = new EnumStringType();

	public static EnumStringType getSingleton() {
		return singleTon;
	}

	private EnumStringType() {
		super(SqlType.STRING, new Class[] { Enum.class });
	}

	/**
	 * Here for others to subclass.
	 */
	protected EnumStringType(SqlType sqlType, Class[] classes) {
		super(sqlType, classes);
	}

	@Override
	public Object resultToSqlArg(FieldType fieldType, DatabaseResults results, int columnPos) throws SQLException {
		return results.getString(columnPos);
	}

	@Override
	public Object sqlArgToJava(FieldType fieldType, Object sqlArg, int columnPos) throws SQLException {
		if (fieldType == null) {
			return sqlArg;
		}
		String value = (String) sqlArg;
		@SuppressWarnings("unchecked")
		Map> enumStringMap = (Map>) fieldType.getDataTypeConfigObj();
		if (enumStringMap == null) {
			return enumVal(fieldType, value, null, fieldType.getUnknownEnumVal());
		} else {
			return enumVal(fieldType, value, enumStringMap.get(value), fieldType.getUnknownEnumVal());
		}
	}

	@Override
	public Object parseDefaultString(FieldType fieldType, String defaultStr) {
		return defaultStr;
	}

	@Override
	public Object javaToSqlArg(FieldType fieldType, Object obj) {
		Enum enumVal = (Enum) obj;
		return getEnumName(enumVal);
	}

	@Override
	public Object makeConfigObject(FieldType fieldType) throws SQLException {
		Map> enumStringMap = new HashMap>();
		Enum[] constants = (Enum[]) fieldType.getType().getEnumConstants();
		if (constants == null) {
			throw new SQLException(
					"Could not get enum-constants for field " + fieldType + ", not an enum or maybe generic?");
		}
		for (Enum enumVal : constants) {
			enumStringMap.put(getEnumName(enumVal), enumVal);
		}
		return enumStringMap;
	}

	@Override
	public int getDefaultWidth() {
		return DEFAULT_WIDTH;
	}

	protected String getEnumName(Enum enumVal) {
		return enumVal.name();
	}
}