Class WhileDirectiveHandler

java.lang.Object

com.igormaznitsa.jcp.directives.AbstractDirectiveHandler

com.igormaznitsa.jcp.directives.WhileDirectiveHandler

public class WhileDirectiveHandler
extends AbstractDirectiveHandler

The class implements the //#while directive handler

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
WhileDirectiveHandler()

Method Summary

Modifier and Type	Method	Description
AfterDirectiveProcessingBehaviour	execute(String string, PreprocessorContext context)	Execute directive
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 AbstractDirectiveHandler

getFullName, isDeprecated, isGlobalPhaseAllowed, isPreprocessingPhaseAllowed

Methods inherited from class Object

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

Constructor Details

WhileDirectiveHandler

public WhileDirectiveHandler()

Method Details

getName

public String getName()

Description copied from class: AbstractDirectiveHandler

Get the name of the directive without prefix

Specified by:

getName in class AbstractDirectiveHandler

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

Specified by:

getReference in class AbstractDirectiveHandler

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 AbstractDirectiveHandler

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 AbstractDirectiveHandler

Returns:

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

execute

public AfterDirectiveProcessingBehaviour execute(String string,
 PreprocessorContext context)

Description copied from class: AbstractDirectiveHandler

Execute directive

Specified by:

execute in class AbstractDirectiveHandler

Parameters:

string - the tail of the string where the directive has been met, must not be null but can be empty

context - the preprocessor context

Returns:

the needed preprocessor behavior, must not be null