org.freedesktop

Interface FreedesktopService<T extends FreedesktopEntity>

All Known Subinterfaces:

AliasService, CursorService, DesktopEntryService, GlobService, IconService, MagicService, MIMEService, ThemeService<T>, WallpaperService

All Known Implementing Classes:

AbstractFreedesktopService, AbstractThemeService, DefaultAliasService, DefaultCursorService, DefaultDesktopEntryService, DefaultGlobService, DefaultIconService, DefaultMagicService, DefaultMIMEService, DefaultWallpaperService, LinuxAliasService, LinuxCursorService, LinuxDesktopEntryService, LinuxGlobService, LinuxIconService, LinuxMagicService, LinuxMIMEService, LinuxWallpaperService

public interface FreedesktopService<T extends FreedesktopEntity>

Implementations of this service interface provide an easy way for Java to use the freedesktop.org's various specifications.

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.
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<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.
void	removeBase(org.apache.commons.vfs2.FileObject base) Remove a directory from the list that is is searched.

Method Detail

addBase

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

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

Parameters:

base - base directory

Throws:

IOException - if location is invalid in some way

removeBase

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

Remove a directory from the list that is is searched.

Parameters:

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

See Also:

#addBase(File)

getBases

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

Get a collection of all base directories.

Returns:

base directories

getEntity

T getEntity(String name)

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.

Parameters:

name - internal name of entities

Returns:

icon theme

getEntities

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

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

Parameters:

base - base directory

Returns:

collection of available entities

getAllEntities

Collection<T> getAllEntities()

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

Returns:

collection of available entities