com.igormaznitsa.jcp.directives

Class DefineDirectiveHandler

java.lang.Object

com.igormaznitsa.jcp.directives.AbstractDirectiveHandler

com.igormaznitsa.jcp.directives.DefineDirectiveHandler

Direct Known Subclasses:

DefinelDirectiveHandler, UndefDirectiveHandler

public class DefineDirectiveHandler
extends AbstractDirectiveHandler

The class implements the //#define directive handler

Author:

Igor Maznitsa (igor.maznitsa@igormaznitsa.com)

Field Summary

Fields inherited from class com.igormaznitsa.jcp.directives.AbstractDirectiveHandler

DIRECTIVE_PREFIX, DIRECTIVES, GLOBAL_DIRECTIVES, ONE_LINE_COMMENT, PREFIX_FOR_KEEPING_LINES, PREFIX_FOR_KEEPING_LINES_PROCESSED_DIRECTIVES

Constructor Summary

Constructors

Constructor and Description
DefineDirectiveHandler()

Method Summary

Modifier and Type	Method and Description
AfterDirectiveProcessingBehaviour	execute(String rawTail, PreprocessorContext context) Execute directive
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
protected void	process(PreprocessorContext context, String varName, Value value, boolean exists)

Methods inherited from class com.igormaznitsa.jcp.directives.AbstractDirectiveHandler

executeOnlyWhenExecutionAllowed, getFullName, isDeprecated, isGlobalPhaseAllowed, isPreprocessingPhaseAllowed

Methods inherited from class java.lang.Object

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

Constructor Detail

DefineDirectiveHandler

public DefineDirectiveHandler()

Method Detail

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

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

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

process

protected void process(PreprocessorContext context,
                       String varName,
                       Value value,
                       boolean exists)

execute

public AfterDirectiveProcessingBehaviour execute(String rawTail,
                                                 PreprocessorContext context)

Description copied from class: AbstractDirectiveHandler

Execute directive

Specified by:

execute in class AbstractDirectiveHandler

Parameters:

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

context - the preprocessor context, it can be null

Returns:

the needed preprocessor behavior, must not be null