Package com.devonfw.cobigen.openapiplugin.inputreader

Class OpenAPIInputReader

  • All Implemented Interfaces:
    com.devonfw.cobigen.api.extension.InputReader
    public class OpenAPIInputReader
extends java.lang.Object
implements com.devonfw.cobigen.api.extension.InputReader
    Extension for the InputReader Interface of the CobiGen, to be able to read OpenApi3 definition files into FreeMarker models

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String VALID_EXTENSION_YAML
      Valid extensions for the input reader
      static java.lang.String VALID_EXTENSION_YML
      Valid extensions for the input reader

      • Fields inherited from interface com.devonfw.cobigen.api.extension.InputReader

        LOG

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Map<java.lang.String,​java.lang.Object> createModel​(java.lang.Object input)  
      java.util.List<java.lang.Object> getInputObjects​(java.lang.Object input, java.nio.charset.Charset inputCharset)  
      java.util.List<java.lang.Object> getInputObjectsRecursively​(java.lang.Object input, java.nio.charset.Charset inputCharset)  
      boolean isMostLikelyReadable​(java.nio.file.Path path)  
      boolean isValidInput​(java.lang.Object input)  
      java.lang.Object read​(java.nio.file.Path path, java.nio.charset.Charset inputCharset, java.lang.Object... additionalArguments)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • VALID_EXTENSION_YAML

        public static final java.lang.String VALID_EXTENSION_YAML
        Valid extensions for the input reader
        See Also:
        Constant Field Values

      • VALID_EXTENSION_YML

        public static final java.lang.String VALID_EXTENSION_YML
        Valid extensions for the input reader
        See Also:
        Constant Field Values

    • Constructor Detail

      • OpenAPIInputReader

        public OpenAPIInputReader()

    • Method Detail

      • isValidInput

        public boolean isValidInput​(java.lang.Object input)
        Specified by:
        isValidInput in interface com.devonfw.cobigen.api.extension.InputReader

      • createModel

        public java.util.Map<java.lang.String,​java.lang.Object> createModel​(java.lang.Object input)
        Specified by:
        createModel in interface com.devonfw.cobigen.api.extension.InputReader

      • getInputObjects

        public java.util.List<java.lang.Object> getInputObjects​(java.lang.Object input,
                                                        java.nio.charset.Charset inputCharset)
        Specified by:
        getInputObjects in interface com.devonfw.cobigen.api.extension.InputReader

      • getInputObjectsRecursively

        public java.util.List<java.lang.Object> getInputObjectsRecursively​(java.lang.Object input,
                                                                   java.nio.charset.Charset inputCharset)
        Specified by:
        getInputObjectsRecursively in interface com.devonfw.cobigen.api.extension.InputReader

      • read

        public java.lang.Object read​(java.nio.file.Path path,
                             java.nio.charset.Charset inputCharset,
                             java.lang.Object... additionalArguments)
                      throws com.devonfw.cobigen.api.exception.InputReaderException
        Specified by:
        read in interface com.devonfw.cobigen.api.extension.InputReader
        Throws:
        com.devonfw.cobigen.api.exception.InputReaderException

      • isMostLikelyReadable

        public boolean isMostLikelyReadable​(java.nio.file.Path path)
        Specified by:
        isMostLikelyReadable in interface com.devonfw.cobigen.api.extension.InputReader