| Title: | Jplantuml4r: R6 Java Wrapper Package |
|---|---|
| Description: | An R6 package wrapping java code in the org.github.io.github.terminological:jplantuml4r library. This library was generated by the r6-generator-maven-plugin. |
| Authors: | Rob Challen [aut, cre] |
| Maintainer: | Rob Challen <[email protected]> |
| License: | MIT + file LICENSE |
| Version: | 0.0.0.9000 |
| Built: | 2025-01-19 03:45:33 UTC |
| Source: | https://github.com/terminological/jplantuml4r |
An R6 package wrapping java code in the org.github.io.github.terminological:jplantuml4r library. This library was generated by the r6-generator-maven-plugin.
Version: 0.0.0.9000
Classes:
JavaApi
PlantUML
Rob Challen [email protected] 0000-0002-5504-7768
An R6 package wrapping java code in the org.github.io.github.terminological:jplantuml4r library. This library was generated by the r6-generator-maven-plugin.
Version: 0.0.0.9000
Generated: 2024-04-24T15:45:25.865875868
logLevel |
optional - the slf4j log level as a string - one of OFF (most specific, no logging), FATAL (most specific, little data), ERROR, WARN, INFO, DEBUG, TRACE (least specific, a lot of data), ALL (least specific, all data) |
J = jplantuml4r::JavaApi$get(logLevel)
JavaApi$installDependencies()
This package level method checks for, and installs any dependencies needed for the running of the package. It is called automatically on first package load and so in general does not need to be used directly.
jplantuml4r::JavaApi$installDependencies()
none
nothing. called for side effects.
JavaApi$rebuildDependencies()
This package level method removes existing dependencies and re-installs dependencies needed for the running of the package. It is called automatically on first package load and so in general does not need to be called.
jplantuml4r::JavaApi$rebuildDependencies()
none
nothing. called for side effects.
JavaApi$versionInformation()
This package level method returns debugging version information for the package
jplantuml4r::JavaApi$versionInformation()
none
A list containing a set of versioning information about this package.
JavaApi$get()
This is the main entry point for the package and the root of the Java API in this package. All classes defined in the package are made available as items under this root. The JavaApi object manages the communication between R and Java.
J = jplantuml4r::JavaApi$get() # package classes and functions are nested under the `J` api object.
logLevel The desired verbosity of the package. One of "OFF", "FATAL", "ERROR", "WARN", "INFO", "DEBUG", "TRACE", "ALL".
A R6 jplantuml4r::JavaApi object containing the access point to the objects and functions defined in this package
J$changeLogLevel(logLevel)
Once the package is initialised the log level can be changed to increase the level of messages from the api.
J = jplantuml4r::JavaApi$get()
J$changeLogLevel("DEBUG")
logLevel The desired verbosity of the package. One of "OFF", "FATAL", "ERROR", "WARN", "INFO", "DEBUG", "TRACE", "ALL".
nothing. used for side effects.
J$reconfigureLog(log4jproperties)
Experimental / Advanced use: Once the package is initialised the log configureation can be changed to log to an external file for example.
J = jplantuml4r::JavaApi$get()
prp = fs::path(getwd(),"log4j.properties")
if (fs::file_exists(prp)) {
J$changeLogLevel(prp)
}
log4jproperties a full path to a log4jproperies file
nothing. used for side effects.
J$printMessages()
Experimental / Internal use: Messages from Java to R are queued and printed after each function call. It is unlikely that any will be not printed so in normal circumstances this function should do nothing.
J = jplantuml4r::JavaApi$get() J$printMessages()
none
nothing. used for side effects.
PlantUML$new()
the default no-args constructor
J = jplantuml4r::JavaApi$get() J$PlantUML$new()
none
R6 PlantUML object:
PlantUML$savePlantUml()
Render a plantuml file to a png file
J = jplantuml4r::JavaApi$get() J$PlantUML$savePlantUml(plantuml, outFile, format) # this method is also exposed as a package function: jplantuml4r::save_plant_uml(plantuml, outFile, format)
plantuml a plantuml file as a character vector. - (java expects a RCharacterVector)
outFile the output filename - (defaulting to 'tempfile()') - (java expects a RFile)
format see supported_formats method - (defaulting to ''png'') - (java expects a RCharacter)
RFile: this java method returns the message that the object was created with
PlantUML$supportedFormats()
Get the list of supported formats for plantuml
J = jplantuml4r::JavaApi$get() J$PlantUML$supportedFormats() # this method is also exposed as a package function: jplantuml4r::supported_formats()
none
RCharacterVector: a list of formats.
## ----------------------------------- ## Check library dependencies for jplantuml4r ## ----------------------------------- jplantuml4r::JavaApi$installDependencies() ## ----------------------------------- ## Construct a jplantuml4r Java API instance ## ----------------------------------- J = jplantuml4r::JavaApi$get() # or a more verbose configuration # J = jplantuml4r::JavaApi$get("DEBUG") ## ----------------------------------- ## Method `J$PlantUML$new(...)` ## ----------------------------------- ## Not run: # no example given - appropriate parameter values must be provided: J$PlantUML$new() # or alternatively: jplantuml4r::new() ## End(Not run) ## ----------------------------------- ## Method `J$PlantUML$savePlantUml(...)` ## Aliased as `jplantuml4r::save_plant_uml(...)` ## ----------------------------------- ## Not run: # no example given - appropriate parameter values must be provided: J$PlantUML$savePlantUml(plantuml, outFile, format) # or alternatively: jplantuml4r::save_plant_uml(plantuml, outFile, format) ## End(Not run) ## ----------------------------------- ## Method `J$PlantUML$supportedFormats(...)` ## Aliased as `jplantuml4r::supported_formats(...)` ## ----------------------------------- ## Not run: # no example given - appropriate parameter values must be provided: J$PlantUML$supportedFormats() # or alternatively: jplantuml4r::supported_formats() ## End(Not run)## ----------------------------------- ## Check library dependencies for jplantuml4r ## ----------------------------------- jplantuml4r::JavaApi$installDependencies() ## ----------------------------------- ## Construct a jplantuml4r Java API instance ## ----------------------------------- J = jplantuml4r::JavaApi$get() # or a more verbose configuration # J = jplantuml4r::JavaApi$get("DEBUG") ## ----------------------------------- ## Method `J$PlantUML$new(...)` ## ----------------------------------- ## Not run: # no example given - appropriate parameter values must be provided: J$PlantUML$new() # or alternatively: jplantuml4r::new() ## End(Not run) ## ----------------------------------- ## Method `J$PlantUML$savePlantUml(...)` ## Aliased as `jplantuml4r::save_plant_uml(...)` ## ----------------------------------- ## Not run: # no example given - appropriate parameter values must be provided: J$PlantUML$savePlantUml(plantuml, outFile, format) # or alternatively: jplantuml4r::save_plant_uml(plantuml, outFile, format) ## End(Not run) ## ----------------------------------- ## Method `J$PlantUML$supportedFormats(...)` ## Aliased as `jplantuml4r::supported_formats(...)` ## ----------------------------------- ## Not run: # no example given - appropriate parameter values must be provided: J$PlantUML$supportedFormats() # or alternatively: jplantuml4r::supported_formats() ## End(Not run)
PlantUML can generate a variety of diagrams from a DSL
Version: 0.0.0.9000
Generated: 2024-04-24T15:45:25.925080745
PlantUML can generate a variety of diagrams from a DSL
none
instance$clone()
instance$print()
new()
the default no-args constructor
J = jplantuml4r::JavaApi$get() instance = J$PlantUML$new();
none
the new R6 PlantUML object
## ----------------------------------- ## Construct new instance of PlantUML ## ----------------------------------- ## Not run: J = jplantuml4r::JavaApi$get() # appropriate parameter values must be provided instance = J$PlantUML$new() ## End(Not run)## ----------------------------------- ## Construct new instance of PlantUML ## ----------------------------------- ## Not run: J = jplantuml4r::JavaApi$get() # appropriate parameter values must be provided instance = J$PlantUML$new() ## End(Not run)
no description
save_plant_uml( plantuml, outFile, format )save_plant_uml( plantuml, outFile, format )
plantuml |
plantuml a plantuml file as a character vector. - (java expects a RCharacterVector) |
outFile |
outFile the output filename - (defaulting to 'tempfile()') - (java expects a RFile) |
format |
format see supported_formats method - (defaulting to ''png'') - (java expects a RCharacter) |
RFile: this java method returns the message that the object was created with
no description
supported_formats()supported_formats()
RCharacterVector: a list of formats.