org.apache.flex.compiler.internal.mxml

Class MXMLUnitData

java.lang.Object

org.apache.flex.compiler.common.SourceLocation

org.apache.flex.compiler.internal.mxml.MXMLUnitData

All Implemented Interfaces:

ISourceLocation, IMXMLUnitData

Direct Known Subclasses:

MXMLInstructionData, MXMLTagData, MXMLTextData

public abstract class MXMLUnitData
extends SourceLocation
implements IMXMLUnitData

Encapsulation of an MXML unit: an open/close/empty tag, a chunk of text (perhaps whitespace, CDATA, or a comment), or a processing instruction.

An MXMLData object stores a linear list of MXML units, but it is possible to walk them in a hierarchical way.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	index This position of this unit in the linear list of units owned by the MXMLData.

Fields inherited from interface org.apache.flex.compiler.common.ISourceLocation

UNKNOWN

Constructor Summary

Constructors

Constructor and Description
MXMLUnitData() Constructor.
MXMLUnitData(MXMLUnitData other) Copy constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	adjustOffsets(int offsetAdjustment) Adjust all associated offsets by the adjustment amount
String	buildDumpString(boolean skipSrcPath)
boolean	containsOffset(int offset) Does this unit contain the given offset (excluding start and including end)?
IMXMLTagData	getContainingTag(int offset) Get the nearest containing tag.
int	getContentEnd() Returns the offset after the last character of actual content.
int	getContentStart() Returns the first character of the actual content of the unit For most units this is the same as getStart(), but for things like tags which have "junk punctuation" around them, SourceLocation.getAbsoluteStart() will return the junk punctuation, whereas getContentStart will get the content inside the punctuation.
int	getIndex() Get this unit's position in the IMXMLData.
MXMLDialect	getMXMLDialect() Returns the MXML dialect used in the MXML document that contains this unit.
IMXMLUnitData	getNext() Gets the next MXML unit.
IMXMLUnitData	getNextSiblingUnit() Gets the next sibling unit after this unit.
IMXMLTagData	getNextTag() Gets the next tag.
IMXMLData	getParent() Gets the IMXMLData representing the MXML document that contains this unit.
IMXMLUnitData	getParentUnitData() Gets the IMXMLUnitData which is the hierarchical parent of this unit in its parents array of IMXMLUnitData objects
int	getParentUnitDataIndex() Gets the index of this tags hierarchical parent in its parents array of MXMLUnitData objects
IMXMLUnitData	getPrevious() Gets the previous MXML unit.
IFileSpecification	getSource() Gets the source file that contains this unit.
protected String	getTypeString()
boolean	isCloseTag() Is this MXML unit an close tag?
boolean	isOpenAndNotEmptyTag() Is this MXML unit an open tag and not an empty tag (i.e. only <foo>, not <foo;/>)?
boolean	isOpenTag() Is this MXML unit an open tag?
boolean	isTag() Is this MXML unit a tag?
boolean	isText() Is this MXML unit a block of text?
void	setLocation(MXMLData parent, int index) Set this unit's position relative to its parent.
void	setOffsets(int start, int end) Set this unit's start and end offsets.
void	setParentUnitDataIndex(int parentIndex) Sets the index of this tags hierarchical parent in its parents array of MXMLUnitData objects
String	toDumpString() For debugging only.
boolean	verify() Verifies that this unit has its source location information set.

Methods inherited from class org.apache.flex.compiler.common.SourceLocation

getAbsoluteEnd, getAbsoluteStart, getColumn, getEnd, getEndColumn, getEndLine, getLine, getLineColumnString, getOffsetsString, getSourcePath, getSourcePathString, getStart, setColumn, setEnd, setEndColumn, setEndLine, setLine, setSourceLocation, setSourcePath, setStart, span, span, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flex.compiler.common.ISourceLocation

getAbsoluteEnd, getAbsoluteStart, getColumn, getEnd, getEndColumn, getEndLine, getLine, getSourcePath, getStart

Field Detail

index

protected int index

This position of this unit in the linear list of units owned by the MXMLData.

Constructor Detail

MXMLUnitData

public MXMLUnitData()

Constructor.

MXMLUnitData

public MXMLUnitData(MXMLUnitData other)

Copy constructor.

Method Detail

getContentStart

public int getContentStart()

Description copied from interface: IMXMLUnitData

Returns the first character of the actual content of the unit For most units this is the same as getStart(), but for things like tags which have "junk punctuation" around them, SourceLocation.getAbsoluteStart() will return the junk punctuation, whereas getContentStart will get the content inside the punctuation.

Specified by:

getContentStart in interface IMXMLUnitData

getContentEnd

public int getContentEnd()

Description copied from interface: IMXMLUnitData

Returns the offset after the last character of actual content. See IMXMLUnitData.getContentStart() for more.

Specified by:

getContentEnd in interface IMXMLUnitData

setLocation

public void setLocation(MXMLData parent,
               int index)

Set this unit's position relative to its parent. Used in parsing.

Parameters:

parent - MXML file containing the unit

index - this unit's position in the list

setParentUnitDataIndex

public void setParentUnitDataIndex(int parentIndex)

Sets the index of this tags hierarchical parent in its parents array of MXMLUnitData objects

Parameters:

parentIndex - The index of the parent tag.

getParentUnitData

public final IMXMLUnitData getParentUnitData()

Description copied from interface: IMXMLUnitData

Gets the IMXMLUnitData which is the hierarchical parent of this unit in its parents array of IMXMLUnitData objects

Specified by:

getParentUnitData in interface IMXMLUnitData

Returns:

the parent IMXMLUnitData or null.

getParentUnitDataIndex

public final int getParentUnitDataIndex()

Gets the index of this tags hierarchical parent in its parents array of MXMLUnitData objects

Returns:

the index, or -1

setOffsets

public void setOffsets(int start,
              int end)

Set this unit's start and end offsets. Used in parsing.

Parameters:

start - start offset

end - end offset

adjustOffsets

public void adjustOffsets(int offsetAdjustment)

Adjust all associated offsets by the adjustment amount

Parameters:

offsetAdjustment - amount to add to offsets

getSource

public final IFileSpecification getSource()

Description copied from interface: IMXMLUnitData

Gets the source file that contains this unit.

Specified by:

getSource in interface IMXMLUnitData

Returns:

An IFileSpecification representing the source file.

getIndex

public final int getIndex()

Description copied from interface: IMXMLUnitData

Get this unit's position in the IMXMLData.

Specified by:

getIndex in interface IMXMLUnitData

Returns:

The index of this unit.

isText

public boolean isText()

Description copied from interface: IMXMLUnitData

Is this MXML unit a block of text?

Specified by:

isText in interface IMXMLUnitData

Returns:

true if the unit is a block of text

isTag

public boolean isTag()

Description copied from interface: IMXMLUnitData

Is this MXML unit a tag?

Specified by:

isTag in interface IMXMLUnitData

Returns:

true if the unit is a tag

isOpenTag

public boolean isOpenTag()

Description copied from interface: IMXMLUnitData

Is this MXML unit an open tag?

Specified by:

isOpenTag in interface IMXMLUnitData

Returns:

true if the unit is an open tag

isOpenAndNotEmptyTag

public boolean isOpenAndNotEmptyTag()

Description copied from interface: IMXMLUnitData

Is this MXML unit an open tag and not an empty tag (i.e. only <foo>, not <foo;/>)?

Specified by:

isOpenAndNotEmptyTag in interface IMXMLUnitData

Returns:

true if the unit is an open tag, and not an empty tag

isCloseTag

public boolean isCloseTag()

Description copied from interface: IMXMLUnitData

Is this MXML unit an close tag?

Specified by:

isCloseTag in interface IMXMLUnitData

Returns:

true if the unit is a close tag

getParent

public final IMXMLData getParent()

Description copied from interface: IMXMLUnitData

Gets the IMXMLData representing the MXML document that contains this unit.

Specified by:

getParent in interface IMXMLUnitData

Returns:

The IMXMLData that contains this unit.

getPrevious

public final IMXMLUnitData getPrevious()

Description copied from interface: IMXMLUnitData

Gets the previous MXML unit.

Specified by:

getPrevious in interface IMXMLUnitData

Returns:

the previous MXML unit.

getNext

public final IMXMLUnitData getNext()

Description copied from interface: IMXMLUnitData

Gets the next MXML unit.

Specified by:

getNext in interface IMXMLUnitData

Returns:

The next MXML unit.

getNextSiblingUnit

public final IMXMLUnitData getNextSiblingUnit()

Description copied from interface: IMXMLUnitData

Gets the next sibling unit after this unit. The next sibling unit may be a tag or text. If there is no sibling unit after this one, this method returns null.

Specified by:

getNextSiblingUnit in interface IMXMLUnitData

Returns:

The next sibling unit.

getNextTag

public final IMXMLTagData getNextTag()

Description copied from interface: IMXMLUnitData

Gets the next tag.

Specified by:

getNextTag in interface IMXMLUnitData

Returns:

The next tag, or null if none.

containsOffset

public boolean containsOffset(int offset)

Description copied from interface: IMXMLUnitData

Does this unit contain the given offset (excluding start and including end)?

Specified by:

containsOffset in interface IMXMLUnitData

Returns:

true if the offset falls within this unit's bounds.

getContainingTag

public final IMXMLTagData getContainingTag(int offset)

Description copied from interface: IMXMLUnitData

Get the nearest containing tag. Moving backwards through the list of tokens for this MXML file, this is the first open tag that you find for which you haven't found a corresponding close.

Specified by:

getContainingTag in interface IMXMLUnitData

Returns:

nearest containing open tag (or null, if no such open tag exists)

getMXMLDialect

public MXMLDialect getMXMLDialect()

Description copied from interface: IMXMLUnitData

Returns the MXML dialect used in the MXML document that contains this unit.

Specified by:

getMXMLDialect in interface IMXMLUnitData

Returns:

An MXMLDialect object.

getTypeString

protected String getTypeString()

toDumpString

public String toDumpString()

For debugging only. This format is nice in a text file.

buildDumpString

public String buildDumpString(boolean skipSrcPath)

verify

public boolean verify()

Verifies that this unit has its source location information set.

This is used only in asserts.