Package de.bcxp.challenge.common.model

Class Document

java.lang.Object

de.bcxp.challenge.common.model.Document

public class Document
extends Object

Represents an abstract document containing a list of DocumentEntry objects.
Subclasses should define specific behavior for different types of documents.

Field Summary

Fields

Modifier and Type	Field	Description
private final List<DocumentEntry>	entries	A list of DocumentEntry objects present in the represented document.
private static final org.apache.logging.log4j.Logger	logger

Constructor Summary

Constructors

Constructor	Description
Document(List<DocumentEntry> entries)	Constructs a new Document.

Method Summary

Modifier and Type	Method	Description
List<DocumentEntry>	getEntries()
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

logger

private static final org.apache.logging.log4j.Logger logger

entries

private final List<DocumentEntry> entries

A list of DocumentEntry objects present in the represented document.

Consideration was given to represent entries as a Set to avoid saving duplicate entries. A List was chosen to represent the entries since there might be documents with identical entries that could be valid.

Constructor Details

Document

public Document(List<DocumentEntry> entries)
         throws DocumentCreationException

Constructs a new Document.

Parameters:

entries - a List of DocumentEntry objects that represent the Document contents

Throws:

DocumentCreationException

Method Details

getEntries

public List<DocumentEntry> getEntries()

toString

public String toString()

Overrides:

toString in class Object