org.apache.flink.docs.util

Class ConfigurationOptionLocator

java.lang.Object

org.apache.flink.docs.util.ConfigurationOptionLocator

public class ConfigurationOptionLocator
extends Object

Utility for discovering config options.

Constructor Summary

Constructors

Constructor and Description
ConfigurationOptionLocator()
ConfigurationOptionLocator(OptionsClassLocation[] locations, String pathPrefix)

Method Summary

Modifier and Type	Method and Description
void	discoverOptionsAndApply(Path rootDir, BiConsumerWithException<Class<?>,Collection<OptionWithMetaInfo>,? extends Exception> optionsConsumer)
static List<Class<?>>	discoverOptionsAndApply(Path rootDir, String module, String packageName, String pathPrefix)
static List<OptionWithMetaInfo>	extractConfigOptions(Class<?> clazz)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationOptionLocator

public ConfigurationOptionLocator()

ConfigurationOptionLocator

public ConfigurationOptionLocator(OptionsClassLocation[] locations,
                                  String pathPrefix)

Method Detail

discoverOptionsAndApply

public void discoverOptionsAndApply(Path rootDir,
                                    BiConsumerWithException<Class<?>,Collection<OptionWithMetaInfo>,? extends Exception> optionsConsumer)
                             throws Exception

Throws:

Exception

discoverOptionsAndApply

public static List<Class<?>> discoverOptionsAndApply(Path rootDir,
                                                     String module,
                                                     String packageName,
                                                     String pathPrefix)
                                              throws IOException,
                                                     ClassNotFoundException

Throws:

IOException

ClassNotFoundException

extractConfigOptions

@VisibleForTesting
public static List<OptionWithMetaInfo> extractConfigOptions(Class<?> clazz)