org.freedesktop

Class AbstractFreedesktopService<T extends FreedesktopEntity>

java.lang.Object

org.freedesktop.AbstractFreedesktopService<T>

All Implemented Interfaces:

FreedesktopService<T>

Direct Known Subclasses:

AbstractThemeService, DefaultAliasService, DefaultDesktopEntryService, DefaultGlobService, DefaultMagicService, DefaultMIMEService

public abstract class AbstractFreedesktopService<T extends FreedesktopEntity>
extends Object
implements FreedesktopService<T>

Abstract implementations of a FreedesktopService that provides methods for maintaining the list of base directories (common to all specifications).

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<org.apache.commons.vfs2.FileObject,Collection<T>>	bases
protected List<org.apache.commons.vfs2.FileObject>	basesList

Constructor Summary

Constructors

Constructor and Description
AbstractFreedesktopService()

Method Summary

Modifier and Type	Method and Description
void	addBase(org.apache.commons.vfs2.FileObject base) Add a directory to the list of those that should be searched.
protected void	checkAndAddBase(File file)
protected void	checkAndAddBase(org.apache.commons.vfs2.FileObject file)
Collection<T>	getAllEntities() Get a collection of all available entities in all bases.
Collection<org.apache.commons.vfs2.FileObject>	getBases() Get a collection of all base directories.
Collection<org.apache.commons.vfs2.FileObject>	getBasesInReverse()
Collection<T>	getEntities(org.apache.commons.vfs2.FileObject base) Get a collection of all available entities in the specified base directory.
T	getEntity(String name) Get a entities given its name.
protected org.apache.commons.vfs2.FileObject[]	listDirs(org.apache.commons.vfs2.FileObject dir)
void	removeBase(org.apache.commons.vfs2.FileObject base) Remove a directory from the list that is is searched.
protected abstract Collection<T>	scanBase(org.apache.commons.vfs2.FileObject base)

Methods inherited from class java.lang.Object

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

Field Detail

bases

protected Map<org.apache.commons.vfs2.FileObject,Collection<T extends FreedesktopEntity>> bases

basesList

protected List<org.apache.commons.vfs2.FileObject> basesList

Constructor Detail

AbstractFreedesktopService

public AbstractFreedesktopService()

Method Detail

addBase

public void addBase(org.apache.commons.vfs2.FileObject base)
             throws IOException

Description copied from interface: FreedesktopService

Add a directory to the list of those that should be searched. The base directories will be searched in the order they were added.

Specified by:

addBase in interface FreedesktopService<T extends FreedesktopEntity>

Parameters:

base - base directory

Throws:

IOException - if location is invalid in some way

removeBase

public void removeBase(org.apache.commons.vfs2.FileObject base)

Description copied from interface: FreedesktopService

Remove a directory from the list that is is searched.

Specified by:

removeBase in interface FreedesktopService<T extends FreedesktopEntity>

Parameters:

base - base directory to remove from the list that is searched

See Also:

#addBase(File)

getEntities

public Collection<T> getEntities(org.apache.commons.vfs2.FileObject base)

Description copied from interface: FreedesktopService

Get a collection of all available entities in the specified base directory.

Specified by:

getEntities in interface FreedesktopService<T extends FreedesktopEntity>

Parameters:

base - base directory

Returns:

collection of available entities

getAllEntities

public Collection<T> getAllEntities()

Description copied from interface: FreedesktopService

Get a collection of all available entities in all bases. The bases are returned in reverse order, so that overriding entities come first.

Specified by:

getAllEntities in interface FreedesktopService<T extends FreedesktopEntity>

Returns:

collection of available entities

getEntity

public T getEntity(String name)

Description copied from interface: FreedesktopService

Get a entities given its name. If the entities exists in more than one base directory, the first base that the named theme is found in is returned.

Specified by:

getEntity in interface FreedesktopService<T extends FreedesktopEntity>

Parameters:

name - internal name of entities

Returns:

icon theme

getBases

public Collection<org.apache.commons.vfs2.FileObject> getBases()

Description copied from interface: FreedesktopService

Get a collection of all base directories.

Specified by:

getBases in interface FreedesktopService<T extends FreedesktopEntity>

Returns:

base directories

getBasesInReverse

public Collection<org.apache.commons.vfs2.FileObject> getBasesInReverse()

checkAndAddBase

protected void checkAndAddBase(org.apache.commons.vfs2.FileObject file)
                        throws IOException,
                               ParseException

Throws:

IOException

ParseException

checkAndAddBase

protected void checkAndAddBase(File file)
                        throws IOException,
                               ParseException

Throws:

IOException

ParseException

listDirs

protected org.apache.commons.vfs2.FileObject[] listDirs(org.apache.commons.vfs2.FileObject dir)
                                                 throws IOException

Throws:

IOException

scanBase

protected abstract Collection<T> scanBase(org.apache.commons.vfs2.FileObject base)
                                   throws IOException

Throws:

IOException