Package de.delinkedde.areashopreborn.importer.legacy

Klasse LegacyImportMappingStore

java.lang.Object

de.delinkedde.areashopreborn.importer.legacy.LegacyImportMappingStore

public final class LegacyImportMappingStore
extends Object

Stores explicit administrator-approved values for ambiguous legacy AreaShop inheritance.

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
static enum	LegacyImportMappingStore.Field	Fields whose effective legacy values may be supplied explicitly.
static final record	LegacyImportMappingStore.Mapping	Immutable mapping row.
static final record	LegacyImportMappingStore.Snapshot	Immutable in-memory view used for one complete import run.

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
LegacyImportMappingStore(Path file)	Creates a mapping store.
LegacyImportMappingStore(Path file, long maximumFileBytes, int maximumEntries)	Creates a bounded mapping store.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
List<LegacyImportMappingStore.Mapping>	list()	Lists every configured mapping in stable source order.
List<LegacyImportMappingStore.Mapping>	list(int limit)	Lists a bounded prefix of configured mappings.
boolean	remove(String sourceKey, LegacyImportMappingStore.Field field)	Removes one mapped field and deletes an empty source row.
Optional<String>	resolve(String sourceKey, LegacyImportMappingStore.Field field)	Resolves one explicit value.
void	set(String sourceKey, LegacyImportMappingStore.Field field, String value)	Sets one explicit effective value and atomically rewrites the mapping file.
LegacyImportMappingStore.Snapshot	snapshot()	Loads, validates, and deeply freezes the entire bounded mapping file once.

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

LegacyImportMappingStore

public LegacyImportMappingStore(Path file)

Creates a mapping store.

Parameter:

file - mapping YAML file inside the plugin data directory

LegacyImportMappingStore

public LegacyImportMappingStore(Path file,
 long maximumFileBytes,
 int maximumEntries)

Creates a bounded mapping store.

Parameter:

file - mapping YAML file inside the plugin data directory

maximumFileBytes - maximum mapping YAML size

maximumEntries - maximum distinct source rows

Methodendetails

resolve

public Optional<String> resolve(String sourceKey,
 LegacyImportMappingStore.Field field)
                         throws IOException,
LegacyImportException

Resolves one explicit value.

Parameter:

sourceKey - legacy source path

field - requested field

Gibt zurück:

mapped value when configured

Löst aus:

IOException - when the mapping file cannot be read

LegacyImportException - when stored data is malformed

snapshot

public LegacyImportMappingStore.Snapshot snapshot()
                                           throws IOException,
LegacyImportException

Loads, validates, and deeply freezes the entire bounded mapping file once.

Gibt zurück:

immutable mapping snapshot

Löst aus:

IOException - when the mapping file cannot be read

LegacyImportException - when stored data is malformed

list

public List<LegacyImportMappingStore.Mapping> list()
                                            throws IOException,
LegacyImportException

Lists every configured mapping in stable source order.

Gibt zurück:

immutable mappings

Löst aus:

IOException - when the mapping file cannot be read

LegacyImportException - when stored data is malformed

list

public List<LegacyImportMappingStore.Mapping> list(int limit)
                                            throws IOException,
LegacyImportException

Lists a bounded prefix of configured mappings.

Parameter:

limit - maximum rows returned

Gibt zurück:

immutable mappings in stable order

Löst aus:

IOException - when the mapping file cannot be read

LegacyImportException - when stored data is malformed

set

public void set(String sourceKey,
 LegacyImportMappingStore.Field field,
 String value)
         throws IOException,
LegacyImportException

Sets one explicit effective value and atomically rewrites the mapping file.

Parameter:

sourceKey - legacy source path

field - mapped field

value - explicit literal value

Löst aus:

IOException - when persistence fails

LegacyImportException - when input or stored data is malformed

remove

public boolean remove(String sourceKey,
 LegacyImportMappingStore.Field field)
               throws IOException,
LegacyImportException

Removes one mapped field and deletes an empty source row.

Parameter:

sourceKey - legacy source path

field - mapped field

Gibt zurück:

whether a value existed

Löst aus:

IOException - when persistence fails

LegacyImportException - when input or stored data is malformed