Package io.opencaesar.oml.convert

Class OmlConvertTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
io.opencaesar.oml.convert.OmlConvertTask
All Implemented Interfaces:
Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>
public abstract class OmlConvertTask extends org.gradle.api.DefaultTask
A gradle task to invoke the OmlConvert tool

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.gradle.api.Task

    org.gradle.api.Task.Namer

  • Field Summary

    Fields inherited from interface org.gradle.api.Task

    TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

  • Constructor Summary

    Constructors
    Constructor
    Description
    OmlConvertTask()
    Creates a new OmlConvertTask object

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract org.gradle.api.provider.Property<Boolean>
    getDebug()
    The debug flag
    abstract org.gradle.api.provider.Property<File>
    getInputCatalogPath()
    The path to an input OML catalog
    protected org.gradle.api.file.ConfigurableFileCollection
    getInputFiles()
    The collection of input OML files referenced by the input OML catalog
    abstract org.gradle.api.provider.Property<File>
    getOutputCatalogPath()
    The path to an output OML catalog
    abstract org.gradle.api.provider.Property<String>
    getOutputFileExtension()
    The extension for the output OML files (options: oml, omlxmi, omljson)
    abstract org.gradle.api.provider.Property<Boolean>
    getUseCatalog()
    Whether to use the catalog to resolve cross references (default: true, only relevant when output file extension is omlxmi or omljson)
    void
    run()
    The gradle task action logic.

    Methods inherited from class org.gradle.api.DefaultTask

    compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

    Methods inherited from class org.gradle.api.internal.AbstractTask

    appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjects

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.gradle.api.Task

    doNotTrackState, getConvention, notCompatibleWithConfigurationCache

  • Constructor Details

    • OmlConvertTask

      public OmlConvertTask()
      Creates a new OmlConvertTask object

  • Method Details

    • getInputCatalogPath

      @InputFile public abstract org.gradle.api.provider.Property<File> getInputCatalogPath()
      The path to an input OML catalog
      Returns:
      File Property

    • getOutputCatalogPath

      @InputFile public abstract org.gradle.api.provider.Property<File> getOutputCatalogPath()
      The path to an output OML catalog
      Returns:
      File Property

    • getOutputFileExtension

      @Input public abstract org.gradle.api.provider.Property<String> getOutputFileExtension()
      The extension for the output OML files (options: oml, omlxmi, omljson)
      Returns:
      String Property

    • getUseCatalog

      @Input public abstract org.gradle.api.provider.Property<Boolean> getUseCatalog()
      Whether to use the catalog to resolve cross references (default: true, only relevant when output file extension is omlxmi or omljson)
      Returns:
      Boolean Property

    • getDebug

      @Input @Optional public abstract org.gradle.api.provider.Property<Boolean> getDebug()
      The debug flag
      Returns:
      Boolean Property

    • getInputFiles

      @Incremental @InputFiles protected org.gradle.api.file.ConfigurableFileCollection getInputFiles() throws IOException
      The collection of input OML files referenced by the input OML catalog
      Returns:
      ConfigurableFileCollection
      Throws:
      IOException - error

    • run

      public void run()
      The gradle task action logic.