Class IfDefDirectiveHandler

java.lang.Object

com.igormaznitsa.jcp.directives.AbstractDirectiveHandler

com.igormaznitsa.jcp.directives.IfDefinedDirectiveHandler

com.igormaznitsa.jcp.directives.IfDefDirectiveHandler

public class IfDefDirectiveHandler
extends IfDefinedDirectiveHandler

The class implements short synonym for the //#ifdefined directive

Author:

Igor Maznitsa (igor.maznitsa@igormaznitsa.com)

Field Summary

Fields inherited from class AbstractDirectiveHandler

DIRECTIVE_PREFIX, DIRECTIVES, GLOBAL_DIRECTIVES, ONE_LINE_COMMENT, PREFIX_FOR_KEEPING_LINES, PREFIX_FOR_KEEPING_LINES_PROCESSED_DIRECTIVES

Constructor Summary

Constructors

Constructor	Description
IfDefDirectiveHandler()

Method Summary

Modifier and Type	Method	Description
boolean	executeOnlyWhenExecutionAllowed()	Shows that the directive can be executed only when the preprocessing n active state i.e. if it is in active block //#if..
DirectiveArgumentType	getArgumentType()	Get the argument type needed by the directive
String	getName()	Get the name of the directive without prefix
String	getReference()	Get the directive reference, it will be printed for a help request

Methods inherited from class IfDefinedDirectiveHandler

execute, postprocessFlag

Methods inherited from class AbstractDirectiveHandler

getFullName, isDeprecated, isGlobalPhaseAllowed, isPreprocessingPhaseAllowed

Methods inherited from class Object

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

Constructor Details

IfDefDirectiveHandler

public IfDefDirectiveHandler()

Method Details

getName

public String getName()

Description copied from class: AbstractDirectiveHandler

Get the name of the directive without prefix

Overrides:

getName in class IfDefinedDirectiveHandler

Returns:

the directive name, must not be null

getReference

public String getReference()

Description copied from class: AbstractDirectiveHandler

Get the directive reference, it will be printed for a help request

Overrides:

getReference in class IfDefinedDirectiveHandler

Returns:

the directive reference as a String, must not be null

executeOnlyWhenExecutionAllowed

public boolean executeOnlyWhenExecutionAllowed()

Description copied from class: AbstractDirectiveHandler

Shows that the directive can be executed only when the preprocessing n active state i.e. if it is in active block //#if..//#endif of //#while

Overrides:

executeOnlyWhenExecutionAllowed in class IfDefinedDirectiveHandler

Returns:

true if the directive can be executed only if it is in active block, else the directive will be called in any case

getArgumentType

public DirectiveArgumentType getArgumentType()

Description copied from class: AbstractDirectiveHandler

Get the argument type needed by the directive

Overrides:

getArgumentType in class IfDefinedDirectiveHandler

Returns:

the argument type needed by the directive, it can't be null