com.asakusafw.utils.java.parser.javadoc

Class IllegalDocCommentFormatException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.asakusafw.utils.java.parser.javadoc.JavadocParseException

com.asakusafw.utils.java.parser.javadoc.IllegalDocCommentFormatException

All Implemented Interfaces:

Serializable

public class IllegalDocCommentFormatException
extends JavadocParseException

An exception which represents a comment is malformed.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IllegalDocCommentFormatException(boolean head, IrLocation location, Throwable cause) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	isMissingHead() Returns whether this is occurred by missing comment header or not.
boolean	isMissingTail() Returns whether this is occurred by missing comment footer or not.

Methods inherited from class com.asakusafw.utils.java.parser.javadoc.JavadocParseException

getLocation

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

IllegalDocCommentFormatException

public IllegalDocCommentFormatException(boolean head,
                                        IrLocation location,
                                        Throwable cause)

Creates a new instance.

Parameters:

head - true if missing comment header, or false if missing comment footer

location - the location

cause - the exception cause

Method Detail

isMissingHead

public boolean isMissingHead()

Returns whether this is occurred by missing comment header or not.

Returns:

true if this is occurred by missing comment header, otherwise false

See Also:

isMissingTail()

isMissingTail

public boolean isMissingTail()

Returns whether this is occurred by missing comment footer or not.

Returns:

true if this is occurred by missing comment footer, otherwise false