com.speedment.generator.translator.component.CodeGenerationComponent Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of tool-deploy Show documentation
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.generator.translator.component;
import com.speedment.common.codegen.model.ClassOrInterface;
import com.speedment.common.injector.annotation.InjectKey;
import com.speedment.generator.translator.Translator;
import com.speedment.generator.translator.TranslatorConstructor;
import com.speedment.generator.translator.TranslatorDecorator;
import com.speedment.generator.translator.TranslatorKey;
import com.speedment.generator.translator.component.function.GenerateClass;
import com.speedment.generator.translator.component.function.GenerateEnum;
import com.speedment.generator.translator.component.function.GenerateInterface;
import com.speedment.generator.translator.exception.SpeedmentTranslatorException;
import com.speedment.runtime.config.Dbms;
import com.speedment.runtime.config.Project;
import com.speedment.runtime.config.Schema;
import com.speedment.runtime.config.Table;
import com.speedment.runtime.config.trait.HasMainInterface;
import com.speedment.runtime.config.trait.HasName;
import java.util.stream.Stream;
/**
* This Component interface is used for Speedments's code generation.
*
* @author Per Minborg
* @author Emil Forslund
* @since 2.2.0
*/
@InjectKey(CodeGenerationComponent.class)
public interface CodeGenerationComponent {
/**
* Creates a new dynamic code translator and adds it to this component. The
* created translator will not listen to any decorators.
*
* @param creator the CodeGen model creator
* @return this component
* @since 3.1.4
*/
CodeGenerationComponent newClass(GenerateClass creator);
/**
* Creates a new dynamic code translator and adds it to this component. The
* created translator will not listen to any decorators.
*
* @param creator the CodeGen model creator
* @return this component
* @since 3.1.4
*/
CodeGenerationComponent newEnum(GenerateEnum creator);
/**
* Creates a new dynamic code translator and adds it to this component. The
* created translator will not listen to any decorators.
*
* @param creator the CodeGen model creator
* @return this component
* @since 3.1.4
*/
CodeGenerationComponent newInterface(GenerateInterface creator);
/**
* Creates a new dynamic code translator by first creating a
* {@link TranslatorAppender} and taking in the additional information from
* it.
*
* @return the appender
* @since 3.1.4
*/
TranslatorAppender forEveryTable();
/**
* Creates a new dynamic code translator by first creating a
* {@link TranslatorAppender} and taking in the additional information from
* it.
*
* @return the appender
* @since 3.1.4
*/
TranslatorAppender forEverySchema();
/**
* Creates a new dynamic code translator by first creating a
* {@link TranslatorAppender} and taking in the additional information from
* it.
*
* @return the appender
* @since 3.1.4
*/
TranslatorAppender forEveryDbms();
/**
* Decorates one of the translators in this component. The object returned
* by this method holds additional configuration.
*
* @param key key identifying the translator to decorate
* @param the document type (Project, Table, etc)
* @param the generated type (Class, Interface, Enum, etc)
* @return the decorator builder
*/
>
DecoratorBuilder decorate(TranslatorKey key);
/**
* Puts a new {@code TranslatorConstructor} for the given class/key pair. If
* an old TranslatorConstructor exists for the same class/key pair, it is
* replaced.
*
* @param type of Document
* @param type of codegen model
* @param docType class of the Document
* @param tKey translatorKey to use
* @param constructor to use when producing Translators of the specified
* type
*/
default > void
put(Class docType, TranslatorKey tKey, TranslatorConstructor constructor) {
put(docType, tKey.getTranslatedType(), tKey.getKey(), constructor);
}
/**
* Puts a new {@code TranslatorConstructor} for the given class/key pair. If
* an old TranslatorConstructor exists for the same class/key pair, it is
* replaced.
*
* @param type of Document
* @param type of codegen model
* @param docType class of the Document
* @param modelType class of the codegen model
* @param key key to use
* @param constructor to use when producing Translators of the specified
* type
*/
> void
put(Class docType, Class modelType, String key, TranslatorConstructor constructor);
/**
* Adds a new {@code TranslatorDecorator} for the given class/key pair.
*
* @param type of Document
* @param type of codegen model
* @param docType class of the Document
* @param tKey translatorKey to use
* @param decorator the new decorator
*/
default > void
add(Class docType, TranslatorKey tKey, TranslatorDecorator decorator) {
add(docType, tKey.getTranslatedType(), tKey.getKey(), decorator);
}
/**
* Adds a new {@code TranslatorDecorator} for the given class/key pair.
*
* @param type of Document
* @param type of codegen model
* @param docType class of the Document
* @param modelType class of the codegen mdoel
* @param key key to use
* @param decorator the new decorator
*/
> void
add(Class docType, Class modelType, String key, TranslatorDecorator decorator);
/**
* Removes the {@code TranslatorConstructor} for the given class/key pair.
*
* @param type of Document
* @param type of codegen model
* @param docType class of the Document
* @param tKey translatorKey to use
*/
default > void
remove(Class docType, TranslatorKey tKey) {
remove(docType, tKey.getKey());
}
/**
* Removes the {@code TranslatorConstructor} for the given class/key pair.
*
* @param type of Document
* @param type of codegen model
* @param docType class of the Document
* @param key key to use
*/
> void
remove(Class docType, String key);
/**
* Returns a Stream of newly created {@code Translator Translators} for the
* given Document. The translators are all created regardless of its
* registered key.
*
* @param Document type
* @param document to use when making translators
* @return a Stream of newly created {@code Translator Translators}
* for the given Document
*/
Stream>
translators(DOC document);
/**
* Returns a Stream of newly created {@code Translator Translators} for the
* given Document and key. Only Translators that match the provided key are
* included in the Stream.
*
* @param document type
* @param codegen model type
* @param document to use when making translators
* @param key the key
* @return a Stream of newly created {@code Translator Translators}
* for the given Document
*
* @throws SpeedmentTranslatorException if the specified translator did not
* exist
*/
default > Translator
findTranslator(DOC document, TranslatorKey key) throws SpeedmentTranslatorException {
return CodeGenerationComponent.this.findTranslator(document, key.getTranslatedType(), key.getKey());
}
/**
* Returns a Stream of newly created {@code Translator Translators} for the
* given Document and key. Only Translators that match the provided key are
* included in the Stream.
*
* @param document type
* @param codegen model type
* @param document to use when making translators
* @param modelType type to indicate return type variables
* @param key the key
* @return the newly created {@code Translator Translators} for the
* given Document
*
* @throws SpeedmentTranslatorException if the specified translator did not
* exist
*/
> Translator
findTranslator(DOC document, Class modelType, String key) throws SpeedmentTranslatorException;
/**
* Returns a stream over the currently installed translator keys.
*
* @return stream of translator keys
*/
Stream translatorKeys();
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy