Package me.deecaad.core.file

Class FileReader

java.lang.Object

me.deecaad.core.file.FileReader

public class FileReader
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	FileReader.NestedPathToSerializer	Stores temporary data to help with the 'Path To' feature of serializers, specifically when used nested in SerializeData.
static final record	FileReader.PathToSerializer	Stores temporary data to help with the 'Path To' feature of serializers.
static final record	FileReader.ValidatorData	Stores temporary data to help with 'Validators', a type of serializer checked AFTER all serialization is done.

Constructor Summary

Constructors

Constructor	Description
FileReader(@NotNull me.deecaad.core.MechanicsLogger debug, @Nullable List<Serializer<?>> serializers, @Nullable List<IValidator> validators)

Method Summary

Modifier and Type	Method	Description
void	addSerializer(Serializer<?> serializer)	Adds new serializer for this file reader.
void	addSerializers(List<Serializer<?>> serializers)	Adds new serializers for this file reader.
void	addValidator(IValidator validator)	Adds new validator for this file reader.
void	addValidators(List<IValidator> validators)	Adds new validators for this file reader.
me.deecaad.core.file.Configuration	fillAllFiles(File directory, @Nullable String... ignoreFiles)	Iterates through all .yml files inside every directory starting from the given directory.
@NotNull me.deecaad.core.file.Configuration	fillOneFile(File file)	Fills one file into map and returns its configuration.
me.deecaad.core.file.Configuration	usePathToSerializersAndValidators(me.deecaad.core.file.Configuration filledMap)	Uses all path to serializers and validators.

Methods inherited from class java.lang.Object

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

Constructor Details

FileReader

public FileReader(@NotNull
 @NotNull me.deecaad.core.MechanicsLogger debug,
 @Nullable
 @Nullable List<Serializer<?>> serializers,
 @Nullable
 @Nullable List<IValidator> validators)

Method Details

addSerializers

public void addSerializers(List<Serializer<?>> serializers)

Adds new serializers for this file reader. Serializers should be added before using fillAllFiles() or fillOneFile() methods.

Parameters:

serializers - the new list serializers for this file reader

addSerializer

public void addSerializer(Serializer<?> serializer)

Adds new serializer for this file reader. Serializers should be added before using fillAllFiles() or fillOneFile() methods.

Parameters:

serializer - the new serializer for this file reader

addValidators

public void addValidators(List<IValidator> validators)

Adds new validators for this file reader. Validators should be added before using fillAllFiles() or fillOneFile() methods.

Parameters:

validators - the new list validators for this file reader

addValidator

public void addValidator(IValidator validator)

Adds new validator for this file reader. Validators should be added before using fillAllFiles() or fillOneFile() methods.

Parameters:

validator - the new validator for this file reader

fillAllFiles

public me.deecaad.core.file.Configuration fillAllFiles(File directory,
 @Nullable
 @Nullable String... ignoreFiles)

Iterates through all .yml files inside every directory starting from the given directory. It is recommended to give this method plugin's data folder directory. This also takes in account given serializers.

Parameters:

directory - the directory

ignoreFiles - ignored files which name starts with any given string

Returns:

the map with all configurations

fillOneFile

@NotNull
public @NotNull me.deecaad.core.file.Configuration fillOneFile(File file)

Fills one file into map and returns its configuration. This also takes in account given serializers.

Parameters:

file - the file to read

Returns:

the map with file's configurations

usePathToSerializersAndValidators

public me.deecaad.core.file.Configuration usePathToSerializersAndValidators(me.deecaad.core.file.Configuration filledMap)

Uses all path to serializers and validators. This should be used AFTER normal serialization.

Parameters:

filledMap - the filled mappings

Returns:

the map with used path to serializers and validators