Package org.opencms.ade.configuration.formatters

Class CmsSettingConfiguration.CmsSettingDefiningFile

java.lang.Object

org.opencms.ade.configuration.formatters.CmsSettingConfiguration.CmsSettingDefiningFile

Enclosing class:

CmsSettingConfiguration

public static class CmsSettingConfiguration.CmsSettingDefiningFile
extends Object

The shared setting configuration file that defines a setting, for configuration origin discovery: the file's structure id, whether the matching definition is formatter-specific, and whether it comes from a sitemap setting override (rather than the formatter's own shared settings).

Constructor Summary

Constructors

Constructor	Description
CmsSettingDefiningFile(CmsUUID fileId, boolean formatterScoped, boolean fromOverride)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
CmsUUID	getFileId()	Gets the structure id of the defining shared setting configuration file.
boolean	isFormatterScoped()	Returns whether the matching definition is keyed to the formatter (vs.
boolean	isFromOverride()	Returns whether the file is a sitemap setting override (vs.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsSettingDefiningFile

public CmsSettingDefiningFile(CmsUUID fileId,
 boolean formatterScoped,
 boolean fromOverride)

Creates a new instance.

Parameters:

fileId - the file structure id

formatterScoped - whether the matching definition is formatter-specific

fromOverride - whether the file is a sitemap setting override

Method Details

getFileId

public CmsUUID getFileId()

Gets the structure id of the defining shared setting configuration file.

Returns:

the file structure id

isFormatterScoped

public boolean isFormatterScoped()

Returns whether the matching definition is keyed to the formatter (vs. the global setting).

Returns:

true if the definition is formatter-specific

isFromOverride

public boolean isFromOverride()

Returns whether the file is a sitemap setting override (vs. a formatter shared setting).

Returns:

true if the file is a sitemap setting override