StandardTranslatorKey.java example

Explorer
speedment-master
/**
 *
 * Copyright (c) 2006-2017, 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.generator.standard;

import com.speedment.common.codegen.model.Class;
import com.speedment.common.codegen.model.ClassOrInterface;
import com.speedment.common.codegen.model.Interface;
import com.speedment.generator.translator.TranslatorKey;
import com.speedment.runtime.config.Project;
import com.speedment.runtime.config.Table;

import java.util.stream.Stream;

import static com.speedment.common.codegen.internal.util.StaticClassUtil.instanceNotAllowed;

/**
 * Standard implementations of the {@link TranslatorKey} interface to make it
 * easier and more efficient to mention the most common files generated by
 * Speedment.
 * 
 * @author  Emil Forslund
 * @author  Per Minborg
 * @since   2.3.0
 */

public final class StandardTranslatorKey {
    
    public static final TranslatorKey<Project, Interface> 
        APPLICATION           = TranslatorKey.of("Application", Interface.class),
        GENERATED_APPLICATION = TranslatorKey.of("GeneratedApplication", Interface.class);

    public static final TranslatorKey<Project, Class> 
        APPLICATION_IMPL              = TranslatorKey.of("ApplicationImpl", Class.class),
        GENERATED_APPLICATION_IMPL    = TranslatorKey.of("GeneratedApplicationImpl", Class.class),
        APPLICATION_BUILDER           = TranslatorKey.of("ApplicationBuilder", Class.class),
        GENERATED_APPLICATION_BUILDER = TranslatorKey.of("GeneratedApplicationBuilder", Class.class),
        GENERATED_METADATA            = TranslatorKey.of("GeneratedMetadata", Class.class);
    
    public static final TranslatorKey<Table, Interface> 
        ENTITY            = TranslatorKey.of("Entity", Interface.class),
        MANAGER           = TranslatorKey.of("Manager", Interface.class),
        GENERATED_ENTITY  = TranslatorKey.of("GeneratedEntity", Interface.class),
        GENERATED_MANAGER = TranslatorKey.of("GeneratedManager", Interface.class);
    
    public static final TranslatorKey<Table, Class>
        ENTITY_IMPL            = TranslatorKey.of("EntityImpl", Class.class),
        MANAGER_IMPL           = TranslatorKey.of("ManagerImpl", Class.class),
        SQL_ADAPTER            = TranslatorKey.of("SqlAdapter", Class.class),
        GENERATED_ENTITY_IMPL  = TranslatorKey.of("GeneratedEntityImpl", Class.class),
        GENERATED_MANAGER_IMPL = TranslatorKey.of("GeneratedManagerImpl", Class.class),
        GENERATED_SQL_ADAPTER  = TranslatorKey.of("GeneratedSqlAdapter", Class.class);

    /**
     * Returns a stream of the standard {@link TranslatorKey Translator Keys}
     * that is used on a per project basis.
     * 
     * @return  stream of standard project {@link TranslatorKey Translator Keys}
     */
    public static Stream<TranslatorKey<Project, ? extends ClassOrInterface<?>>> projectTranslatorKeys() {
        return Stream.of(
            APPLICATION, GENERATED_APPLICATION, 
            APPLICATION_IMPL, GENERATED_APPLICATION_IMPL,
            APPLICATION_BUILDER, GENERATED_APPLICATION_BUILDER,
            GENERATED_METADATA
        );
    }
    
    /**
     * Returns a stream of the standard {@link TranslatorKey Translator Keys}
     * that is used on a 'per table' basis.
     * 
     * @return  stream of standard table {@link TranslatorKey Translator Keys}
     */
    public static Stream<TranslatorKey<Table, ? extends ClassOrInterface<?>>> tableTranslatorKeys() {
        return Stream.of(
            ENTITY, GENERATED_ENTITY,
            ENTITY_IMPL, GENERATED_ENTITY_IMPL,
            MANAGER, GENERATED_MANAGER,
            MANAGER_IMPL , GENERATED_MANAGER_IMPL
        );
    }

    /**
     * Utility classes should not be instantiated.
     */
    private StandardTranslatorKey() {
        throw new UnsupportedOperationException();
    }
}