Package org.ametys.cms.contenttype
Class ContentTypeEnumerator
java.lang.Object
org.ametys.cms.contenttype.ContentTypeEnumerator
- All Implemented Interfaces:
Enumerator<String>
,Enumerator
,Configurable
,Serviceable
- Direct Known Subclasses:
AvailableContentTypesEnumerator
,CalendarContentTypesEnumerator
,ContentTypesForSearchEnumerator
public class ContentTypeEnumerator
extends Object
implements Enumerator<String>, Enumerator, Serviceable, Configurable
Enumerator for
ContentType
-
Field Summary
Modifier and TypeFieldDescriptionprotected String
All option : 'disabled' to disable the 'all' option, 'blank' to use a blank value for 'all' option, or 'concat' to concat all content types' ids for 'all' optionprotected String[]
The parent content typesprotected ContentTypeExtensionPoint
The content type extension pointprotected boolean
True to exclude abstract content typesprotected boolean
True to exclude mixin content typesprotected boolean
True to exclude private content typesprotected boolean
True to exclude reference table content typesprotected boolean
True to include only mixin content typesprotected boolean
True to include only reference table content typesprotected String[]
The strict content types -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected void
_handleAllOptionEntry
(Map<String, I18nizableText> entries) Add the all option entry to the entry list if necessaryvoid
configure
(Configuration configuration) Get the configuration of this enumeratorProvides the enumerated values with their optional label.Retrieves a single label from a value.protected Set<ContentType>
Get the matching content typesProvides the enumerated values with their optional label.void
service
(ServiceManager smanager)
-
Field Details
-
_cTypeExtPt
The content type extension point -
_allOption
All option : 'disabled' to disable the 'all' option, 'blank' to use a blank value for 'all' option, or 'concat' to concat all content types' ids for 'all' option -
_excludePrivate
True to exclude private content types -
_excludeReferenceTable
True to exclude reference table content types -
_excludeAbstract
True to exclude abstract content types -
_excludeMixin
True to exclude mixin content types -
_mixinOnly
True to include only mixin content types -
_referenceTableOnly
True to include only reference table content types -
_contentTypes
The parent content types -
_strictContentTypes
The strict content types
-
-
Constructor Details
-
ContentTypeEnumerator
public ContentTypeEnumerator()
-
-
Method Details
-
service
- Specified by:
service
in interfaceServiceable
- Throws:
ServiceException
-
configure
- Specified by:
configure
in interfaceConfigurable
- Throws:
ConfigurationException
-
getConfiguration
Description copied from interface:Enumerator
Get the configuration of this enumerator- Specified by:
getConfiguration
in interfaceEnumerator<String>
- Specified by:
getConfiguration
in interfaceEnumerator
- Returns:
- the configuration
-
getEntries
Description copied from interface:Enumerator
Provides the enumerated values with their optional label.- Specified by:
getEntries
in interfaceEnumerator
- Returns:
- the enumerated values and their label.
- Throws:
Exception
- if an error occurs.
-
getTypedEntries
Description copied from interface:Enumerator
Provides the enumerated values with their optional label.- Specified by:
getTypedEntries
in interfaceEnumerator<String>
- Returns:
- the enumerated values and their label.
- Throws:
Exception
- if an error occurs. TODO NEWATTRIBUTEAPI: rename this method whenEnumerator
will be removed
-
getMatchingContentTypes
Get the matching content types- Returns:
- the matching content types
-
_handleAllOptionEntry
Add the all option entry to the entry list if necessary- Parameters:
entries
- The enumerator entries
-
getEntry
Description copied from interface:Enumerator
Retrieves a single label from a value.- Specified by:
getEntry
in interfaceEnumerator<String>
- Specified by:
getEntry
in interfaceEnumerator
- Parameters:
value
- the value.- Returns:
- the label or
null
if not found. - Throws:
Exception
- if an error occurs.
-