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()
protected void	ensureLoaded()
boolean	exists()
Integer	findLineNumberOfKey(String messageKey)
Map<String,Integer>	findLineNumberOfKeys(Collection<String> messageKeys)
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()
boolean	save(boolean force)
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 Detail

BundleFile

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

Method Detail

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)
                            throws BundleException

Throws:

BundleException

findLineNumberOfKeys

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

Throws:

BundleException

exists

public boolean exists()

needsSaving

public boolean needsSaving()

needsSorting

public boolean needsSorting()

save

public boolean save()
             throws BundleException

Throws:

BundleException

save

public boolean save(boolean force)
             throws BundleException

Throws:

BundleException

ensureLoaded

protected void ensureLoaded()
                     throws BundleException

Throws:

BundleException

delete

public void delete()
            throws BundleException

Throws:

BundleException

compareTo

public int compareTo(BundleFile<F> o)

Specified by:

compareTo in interface Comparable<F>