Package com.igormaznitsa.jcp.containers

Class FileInfoContainer

java.lang.Object

com.igormaznitsa.jcp.containers.FileInfoContainer

public class FileInfoContainer
extends Object

The class is one from the main classes in the preprocessor because it describes a preprocessing file and contains business logic for the process

Field Summary

Fields

Modifier and Type	Field	Description
private String	destFileName	The destination name for the file
private String	destFolder	The destination directory for the file
private static final Pattern	DIRECTIVE_HASH_PREFIXED
private static final Pattern	DIRECTIVE_SINGLE_DOLLAR_PREFIXED
private static final Pattern	DIRECTIVE_TAIL_REMOVER
private static final Pattern	DIRECTIVE_TWO_DOLLARS_PREFIXED
private boolean	excludedFromPreprocessing	The flag shows that the file has been excluded from preprocessing and it will not be preprocessed and copied
private final boolean	forCopyOnly	The flag shows that the file should be just copied into the destination place without any preprocessing
private final File	sourceFile	The source file for the container

Constructor Summary

Constructors

Constructor	Description
FileInfoContainer(File srcFile, String dstFileName, boolean copyOnly)

Method Summary

Modifier and Type	Method	Description
private boolean	checkDirectiveArgumentRoughly(AbstractDirectiveHandler directive, String rest)
private String	extractDoubleDollarPrefixedDirective(String line, PreprocessorContext context)
private String	extractHashPrefixedDirective(String line, PreprocessorContext context)
private String	extractSingleDollarPrefixedDirective(String line, PreprocessorContext context)
private static String	findTailRemover(String str, PreprocessorContext context)
String	getDestinationDir()
String	getDestinationFilePath()
String	getDestinationName()
File	getSourceFile()
private boolean	isDoubleDollarPrefixed(String line, PreprocessorContext context)
boolean	isExcludedFromPreprocessing()
boolean	isForCopyOnly()
private boolean	isHashPrefixed(String line, PreprocessorContext context)
private boolean	isSingleDollarPrefixed(String line, PreprocessorContext context)
PreprocessingState	preprocessFile(PreprocessingState state, PreprocessorContext context)	Preprocess file, NB! it doesn't clear local variables automatically for cloned contexts
protected AfterDirectiveProcessingBehaviour	processDirective(PreprocessingState state, String directiveString, PreprocessorContext context, boolean firstPass)
List<PreprocessingState.ExcludeIfInfo>	processGlobalDirectives(PreprocessingState state, PreprocessorContext context)
void	setDestinationDir(String destDir)
void	setDestinationName(String destName)
void	setExcluded(boolean flag)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

DIRECTIVE_HASH_PREFIXED

private static final Pattern DIRECTIVE_HASH_PREFIXED

DIRECTIVE_TWO_DOLLARS_PREFIXED

private static final Pattern DIRECTIVE_TWO_DOLLARS_PREFIXED

DIRECTIVE_SINGLE_DOLLAR_PREFIXED

private static final Pattern DIRECTIVE_SINGLE_DOLLAR_PREFIXED

DIRECTIVE_TAIL_REMOVER

private static final Pattern DIRECTIVE_TAIL_REMOVER

sourceFile

private final File sourceFile

The source file for the container

forCopyOnly

private final boolean forCopyOnly

The flag shows that the file should be just copied into the destination place without any preprocessing

excludedFromPreprocessing

private boolean excludedFromPreprocessing

The flag shows that the file has been excluded from preprocessing and it will not be preprocessed and copied

destFolder

private String destFolder

The destination directory for the file

destFileName

private String destFileName

The destination name for the file

Constructor Details

FileInfoContainer

public FileInfoContainer(File srcFile,
 String dstFileName,
 boolean copyOnly)

Method Details

getSourceFile

public File getSourceFile()

isExcludedFromPreprocessing

public boolean isExcludedFromPreprocessing()

isForCopyOnly

public boolean isForCopyOnly()

getDestinationDir

public String getDestinationDir()

getDestinationName

public String getDestinationName()

getDestinationFilePath

public String getDestinationFilePath()

toString

public String toString()

Overrides:

toString in class Object

processGlobalDirectives

@MustNotContainNull
public List<PreprocessingState.ExcludeIfInfo> processGlobalDirectives(PreprocessingState state,
 PreprocessorContext context)
                                                               throws IOException

Throws:

IOException

isDoubleDollarPrefixed

private boolean isDoubleDollarPrefixed(String line,
 PreprocessorContext context)

isSingleDollarPrefixed

private boolean isSingleDollarPrefixed(String line,
 PreprocessorContext context)

isHashPrefixed

private boolean isHashPrefixed(String line,
 PreprocessorContext context)

extractHashPrefixedDirective

private String extractHashPrefixedDirective(String line,
 PreprocessorContext context)

extractDoubleDollarPrefixedDirective

private String extractDoubleDollarPrefixedDirective(String line,
 PreprocessorContext context)

extractSingleDollarPrefixedDirective

private String extractSingleDollarPrefixedDirective(String line,
 PreprocessorContext context)

preprocessFile

public PreprocessingState preprocessFile(PreprocessingState state,
 PreprocessorContext context)
                                  throws IOException

Preprocess file, NB! it doesn't clear local variables automatically for cloned contexts

Parameters:

state - the start preprocessing state, can be null

context - the preprocessor context, must not be null

Returns:

the state for the preprocessed file

Throws:

IOException - it will be thrown for IO errors

PreprocessorException - it will be thrown for violation of preprocessing logic, like undefined variable

findTailRemover

private static String findTailRemover(String str,
 PreprocessorContext context)

checkDirectiveArgumentRoughly

private boolean checkDirectiveArgumentRoughly(AbstractDirectiveHandler directive,
 String rest)

processDirective

protected AfterDirectiveProcessingBehaviour processDirective(PreprocessingState state,
 String directiveString,
 PreprocessorContext context,
 boolean firstPass)
                                                      throws IOException

Throws:

IOException

setDestinationDir

public void setDestinationDir(String destDir)

setDestinationName

public void setDestinationName(String destName)

setExcluded

public void setExcluded(boolean flag)