proguard

Class ConfigurationParser

java.lang.Object

proguard.ConfigurationParser

All Implemented Interfaces:

java.lang.AutoCloseable

public class ConfigurationParser
extends java.lang.Object
implements java.lang.AutoCloseable

This class parses ProGuard configurations. Configurations can be read from an array of arguments or from a configuration file or URL. External references in file names ('<...>') can be resolved against a given set of properties.

Constructor Summary

Constructors

Constructor and Description
ConfigurationParser(java.io.File file) Deprecated. Temporary code for backward compatibility in Obclipse.
ConfigurationParser(java.io.File file, java.util.Properties properties) Creates a new ConfigurationParser for the given file and the given Properties.
ConfigurationParser(java.lang.String[] args, java.io.File baseDir, java.util.Properties properties) Creates a new ConfigurationParser for the given String arguments, with the given base directory and the given Properties.
ConfigurationParser(java.lang.String[] args, java.util.Properties properties) Creates a new ConfigurationParser for the given String arguments and the given Properties.
ConfigurationParser(java.lang.String lines, java.lang.String description, java.io.File baseDir, java.util.Properties properties) Creates a new ConfigurationParser for the given lines, with the given base directory and the given Properties.
ConfigurationParser(java.net.URL url, java.util.Properties properties) Creates a new ConfigurationParser for the given URL and the given Properties.
ConfigurationParser(WordReader reader, java.util.Properties properties) Creates a new ConfigurationParser for the given word reader and the given Properties.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the configuration.
static void	main(java.lang.String[] args) A main method for testing configuration parsing.
void	parse(Configuration configuration) Parses and returns the configuration.
void	parse(Configuration configuration, java.util.function.BiConsumer<java.lang.String,java.lang.String> unknownOptionHandler) Parses and returns the configuration.
ClassSpecification	parseClassSpecificationArguments()
ClassSpecification	parseClassSpecificationArguments(boolean readFirstWord, boolean allowClassMembers, boolean allowValues) Parses and returns a class specification.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationParser

public ConfigurationParser(java.lang.String[] args,
                           java.util.Properties properties)
                    throws java.io.IOException

Creates a new ConfigurationParser for the given String arguments and the given Properties.

Throws:

java.io.IOException

ConfigurationParser

public ConfigurationParser(java.lang.String[] args,
                           java.io.File baseDir,
                           java.util.Properties properties)
                    throws java.io.IOException

Creates a new ConfigurationParser for the given String arguments, with the given base directory and the given Properties.

Throws:

java.io.IOException

ConfigurationParser

public ConfigurationParser(java.lang.String lines,
                           java.lang.String description,
                           java.io.File baseDir,
                           java.util.Properties properties)
                    throws java.io.IOException

Creates a new ConfigurationParser for the given lines, with the given base directory and the given Properties.

Throws:

java.io.IOException

ConfigurationParser

public ConfigurationParser(java.io.File file)
                    throws java.io.IOException

Deprecated. Temporary code for backward compatibility in Obclipse.

Creates a new ConfigurationParser for the given file, with the system Properties.

Throws:

java.io.IOException

ConfigurationParser

public ConfigurationParser(java.io.File file,
                           java.util.Properties properties)
                    throws java.io.IOException

Creates a new ConfigurationParser for the given file and the given Properties.

Throws:

java.io.IOException

ConfigurationParser

public ConfigurationParser(java.net.URL url,
                           java.util.Properties properties)
                    throws java.io.IOException

Creates a new ConfigurationParser for the given URL and the given Properties.

Throws:

java.io.IOException

ConfigurationParser

public ConfigurationParser(WordReader reader,
                           java.util.Properties properties)
                    throws java.io.IOException

Creates a new ConfigurationParser for the given word reader and the given Properties.

Throws:

java.io.IOException

Method Detail

parse

public void parse(Configuration configuration)
           throws ParseException,
                  java.io.IOException

Parses and returns the configuration.

Parameters:

configuration - the configuration that is updated as a side-effect.

Throws:

ParseException - if the any of the configuration settings contains a syntax error.

java.io.IOException - if an IO error occurs while reading a configuration.

parse

public void parse(Configuration configuration,
                  java.util.function.BiConsumer<java.lang.String,java.lang.String> unknownOptionHandler)
           throws ParseException,
                  java.io.IOException

Parses and returns the configuration.

Parameters:

configuration - the configuration that is updated as a side-effect.

unknownOptionHandler - optional handler for unknown options; if null then a ParseException is thrown when encountering an unknown option.

Throws:

ParseException - if the any of the configuration settings contains a syntax error.

java.io.IOException - if an IO error occurs while reading a configuration.

close

public void close()
           throws java.io.IOException

Closes the configuration.

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException - if an IO error occurs while closing the configuration.

parseClassSpecificationArguments

public ClassSpecification parseClassSpecificationArguments()
                                                    throws ParseException,
                                                           java.io.IOException

Throws:

ParseException

java.io.IOException

parseClassSpecificationArguments

public ClassSpecification parseClassSpecificationArguments(boolean readFirstWord,
                                                           boolean allowClassMembers,
                                                           boolean allowValues)
                                                    throws ParseException,
                                                           java.io.IOException

Parses and returns a class specification. For example: "public class SomeClass { public void someMethod(); }"

Throws:

ParseException - if the class specification contains a syntax error.

java.io.IOException - if an IO error occurs while reading the class specification.

main

public static void main(java.lang.String[] args)

A main method for testing configuration parsing.