org.ametys.cms.data.type.impl

Class StringRepositoryElementType

java.lang.Object

org.ametys.core.model.type.AbstractModelItemType

org.ametys.core.model.type.AbstractElementType<String>

org.ametys.core.model.type.AbstractStringElementType

org.ametys.cms.data.type.impl.StringRepositoryElementType

All Implemented Interfaces:

RepositoryElementType<String>, RepositoryModelItemType, ElementType<String>, ModelItemType, PluginAware

Direct Known Subclasses:

PasswordRepositoryElementType

public class StringRepositoryElementType
extends AbstractStringElementType
implements RepositoryElementType<String>

Class for string type of elements stored in the repository

Constructor Summary

Constructors

Constructor and Description
StringRepositoryElementType()

Method Summary

Modifier and Type	Method and Description
boolean	isCompatible(RepositoryData parentData, String name) Checks if the value in the given repository data is compatible with the item type
Object	read(RepositoryData parentData, String name) Read the value in the given repository data
void	write(ModifiableRepositoryData parentData, String name, Object value) Write the value into the given repository data

Methods inherited from class org.ametys.core.model.type.AbstractStringElementType

castValue, fromJSONForClient, isSimple, passwordValueToJSONForClient, toString

Methods inherited from class org.ametys.core.model.type.AbstractElementType

_singleValueToJSON, _singleValueToSAX, getManagedClass, getManagedClassArray, isCompatible, parseConfiguration, valueToJSONForClient, valueToSAX

Methods inherited from class org.ametys.core.model.type.AbstractModelItemType

getId, setPluginInfo

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.ametys.runtime.model.type.ElementType

castValue, fromJSONForClient, getManagedClass, getManagedClassArray, isCompatible, isSimple, parseConfiguration, toString, valueToJSONForClient

Methods inherited from interface org.ametys.runtime.model.type.ModelItemType

getId, valueToSAX

Methods inherited from interface org.ametys.runtime.plugin.component.PluginAware

setPluginInfo

Constructor Detail

StringRepositoryElementType

public StringRepositoryElementType()

Method Detail

read

public Object read(RepositoryData parentData,
                   String name)
            throws BadItemTypeException

Description copied from interface: RepositoryElementType

Read the value in the given repository data

Specified by:

read in interface RepositoryElementType<String>

Parameters:

parentData - repository data containing the value

name - the name of the element to read

Returns:

the value. Can return a T or a T[]. That's why the return type is Object

Throws:

BadItemTypeException - if the reading value doesn't match this element type

write

public void write(ModifiableRepositoryData parentData,
                  String name,
                  Object value)
           throws BadItemTypeException

Description copied from interface: RepositoryElementType

Write the value into the given repository data

Specified by:

write in interface RepositoryElementType<String>

Parameters:

parentData - repository where to store the value.

name - the name of the element to write

value - the value to write. Can be a T or a T[]. That's why it is an Object

Throws:

BadItemTypeException - If the given value doesn't match this element type

isCompatible

public boolean isCompatible(RepositoryData parentData,
                            String name)
                     throws UnknownDataException

Description copied from interface: RepositoryModelItemType

Checks if the value in the given repository data is compatible with the item type

Specified by:

isCompatible in interface RepositoryModelItemType

Parameters:

parentData - repository data containing the data to check

name - the name of the data to check

Returns:

true if the data type matches the current type, false otherwise

Throws:

UnknownDataException - if there is no data in the parent repository data with this name