Package org.freeyourgadget.kaitai

Class KaitaiExtension

java.lang.Object
org.freeyourgadget.kaitai.KaitaiExtension
public abstract class KaitaiExtension extends Object
Configuration for the Kaitai Struct compiler.

  • Constructor Summary

    Constructors
    Constructor
    Description
    KaitaiExtension()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract org.gradle.api.file.ConfigurableFileCollection
    getImportPaths()
    Extra search directories for .ksy imports.
    abstract org.gradle.api.provider.Property<String>
    getJavaPackage()
    Java package for the generated classes.
    abstract org.gradle.api.provider.Property<Boolean>
    getOpaqueTypes()
    Set opaque (external) types on or off.
    abstract org.gradle.api.file.DirectoryProperty
    getOutputDir()
    Directory for the generated sources.
    abstract org.gradle.api.provider.Property<Boolean>
    getReadWrite()
    Generate read-write (serialization) support in the classes.
    abstract org.gradle.api.file.DirectoryProperty
    getSourceDir()
    Directory that contains the .ksy source files.
    abstract org.gradle.api.provider.ListProperty<String>
    getTargets()
    Target languages.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • KaitaiExtension

      public KaitaiExtension()

  • Method Details

    • getSourceDir

      public abstract org.gradle.api.file.DirectoryProperty getSourceDir()
      Directory that contains the .ksy source files. Default: src/main/ksy

    • getOutputDir

      public abstract org.gradle.api.file.DirectoryProperty getOutputDir()
      Directory for the generated sources. Default: build/generated/kaitai

    • getTargets

      public abstract org.gradle.api.provider.ListProperty<String> getTargets()
      Target languages. Default: ["java"]

    • getJavaPackage

      public abstract org.gradle.api.provider.Property<String> getJavaPackage()
      Java package for the generated classes. Default: "" (default package)

    • getImportPaths

      public abstract org.gradle.api.file.ConfigurableFileCollection getImportPaths()
      Extra search directories for .ksy imports. The source directory is always included.

    • getOpaqueTypes

      public abstract org.gradle.api.provider.Property<Boolean> getOpaqueTypes()
      Set opaque (external) types on or off. Default: false

    • getReadWrite

      public abstract org.gradle.api.provider.Property<Boolean> getReadWrite()
      Generate read-write (serialization) support in the classes.