Package org.codelibs.fess.theme

Class Theme

java.lang.Object

org.codelibs.fess.theme.Theme

public final class Theme
extends Object

Immutable value object describing a registered static theme.

A Theme is backed by a theme.yml manifest under the configured themes directory. The manifest may be absent when unit tests construct synthetic themes without a real bundle.

Constructor Summary

Constructors

Constructor	Description
Theme(String name, Path basePath, ThemeManifest manifest)	Constructs a new theme descriptor.

Method Summary

Modifier and Type	Method	Description
Path	getBasePath()	Returns the filesystem base path of the theme bundle.
Optional<ThemeManifest>	getManifest()	Returns the parsed manifest, if any.
String	getName()	Returns the theme name.

Methods inherited from class java.lang.Object

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

Constructor Details

Theme

public Theme(String name,
 Path basePath,
 ThemeManifest manifest)

Constructs a new theme descriptor.

Parameters:

name - theme directory name

basePath - filesystem location of the theme bundle

manifest - parsed manifest, or null for test fixtures without one

Method Details

getName

public String getName()

Returns the theme name.

Returns:

the theme name

getBasePath

public Path getBasePath()

Returns the filesystem base path of the theme bundle.

Returns:

the base path

getManifest

public Optional<ThemeManifest> getManifest()

Returns the parsed manifest, if any.

Returns:

the optional manifest