All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.devonfw.cobigen.api.extension.InputReader Maven / Gradle / Ivy

Go to download

A Code-based incremental Generator

The newest version!
package com.devonfw.cobigen.api.extension;

import java.nio.charset.Charset;
import java.nio.file.Path;
import java.util.List;
import java.util.Map;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.devonfw.cobigen.api.annotation.Cached;
import com.devonfw.cobigen.api.annotation.ExceptionFacade;
import com.devonfw.cobigen.api.exception.InputReaderException;

/**
 * This is an extension point to enable further generator input support. Implementations should inherit this interface
 * and should be registered via an implemented {@link TriggerInterpreter} to be integrated into the CobiGen generation
 * process.
 */
@ExceptionFacade
@Cached
public interface InputReader {

  /** Logger instance. */
  public static final Logger LOG = LoggerFactory.getLogger(InputReader.class);

  /**
   * This function will be called if matching triggers or matching templates should be retrieved for a given input
   * object
   *
   * @param input object to be checked
   * @return true if the given input can be processed by the implementing {@link InputReader},
   *         false otherwise
   */
  public boolean isValidInput(Object input);

  /**
   * This function should create the FreeMarker object model from the given input
   *
   * @param input object the model should be build of (not null)
   * @return a key to object {@link Map} representing an object model for the generation
   */
  public Map createModel(Object input);

  /**
   * Will return the set of combined input objects if the given input combines multiple input objects.
   *
   * @param input the combined input object
   * @param inputCharset to be used for reading new inputs
   * @return a list of input objects, the generation should be triggered for each.
   */
  public List getInputObjects(Object input, Charset inputCharset);

  /**
   * Will return the set of combined input objects if the given input combines multiple input objects.
   *
   * @param input the combined input object
   * @param inputCharset to be used for reading new inputs
   * @return a list of input objects, the generation should be triggered for each.
   */
  public List getInputObjectsRecursively(Object input, Charset inputCharset);

  /**
   * Reads the content at a path and returns a cobigen compliant input
   *
   * @param path the {@link Path} to the object. Can also point to a folder
   * @param inputCharset of the input
   * @param additionalArguments depending on the InputReader implementation
   * @return Object that is a valid input
   * @throws InputReaderException if the Path cannot be read
   * @throws IllegalArgumentException if the provided additional arguments do not suffice the used implementation
   */
  public Object read(Path path, Charset inputCharset, Object... additionalArguments) throws InputReaderException;

  /**
   * Try to determine, whether the input file is readable by the plug-ins parser. If false is returned by the method, it
   * is not assured, that the read method is not called at all. In case of the situation, that no plug-in is most likely
   * to read the input, CobiGen will try every input reader to read the input. Please be aware, that this method should
   * be kept highly performant. It does not have to be an exact result.
   *
   * @param path the file {@link Path}.
   * @return true, if it is most likely, that the file can be read by this input reader's read method

   *         false, if the reader is most likely not able to read the file.
   */
  public boolean isMostLikelyReadable(Path path);

}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy