com.speedment.runtime.config.trait.HasTypeMapper Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of tool-deploy Show documentation

A Speedment bundle that shades all dependencies into one jar. This is useful when deploying an application on a server.

The newest version!

/*
 *
 * Copyright (c) 2006-2019, Speedment, Inc. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); You may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at:
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package com.speedment.runtime.config.trait;

import com.speedment.runtime.config.Document;
import com.speedment.runtime.config.exception.SpeedmentConfigException;
import com.speedment.runtime.config.util.ClassUtil;

import java.util.Optional;

import static com.speedment.runtime.config.util.DocumentUtil.newNoSuchElementExceptionFor;

/**
 * Trait for documents that have a {@code TypeMapper} specified.
 * 
 * @author Emil Forslund
 * @since  3.0.2
 */
public interface HasTypeMapper extends Document {

    /**
     * Returns the name of the mapper class that will be used to generate a java
     * representation of the database types.
     *
     * @return the mapper class
     */
    default Optional getTypeMapper() {
        return getAsString(HasTypeMapperUtil.TYPE_MAPPER);
    }
    
    /**
     * Returns the name of the class that represents the database type.
     *
     * @return the database type class
     */
    default String getDatabaseType() {
        return getAsString(HasTypeMapperUtil.DATABASE_TYPE)
            .orElseThrow(newNoSuchElementExceptionFor(this, HasTypeMapperUtil.DATABASE_TYPE));
    }
    
    /**
     * Returns the class that represents the database type.
     *
     * @return the database type
     */
    default Class findDatabaseType() {
        final String name = getDatabaseType();

        try {
            return ClassUtil.classFromString(name);
        } catch (final ClassNotFoundException ex) {
            throw new SpeedmentConfigException(
                "Could not find database type: '" + name + "'.", 
                ex
            );
        }
    }
}