Package alluxio.cli.docgen

Class ConfigurationDocGenerator

java.lang.Object

alluxio.cli.docgen.ConfigurationDocGenerator

@ThreadSafe
@PublicApi
public final class ConfigurationDocGenerator
extends java.lang.Object

CSV_FILE_DIR utility to generate property keys to csv files.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CSV_FILE_HEADER

Method Summary

Modifier and Type	Method	Description
static void	generate()	Generates the configuration docs.
static void	writeCSVFile(java.util.Collection<? extends alluxio.conf.PropertyKey> defaultKeys, java.lang.String filePath)	Writes property key to csv files.
static void	writeYMLFile(java.util.Collection<? extends alluxio.conf.PropertyKey> defaultKeys, java.lang.String filePath)	Writes description of property key to yml files.

Methods inherited from class java.lang.Object

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

Field Detail

CSV_FILE_HEADER

public static final java.lang.String CSV_FILE_HEADER

See Also:

Constant Field Values

Method Detail

writeCSVFile

public static void writeCSVFile(java.util.Collection<? extends alluxio.conf.PropertyKey> defaultKeys,
                                java.lang.String filePath)
                         throws java.io.IOException

Writes property key to csv files.

Parameters:

defaultKeys - Collection which is from PropertyKey DEFAULT_KEYS_MAP.values()

filePath - path for csv files

Throws:

java.io.IOException

writeYMLFile

public static void writeYMLFile(java.util.Collection<? extends alluxio.conf.PropertyKey> defaultKeys,
                                java.lang.String filePath)
                         throws java.io.IOException

Writes description of property key to yml files.

Parameters:

defaultKeys - Collection which is from PropertyKey DEFAULT_KEYS_MAP.values()

filePath - path for csv files

Throws:

java.io.IOException

generate

public static void generate()
                     throws java.io.IOException

Generates the configuration docs.

Throws:

java.io.IOException