org.apache.flex.compiler.problems

Class CompilerProblem

java.lang.Object

org.apache.flex.compiler.problems.CompilerProblem

All Implemented Interfaces:

ISourceLocation, ICompilerProblem

Direct Known Subclasses:

AbstractSemanticProblem, ANELibraryNotAllowedProblem, BadCharacterProblem, CannotResolveProjectLevelConfigExpressionProblem, ClassesMappedToSameRemoteAliasProblem, CompiledAsAComponentProblem, ComponentTagWithoutURIProblem, ConfigurationFileNotFoundProblem, ConfigurationProblem, CSSParserProblem, CSSProblem, CyclicalIncludesProblem, DependencyNotCompatibleProblem, DuplicateQNameInSourcePathProblem, DuplicateScriptProblem, DuplicateSkinStateProblem, DuplicateSourceFileProblem, EmbedAS2TagsModifiedProblem, EmbedBadScalingGridTargetProblem, EmbedCouldNotDetermineSampleFrameCountProblem, EmbedExceptionWhileTranscodingProblem, EmbedInitialValueProblem, EmbedInvalidAttributeValueProblem, EmbedInvalidUnicodeRangeProblem, EmbedMissingSymbolProblem, EmbedMovieScalingNoSymbolProblem, EmbedMultipleMetaTagsProblem, EmbedNoSkinClassProblem, EmbedNoSourceAttributeProblem, EmbedOnlyOnClassesAndVarsProblem, EmbedQualityRequiresCompressionProblem, EmbedQualityValueProblem, EmbedScalingGridProblem, EmbedScalingGridValueProblem, EmbedSkinClassNotFoundProblem, EmbedSourceAttributeCouldNotBeReadProblem, EmbedSourceAttributeDoesNotExistProblem, EmbedSourceFileNotFoundProblem, EmbedTypeNotEmbeddableProblem, EmbedUnableToReadSourceProblem, EmbedUnknownAttributeProblem, EmbedUnknownMimeTypeProblem, EmbedUnrecogniedFileTypeProblem, EmbedUnsupportedAttributeProblem, EmbedUnsupportedSamplingRateProblem, EmbedUnsupportedTypeProblem, FatalProblem, FileInLibraryIOProblem, FileInLibraryNotFoundProblem, FileIOProblem, FileNotFoundProblem, FileWriteProblem, FontEmbeddingNotSupported, FXGProblem, HostComponentClassNotFoundProblem, HostComponentMustHaveTypeProblem, InlineFunctionNotFinalStaticOrGlobalProblem, InlineFunctionTooLargeProblem, InlineNestedInliningNotSupportedProblem, InlineNoSourceProblem, InlineUnsupportedInstructionProblem, InlineUnsupportedNodeProblem, InternalCompilerProblem, InternalCompilerProblem2, InvalidABCByteCodeProblem, InvalidBackgroundColorProblem, InvalidByteCodeGeneratedProblem, InvalidImportFileProblem, LibraryNotFoundProblem, ManifestProblem, MissingFactoryClassInFrameMetadataProblem, MissingRequirementConfigurationProblem, MissingSignedDigestProblem, MissingSkinPartProblem, MissingSkinStateProblem, MissingUnsignedDigestProblem, MultipleExternallyVisibleDefinitionsProblem, MXMLExecutableStatementsInScriptBlockProblem, MXMLOuterDocumentAlreadyDeclaredProblem, MXMLSyntaxProblem, MXMLUnrecognizedCompilerDirectiveProblem, NoCompilationUnitForDefinitionProblem, NoDefinitionForSWCDependencyProblem, NoMainDefinitionProblem, NonDirectoryInSourcePathProblem, NoScopesInABCCompilationUnitProblem, NoSourceForClassInNamespaceProblem, NoSourceForClassProblem, OnlyOneHostComponentAllowedProblem, OverlappingSourcePathProblem, ParserProblem, ResourceBundleNoBundleParameterProblem, ResourceBundleNoKeyParameterProblem, ResourceBundleNotFoundProblem, SkinPartsMustBePublicProblem, SourcePathNotFoundProblem, SWFCharacterIDNotFoundProblem, SWFCSMTextSettingsWrongReferenceTypeProblem, SWFDefineFontAlignZonesLinkToIncorrectFontProblem, SWFFrameCountMismatchProblem, SWFInvalidSignatureProblem, SWFTagLengthTooLongProblem, SWFUnableToReadTagBodyProblem, SWFUnexpectedEndOfFileProblem, SWFUnknownFillStyleProblem, UnableToBuildReportProblem, UnableToBuildSWFProblem, UnableToBuildSWFTagProblem, UnableToCreateLinkReportProblem, UnableToFindRootClassDefinitionProblem, UnableToListFilesProblem, UnexpectedExceptionProblem, UnresolvedClassReferenceProblem, UnsupportedSourceFileProblem, WrongSkinPartProblem

@ProblemClassification(value=DEFAULT)
@DefaultSeverity(value=ERROR)
public abstract class CompilerProblem
extends Object
implements ICompilerProblem

CompilerProblem is the base class for all error and warning classes in the compiler, which are collectively called "problems". Each problem has 1) source location information (file/start/end/line/column); 2) a description with named placeholders which get filled in from the public fields of the problem class; 3) the ability to compare itself to other problems, to produce a nicely sorted list of problems; 4) the ability to toString() itself for command-line output such as C:\Faramir\compiler\trunk\tests\resources\milestones\m1\M1.as:4 Syntax error: '+' is not allowed here import flash.display.+Sprite; ^ where a caret marks the offending spot in the offending line.

Field Summary

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

UNKNOWN

Constructor Summary

Constructors

Constructor and Description
CompilerProblem() Constructor for a problem with no source-location information.
CompilerProblem(ASToken site) Constructor for a problem associated with an ASToken.
CompilerProblem(IDefinition site) Constructor for a problem associated with an IDefinition.
CompilerProblem(ISourceLocation site) Constructor for a problem associated with an object implementing ISourceLocation.
CompilerProblem(String sourcePath) Constructor for a problem whose only source-location information is a source path.
CompilerProblem(String sourcePath, int start, int end, int line, int column) Constructor.
CompilerProblem(String sourcePath, int start, int end, int line, int column, boolean normalizeFilePath) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
int	getAbsoluteEnd() Gets the absolute starting offset.
int	getAbsoluteStart() Gets the absolute starting offset.
int	getColumn() Gets the local column number.
int	getEnd() Gets the local ending offset.
int	getEndColumn() Gets the local column number at the end.
int	getEndLine() Gets the local line number at the end.
String	getID() Returns a unique identifier for this type of problem.
int	getLine() Gets the local line number.
String	getSourcePath() Gets the normalized source path.
int	getStart() Gets the local starting offset.
String	toString() Returns a String for displaying this compiler problem in a console window.

Methods inherited from class java.lang.Object

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

Constructor Detail

CompilerProblem

public CompilerProblem(String sourcePath,
               int start,
               int end,
               int line,
               int column,
               boolean normalizeFilePath)

Constructor.

Parameters:

sourcePath - The path of the file in which the problem occurred.

start - The offset within the source buffer at which the problem starts.

end - The offset within the source buffer at which the problem ends.

line - The line number within the source buffer at which the problem starts.

column - The column number within the source buffer at which the problem starts.

normalizeFilePath - true if the path can be normalized. This is needed by configuration problems that have the "command line" as there source.

CompilerProblem

public CompilerProblem(String sourcePath,
               int start,
               int end,
               int line,
               int column)

Constructor.

Parameters:

sourcePath - The normalized path of the file in which the problem occurred.

start - The offset within the source buffer at which the problem starts.

end - The offset within the source buffer at which the problem ends.

line - The line number within the source buffer at which the problem starts.

column - The column number within the source buffer at which the problem starts.

CompilerProblem

public CompilerProblem(String sourcePath)

Constructor for a problem whose only source-location information is a source path.

Parameters:

sourcePath - The normalized path of the file in which the problem occurred.

CompilerProblem

public CompilerProblem()

Constructor for a problem with no source-location information.

CompilerProblem

public CompilerProblem(ISourceLocation site)

Constructor for a problem associated with an object implementing ISourceLocation.

Parameters:

site - The ISourceLocation where the problem occurred.

CompilerProblem

public CompilerProblem(IDefinition site)

Constructor for a problem associated with an IDefinition.

Parameters:

site - The IDefinition where the problem occurred.

CompilerProblem

public CompilerProblem(ASToken site)

Constructor for a problem associated with an ASToken.

Parameters:

site - The ASToken where the problem occurred.

Method Detail

getID

public String getID()

Description copied from interface: ICompilerProblem

Returns a unique identifier for this type of problem.

Clients can use this identifier to look up, in a .properties file, a localized template string describing the problem. The template string can have named placeholders such as ${name} to be filled in, based on correspondingly-named fields in the problem instance.

Clients can also use this identifier to decide whether the problem is an error, a warning, or something else; for example, they might keep a list of error ids and a list of warning ids.

The unique identifier happens to be the fully-qualified classname of the problem class.

Specified by:

getID in interface ICompilerProblem

Returns:

A unique identifier for the type of problem.

getSourcePath

public String getSourcePath()

Description copied from interface: ISourceLocation

Gets the normalized source path.

Specified by:

getSourcePath in interface ISourceLocation

getStart

public int getStart()

Description copied from interface: ISourceLocation

Gets the local starting offset. It is zero-based.

Specified by:

getStart in interface ISourceLocation

getEnd

public int getEnd()

Description copied from interface: ISourceLocation

Gets the local ending offset. It is zero-based.

Specified by:

getEnd in interface ISourceLocation

getLine

public int getLine()

Description copied from interface: ISourceLocation

Gets the local line number. It is zero-based.

Specified by:

getLine in interface ISourceLocation

getColumn

public int getColumn()

Description copied from interface: ISourceLocation

Gets the local column number. It is zero-based.

Specified by:

getColumn in interface ISourceLocation

getEndLine

public int getEndLine()

Description copied from interface: ISourceLocation

Gets the local line number at the end. It is zero-based.

Specified by:

getEndLine in interface ISourceLocation

getEndColumn

public int getEndColumn()

Description copied from interface: ISourceLocation

Gets the local column number at the end. It is zero-based.

Specified by:

getEndColumn in interface ISourceLocation

getAbsoluteStart

public int getAbsoluteStart()

Description copied from interface: ISourceLocation

Gets the absolute starting offset. It is zero-based.

Specified by:

getAbsoluteStart in interface ISourceLocation

getAbsoluteEnd

public int getAbsoluteEnd()

Description copied from interface: ISourceLocation

Gets the absolute starting offset. It is zero-based.

Specified by:

getAbsoluteEnd in interface ISourceLocation

toString

public String toString()

Returns a String for displaying this compiler problem in a console window. This is for debugging purposes, therefore no non-test code should call this. There are typically four lines output for each problem: location (file and line number) description For example: C:\Faramir\compiler\trunk\tests\resources\milestones\m1\M1.as:4 Syntax error: '+' not allowed here.

Overrides:

toString in class Object