MXMLDialect (Apache Flex - FlexJS: Compiler: Parent 0.8.0-SNAPSHOT API)

java.lang.Object
- org.apache.flex.compiler.internal.mxml.MXMLDialect

Direct Known Subclasses:

MXMLDialect2006
```
public abstract class MXMLDialect
extends Object
```
This is the abstract base class for classes representing dialects of MXML, such as MXML 2006 or MXML 2009.
Each MXML dialect has a unique language namespace, such as "http://ns.adobe.com/mxml/2009" for MXML 2009.
You can use an MXML dialect to get the XML name for various core tags of the language, such as ("http://ns.adobe.com/mxml/2009", "Library") for the <Library> tag of MXML 2009. The name will be null if the tag is not supported in the dialect. For example, the <Library> tag does not exist in MXML 2006.
You can also use an MXML dialect to perform core MXML parsing, such as parsing ActionScript values of type Boolean, int, etc. from attribute values and character data.
Static methods on this class allow you to determine whether a URI is language namespace for a dialect of MXML, and to get the dialect object for that namespace.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MXMLDialect.TextParsingFlags
Flags that affect how the parsing methods work.

Nested Classes
Modifier and Type	Class and Description
`static class`	`MXMLDialect.TextParsingFlags` Flags that affect how the parsing methods work.

Field Summary

Fields
Modifier and Type	Field and Description
`protected XMLName`	`bindingXMLName`
`protected XMLName`	`componentXMLName`
`protected XMLName`	`declarationsXMLName`
`static MXMLDialect`	`DEFAULT` The `MXMLDialect` representing the default dialect of MXML.
`protected XMLName`	`definitionXMLName`
`protected XMLName`	`libraryXMLName`
`protected XMLName`	`metadataXMLName`
`protected XMLName`	`modelXMLName`
`static MXMLDialect`	`MXML_2006` The `MXMLDialect` representing MXML 2006.
`static MXMLDialect`	`MXML_2009` The `MXMLDialect` representing MXML 2009.
`static MXMLDialect`	`MXML_2012` The `MXMLDialect` representing MXML 2012 (experimental).
`protected XMLName`	`privateXMLName`
`protected XMLName`	`reparentXMLName`
`protected XMLName`	`scriptXMLName`
`protected XMLName`	`styleXMLName`

Constructor Summary

Constructors
Modifier Constructor and Description

protected MXMLDialect(String languageNamespace, int year)
Constructor.

Constructors
Modifier	Constructor and Description
`protected`	`MXMLDialect(String languageNamespace, int year)` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`abstract String`	`collapseWhitespace(String s, char replacementChar)` Removes whitespace from the input string and returns a string that contains at most 1 'replacementChar' character between each word.
`static MXMLDialect`	`getDialectForLanguageNamespace(String uri)` Gets the `MXMLDialect` object corresponding to a specified language namespace.
`String`	`getLanguageNamespace()` Gets the language namespace for this dialect of MXML.
`static MXMLDialect`	`getMXMLDialect(PrefixMap rootPrefixMap)` Given a `PrefixMap` representing the `xmlns` attributes on the root tag, determines which dialect of MXML is being used.
`Character`	`getNamedEntity(String entityName)` Gets the character corresponding to an entity name in this dialect of MXML.
`boolean`	`isEqualToOrAfter(MXMLDialect other)` Determines whether this dialect is equal to, or later than, another dialect.
`boolean`	`isEqualToOrBefore(MXMLDialect other)` Determines whether this dialect is equal to, or earlier than, another dialect.
`static boolean`	`isLanguageNamespace(String uri)` Determines whether a specified URI is the language namespace for a supported dialect of MXML.
`abstract boolean`	`isWhitespace(char c)` Determines whether a character is considered whitespace in this dialect of MXML.
`abstract boolean`	`isWhitespace(String s)` Determines whether a text String contains only characters that are considered whitespace in this dialect of MXML.
`abstract List<Object>`	`parseArray(FlexProject project, String s, EnumSet<MXMLDialect.TextParsingFlags> flags)` Parses an ActionScript `Array` value from a string.
`abstract Boolean`	`parseBoolean(FlexProject project, String s, EnumSet<MXMLDialect.TextParsingFlags> flags)` Parses an ActionScript `Boolean` value from a string.
`abstract Integer`	`parseInt(FlexProject project, String s, EnumSet<MXMLDialect.TextParsingFlags> flags)` Parses an ActionScript `int` value from a string.
`abstract Number`	`parseNumber(FlexProject project, String s, EnumSet<MXMLDialect.TextParsingFlags> flags)` Parses an ActionScript `Number` value from a string.
`abstract Object`	`parseObject(FlexProject project, String s, EnumSet<MXMLDialect.TextParsingFlags> flags)` Parses an ActionScript value from a string.
`abstract String`	`parseString(FlexProject project, String s, EnumSet<MXMLDialect.TextParsingFlags> flags)` Parses an ActionScript `String` value from a string.
`abstract Long`	`parseUint(FlexProject project, String s, EnumSet<MXMLDialect.TextParsingFlags> flags)` Parses an ActionScript `uint` value from a string.
`XMLName`	`resolveArray()` Gets the XML name of the `<Array>` tag in this dialect of MXML.
`XMLName`	`resolveBinding()` Gets the XML name of the `<Binding>` tag in this dialect of MXML.
`XMLName`	`resolveBoolean()` Gets the XML name of the `<Boolean>` tag in this dialect of MXML.
`XMLName`	`resolveClass()` Gets the XML name of the `<Class>` tag in this dialect of MXML.
`XMLName`	`resolveComponent()` Gets the XML name of the `<Component>` tag in this dialect of MXML.
`XMLName`	`resolveDate()` Gets the XML name of the `<Date>` tag in this dialect of MXML.
`XMLName`	`resolveDeclarations()` Gets the XML name of the `<De3clarations>` tag in this dialect of MXML.
`XMLName`	`resolveDefinition()` Gets the XML name of the `<Definition>` tag in this dialect of MXML.
`XMLName`	`resolveFunction()` Gets the XML name of the `<Function>` tag in this dialect of MXML.
`XMLName`	`resolveInt()` Gets the XML name of the `<int>` tag in this dialect of MXML.
`XMLName`	`resolveLibrary()` Gets the XML name of the `<Library>` tag in this dialect of MXML.
`XMLName`	`resolveMetadata()` Gets the XML name of the `<Metadata>` tag in this dialect of MXML.
`XMLName`	`resolveModel()` Gets the XML name of the `<Model>` tag in this dialect of MXML.
`XMLName`	`resolveNumber()` Gets the XML name of the `<Number>` tag in this dialect of MXML.
`XMLName`	`resolveObject()` Gets the XML name of the `<Object>` tag in this dialect of MXML.
`XMLName`	`resolvePrivate()` Gets the XML name of the `<Private>` tag in this dialect of MXML.
`XMLName`	`resolveReparent()` Gets the XML name of the `<Reparent>` tag in this dialect of MXML.
`XMLName`	`resolveScript()` Gets the XML name of the `<Script>` tag in this dialect of MXML.
`XMLName`	`resolveString()` Gets the XML name of the `<String>` tag in this dialect of MXML.
`XMLName`	`resolveStyle()` Gets the XML name of the `<Style>` tag in this dialect of MXML.
`XMLName`	`resolveUint()` Gets the XML name of the `<uint>` tag in this dialect of MXML.
`XMLName`	`resolveXML()` Gets the XML name of the `<XML>` tag in this dialect of MXML.
`XMLName`	`resolveXMLList()` Gets the XML name of the `<XMLList>` tag in this dialect of MXML.
`abstract String[]`	`splitAndTrim(String s)` Splits a string at commas and then trims whitespace from each part.
`abstract String`	`trim(String s)` Removes any leading and trailing characters from a String that are considered whitespace in this version of MXML.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - MXML_2012
```
public static final MXMLDialect MXML_2012
```
    The MXMLDialect representing MXML 2012 (experimental).
  - MXML_2009
```
public static final MXMLDialect MXML_2009
```
    The MXMLDialect representing MXML 2009.
  - MXML_2006
```
public static final MXMLDialect MXML_2006
```
    The MXMLDialect representing MXML 2006.
  - DEFAULT
```
public static final MXMLDialect DEFAULT
```
    The MXMLDialect representing the default dialect of MXML. It is used when the dialect is not explicitly expressed.
  - bindingXMLName
```
protected XMLName bindingXMLName
```
  - componentXMLName
```
protected XMLName componentXMLName
```
  - declarationsXMLName
```
protected XMLName declarationsXMLName
```
  - definitionXMLName
```
protected XMLName definitionXMLName
```
  - libraryXMLName
```
protected XMLName libraryXMLName
```
  - metadataXMLName
```
protected XMLName metadataXMLName
```
  - modelXMLName
```
protected XMLName modelXMLName
```
  - privateXMLName
```
protected XMLName privateXMLName
```
  - reparentXMLName
```
protected XMLName reparentXMLName
```
  - scriptXMLName
```
protected XMLName scriptXMLName
```
  - styleXMLName
```
protected XMLName styleXMLName
```
- Constructor Detail
  - MXMLDialect
```
protected MXMLDialect(String languageNamespace,
           int year)
```
    Constructor.
    
    Parameters:
    languageNamespace - The language namespace URI that identifies this dialect of MXML, such as "http://ns.adobe.com/mxml/2009" for MXML 2009.
    year - The numeric value (such as 2009) used for comparing different dialects of MXML.
- Method Detail
  - isLanguageNamespace
```
public static boolean isLanguageNamespace(String uri)
```
    Determines whether a specified URI is the language namespace for a supported dialect of MXML.
    The supported URIs are:
    - "http://www.adobe.com/2006/mxml" for MXML 2006
    - "http://ns.adobe.com/mxml/2009" for MXML 2009
    - "http://ns.adobe.com/mxml/2012" for MXML 2012
    Parameters:
    uri - A URI specifying a language namespace.
    
    Returns:
    true if the URI is a supported language namespace.
  - getDialectForLanguageNamespace
```
public static MXMLDialect getDialectForLanguageNamespace(String uri)
```
    Gets the MXMLDialect object corresponding to a specified language namespace.
    
    Parameters:
    uri - A URI string specifying a langauge namespace.
    
    Returns:
    An MXMLDialect or null.
  - getMXMLDialect
```
public static MXMLDialect getMXMLDialect(PrefixMap rootPrefixMap)
```
    Given a PrefixMap representing the xmlns attributes on the root tag, determines which dialect of MXML is being used.
    
    Parameters:
    rootPrefixMap - A PrefixMap.
    
    Returns:
    An MXMLDialect.
  - getLanguageNamespace
```
public String getLanguageNamespace()
```
    Gets the language namespace for this dialect of MXML.
    For MXML 2009, for example, this is "http://ns.adobe.com/mxml/2009".
    
    Returns:
    The language namespace as a String.
  - isEqualToOrAfter
```
public boolean isEqualToOrAfter(MXMLDialect other)
```
    Determines whether this dialect is equal to, or later than, another dialect.
    
    Parameters:
    other - Another MXMLDialect.
    
    Returns:
    true
  - isEqualToOrBefore
```
public boolean isEqualToOrBefore(MXMLDialect other)
```
    Determines whether this dialect is equal to, or earlier than, another dialect.
    
    Parameters:
    other - Another MXMLDialect.
    
    Returns:
    true
  - resolveArray
```
public XMLName resolveArray()
```
    Gets the XML name of the <Array> tag in this dialect of MXML.
    
    Returns:
    An XMLName or null if this tag is not supported.
  - resolveBinding
```
public XMLName resolveBinding()
```
    Gets the XML name of the <Binding> tag in this dialect of MXML.
    
    Returns:
    An XMLName or null if this tag is not supported.
  - resolveBoolean
```
public XMLName resolveBoolean()
```
    Gets the XML name of the <Boolean> tag in this dialect of MXML.
    
    Returns:
    An XMLName or null if this tag is not supported.
  - resolveClass
```
public XMLName resolveClass()
```
    Gets the XML name of the <Class> tag in this dialect of MXML.
    
    Returns:
    An XMLName or null if this tag is not supported.
  - resolveComponent
```
public XMLName resolveComponent()
```
    Gets the XML name of the <Component> tag in this dialect of MXML.
    
    Returns:
    An XMLName or null if this tag is not supported.
  - resolveDeclarations
```
public XMLName resolveDeclarations()
```
    Gets the XML name of the <De3clarations> tag in this dialect of MXML.
    
    Returns:
    An XMLName or null if this tag is not supported.
  - resolveDate
```
public XMLName resolveDate()
```
    Gets the XML name of the <Date> tag in this dialect of MXML.
    
    Returns:
    An XMLName or null if this tag is not supported.
  - resolveDefinition
```
public XMLName resolveDefinition()
```
    Gets the XML name of the <Definition> tag in this dialect of MXML.
    
    Returns:
    An XMLName or null if this tag is not supported.
  - resolveFunction
```
public XMLName resolveFunction()
```
    Gets the XML name of the <Function> tag in this dialect of MXML.
    
    Returns:
    An XMLName or null if this tag is not supported.
  - resolveInt
```
public XMLName resolveInt()
```
    Gets the XML name of the <int> tag in this dialect of MXML.
    
    Returns:
    An XMLName or null if this tag is not supported.
  - resolveLibrary
```
public XMLName resolveLibrary()
```
    Gets the XML name of the <Library> tag in this dialect of MXML.
    
    Returns:
    An XMLName or null if this tag is not supported.
  - resolveMetadata
```
public XMLName resolveMetadata()
```
    Gets the XML name of the <Metadata> tag in this dialect of MXML.
    
    Returns:
    An XMLName or null if this tag is not supported.
  - resolveModel
```
public XMLName resolveModel()
```
    Gets the XML name of the <Model> tag in this dialect of MXML.
    
    Returns:
    An XMLName or null if this tag is not supported.
  - resolveNumber
```
public XMLName resolveNumber()
```
    Gets the XML name of the <Number> tag in this dialect of MXML.
    
    Returns:
    An XMLName or null if this tag is not supported.
  - resolveObject
```
public XMLName resolveObject()
```
    Gets the XML name of the <Object> tag in this dialect of MXML.
    
    Returns:
    An XMLName or null if this tag is not supported.
  - resolvePrivate
```
public XMLName resolvePrivate()
```
    Gets the XML name of the <Private> tag in this dialect of MXML.
    
    Returns:
    An XMLName or null if this tag is not supported.
  - resolveReparent
```
public XMLName resolveReparent()
```
    Gets the XML name of the <Reparent> tag in this dialect of MXML.
    
    Returns:
    An XMLName or null if this tag is not supported.
  - resolveScript
```
public XMLName resolveScript()
```
    Gets the XML name of the <Script> tag in this dialect of MXML.
    
    Returns:
    An XMLName or null if this tag is not supported.
  - resolveString
```
public XMLName resolveString()
```
    Gets the XML name of the <String> tag in this dialect of MXML.
    
    Returns:
    An XMLName or null if this tag is not supported.
  - resolveStyle
```
public XMLName resolveStyle()
```
    Gets the XML name of the <Style> tag in this dialect of MXML.
    
    Returns:
    An XMLName or null if this tag is not supported.
  - resolveUint
```
public XMLName resolveUint()
```
    Gets the XML name of the <uint> tag in this dialect of MXML.
    
    Returns:
    An XMLName or null if this tag is not supported.
  - resolveXML
```
public XMLName resolveXML()
```
    Gets the XML name of the <XML> tag in this dialect of MXML.
    
    Returns:
    An XMLName or null if this tag is not supported.
  - resolveXMLList
```
public XMLName resolveXMLList()
```
    Gets the XML name of the <XMLList> tag in this dialect of MXML.
    
    Returns:
    An XMLName or null if this tag is not supported.
  - getNamedEntity
```
public Character getNamedEntity(String entityName)
```
    Gets the character corresponding to an entity name in this dialect of MXML.
    For example, if you pass the entity name "lt", this returns the character '>'.
    
    Returns:
    A Character, or null if the entity name is invalid in this dialect of MXML.
  - isWhitespace
```
public abstract boolean isWhitespace(char c)
```
    Determines whether a character is considered whitespace in this dialect of MXML.
    
    Parameters:
    c - The character.
    
    Returns:
    true if the character is whitespace.
  - isWhitespace
```
public abstract boolean isWhitespace(String s)
```
    Determines whether a text String contains only characters that are considered whitespace in this dialect of MXML.
    
    Parameters:
    s - The string.
    
    Returns:
    true if the string is all-whitespace, or empty.
  - collapseWhitespace
```
public abstract String collapseWhitespace(String s,
                        char replacementChar)
```
    Removes whitespace from the input string and returns a string that contains at most 1 'replacementChar' character between each word.
    This method can be used to strip newlines, tabs, multiple spaces, etc. between words and replace them with a single space.
    
    Parameters:
    s - The input String.
    replacementChar - The character that replaces whitespace between words.
    
    Returns:
    The output String.
  - trim
```
public abstract String trim(String s)
```
    Removes any leading and trailing characters from a String that are considered whitespace in this version of MXML.
    
    Parameters:
    s - A String.
    
    Returns:
    A new String with the leading and trailing whitespace removed.
  - splitAndTrim
```
public abstract String[] splitAndTrim(String s)
```
    Splits a string at commas and then trims whitespace from each part.
    
    Parameters:
    s - The input string.
    
    Returns:
    An array of trimmed strings split from the input string.
  - parseBoolean
```
public abstract Boolean parseBoolean(FlexProject project,
                   String s,
                   EnumSet<MXMLDialect.TextParsingFlags> flags)
```
    Parses an ActionScript Boolean value from a string.
    
    Parameters:
    project - The FlexProject within which the MXML is being parsed.
    s - The string to be parsed.
    flags - A set of flags controlling the text parsing.
    
    Returns:
    A Java Boolean representing the ActionScript Boolean, or null.
  - parseInt
```
public abstract Integer parseInt(FlexProject project,
               String s,
               EnumSet<MXMLDialect.TextParsingFlags> flags)
```
    Parses an ActionScript int value from a string.
    
    Parameters:
    project - The FlexProject within which the MXML is being parsed.
    s - The string to be parsed.
    flags - A set of flags controlling the text parsing.
    
    Returns:
    A Java Integer representing the ActionScript int, or null.
  - parseUint
```
public abstract Long parseUint(FlexProject project,
             String s,
             EnumSet<MXMLDialect.TextParsingFlags> flags)
```
    Parses an ActionScript uint value from a string.
    
    Parameters:
    project - The FlexProject within which the MXML is being parsed.
    s - The string to be parsed.
    flags - A set of flags controlling the text parsing.
    
    Returns:
    A Java Long representing the ActionScript uint, or null.
  - parseNumber
```
public abstract Number parseNumber(FlexProject project,
                 String s,
                 EnumSet<MXMLDialect.TextParsingFlags> flags)
```
    Parses an ActionScript Number value from a string.
    
    Parameters:
    project - The FlexProject within which the MXML is being parsed.
    s - The string to be parsed.
    flags - A set of flags controlling the text parsing.
    
    Returns:
    A Java Number representing the ActionScript Number, or null.
  - parseString
```
public abstract String parseString(FlexProject project,
                 String s,
                 EnumSet<MXMLDialect.TextParsingFlags> flags)
```
    Parses an ActionScript String value from a string.
    
    Parameters:
    project - The FlexProject within which the MXML is being parsed.
    s - The string to be parsed.
    flags - A set of flags controlling the text parsing.
    
    Returns:
    A Java String representing the ActionScript String, or null.
  - parseArray
```
public abstract List<Object> parseArray(FlexProject project,
                      String s,
                      EnumSet<MXMLDialect.TextParsingFlags> flags)
```
    Parses an ActionScript Array value from a string.
    
    Parameters:
    project - The FlexProject within which the MXML is being parsed.
    s - The string to be parsed.
    flags - A set of flags controlling the text parsing.
    
    Returns:
    A List of Java Object instances representing the elements of the ActionScript Array, or null.
  - parseObject
```
public abstract Object parseObject(FlexProject project,
                 String s,
                 EnumSet<MXMLDialect.TextParsingFlags> flags)
```
    Parses an ActionScript value from a string.
    
    Parameters:
    project - The FlexProject within which the MXML is being parsed.
    s - The string to be parsed.
    flags - A set of flags controlling the text parsing.
    
    Returns:
    A Java Object representing the ActionScript value, or null.

Class MXMLDialect

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MXML_2012

MXML_2009

MXML_2006

DEFAULT

bindingXMLName

componentXMLName

declarationsXMLName

definitionXMLName

libraryXMLName

metadataXMLName

modelXMLName

privateXMLName

reparentXMLName

scriptXMLName

styleXMLName

Constructor Detail

MXMLDialect

Method Detail

isLanguageNamespace

getDialectForLanguageNamespace

getMXMLDialect

getLanguageNamespace

isEqualToOrAfter

isEqualToOrBefore

resolveArray

resolveBinding

resolveBoolean

resolveClass

resolveComponent

resolveDeclarations

resolveDate

resolveDefinition

resolveFunction

resolveInt

resolveLibrary

resolveMetadata

resolveModel

resolveNumber

resolveObject

resolvePrivate

resolveReparent

resolveScript

resolveString

resolveStyle

resolveUint

resolveXML

resolveXMLList

getNamedEntity

isWhitespace

isWhitespace

collapseWhitespace

trim

splitAndTrim

parseBoolean

parseInt

parseUint

parseNumber

parseString

parseArray

parseObject