Package com.e1c.langtool.storage

Class AbstractFileStorage

java.lang.Object

com.e1c.langtool.storage.AbstractFileStorage

All Implemented Interfaces:

ITranslationStorageProvider.Storage

Direct Known Subclasses:

ContextFileStorage, DictionaryFileStorage

public abstract class AbstractFileStorage
extends Object
implements ITranslationStorageProvider.Storage

The abstract class of resource file storage, that allows to use common logic to track external file changing events, or save asynchronously, storage batch mode, firing changes events and etc.

Nested Class Summary

Nested classes/interfaces inherited from interface com.e1c.langtool.storage.ITranslationStorageProvider.Storage

ITranslationStorageProvider.Storage.Type

Field Summary

Fields

Modifier and Type	Field	Description
protected AtomicBoolean	batchUpdate
protected final CachedFileMediator	fileMediator
protected final StorageID	id
protected final org.eclipse.core.resources.IProject	project

Constructor Summary

Constructors

Constructor	Description
AbstractFileStorage(org.eclipse.core.resources.IProject project, StorageID id, StorageSettings settings)	Instantiates a new abstract file storage.

Method Summary

Modifier and Type	Method	Description
void	addBatchUpdateNotification(StorageValueChangeEvent event)	Adds the batch update notification.
void	addValueChangedListener(IStorageValueChangedListener listener)	Adds a listener for post value changes in this storage.
void	beginBatchUpdate()	Inform storage about planned batch update.
void	dispose()
void	endBatchUpdate()	End storage batch update.
protected void	firePostValueChanged(StorageValueChangeEvent event)	Notifies any post value changed listeners that a post change event has been received.
StorageID	getId()	Gets the id of storage.
String	getSegment()	The unique segment.
protected abstract com.google.inject.Provider<ITranslationFileEditorFactory<?>>	getTranslationFileEditorFactory(StorageSettings settings)
boolean	isReadOnly()	Checks if the storage is read only.
void	removeValueChangedListener(IStorageValueChangedListener listener)	Removes the given listener for post value changes from this storage.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.e1c.langtool.storage.ITranslationStorageProvider.Storage

getTranslation, getType, moveTranslation, removeTranslation, setTranslation

Field Details

fileMediator

protected final CachedFileMediator fileMediator

project

protected final org.eclipse.core.resources.IProject project

id

protected final StorageID id

batchUpdate

protected AtomicBoolean batchUpdate

Constructor Details

AbstractFileStorage

public AbstractFileStorage(org.eclipse.core.resources.IProject project,
 StorageID id,
 StorageSettings settings)

Instantiates a new abstract file storage.

Parameters:

project - the project, cannot be null.

id - the storage id, cannot be null.

settings - the settings, cannot be null.

Method Details

getId

public StorageID getId()

Description copied from interface: ITranslationStorageProvider.Storage

Gets the id of storage.

Specified by:

getId in interface ITranslationStorageProvider.Storage

Returns:

the id. Cannot return null.

getSegment

public String getSegment()

Description copied from interface: ITranslationStorageProvider.Storage

The unique segment.

Specified by:

getSegment in interface ITranslationStorageProvider.Storage

Returns:

the segment

isReadOnly

public boolean isReadOnly()

Description copied from interface: ITranslationStorageProvider.Storage

Checks if the storage is read only.

Specified by:

isReadOnly in interface ITranslationStorageProvider.Storage

Returns:

true, if the storage is read only

addValueChangedListener

public void addValueChangedListener(IStorageValueChangedListener listener)

Description copied from interface: ITranslationStorageProvider.Storage

Adds a listener for post value changes in this storage. Has no effect if an identical listener is already registered.

Specified by:

addValueChangedListener in interface ITranslationStorageProvider.Storage

Parameters:

listener - the listener

removeValueChangedListener

public void removeValueChangedListener(IStorageValueChangedListener listener)

Description copied from interface: ITranslationStorageProvider.Storage

Removes the given listener for post value changes from this storage. Has no effect if an identical listener is not registered.

Specified by:

removeValueChangedListener in interface ITranslationStorageProvider.Storage

Parameters:

listener - the listener

addBatchUpdateNotification

public void addBatchUpdateNotification(StorageValueChangeEvent event)

Description copied from interface: ITranslationStorageProvider.Storage

Adds the batch update notification.

Specified by:

addBatchUpdateNotification in interface ITranslationStorageProvider.Storage

Parameters:

event - the event, cannot be null

beginBatchUpdate

public void beginBatchUpdate()

Description copied from interface: ITranslationStorageProvider.Storage

Inform storage about planned batch update. Storage implementation may use this information for work optimization. After batch update done endUpdate() must be called. Nested updates supported. Update mode end when last endUpdate() paired to called.

Specified by:

beginBatchUpdate in interface ITranslationStorageProvider.Storage

endBatchUpdate

public void endBatchUpdate()

Description copied from interface: ITranslationStorageProvider.Storage

End storage batch update.

Specified by:

endBatchUpdate in interface ITranslationStorageProvider.Storage

dispose

public void dispose()

firePostValueChanged

protected void firePostValueChanged(StorageValueChangeEvent event)

Notifies any post value changed listeners that a post change event has been received. Only listeners registered at the time this method is called are notified.

Parameters:

event - a value changed event

See Also:

• addValueChangedListener(IStorageValueChangedListener)

getTranslationFileEditorFactory

protected abstract com.google.inject.Provider<ITranslationFileEditorFactory<?>> getTranslationFileEditorFactory(StorageSettings settings)