one.edee.babylon.snapshot

Class SnapshotAdapter

java.lang.Object

one.edee.babylon.snapshot.SnapshotAdapter

All Implemented Interfaces:

TranslationSnapshotReadContract, TranslationSnapshotWriteContract

public class SnapshotAdapter
extends Object
implements TranslationSnapshotReadContract, TranslationSnapshotWriteContract

Implements snapshot contracts by delegating to [Snapshot] without exposing its details.

Constructor Summary

Constructors

Constructor and Description
SnapshotAdapter(Snapshot snapshot)

Method Summary

Modifier and Type	Method and Description
boolean	containsMessage(String msgKey, String msgFile) Check if translation snapshot contains message msgKey for file msgFile.
Snapshot	getUnderlyingSnapshot() Gives access to underlying Snapshot, mainly for use in tests.
boolean	hasSameMessage(@NotNull String msgKey, @NotNull String msgFile, @Nullable String currentMsg)
boolean	includesMsgFile(String msgFile) Check if message file msgFile is part of translation snapshot.
Collection<String>	listMsgFiles() Lists all message files included in the translation snapshot
Integer	registerMsgFile(String msgFilePath) Generated persistent id for [msgFilePath] and stores the path along the new id
void	removeMsgFilePaths(Collection<String> msgFilePaths) Removes message file paths from the translation snapshot.

Methods inherited from class java.lang.Object

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

Constructor Detail

SnapshotAdapter

public SnapshotAdapter(Snapshot snapshot)

Method Detail

getUnderlyingSnapshot

public Snapshot getUnderlyingSnapshot()

Description copied from interface: TranslationSnapshotWriteContract

Gives access to underlying Snapshot, mainly for use in tests.

Specified by:

getUnderlyingSnapshot in interface TranslationSnapshotWriteContract

Returns:

underlying snapshot

includesMsgFile

public boolean includesMsgFile(String msgFile)

Description copied from interface: TranslationSnapshotReadContract

Check if message file msgFile is part of translation snapshot.

Specified by:

includesMsgFile in interface TranslationSnapshotReadContract

Parameters:

msgFile - message file path that is either included in the snapshot or it is not

listMsgFiles

public Collection<String> listMsgFiles()

Description copied from interface: TranslationSnapshotReadContract

Lists all message files included in the translation snapshot

Specified by:

listMsgFiles in interface TranslationSnapshotReadContract

Returns:

collection of message file paths

registerMsgFile

public Integer registerMsgFile(String msgFilePath)

Description copied from interface: TranslationSnapshotWriteContract

Generated persistent id for [msgFilePath] and stores the path along the new id

Specified by:

registerMsgFile in interface TranslationSnapshotWriteContract

Parameters:

msgFilePath - message file path that will be registered in the snapshot

Returns:

persistent id given to the [msgFilePath]

removeMsgFilePaths

public void removeMsgFilePaths(Collection<String> msgFilePaths)

Description copied from interface: TranslationSnapshotWriteContract

Removes message file paths from the translation snapshot.

Specified by:

removeMsgFilePaths in interface TranslationSnapshotWriteContract

Parameters:

msgFilePaths - message file paths to remove

containsMessage

public boolean containsMessage(String msgKey,
                               String msgFile)

Description copied from interface: TranslationSnapshotReadContract

Check if translation snapshot contains message msgKey for file msgFile.

Specified by:

containsMessage in interface TranslationSnapshotReadContract

Parameters:

msgKey - key of message that might be contained in message file msgFile

msgFile - message file path that we assume is included in the snapshot

hasSameMessage

public boolean hasSameMessage(@NotNull
                              @NotNull String msgKey,
                              @NotNull
                              @NotNull String msgFile,
                              @Nullable
                              @Nullable String currentMsg)

Specified by:

hasSameMessage in interface TranslationSnapshotReadContract