Package de.codecamp.messages.shared.model

Class MessageKeyIndex

java.lang.Object

de.codecamp.messages.shared.model.AbstractPersistableData

de.codecamp.messages.shared.model.MessageKeyIndex

All Implemented Interfaces:

MessageModule

public class MessageKeyIndex
extends AbstractPersistableData
implements MessageModule

The message key index file contains the information which message keys this project / module declares and where they are declared in the source.

Nested Class Summary

Nested classes/interfaces inherited from class de.codecamp.messages.shared.model.AbstractPersistableData

AbstractPersistableData.PersistableDataException

Constructor Summary

Constructors

Constructor	Description
MessageKeyIndex()

Method Summary

Modifier and Type	Method	Description
boolean	containsKey(String key)
static MessageKeyIndex	copyOf(MessageKeyIndex index)
int	countKeys()
int	countKeys(String sourceType)
int	countSourceTypes()
List<BundleMapping>	getBundleMappings()
List<String>	getImportedModules()
MessageKeyWithSourceLocation	getKey(String code)
Stream<MessageKeyWithSourceLocation>	getKeys()
Stream<MessageKeyWithSourceLocation>	getKeysForType(String sourceType)
String	getMessageFormat()
String	getModuleName()
String	getPreferredFilePath()
static String	getPreferredFilePath(String moduleName)
int	getSize()
Stream<String>	getSourceTypes()
List<Locale>	getTargetLocales()
boolean	hasSourceType(String sourceType)
static boolean	isIndexFile(String filename)
static MessageKeyIndex	readFrom(InputStream inputStream)
static MessageKeyIndex	readFrom(Path path)
void	setBundleMappings(List<BundleMapping> bundleMappings)
void	setImportedModules(List<String> importedModules)
void	setMessageFormat(String messageFormat)
void	setModuleName(String moduleName)
void	setTargetLocales(List<Locale> targetLocales)
void	updateWith(String typeName, Set<MessageKeyWithSourceLocation> messageKeys)

Methods inherited from class de.codecamp.messages.shared.model.AbstractPersistableData

readFrom, readFrom, writeTo, writeTo

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageKeyIndex

public MessageKeyIndex()

Method Detail

getModuleName

public String getModuleName()

Specified by:

getModuleName in interface MessageModule

setModuleName

public void setModuleName(String moduleName)

getTargetLocales

public List<Locale> getTargetLocales()

Specified by:

getTargetLocales in interface MessageModule

setTargetLocales

public void setTargetLocales(List<Locale> targetLocales)

getBundleMappings

public List<BundleMapping> getBundleMappings()

Specified by:

getBundleMappings in interface MessageModule

setBundleMappings

public void setBundleMappings(List<BundleMapping> bundleMappings)

getImportedModules

public List<String> getImportedModules()

Specified by:

getImportedModules in interface MessageModule

setImportedModules

public void setImportedModules(List<String> importedModules)

getMessageFormat

public String getMessageFormat()

Specified by:

getMessageFormat in interface MessageModule

setMessageFormat

public void setMessageFormat(String messageFormat)

containsKey

public boolean containsKey(String key)

hasSourceType

public boolean hasSourceType(String sourceType)

getSourceTypes

public Stream<String> getSourceTypes()

countSourceTypes

public int countSourceTypes()

getKeysForType

public Stream<MessageKeyWithSourceLocation> getKeysForType(String sourceType)

getKey

public MessageKeyWithSourceLocation getKey(String code)

countKeys

public int countKeys(String sourceType)

getKeys

public Stream<MessageKeyWithSourceLocation> getKeys()

countKeys

public int countKeys()

updateWith

public void updateWith(String typeName,
                       Set<MessageKeyWithSourceLocation> messageKeys)

getSize

public int getSize()

getPreferredFilePath

public String getPreferredFilePath()

getPreferredFilePath

public static String getPreferredFilePath(String moduleName)

isIndexFile

public static boolean isIndexFile(String filename)

readFrom

public static MessageKeyIndex readFrom(InputStream inputStream)
                                throws AbstractPersistableData.PersistableDataException

Throws:

AbstractPersistableData.PersistableDataException

readFrom

public static MessageKeyIndex readFrom(Path path)
                                throws AbstractPersistableData.PersistableDataException

Throws:

AbstractPersistableData.PersistableDataException

copyOf

public static MessageKeyIndex copyOf(MessageKeyIndex index)