Package uk.co.terminological.rjava.plugin

Class PackageData

java.lang.Object
uk.co.terminological.rjava.plugin.PackageData
public class PackageData extends Object
Holds all the options for the maven plugin
Author:
terminological

  • Constructor Details

    • PackageData

      public PackageData()

  • Method Details

    • getMaintainerName

      public String getMaintainerName()

    • getMaintainerFamilyName

      public String getMaintainerFamilyName()

    • getMaintainerOrganisation

      public String getMaintainerOrganisation()

    • getGithubOrganisation

      public String getGithubOrganisation()

    • getGithubRepository

      public String getGithubRepository()

    • getMaintainerEmail

      public String getMaintainerEmail()

    • getMaintainerORCID

      public String getMaintainerORCID()

    • getDebugMode

      public boolean getDebugMode()
      <debugMode>true</debugMode>
      Returns:
      the debug mode

    • getDefaultLogLevel

      public String getDefaultLogLevel()
      <defaultLogLevel>WARN</defaultLogLevel>
      Returns:
      the default log level

    • usePkgdown

      public boolean usePkgdown()
      <usePkgdown>true</usePkgdown> build machine must have R and pkgdown installed
      Returns:
      pkgDown flag

    • useCmdCheck

      public boolean useCmdCheck()
      <usePkgdown>true</usePkgdown> build machine must have R and pkgdown installed
      Returns:
      pkgDown flag

    • useRoxygen2

      public boolean useRoxygen2()
      <useRoxygen2>true</useRoxygen2> defaults to false, as requires build machine must have R, roxygen and devtools installed
      Returns:
      roxygen2 flag

    • installLocal

      public boolean installLocal()
      <installLocal>true</installLocal> defaults to false, as requires build machine must have R and devtools installed
      Returns:
      install local flag

    • preCompileBinary

      public boolean preCompileBinary()
      <preCompileBinary>true</preCompileBinary> defaults to true. if false then no precompiled files are included and the package will have to be compiled from java source on first load
      Returns:
      precompile flag

    • packageAllDependencies

      public boolean packageAllDependencies()
      <packageAllDependencies>true</packageAllDependencies> defaults to false. only relevant if preCompileBinary is true (the default) if packageAllDependencies is true then a fat jar will be precompiled and included in the R package making the package large but completely self contained. This may be needed if the package depends on libraries that are not available to download from a public maven repository. If false then only this maven artifact is precompiled making the bundled java library code comparatively small. All other java dependencies declared in the maven file are fetched on first use of this library.
      Returns:
      package fat jar flag

    • useShadePlugin

      public boolean useShadePlugin()
      <useShadePlugin>true</useShadePlugin> defaults to false. only relevant if packageAllDependencies is true (the default). if useShadePlugin is true then a shaded jar will be precompiled and included in the R package making the package large but completely self contained. This may be needed if the package depends on libraries that are not available to download from a public maven repository.
      Returns:
      package shaded flag

    • useJavadoc

      public boolean useJavadoc()
      <useJavadoc>true</useJavadoc> build machine must have R and pkgdown installed
      Returns:
      javadoc flag

    • getJavadocExecutable

      public String getJavadocExecutable()

    • needsLicense

      public boolean needsLicense()

    • getYear

      public String getYear()

    • getDate

      public String getDate()

    • hasRJavaOpts

      public boolean hasRJavaOpts()

    • getRJavaOpts

      public List<String> getRJavaOpts()
      For example <rJavaOpts><rJavaOpt>-Xmx2048M</rJavaOpt></rJavaOpts>
      Returns:
      list of java options

    • setMaintainerName

      public void setMaintainerName(String maintainerName)

    • setMaintainerFamilyName

      public void setMaintainerFamilyName(String maintainerFamilyName)

    • setMaintainerEmail

      public void setMaintainerEmail(String maintainerEmail)

    • getDescription

      public String getDescription()

    • getLicense

      public String getLicense()

    • getLicenseType

      public String getLicenseType()

    • setDescription

      public void setDescription(String description)

    • setLicense

      public void setLicense(String license)

    • getInputFiles

      public File[] getInputFiles()

    • setInputFiles

      public void setInputFiles(File[] inputFiles)

    • getPackageName

      public String getPackageName()

    • getTitle

      public String getTitle()

    • getVersion

      public String getVersion() throws org.apache.maven.plugin.MojoExecutionException
      Throws:
      org.apache.maven.plugin.MojoExecutionException

    • setPackageName

      public void setPackageName(String packageName)

    • setTitle

      public void setTitle(String title)

    • setVersion

      public void setVersion(String version)

    • setDefaultLogLevel

      public void setDefaultLogLevel(String defaultLogLevel)

    • getDoi

      public String getDoi()

    • setDoi

      public void setDoi(String doi)

    • getUrl

      public String getUrl()

    • getUrls

      public List<String> getUrls()

    • setUrl

      public void setUrl(String url)