model.definition

Class DefinitionFile

java.lang.Object

model.definition.DefinitionFile

public class DefinitionFile
extends java.lang.Object

DefinitionFileFile represents the "\check\.txt" files.

Author:

HFW410RA - Philipp Rammos

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.List<Comment>	comments HashMap of all comments from the AssignmentFile.
private java.util.Map<java.lang.String,AbstractVariableDefinition>	definitions HashMap of all definitions from the DefinitionFile.

Constructor Summary

Constructors

Constructor and Description
DefinitionFile() Default constructor.
DefinitionFile(java.util.Map<java.lang.String,AbstractVariableDefinition> definitions2, java.util.List<Comment> comments) Constructor, just sets the fields.

Method Summary

Modifier and Type	Method and Description
private java.util.Map<Position,Comment>	createPosCommentMap() Creates a Map containing comment.getPosition() as Key and comment as Value.No side effects to fields.
private java.util.Map<Position,AbstractVariableDefinition>	createPosDefMap() Creates a Map containing definition.getPosition() as Key and definition as Value.
boolean	equals(java.lang.Object obj)
java.util.List<Comment>	getComments()
java.util.Map<java.lang.String,AbstractVariableDefinition>	getDefinitions() Returns the field definitions.
int	hashCode()
private java.lang.StringBuffer	prepareStringToPrint() Prepares the StringBuffer for printing.
java.lang.String	print(java.lang.String pathToPrint) Prints a DefinitionFile containing the VariableDefinitions and Comments.
private void	printTheLinesToFile(java.lang.String pathToPrint, java.lang.StringBuffer stringBuffer) The only one method, that real prints lines into the file.
private java.util.List<Position>	sortPositions() Sorts the Positions of VariableAssignments and Comments in one List.

Methods inherited from class java.lang.Object

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

Field Detail

definitions

private final java.util.Map<java.lang.String,AbstractVariableDefinition> definitions

HashMap of all definitions from the DefinitionFile.

comments

private final java.util.List<Comment> comments

HashMap of all comments from the AssignmentFile.

Constructor Detail

DefinitionFile

public DefinitionFile()

Default constructor.

DefinitionFile

public DefinitionFile(java.util.Map<java.lang.String,AbstractVariableDefinition> definitions2,
                      java.util.List<Comment> comments)

Constructor, just sets the fields.

Parameters:

definitions2 - The definitions to set.

comments - The comments to set.

Method Detail

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getDefinitions

public java.util.Map<java.lang.String,AbstractVariableDefinition> getDefinitions()

Returns the field definitions. No side effects.

Returns:

this.definitions

getComments

public java.util.List<Comment> getComments()

Returns:

the comments

print

public java.lang.String print(java.lang.String pathToPrint)
                       throws PrinterException

Prints a DefinitionFile containing the VariableDefinitions and Comments.

Parameters:

pathToPrint - The path where to print the file.

Returns:

Returns a string representing the printed lines (for testing).

Throws:

PrinterException - If a IOException is thrown.

PrinterException

prepareStringToPrint

private java.lang.StringBuffer prepareStringToPrint()

Prepares the StringBuffer for printing. After this method, the buffer is ready for printing and it will contain the needed lines.

Returns:

The print-ready Buffer.

createPosDefMap

private java.util.Map<Position,AbstractVariableDefinition> createPosDefMap()

Creates a Map containing definition.getPosition() as Key and definition as Value. No side effects to fields.

Returns:

The created map.

createPosCommentMap

private java.util.Map<Position,Comment> createPosCommentMap()

Creates a Map containing comment.getPosition() as Key and comment as Value.No side effects to fields.

Returns:

The created map.

printTheLinesToFile

private void printTheLinesToFile(java.lang.String pathToPrint,
                                 java.lang.StringBuffer stringBuffer)
                          throws PrinterException

The only one method, that real prints lines into the file.

Parameters:

pathToPrint - The path where to print the file-

stringBuffer - The buffer with the lines to print.

Throws:

PrinterException - If an IOException is caused by the printer.

sortPositions

private java.util.List<Position> sortPositions()

Sorts the Positions of VariableAssignments and Comments in one List.

Returns:

The list of sorted Positions.