org.apache.flex.compiler.internal.fxg.dom

Class DOMParserHelper

java.lang.Object

org.apache.flex.compiler.internal.fxg.dom.DOMParserHelper

public class DOMParserHelper
extends Object

Utilities to help parsing FXG.

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	idPattern
static Pattern	rgbPattern

Constructor Summary

Constructors

Constructor and Description
DOMParserHelper()

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	parseBoolean(IFXGNode node, String value, String name, boolean defaultValue, Collection<ICompilerProblem> problems) Convert an FXG String value to a boolean.
static double	parseDouble(IFXGNode node, String value, double min, double max) Convert an FXG String value to a double and check that the result is within the specified range (inclusive).
static double	parseDouble(IFXGNode node, String value, String name, double defaultValue, Collection<ICompilerProblem> problems) Convert an FXG String value to a double.
static double	parseDouble(IFXGNode node, String value, String name, double min, double max, double defaultValue, Collection<ICompilerProblem> problems) Convert an FXG String value to a double and check that the result is within the specified range (inclusive).
static FillMode	parseFillMode(IFXGNode node, String value, FillMode defaultValue, Collection<ICompilerProblem> problems) Convert an FXG String value to a fillMode enumeration.
static float	parseFloat(IFXGNode node, String value) Convert an FXG String value to a float.
static float	parseFloat(IFXGNode node, String name, String value, float defaultValue, Collection<ICompilerProblem> problems) Convert an FXG String value to a float.
static String	parseIdentifier(IFXGNode node, String name, String value, String defaultValue, Collection<ICompilerProblem> problems) Convert an FXG String value to a Identifier matching pattern [a-zA-Z_][a-zA-Z_0-9]*.
static int	parseInt(IFXGNode node, String value, int min, int max) Convert an FXG String value to an int and check that the result is within the specified range (inclusive).
static int	parseInt(IFXGNode node, String value, String name, int min, int max, int defaultValue, Collection<ICompilerProblem> problems) Convert an FXG String value to an int and check that the result is within the specified range (inclusive).
static InterpolationMethod	parseInterpolationMethod(IFXGNode node, String value, InterpolationMethod defaultValue, Collection<ICompilerProblem> problems) Convert an FXG String value to an InterpolationMethod enumeration.
static MaskType	parseMaskType(IFXGNode node, String value, MaskType defaultValue, Collection<ICompilerProblem> problems) Convert an FXG String value to a MaskType enumeration.
static double	parseNumberPercent(IFXGNode node, String value, double min, double max) Convert an FXG String value to a double after taking care of the % sign.
static double	parseNumberPercent(IFXGNode node, String value, String name, double min, double max, double defaultValue, Collection<ICompilerProblem> problems) Convert an FXG String value to a double after taking care of the % sign.
static double	parseNumberPercentWithSeparateRange(IFXGNode node, String value, String name, double minNumber, double maxNumber, double minPercent, double maxPercent, double defaultValue, Collection<ICompilerProblem> problems) Convert an FXG String value to a double after taking care of the % sign.
static double	parsePercent(IFXGNode node, String value, String name, double defaultValue, Collection<ICompilerProblem> problems) Convert an FXG String value to a double after taking care of the % sign.
static int	parseRGB(IFXGNode node, String value, String name, int defaultValue, Collection<ICompilerProblem> problems) Convert an FXG hexadecimal color String to an int.
static SpreadMethod	parseSpreadMethod(IFXGNode node, String value, SpreadMethod defaultValue, Collection<ICompilerProblem> problems) Convert an FXG String value to a SpreadMethod enumeration.

Methods inherited from class java.lang.Object

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

Field Detail

idPattern

public static Pattern idPattern

rgbPattern

public static Pattern rgbPattern

Constructor Detail

DOMParserHelper

public DOMParserHelper()

Method Detail

parseBoolean

public static boolean parseBoolean(IFXGNode node,
                   String value,
                   String name,
                   boolean defaultValue,
                   Collection<ICompilerProblem> problems)

Convert an FXG String value to a boolean.

Parameters:

node - - the FXG node.

value - - the FXG String value.

name - - the FXG attribute name.

defaultValue - default value to use in case of any problem

problems - problem collection used to collect problems occurred within this method

Returns:

true for the String 'true' (case insensitive), otherwise false.

parseRGB

public static int parseRGB(IFXGNode node,
           String value,
           String name,
           int defaultValue,
           Collection<ICompilerProblem> problems)

Convert an FXG hexadecimal color String to an int. The format must be a '#' character followed by six hexadecimal characters, i.e. '#RRGGBB'.

Parameters:

node - - the FXG node.

value - - an FXG a hexadecimal color String.

name - - the FXG attribute name.

defaultValue - default value to use in case of any problem

problems - problem collection used to collect problems occurred within this method

Returns:

an RGB color represented as an int.

parseDouble

public static double parseDouble(IFXGNode node,
                 String value,
                 String name,
                 double defaultValue,
                 Collection<ICompilerProblem> problems)

Convert an FXG String value to a double.

Parameters:

node - - the FXG node.

value - - the FXG String value.

name - - the FXG attribute name.

defaultValue - default value to use in case of any problem

problems - problem collection used to collect problems occurred within this method

Returns:

the double precision floating point value represented by the String.

parsePercent

public static double parsePercent(IFXGNode node,
                  String value,
                  String name,
                  double defaultValue,
                  Collection<ICompilerProblem> problems)

Convert an FXG String value to a double after taking care of the % sign.

Parameters:

node - - the FXG node.

value - - the FXG String value.

name - - the FXG attribute name.

defaultValue - default value to use in case of any problem

problems - problem collection used to collect problems occurred within this method

Returns:

the double precision floating point value represented by the String.

parseNumberPercent

public static double parseNumberPercent(IFXGNode node,
                        String value,
                        String name,
                        double min,
                        double max,
                        double defaultValue,
                        Collection<ICompilerProblem> problems)

Convert an FXG String value to a double after taking care of the % sign. If the value is double, it is checked against the specified range (inclusive).

Parameters:

node - - the FXG node.

value - - the FXG String value.

name - - the FXG attribute name.

min - - the smallest double value that the result must be greater or equal to.

max - - the largest double value that the result must be smaller than or equal to.

defaultValue - - the default double value; if the encountered minor version is later than the supported minor version and the attribute value is out-of-range, the default value is returned.

problems - problem collection used to collect problems occurred within this method.

Returns:

the double precision floating point value represented by the String.

parseNumberPercent

public static double parseNumberPercent(IFXGNode node,
                        String value,
                        double min,
                        double max)
                                 throws NumberFormatException

Convert an FXG String value to a double after taking care of the % sign. If the value is double, it is checked against the specified range (inclusive).

Parameters:

node - - the FXG node.

value - - the FXG String value.

min - - the smallest double value that the result must be greater or equal to.

max - - the largest double value that the result must be smaller than or equal to.

Returns:

the double precision floating point value represented by the String.

Throws:

NumberFormatException - if the number is not in an acceptable format or out of bounds defined by min and max.

parseNumberPercentWithSeparateRange

public static double parseNumberPercentWithSeparateRange(IFXGNode node,
                                         String value,
                                         String name,
                                         double minNumber,
                                         double maxNumber,
                                         double minPercent,
                                         double maxPercent,
                                         double defaultValue,
                                         Collection<ICompilerProblem> problems)

Convert an FXG String value to a double after taking care of the % sign. If the value is double, it is checked against the specified range (inclusive). There are separate ranges for percent and number.

Parameters:

node - - the FXG node.

value - - the FXG String value.

minNumber - - the smallest double value that the result must be greater or equal to.

maxNumber - - the largest double value that the result must be smaller than or equal to.

defaultValue - - the default double value; if the encountered minor version is later than the supported minor version and the attribute value is out-of-range, the default value is returned.

problems - problem collection used to collect problems occurred within this method.

Returns:

the double precision floating point value represented by the String.

parseDouble

public static double parseDouble(IFXGNode node,
                 String value,
                 double min,
                 double max)
                          throws NumberFormatException

Convert an FXG String value to a double and check that the result is within the specified range (inclusive).

Parameters:

node - - the FXG node.

value - - the FXG String value.

min - - the smallest double value that the result must be greater or equal to.

max - - the largest double value that the result must be smaller than or equal to.

Returns:

the double precision floating point value represented by the String.

Throws:

NumberFormatException - if the number is not in an acceptable format or out of bounds defined by min and max.

parseDouble

public static double parseDouble(IFXGNode node,
                 String value,
                 String name,
                 double min,
                 double max,
                 double defaultValue,
                 Collection<ICompilerProblem> problems)

Convert an FXG String value to a double and check that the result is within the specified range (inclusive).

Parameters:

node - - the FXG node.

value - - the FXG String value.

name - - the FXG attribute name.

min - - the smallest double value that the result must be greater or equal to.

max - - the largest double value that the result must be smaller than or equal to.

defaultValue - - the default double value; if the encountered minor version is later than the supported minor version and the attribute value is out-of-range, the default value is returned.

problems - problem collection used to collect problems occurred within this method.

Returns:

the double precision floating point value represented by the String.

parseFloat

public static float parseFloat(IFXGNode node,
               String name,
               String value,
               float defaultValue,
               Collection<ICompilerProblem> problems)

Convert an FXG String value to a float.

Parameters:

node - - the FXG node.

value - - the FXG String value.

defaultValue - default value to use in case of any problem

problems - problem collection used to collect problems occurred within this method

Returns:

the floating point value represented by the String.

parseFloat

public static float parseFloat(IFXGNode node,
               String value)
                        throws NumberFormatException

Convert an FXG String value to a float.

Parameters:

node - - the FXG node.

value - - the FXG String value.

Returns:

the floating point value represented by the String.

Throws:

NumberFormatException - if the number is not in an acceptable format.

parseInt

public static int parseInt(IFXGNode node,
           String value,
           String name,
           int min,
           int max,
           int defaultValue,
           Collection<ICompilerProblem> problems)

Convert an FXG String value to an int and check that the result is within the specified range (inclusive).

Parameters:

node - - the FXG node.

value - - the FXG String value.

name - - the FXG attribute name.

min - - the smallest int value that the result must be greater or equal to.

max - - the largest int value that the result must be smaller than or equal to.

defaultValue - - the default int value; if the encountered minor version is later than the supported minor version and the attribute value is out-of-range, the default value is returned.

problems - problem collection used to collect problems occurred within this method.

Returns:

the integer value represented by the String.

parseInt

public static int parseInt(IFXGNode node,
           String value,
           int min,
           int max)
                    throws NumberFormatException

Convert an FXG String value to an int and check that the result is within the specified range (inclusive).

Parameters:

node - - the FXG node.

value - - the FXG String value.

min - - the smallest int value that the result must be greater or equal to.

max - - the largest int value that the result must be smaller than or equal to.

Returns:

the integer value represented by the String.

Throws:

NumberFormatException - if the number is not in an acceptable format or out of bounds defined by min and max.

parseInterpolationMethod

public static InterpolationMethod parseInterpolationMethod(IFXGNode node,
                                           String value,
                                           InterpolationMethod defaultValue,
                                           Collection<ICompilerProblem> problems)

Convert an FXG String value to an InterpolationMethod enumeration.

Parameters:

node - - the FXG node.

value - - the FXG String value

defaultValue - - the FXG InterpolationMethod default value

problems - problem collection used to collect problems occurred within this method.

Returns:

the matching InterpolationMethod; if the encountered minor version is later than the supported minor version and the attribute value is out-of-range, the default value is returned.

parseMaskType

public static MaskType parseMaskType(IFXGNode node,
                     String value,
                     MaskType defaultValue,
                     Collection<ICompilerProblem> problems)

Convert an FXG String value to a MaskType enumeration.

Parameters:

node - - the FXG node.

value - - the FXG String value

defaultValue - - the FXG MaskType default value; if the encountered minor version is later than the supported minor version and the attribute value is out-of-range, the default value is returned.

problems - problem collection used to collect problems occurred within this method.

Returns:

the matching MaskType

parseFillMode

public static FillMode parseFillMode(IFXGNode node,
                     String value,
                     FillMode defaultValue,
                     Collection<ICompilerProblem> problems)

Convert an FXG String value to a fillMode enumeration.

Parameters:

node - - the FXG node.

value - - the FXG String value.

defaultValue - default value to use in case of any problem

problems - problem collection used to collect problems occurred within this method

Returns:

the matching fillMode value.

parseSpreadMethod

public static SpreadMethod parseSpreadMethod(IFXGNode node,
                             String value,
                             SpreadMethod defaultValue,
                             Collection<ICompilerProblem> problems)

Convert an FXG String value to a SpreadMethod enumeration.

Parameters:

node - - the FXG node.

value - - the FXG String value

defaultValue - - the FXG SpreadMethod default value

problems - problem collection used to collect problems occurred within this method.

Returns:

the matching SpreadMethod; if the encountered minor version is later than the supported minor version and the attribute value is out-of-range, the default value is returned.

parseIdentifier

public static String parseIdentifier(IFXGNode node,
                     String name,
                     String value,
                     String defaultValue,
                     Collection<ICompilerProblem> problems)

Convert an FXG String value to a Identifier matching pattern [a-zA-Z_][a-zA-Z_0-9]*.

Parameters:

node - - the FXG node.

value - - the FXG String value

defaultValue - default value to use in case of any problem

problems - problem collection used to collect problems occurred within this method