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

Author:

Igor Maznitsa (igor.maznitsa@igormaznitsa.com)

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	getDestinationDir()
String	getDestinationFilePath()
String	getDestinationName()
File	getSourceFile()
boolean	isExcludedFromPreprocessing()
boolean	isForCopyOnly()
PreprocessingState	preprocessFile(PreprocessingState state, PreprocessorContext context)	Preprocess file, NB!
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 Object

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

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

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

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)