AspectJ Weaver 1.9.20.1 · org.aspectj.bridge.Message

Modifier and Type	Field and Description
private final boolean	declared
private final String	details
private final List<ISourceLocation>	extraSourceLocations
private final int	id
private final IMessage.Kind	kind
private final String	message
private final int	sourceEnd
private final ISourceLocation	sourceLocation
private final int	sourceStart
private final Throwable	thrown

Constructor Summary

Access	Constructor and Description
public	Message(String the String used as the underlying message message, ISourceLocation the ISourceLocation, if any, associated with this message location, boolean if true, use IMessage.ERROR; else use IMessage.WARNING isError) Create a (compiler) error or warning message
public	Message(String message, ISourceLocation location, boolean isError, ISourceLocation[] extraSourceLocations)
public	Message(String the String used as the underlying message message, String descriptive information about the message details, IMessage.Kind the IMessage.Kind of message - not null kind, ISourceLocation the ISourceLocation, if any, associated with this message sourceLocation, Throwable the Throwable, if any, associated with this message thrown, ISourceLocation[] extraSourceLocations) Create a message, handling null values for message and kind if thrown is not null.
public	Message(String message, String details, IMessage.Kind kind, ISourceLocation sLoc, Throwable thrown, ISourceLocation[] otherLocs, boolean declared, int id, int sourcestart, int sourceend)
public	Message(String the String used as the underlying message message, IMessage.Kind the IMessage.Kind of message - not null kind, Throwable the Throwable, if any, associated with this message thrown, ISourceLocation the ISourceLocation, if any, associated with this message sourceLocation) Create a message, handling null values for message and kind if thrown is not null.

Method Summary

Modifier and Type	Method and Description
public boolean	getDeclared() Implements org.aspectj.bridge.IMessage.getDeclared. Caller can verify if this message came about because of a DEOW
public String	getDetails() Implements org.aspectj.bridge.IMessage.getDetails.
public List<ISourceLocation>	getExtraSourceLocations() Implements org.aspectj.bridge.IMessage.getExtraSourceLocations. Return a List of `ISourceLocation` instances that indicate additional source locations relevent to this message as specified by the message creator.
public int	getID() Implements org.aspectj.bridge.IMessage.getID. Return the ID of the message where applicable, see IProblem for list of valid IDs
public IMessage.Kind	Returns: the kind of this message getKind() Implements org.aspectj.bridge.IMessage.getKind.
public final String	Returns: non-null String with simple message getMessage() Implements org.aspectj.bridge.IMessage.getMessage.
public int	getSourceEnd() Implements org.aspectj.bridge.IMessage.getSourceEnd. Return the end position of the problem (inclusive), or -1 if unknown.
public final ISourceLocation	Returns: ISourceLocation associated with this message, or null if none getSourceLocation() Implements org.aspectj.bridge.IMessage.getSourceLocation.
public int	getSourceStart() Implements org.aspectj.bridge.IMessage.getSourceStart. Return the start position of the problem (inclusive), or -1 if unknown.
public final Throwable	Returns: Throwable associated with this message, or null if none getThrown() Implements org.aspectj.bridge.IMessage.getThrown.
public boolean	Returns: true if kind == IMessage.ABORT isAbort() Implements org.aspectj.bridge.IMessage.isAbort.
public boolean	Returns: true if kind == IMessage.DEBUG isDebug() Implements org.aspectj.bridge.IMessage.isDebug.
public boolean	Returns: true if kind == IMessage.ERROR isError() Implements org.aspectj.bridge.IMessage.isError.
public boolean	Returns: true if kind == IMessage.FAIL isFailed() Implements org.aspectj.bridge.IMessage.isFailed.
public boolean	Returns: true if kind == IMessage.INFO isInfo() Implements org.aspectj.bridge.IMessage.isInfo.
public boolean	isTaskTag() Implements org.aspectj.bridge.IMessage.isTaskTag.
public boolean	Returns: true if kind == IMessage.USAGE isUsage() Implements org.aspectj.bridge.IMessage.isUsage.
public boolean	Returns: true if kind == IMessage.WARNING isWarning() Implements org.aspectj.bridge.IMessage.isWarning.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

declared	back to summary
private final boolean declared

details	back to summary
private final String details

extraSourceLocations	back to summary
private final List<ISourceLocation> extraSourceLocations

id	back to summary
private final int id

kind	back to summary
private final IMessage.Kind kind

message	back to summary
private final String message

sourceEnd	back to summary
private final int sourceEnd

sourceLocation	back to summary
private final ISourceLocation sourceLocation

sourceStart	back to summary
private final int sourceStart

thrown	back to summary
private final Throwable thrown

Constructor Detail

Message	back to summary
public Message(String message, ISourceLocation location, boolean isError) Create a (compiler) error or warning message Parameters message:String the String used as the underlying message location:ISourceLocation the ISourceLocation, if any, associated with this message isError:boolean if true, use IMessage.ERROR; else use IMessage.WARNING

Message

back to summary

public Message(String message, ISourceLocation location, boolean isError)

Create a (compiler) error or warning message

Parameters

message:String: the String used as the underlying message
location:ISourceLocation: the ISourceLocation, if any, associated with this message
isError:boolean: if true, use IMessage.ERROR; else use IMessage.WARNING

Message	back to summary
public Message(String message, ISourceLocation location, boolean isError, ISourceLocation[] extraSourceLocations)

Message	back to summary
public Message(String message, String details, IMessage.Kind kind, ISourceLocation sourceLocation, Throwable thrown, ISourceLocation[] extraSourceLocations) Create a message, handling null values for message and kind if thrown is not null. Parameters message:String the String used as the underlying message details:String descriptive information about the message kind:IMessage.Kind the IMessage.Kind of message - not null sourceLocation:ISourceLocation the ISourceLocation, if any, associated with this message thrown:Throwable the Throwable, if any, associated with this message Exceptions IllegalArgumentException: if message is null and thrown is null or has a null message, or if kind is null and thrown is null.

Message

back to summary

public Message(String message, String details, IMessage.Kind kind, ISourceLocation sourceLocation, Throwable thrown, ISourceLocation[] extraSourceLocations)

Create a message, handling null values for message and kind if thrown is not null.

Parameters

message:String: the String used as the underlying message
details:String: descriptive information about the message
kind:IMessage.Kind: the IMessage.Kind of message - not null
sourceLocation:ISourceLocation: the ISourceLocation, if any, associated with this message
thrown:Throwable: the Throwable, if any, associated with this message

Exceptions

IllegalArgumentException:: if message is null and thrown is null or has a null message, or if kind is null and thrown is null.

Message	back to summary
public Message(String message, String details, IMessage.Kind kind, ISourceLocation sLoc, Throwable thrown, ISourceLocation[] otherLocs, boolean declared, int id, int sourcestart, int sourceend)

Message	back to summary
public Message(String message, IMessage.Kind kind, Throwable thrown, ISourceLocation sourceLocation) Create a message, handling null values for message and kind if thrown is not null. Parameters message:String the String used as the underlying message kind:IMessage.Kind the IMessage.Kind of message - not null thrown:Throwable the Throwable, if any, associated with this message sourceLocation:ISourceLocation the ISourceLocation, if any, associated with this message Exceptions IllegalArgumentException: if message is null and thrown is null or has a null message, or if kind is null and thrown is null.

Message

back to summary

public Message(String message, IMessage.Kind kind, Throwable thrown, ISourceLocation sourceLocation)

Create a message, handling null values for message and kind if thrown is not null.

Parameters

message:String: the String used as the underlying message
kind:IMessage.Kind: the IMessage.Kind of message - not null
thrown:Throwable: the Throwable, if any, associated with this message
sourceLocation:ISourceLocation: the ISourceLocation, if any, associated with this message

Exceptions

IllegalArgumentException:: if message is null and thrown is null or has a null message, or if kind is null and thrown is null.

Method Detail

getDeclared	back to summary
public boolean getDeclared() Implements org.aspectj.bridge.IMessage.getDeclared. Caller can verify if this message came about because of a DEOW

getDeclared

back to summary

public boolean getDeclared()

Implements org.aspectj.bridge.IMessage.getDeclared.

Caller can verify if this message came about because of a DEOW

getDetails	back to summary
public String getDetails() Implements org.aspectj.bridge.IMessage.getDetails. Returns:String Doc from org.aspectj.bridge.IMessage.getDetails. Detailed information about the message. For example, for declare error/warning messages this returns information about the corresponding join point's static part.

getDetails

back to summary

public String getDetails()

Implements org.aspectj.bridge.IMessage.getDetails.

Returns:String

Doc from org.aspectj.bridge.IMessage.getDetails.

Detailed information about the message. For example, for declare error/warning messages this returns information about the corresponding join point's static part.

getExtraSourceLocations back to summary

getExtraSourceLocations	back to summary
public List<ISourceLocation> getExtraSourceLocations() Implements org.aspectj.bridge.IMessage.getExtraSourceLocations. Doc from org.aspectj.bridge.IMessage.getExtraSourceLocations. Return a List of `ISourceLocation` instances that indicate additional source locations relevent to this message as specified by the message creator. The list should not include the primary source location associated with the message which can be obtained from `getSourceLocation().` `An example of using extra locations would be in a warning message that flags all shadow locations that will go unmatched due to a pointcut definition being based on a subtype of a defining type.` `Returns:List<ISourceLocation> a list of additional source locations`

public List<ISourceLocation> getExtraSourceLocations()

Implements org.aspectj.bridge.IMessage.getExtraSourceLocations.

Doc from org.aspectj.bridge.IMessage.getExtraSourceLocations.

Return a List of ISourceLocation instances that indicate additional source locations relevent to this message as specified by the message creator. The list should not include the primary source location associated with the message which can be obtained from getSourceLocation().

An example of using extra locations would be in a warning message that flags all shadow locations that will go unmatched due to a pointcut definition being based on a subtype of a defining type.



Returns:List<ISourceLocation>
a list of additional source locations

getID	back to summary
public int getID() Implements org.aspectj.bridge.IMessage.getID. Doc from org.aspectj.bridge.IMessage.getID. Return the ID of the message where applicable, see IProblem for list of valid IDs

getID

back to summary

public int getID()

Implements org.aspectj.bridge.IMessage.getID.

Doc from org.aspectj.bridge.IMessage.getID.

Return the ID of the message where applicable, see IProblem for list of valid IDs

getKind	back to summary
public IMessage.Kind getKind() Implements org.aspectj.bridge.IMessage.getKind. Returns:IMessage.Kind the kind of this message

getKind

back to summary

public IMessage.Kind getKind()

Implements org.aspectj.bridge.IMessage.getKind.

Returns:IMessage.Kind: the kind of this message

getMessage	back to summary
public final String getMessage() Implements org.aspectj.bridge.IMessage.getMessage. Returns:String non-null String with simple message

getMessage

back to summary

public final String getMessage()

Implements org.aspectj.bridge.IMessage.getMessage.

Returns:String: non-null String with simple message

getSourceEnd	back to summary
public int getSourceEnd() Implements org.aspectj.bridge.IMessage.getSourceEnd. Doc from org.aspectj.bridge.IMessage.getSourceEnd. Return the end position of the problem (inclusive), or -1 if unknown.

getSourceEnd

back to summary

public int getSourceEnd()

Implements org.aspectj.bridge.IMessage.getSourceEnd.

Doc from org.aspectj.bridge.IMessage.getSourceEnd.

Return the end position of the problem (inclusive), or -1 if unknown.

getSourceLocation	back to summary
public final ISourceLocation getSourceLocation() Implements org.aspectj.bridge.IMessage.getSourceLocation. Returns:ISourceLocation ISourceLocation associated with this message, or null if none

getSourceLocation

back to summary

public final ISourceLocation getSourceLocation()

Implements org.aspectj.bridge.IMessage.getSourceLocation.

Returns:ISourceLocation: ISourceLocation associated with this message, or null if none

getSourceStart	back to summary
public int getSourceStart() Implements org.aspectj.bridge.IMessage.getSourceStart. Doc from org.aspectj.bridge.IMessage.getSourceStart. Return the start position of the problem (inclusive), or -1 if unknown.

getSourceStart

back to summary

public int getSourceStart()

Implements org.aspectj.bridge.IMessage.getSourceStart.

Doc from org.aspectj.bridge.IMessage.getSourceStart.

Return the start position of the problem (inclusive), or -1 if unknown.

getThrown	back to summary
public final Throwable getThrown() Implements org.aspectj.bridge.IMessage.getThrown. Returns:Throwable Throwable associated with this message, or null if none

getThrown

back to summary

public final Throwable getThrown()

Implements org.aspectj.bridge.IMessage.getThrown.

Returns:Throwable: Throwable associated with this message, or null if none

isAbort	back to summary
public boolean isAbort() Implements org.aspectj.bridge.IMessage.isAbort. Returns:boolean true if kind == IMessage.ABORT

isAbort

back to summary

public boolean isAbort()

Implements org.aspectj.bridge.IMessage.isAbort.

Returns:boolean: true if kind == IMessage.ABORT

isDebug	back to summary
public boolean isDebug() Implements org.aspectj.bridge.IMessage.isDebug. Returns:boolean true if kind == IMessage.DEBUG

isDebug

back to summary

public boolean isDebug()

Implements org.aspectj.bridge.IMessage.isDebug.

Returns:boolean: true if kind == IMessage.DEBUG

isError	back to summary
public boolean isError() Implements org.aspectj.bridge.IMessage.isError. Returns:boolean true if kind == IMessage.ERROR

isError

back to summary

public boolean isError()

Implements org.aspectj.bridge.IMessage.isError.

Returns:boolean: true if kind == IMessage.ERROR

isFailed	back to summary
public boolean isFailed() Implements org.aspectj.bridge.IMessage.isFailed. Returns:boolean true if kind == IMessage.FAIL

isFailed

back to summary

public boolean isFailed()

Implements org.aspectj.bridge.IMessage.isFailed.

Returns:boolean: true if kind == IMessage.FAIL

isInfo	back to summary
public boolean isInfo() Implements org.aspectj.bridge.IMessage.isInfo. Returns:boolean true if kind == IMessage.INFO

isInfo

back to summary

public boolean isInfo()

Implements org.aspectj.bridge.IMessage.isInfo.

Returns:boolean: true if kind == IMessage.INFO

isTaskTag	back to summary
public boolean isTaskTag() Implements org.aspectj.bridge.IMessage.isTaskTag. Returns:boolean Doc from org.aspectj.bridge.IMessage.isTaskTag. true if this is a task tag message

isTaskTag

back to summary

public boolean isTaskTag()

Implements org.aspectj.bridge.IMessage.isTaskTag.

Returns:boolean

Doc from org.aspectj.bridge.IMessage.isTaskTag.

true if this is a task tag message

isUsage	back to summary
public boolean isUsage() Implements org.aspectj.bridge.IMessage.isUsage. Returns:boolean true if kind == IMessage.USAGE

isUsage

back to summary

public boolean isUsage()

Implements org.aspectj.bridge.IMessage.isUsage.

Returns:boolean: true if kind == IMessage.USAGE

isWarning	back to summary
public boolean isWarning() Implements org.aspectj.bridge.IMessage.isWarning. Returns:boolean true if kind == IMessage.WARNING

isWarning

back to summary

public boolean isWarning()

Implements org.aspectj.bridge.IMessage.isWarning.

Returns:boolean: true if kind == IMessage.WARNING

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object.

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String: a string representation of the object.

public Class Message

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail