Module edu.ntnu.idatt2001.paths

Package edu.ntnu.idatt2001.paths.file

Class StoryFileWriter

java.lang.Object

edu.ntnu.idatt2001.paths.file.StoryFileWriter

public class StoryFileWriter
extends Object

Class for writing a story to a file.

Version:

0.4 29.04.2023

Author:

Carl G. Callum G.

Constructor Summary

Constructors

Constructor	Description
StoryFileWriter(File file)	Constructor for the class.

Method Summary

Modifier and Type	Method	Description
File	getFile()	Method to get the file.
void	writeStory(Story story)	Method to write a story to a file.

Methods inherited from class java.lang.Object

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

Constructor Details

StoryFileWriter

public StoryFileWriter(File file)
                throws BadFileNameException,
WrongFileExtensionException,
NullPointerException

Constructor for the class.

Parameters:

file - File - the file to write to

Throws:

BadFileNameException - thrown if the file name is invalid

WrongFileExtensionException - thrown if the file extension is invalid

NullPointerException - thrown if the file is null

Method Details

writeStory

public void writeStory(Story story)
                throws IOException

Method to write a story to a file. Writes in the following format:

 StoryTitle

 ::PassageTitle
 PassageContent
 [LinkText](LinkReference)<Action1|Action2|...>

 ::PassageTitle
 PassageContent
 [LinkText](LinkReference)<Action1|Action2|...>

 

Parameters:

story - Story - the story to write

Throws:

IOException - if an error occurs while writing to the file

getFile

public File getFile()

Method to get the file.

Returns:

File - the file