one.edee.babylon.snapshot

Interface TranslationSnapshotReadContract

All Known Implementing Classes:

SnapshotAdapter

public interface TranslationSnapshotReadContract

Set of operations that are required from the snapshot of current translation stat - i.e. the result of previous translation synchronization roundtrip (export + import). In case no previous synchronization roundtrip has been completed, the snapshot is empty.

Method Summary

Modifier and Type	Method and Description
boolean	containsMessage(String msgKey, String msgFile) Check if translation snapshot contains message msgKey for file msgFile.
String	getLastMessageValue(String msgKey, String msgFile) Return the message value of the message key msgKey as captured in the snapshot.
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

Method Detail

includesMsgFile

boolean includesMsgFile(String msgFile)

Check if message file msgFile is part of translation snapshot.

Parameters:

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

listMsgFiles

Collection<String> listMsgFiles()

Lists all message files included in the translation snapshot

Returns:

collection of message file paths

containsMessage

boolean containsMessage(String msgKey,
                        String msgFile)

Check if translation snapshot contains message msgKey for file msgFile.

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

getLastMessageValue

String getLastMessageValue(String msgKey,
                           String msgFile)

Return the message value of the message key msgKey as captured in the snapshot.

Parameters:

msgKey - key of the message to retrieve from message file

msgFile - message file path that will be examined for given

Throws:

NoSuchElementException - if snapshot of file msgFile does not contain message with key msgKey of if the snapshot doesn't include msgFile at all