biz.gabrys.maven.plugin.util.io

Class DestinationFileCreator

java.lang.Object

biz.gabrys.maven.plugin.util.io.DestinationFileCreator

public class DestinationFileCreator
extends Object

Responsible for creating a virtual (not physical) destination file in the output directory based on the source directory, the source file and the output file name pattern.

Example:

 public class ExampleMojo extends AbstractMojo {

     protected File sourceDirectory;
     protected File outputDirectory;
     protected String[] outputFileNamePattern = DestinationFileCreator.FILE_NAME_PARAMETER + ".output";

     public void execute() {
         // logic
         File source = ...

         // process file data
         String content = process(source); 

         File output = creatFile(source);
         saveFile(output, content);
     }
 
     private File createFile(File source) {
        DestinationFileCreator fileCreator = new DestinationFileCreator(sourceDirectory, outputDirectory, outputFileNamePattern);
        File output = fileCreator.create(source);
        return output;
    }

    ...
 }
 

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILE_NAME_PARAMETER The pattern in output file name which will be replaced by source file name without extension.

Constructor Summary

Constructors

Constructor and Description
DestinationFileCreator(File sourceDirectory, File outputDirectory) Constructs a new instance.
DestinationFileCreator(File sourceDirectory, File outputDirectory, String fileNamePattern) Constructs a new instance.

Method Summary

Modifier and Type	Method and Description
File	create(File source) Creates a destination file in the output directory.
void	setFileNamePattern(String fileNamePattern) Sets an output file name pattern.

Methods inherited from class java.lang.Object

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

Field Detail

FILE_NAME_PARAMETER

public static final String FILE_NAME_PARAMETER

The pattern in output file name which will be replaced by source file name without extension.

Since:

1.0

See Also:

Constant Field Values

Constructor Detail

DestinationFileCreator

public DestinationFileCreator(File sourceDirectory,
                              File outputDirectory)

Constructs a new instance.

Parameters:

sourceDirectory - the source directory.

outputDirectory - the output directory.

Since:

1.0

DestinationFileCreator

public DestinationFileCreator(File sourceDirectory,
                              File outputDirectory,
                              String fileNamePattern)

Constructs a new instance.

Parameters:

sourceDirectory - the source directory.

outputDirectory - the output directory.

fileNamePattern - the output file name pattern.

Since:

1.0

Method Detail

setFileNamePattern

public void setFileNamePattern(String fileNamePattern)

Sets an output file name pattern.

Parameters:

fileNamePattern - the output file name pattern.

Since:

1.0

create

public File create(File source)

Creates a destination file in the output directory. This method does not create any file on the hard drive.

Parameters:

source - the source file.

Returns:

the destination file.

Since:

1.0