net.sourceforge.javadpkg.field.impl

Class FieldParserImpl

java.lang.Object

net.sourceforge.javadpkg.field.impl.FieldParserImpl

All Implemented Interfaces:

FieldParser, GlobalConstants

public class FieldParserImpl
extends Object
implements FieldParser, GlobalConstants

A FieldParser implementation.

Version:

1.0, 03.01.2016 by Gerrit Hohl

Author:

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

Field Summary

Fields inherited from interface net.sourceforge.javadpkg.GlobalConstants

UTF_8, UTF_8_CHARSET

Constructor Summary

Constructors

Constructor and Description
FieldParserImpl(boolean allowEmptyLines, boolean returnEmptyLines, boolean allowNamelessFields) Creates a parser.

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldParserImpl

public FieldParserImpl(boolean allowEmptyLines,
                       boolean returnEmptyLines,
                       boolean allowNamelessFields)

Creates a parser.

Parameters:

allowEmptyLines - The flag if empty lines are allowed. Otherwise a ParseException is thrown when an empty line is found.

returnEmptyLines - The flag if empty lines should be returned by the parseFieldsAsList(DataSource, Context) method.

allowNamelessFields - The flag if nameless fields should not throw a ParseException.

Method Detail

parseFieldsAsMap

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

Description copied from interface: FieldParser

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.

Specified by:

parseFieldsAsMap in interface FieldParser

Parameters:

source - The source.

context - The context.

Returns:

The fields as map.

Throws:

IOException - If an I/O error occurs.

ParseException - If an error occurs during the parsing.

parseFieldsAsList

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

Description copied from interface: FieldParser

Parses fields from the specified source.

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

Specified by:

parseFieldsAsList in interface FieldParser

Parameters:

source - The source.

context - The context.

Returns:

The fields as list.

Throws:

IOException - If an I/O error occurs.

ParseException - If an error occurs during the parsing.