org.zanata.client.commands

Class OptionsUtil

java.lang.Object

org.zanata.client.commands.OptionsUtil

public class OptionsUtil
extends Object

Constructor Summary

Constructors

Constructor and Description
OptionsUtil()

Method Summary

Modifier and Type	Method and Description
static void	applyConfigFiles(ConfigurableOptions opts) Loads the config files (controlled by the property userConfig) to supply any values which haven't already been set.
static void	applyConfigToGlossaryOptions(ConfigurableGlossaryOptions opts)
protected static void	applyIncludesAndExcludesFromProjectConfig(ConfigurableProjectOptions opts, ZanataConfig config) Note: command line options take precedence over pom.xml which takes precedence over zanata.xml.
static Optional<ZanataConfig>	applyProjectConfigToProjectOptions(ConfigurableProjectOptions opts)
protected static void	applySrcDirAndTransDirFromProjectConfig(ConfigurableProjectOptions opts, ZanataConfig config) Note: command line options take precedence over pom.xml which takes precedence over zanata.xml.
static void	applyUserConfig(ConfigurableOptions opts, org.apache.commons.configuration.HierarchicalINIConfiguration config) Applies values from the user's personal configuration unless they have been set directly (by parameters or by project configuration).
protected static void	checkPotentialMistakesInRules(ConfigurableProjectOptions opts, ConsoleInteractor console) Will check potential mistakes in file mapping rules.
static <O extends ConfigurableOptions> org.zanata.rest.client.RestClientFactory	createClientFactory(O opts) Creates rest client factory that will perform an eager REST version check.
static <O extends ConfigurableOptions> org.zanata.rest.client.RestClientFactory	createClientFactoryWithoutVersionCheck(O opts) Creates rest client factory that will NOT perform an eager REST version check.
static LocaleList	fetchLocalesFromServer(ConfigurableProjectOptions projectOpts, org.zanata.rest.client.RestClientFactory restClientFactory)
static Optional<ZanataConfig>	readProjectConfigFile(ConfigurableProjectOptions projOpts) Unmarshal project config (zanata.xml) file.
static boolean	shouldFetchLocalesFromServer(Optional<ZanataConfig> projectConfig, ConfigurableOptions opts)
static String	stripValidHolders(String rule)

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionsUtil

public OptionsUtil()

Method Detail

applyConfigFiles

public static void applyConfigFiles(ConfigurableOptions opts)
                             throws org.apache.commons.configuration.ConfigurationException,
                                    JAXBException

Loads the config files (controlled by the property userConfig) to supply any values which haven't already been set.

Throws:

Exception

org.apache.commons.configuration.ConfigurationException

JAXBException

applyProjectConfigToProjectOptions

public static Optional<ZanataConfig> applyProjectConfigToProjectOptions(ConfigurableProjectOptions opts)
                                                                 throws JAXBException

Throws:

JAXBException

shouldFetchLocalesFromServer

public static boolean shouldFetchLocalesFromServer(Optional<ZanataConfig> projectConfig,
                                                   ConfigurableOptions opts)

applyConfigToGlossaryOptions

public static void applyConfigToGlossaryOptions(ConfigurableGlossaryOptions opts)
                                         throws JAXBException

Throws:

JAXBException

readProjectConfigFile

public static Optional<ZanataConfig> readProjectConfigFile(ConfigurableProjectOptions projOpts)
                                                    throws JAXBException

Unmarshal project config (zanata.xml) file.

Parameters:

projOpts - project options

Returns:

optional ZanataConfig object

Throws:

JAXBException

fetchLocalesFromServer

public static LocaleList fetchLocalesFromServer(ConfigurableProjectOptions projectOpts,
                                                org.zanata.rest.client.RestClientFactory restClientFactory)

checkPotentialMistakesInRules

protected static void checkPotentialMistakesInRules(ConfigurableProjectOptions opts,
                                                    ConsoleInteractor console)

Will check potential mistakes in file mapping rules. Missing locale in the rule is considered invalid. Extra "{" and/or "}" will incur warnings (user may have mis-spelt the placeholder)

Parameters:

opts -

console -

applySrcDirAndTransDirFromProjectConfig

protected static void applySrcDirAndTransDirFromProjectConfig(ConfigurableProjectOptions opts,
                                                              ZanataConfig config)

Note: command line options take precedence over pom.xml which takes precedence over zanata.xml.

Parameters:

opts - options

config - config from project configuration file i.e. zanata.xml

See Also:

OptionMismatchChecker

applyIncludesAndExcludesFromProjectConfig

protected static void applyIncludesAndExcludesFromProjectConfig(ConfigurableProjectOptions opts,
                                                                ZanataConfig config)

Note: command line options take precedence over pom.xml which takes precedence over zanata.xml.

Parameters:

opts - options

config - config from project configuration file i.e. zanata.xml

See Also:

OptionMismatchChecker

applyUserConfig

public static void applyUserConfig(ConfigurableOptions opts,
                                   org.apache.commons.configuration.HierarchicalINIConfiguration config)

Applies values from the user's personal configuration unless they have been set directly (by parameters or by project configuration).

Parameters:

config -

stripValidHolders

public static String stripValidHolders(String rule)

createClientFactory

public static <O extends ConfigurableOptions> org.zanata.rest.client.RestClientFactory createClientFactory(O opts)

Creates rest client factory that will perform an eager REST version check.

createClientFactoryWithoutVersionCheck

public static <O extends ConfigurableOptions> org.zanata.rest.client.RestClientFactory createClientFactoryWithoutVersionCheck(O opts)

Creates rest client factory that will NOT perform an eager REST version check. You can call org.zanata.rest.client.RestClientFactory#performVersionCheck() afterwards.