Package org.basinmc.plunger.mapping.csv

Class AbstractCSVMappingParser<M>

java.lang.Object

org.basinmc.plunger.mapping.csv.AbstractCSVMappingParser<M>

Direct Known Subclasses:

CSVClassNameMappingParser, CSVFieldNameMappingParser, CSVMethodNameMappingParser, CSVParameterNameMappingParser

public abstract class AbstractCSVMappingParser<M>
extends Object

Provides a base to CSV based mapping parsers which accept arbitrarily formatted files.

Author:

Johannes Donath

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractCSVMappingParser.Builder	Provides a base to factories which produce arbitrary CSV mapper parsers.
static class	AbstractCSVMappingParser.MemberBuilder	Provides a base to factories which produce arbitrary CSV mapper parsers for class members elements.

Method Summary

Modifier and Type	Method	Description
protected abstract M	doParse(org.apache.commons.csv.CSVParser parser)	Parses the contents of a CSV file or stream.
M	parse(InputStream inputStream)
M	parse(InputStream inputStream, Charset charset)	Parses the contents of an arbitrary input stream.
M	parse(Reader reader)	Parses the contents of an arbitrary reader.
M	parse(Path file)
M	parse(Path file, Charset charset)	Parses the contents of an arbitrary file.

Methods inherited from class java.lang.Object

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

Method Detail

doParse

protected abstract M doParse(@NonNull
                             org.apache.commons.csv.CSVParser parser)
                      throws IOException

Parses the contents of a CSV file or stream.

Parameters:

parser - a CSV parser.

Returns:

a mapping.

Throws:

IOException - when parsing fails.

parse

@NonNull
public M parse(@NonNull
               Path file,
               @NonNull
               Charset charset)
        throws IOException

Parses the contents of an arbitrary file.

Parameters:

file - a CSV mapping file.

charset - a charset.

Returns:

a set of mappings of a certain type.

Throws:

IOException - when parsing the mappings fails.

parse

@NonNull
public M parse(@NonNull
               InputStream inputStream)
        throws IOException

Throws:

IOException

See Also:

parse(InputStream, Charset)

parse

@NonNull
public M parse(@NonNull
               InputStream inputStream,
               @NonNull
               Charset charset)
        throws IOException

Parses the contents of an arbitrary input stream.

Parameters:

inputStream - a CSV stream.

charset - a charset.

Returns:

a set of mappings of a certain type.

Throws:

IOException - when parsing the mappings fails.

parse

@NonNull
public M parse(@NonNull
               Reader reader)
        throws IOException

Parses the contents of an arbitrary reader.

Parameters:

reader - a reader.

Returns:

a set of mappings of a certain type.

Throws:

IOException - when parsing the mappings fails.

parse

@NonNull
public M parse(@NonNull
               Path file)
        throws IOException

Throws:

IOException

See Also:

parse(Path, Charset)