Package com.igormaznitsa.jcp.directives

Class GlobalDirectiveHandler

java.lang.Object

com.igormaznitsa.jcp.directives.AbstractDirectiveHandler

com.igormaznitsa.jcp.directives.GlobalDirectiveHandler

public class GlobalDirectiveHandler
extends AbstractDirectiveHandler

The class implements the //#global directive handler

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	Description
GlobalDirectiveHandler()

Method Summary

Modifier and Type	Method	Description
AfterDirectiveProcessingBehaviour	execute(String string, 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
boolean	isGlobalPhaseAllowed()	Shows that the directive can be executed during a global preprocessing phase
boolean	isPreprocessingPhaseAllowed()	Shows that the directive can be executed during the second preprocessing phase
private void	processDefinition(String string, PreprocessorContext context)

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

executeOnlyWhenExecutionAllowed, getFullName, isDeprecated

Methods inherited from class java.lang.Object

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

Constructor Details

GlobalDirectiveHandler

public GlobalDirectiveHandler()

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

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

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

isGlobalPhaseAllowed

public boolean isGlobalPhaseAllowed()

Description copied from class: AbstractDirectiveHandler

Shows that the directive can be executed during a global preprocessing phase

Overrides:

isGlobalPhaseAllowed in class AbstractDirectiveHandler

Returns:

true if the directive allows the global directive phase, false if the directive must be ignored during that phase

isPreprocessingPhaseAllowed

public boolean isPreprocessingPhaseAllowed()

Description copied from class: AbstractDirectiveHandler

Shows that the directive can be executed during the second preprocessing phase

Overrides:

isPreprocessingPhaseAllowed in class AbstractDirectiveHandler

Returns:

true uf the directive can be executed during the second preprocessing phase else false if the directive must be ignored

processDefinition

private void processDefinition(String string,
 PreprocessorContext context)