MkdocsConfig (gradle-mkdocs-plugin 2.3.0 API)

Summary:
Constructor
Method

| Detail:
Constructor
Method

ru.vyarus.gradle.plugin.mkdocs.util.MkdocsConfig

Utility to work with mkdocs config (mkdocs.yml).
Authors:
Vyacheslav Rusakov
Since:
07.12.2017

Constructor Summary

Constructors
Constructor and description
`MkdocsConfig (org.gradle.api.Project project, java.lang.String sourceDir)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.io.File`	`backup()` Backup configuration file.
	`boolean`	`contains(java.lang.String option)` Searches for specified property.
	`java.lang.String`	`find(java.lang.String option)` @param option config option to find
	`java.io.File`	`getConfig()` @return mkdocs config file
	`void`	`restoreBackup(java.io.File backup)` Replace current configuration file with provided backup.
	`void`	`set(java.lang.String option, java.lang.String value)` Replace option value in mkdocks config.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Constructor Detail
  - MkdocsConfig(org.gradle.api.Project project, java.lang.String sourceDir)
- Method Detail
  - java.io.File backup()
    
    Backup configuration file.
    Returns:
    configuration backup file
  - boolean contains(java.lang.String option)
    
    Searches for specified property. Supports nesting: if property contains dots then it will search for each property part sequentially (note that multiline list value also counted as property).
    Looks only not commented lines. Counts hierarchy.
    Parameters:
    option - option (maybe composite: separated with dots) name to find
    Returns:
    true is string found, false otherwise
  - java.lang.String find(java.lang.String option)
    
    Parameters:
    option - config option to find
    Returns:
    option value or null if option commented or not defined
  - java.io.File getConfig()
    
    throws:
    GradleException if config does not exist
    
    Returns:
    mkdocs config file
  - void restoreBackup(java.io.File backup)
    
    Replace current configuration file with provided backup.
    throws:
    IllegalStateException if backup file or config does not exists
    
    Parameters:
    backup - configuration backup
  - void set(java.lang.String option, java.lang.String value)
    
    Replace option value in mkdocks config.
    Parameters:
    option - option name
    value - new option value

Summary:
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation