Module de.codecamp.messages.shared

Package de.codecamp.messages.shared.bundle

Class BundleFile<F>

java.lang.Object

de.codecamp.messages.shared.bundle.BundleFile<F>

Type Parameters:

F - the file reference

All Implemented Interfaces:

Comparable<BundleFile<F>>

public class BundleFile<F>
extends Object
implements Comparable<BundleFile<F>>

Represents one file (i.e. one locale) of a message bundle.

Constructor Summary

Constructors

Constructor	Description
BundleFile(FileSystemAdapter<?,F> fileSystem, F file, Charset encoding, MessageBundleManager.BundleFileCoordinates coordinates, String displayPath)

Method Summary

Modifier and Type	Method	Description
int	compareTo(BundleFile<F> o)
void	delete()	Deletes the bundle file.
protected void	ensureLoaded()	Ensures that the file has been loaded.
boolean	exists()
Integer	findLineNumberOfKey(String messageKey)	Finds the line number of the given message key in the bundle file.
Map<String,Integer>	findLineNumberOfKeys(Collection<String> messageKeys)	Finds the line numbers of the given message keys in the bundle file.
String	getBundleName()
String	getComment(String messageKey)
String	getDisplayPath()
Set<String>	getKeys()
Locale	getLocale()
F	getLocation()
String	getMessage(String messageKey)
boolean	hasMessage(String messageKey)
boolean	hasMessageKey(String messageKey)
boolean	isEmpty()
boolean	isMessageEmpty(String messageKey)
boolean	isReadOnly()
boolean	needsSaving()
boolean	needsSorting()
String	removeMessage(String messageKey)
boolean	save()	Saves the bundle file, if there are unsaved changes.
boolean	save(boolean force)	Saves the bundle file.
void	setComment(String messageKey, String comment)
void	setMessage(String messageKey, String message)

Methods inherited from class java.lang.Object

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

Constructor Details

BundleFile

public BundleFile(FileSystemAdapter<?,F> fileSystem,
 F file,
 Charset encoding,
 MessageBundleManager.BundleFileCoordinates coordinates,
 String displayPath)

Method Details

getLocation

public F getLocation()

getDisplayPath

public String getDisplayPath()

getBundleName

public String getBundleName()

getLocale

public Locale getLocale()

isReadOnly

public boolean isReadOnly()

isEmpty

public boolean isEmpty()

getKeys

public Set<String> getKeys()

hasMessageKey

public boolean hasMessageKey(String messageKey)

isMessageEmpty

public boolean isMessageEmpty(String messageKey)

hasMessage

public boolean hasMessage(String messageKey)

getMessage

public String getMessage(String messageKey)

setMessage

public void setMessage(String messageKey,
 String message)

removeMessage

public String removeMessage(String messageKey)

getComment

public String getComment(String messageKey)

setComment

public void setComment(String messageKey,
 String comment)

findLineNumberOfKey

public Integer findLineNumberOfKey(String messageKey)

Finds the line number of the given message key in the bundle file.

Parameters:

messageKey - the message key

Returns:

the line number or null

Throws:

BundleException - an error during bundle operations

findLineNumberOfKeys

public Map<String,Integer> findLineNumberOfKeys(Collection<String> messageKeys)

Finds the line numbers of the given message keys in the bundle file.

Parameters:

messageKeys - the message keys

Returns:

the line number per message key

Throws:

BundleException - an error during bundle operations

exists

public boolean exists()

needsSaving

public boolean needsSaving()

needsSorting

public boolean needsSorting()

save

public boolean save()

Saves the bundle file, if there are unsaved changes.

Returns:

whether the file was saved

Throws:

BundleException - an error during bundle operations

save

public boolean save(boolean force)

Saves the bundle file.

Parameters:

force - whether to save even without unsaved changes

Returns:

whether the file was saved

Throws:

BundleException - an error during bundle operations

ensureLoaded

protected void ensureLoaded()

Ensures that the file has been loaded.

Throws:

BundleException - an error during bundle operations

delete

public void delete()

Deletes the bundle file.

Throws:

BundleException - an error during bundle operations

compareTo

public int compareTo(BundleFile<F> o)

Specified by:

compareTo in interface Comparable<F>