Package xyz.calcugames.levelz

Class LevelExporter

java.lang.Object

xyz.calcugames.levelz.LevelExporter

public final class LevelExporter
extends Object

Represents a class that exports a LevelZ Level to a file.

Field Summary

Fields

Modifier and Type	Field	Description
String	fileExtension	Whether to include a section separator in the export.
boolean	includeData	Whether to include data in the export.
boolean	includeHeaders	Whether to include headers in the export.
String	lineSeparator	The line separator to use in the export.

Method Summary

Modifier and Type	Method	Description
static @NotNull LevelExporter	export(@NotNull Level level)	Exports the Level to a file.
void	writeToFile(@NotNull File file)	Writes to a file.
void	writeToPath(@NotNull Path file)	Writes to a file path.
@NotNull String	writeToString()	Exports the Level to a string.

Methods inherited from class java.lang.Object

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

Field Details

includeHeaders

public boolean includeHeaders

Whether to include headers in the export.

includeData

public boolean includeData

Whether to include data in the export.

fileExtension

public String fileExtension

Whether to include a section separator in the export.

lineSeparator

public String lineSeparator

The line separator to use in the export. Default is \n.

Method Details

export

@NotNull
public static @NotNull LevelExporter export(@NotNull
 @NotNull Level level)

Exports the Level to a file.

Parameters:

level - Level to Export

Returns:

Level Exporter

writeToString

@NotNull
public @NotNull String writeToString()

Exports the Level to a string.

Returns:

Level String

writeToFile

public void writeToFile(@NotNull
 @NotNull File file)

Writes to a file. This will create the file if it does not exist.

Parameters:

file - File

writeToPath

public void writeToPath(@NotNull
 @NotNull Path file)

Writes to a file path.

Parameters:

file - File Path