io.codechicken.diffpatch.util

Class Output.FolderMultiOutput

java.lang.Object

io.codechicken.diffpatch.util.Output

io.codechicken.diffpatch.util.Output.MultiOutput

io.codechicken.diffpatch.util.Output.FolderMultiOutput

All Implemented Interfaces:

java.lang.AutoCloseable

Enclosing class:

Output

public static class Output.FolderMultiOutput
extends Output.MultiOutput

Nested Class Summary

Nested classes/interfaces inherited from class io.codechicken.diffpatch.util.Output

Output.ArchiveMultiOutput, Output.FolderMultiOutput, Output.MultiOutput, Output.PathArchiveMultiOutput, Output.PipeArchiveMultiOutput, Output.SingleOutput

Field Summary

Fields

Modifier and Type	Field and Description
java.nio.file.Path	folder

Constructor Summary

Constructors

Constructor and Description
FolderMultiOutput(java.nio.file.Path folder)

Method Summary

Modifier and Type	Method and Description
void	close()
boolean	isSamePath(Input input) Used to compare if an input and an output point to the same underlying file.
void	open(boolean clearOutput) Called to open any internal resources and set up the output for writing.
void	validate(java.lang.String kind) Check any preconditions about the output prior to any work occurring.
void	write(java.lang.String path, byte[] data) Called to write a file to the output.

Methods inherited from class io.codechicken.diffpatch.util.Output.MultiOutput

archive, archive, detectedArchive, folder

Methods inherited from class java.lang.Object

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

Field Detail

folder

public final java.nio.file.Path folder

Constructor Detail

FolderMultiOutput

public FolderMultiOutput(java.nio.file.Path folder)

Method Detail

validate

public void validate(java.lang.String kind)
              throws IOValidationException

Description copied from class: Output

Check any preconditions about the output prior to any work occurring.

Used to check if folder outputs are actually folders, or archives are actually zips, etc.

Specified by:

validate in class Output

Parameters:

kind - Descriptive name of the output. I.E patches, outputs, rejects, etc.

Throws:

IOValidationException

open

public void open(boolean clearOutput)
          throws java.io.IOException

Description copied from class: Output.MultiOutput

Called to open any internal resources and set up the output for writing.

Specified by:

open in class Output.MultiOutput

Parameters:

clearOutput - If the output should be wiped, or written over top of. This only effects Output.FolderMultiOutput. Archives are always rewritten.

Throws:

java.io.IOException

write

public void write(java.lang.String path,
                  byte[] data)
           throws java.io.IOException

Description copied from class: Output.MultiOutput

Called to write a file to the output.

Specified by:

write in class Output.MultiOutput

Parameters:

path - The relative path of the output. Will not contain a starting slash.

data - The data.

Throws:

java.io.IOException

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class Output.MultiOutput

isSamePath

public boolean isSamePath(Input input)

Description copied from class: Output

Used to compare if an input and an output point to the same underlying file.

Overrides:

isSamePath in class Output

Parameters:

input - The input.

Returns:

If the input points to the same file as the output.