net.sourceforge.javadpkg.field

Interface FieldParser

All Known Implementing Classes:

FieldParserImpl

public interface FieldParser

A parser for fields.

Version:

1.0, 03.01.2016 by Gerrit Hohl

Author:

Gerrit Hohl (gerrit-hohl@users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
List<Field>	parseFieldsAsList(DataSource source, Context context) Parses fields from the specified source.
Map<String,Field>	parseFieldsAsMap(DataSource source, Context context) Parses fields from the specified source.

Method Detail

parseFieldsAsMap

Map<String,Field> parseFieldsAsMap(DataSource source,
                                   Context context)
                            throws IOException,
                                   ParseException

Parses fields from the specified source.

The key of the returned map is the field name in lower-case.

If a field with the same name occurs twice or more a ParseException is thrown.

Empty fields as well as nameless fields are ignored and never returned.

Parameters:

source - The source.

context - The context.

Returns:

The fields as map.

Throws:

IllegalArgumentException - If any of the parameters are null.

IOException - If an I/O error occurs.

ParseException - If an error occurs during the parsing.

parseFieldsAsList

List<Field> parseFieldsAsList(DataSource source,
                              Context context)
                       throws IOException,
                              ParseException

Parses fields from the specified source.

Empty fields are returned based on the configuration of the FieldParser implementation.

Parameters:

source - The source.

context - The context.

Returns:

The fields as list.

Throws:

IllegalArgumentException - If any of the parameters are null.

IOException - If an I/O error occurs.

ParseException - If an error occurs during the parsing.