Class EnumValueModelConverter
java.lang.Object
de.hybris.platform.servicelayer.internal.converter.impl.EnumValueModelConverter
- All Implemented Interfaces:
ModelConverter
Special model converter for hybris enum values.
-
Constructor Summary
ConstructorsConstructorDescriptionEnumValueModelConverter(Class enumClass, SourceTransformer sourceTransformer) -
Method Summary
Modifier and TypeMethodDescriptionvoidafterDetach(Object model, ModelContext ctx) This method is executed after the givenmodelis attached from the givenModelContextvoidbeforeAttach(Object model, ModelContext ctx) This method is executed before the givenmodelis attached to the givenModelContextCreates a new empty model instance.booleanprotected booleanexists(HybrisEnumValue enumValue) booleanReturnstrueif for the given model a source Item exists and if this item Item#isAlive()getAttributeValue(Object model, String attributeQualifier) Generic attribute value getter to read attribute data from arbitrary model instances.getDirtyAttributes(Object model) Returns a map with all modified attribute qualifiers for the given model.getLocalizedAttributeValue(Object model, String attributeQualifier, Locale locale) Generic attribute value getter to read attribute data from arbitrary model instances.getPartOfAttributes(TypeService typeService) Returns a collection of all partof atrributesgetPersistenceSource(Object model) Returns underlying source for given model.Returns the exact type of the given model.protected MethodgetWritablePartOfAttributes(TypeService typeService) Returns a collection of writable partof atrributesinthashCode()voidinit(ConverterRegistry registry) Called once before using the converter the first time.booleanbooleanisModified(Object model) Returnstrueif the given model is new or the ModelValueHistory of the model contains changed attributes.booleanisModified(Object model, String attribute) Returnstrueif the given model is new or the ModelValueHistory for the given attribute (qualifier) was changed.booleanisModified(Object model, String attribute, Locale loc) Returnstrueif the given model is new or the ModelValueHistory for the given attribute (qualifier) was changed.booleanReturnstrueif the given model was not persisted yet.booleanReturnstrueif for the given model no source Item exists or this item is not Item#isAlive()booleanisUpToDate(Object model) The given model is not up-to-date (returnsfalse) when: the model is new (seeModelConverter.isNew(Object)) or the model was removed (seeModelConverter.isRemoved(Object)) or the model was locally modified or the Item in the database is newer as the source item of the modelCreates a new model instance and fills its attributes with data from given source objectvoidFills the attributes of passed model new using mapped source object.voidTries to remove the source of the given model.voidsave(Object model, Collection<String> excluded) Saves all attribute values from the model to the wrapped source object or creates a new one if no source is mapped yet.voidsetAttributeValue(Object model, String attributeQualifier, Object value) Generic attribute value setter to modify attribute data on arbitrary model instances.
-
Constructor Details
-
EnumValueModelConverter
-
-
Method Details
-
getEnumClass
-
getValueOfMethod
-
exists
-
isJavaEnum
public boolean isJavaEnum() -
create
Description copied from interface:ModelConverterCreates a new empty model instance.- Specified by:
createin interfaceModelConverter- Returns:
- new empty model
-
getType
Description copied from interface:ModelConverterReturns the exact type of the given model.- Specified by:
getTypein interfaceModelConverter
-
getPersistenceSource
- Specified by:
getPersistenceSourcein interfaceModelConverter
-
getSource
Description copied from interface:ModelConverterReturns underlying source for given model.- Specified by:
getSourcein interfaceModelConverter- Parameters:
model- the model for which to return the source- Returns:
- the underlying source of the given model, or null if the source doesn't (yet) exist
-
init
Description copied from interface:ModelConverterCalled once before using the converter the first time.- Specified by:
initin interfaceModelConverter- Parameters:
registry- the registry holding this converter.
-
load
Description copied from interface:ModelConverterCreates a new model instance and fills its attributes with data from given source object- Specified by:
loadin interfaceModelConverter- Parameters:
source- object which will be used for filling new model- Returns:
- new model instance with data of given source
-
reload
Description copied from interface:ModelConverterFills the attributes of passed model new using mapped source object.- Specified by:
reloadin interfaceModelConverter- Parameters:
model- model which will be filled from scratch using mapped source
-
remove
Description copied from interface:ModelConverterTries to remove the source of the given model.- Specified by:
removein interfaceModelConverter- Parameters:
model- the model for which to remove the source
-
save
Description copied from interface:ModelConverterSaves all attribute values from the model to the wrapped source object or creates a new one if no source is mapped yet.- Specified by:
savein interfaceModelConverter- Parameters:
model- the model to save
-
isModified
Description copied from interface:ModelConverterReturnstrueif the given model is new or the ModelValueHistory of the model contains changed attributes.- Specified by:
isModifiedin interfaceModelConverter- Parameters:
model- the model- Returns:
falseotherwise
-
isModified
Description copied from interface:ModelConverterReturnstrueif the given model is new or the ModelValueHistory for the given attribute (qualifier) was changed. If the attribute is localized the current session dataLocale(see LocaleProvider#getCurrentDataLocale()) is used.- Specified by:
isModifiedin interfaceModelConverter- Parameters:
model- the modelattribute- the attribute qualifier- Returns:
falseif the attribute was not modified.
-
isModified
Description copied from interface:ModelConverterReturnstrueif the given model is new or the ModelValueHistory for the given attribute (qualifier) was changed. For localized attributes the givenLocaleis used to check for modifications. If the Locale isnullthen all Locales will be checked for modifications. For non-localized attributes the given Locale will be ignored.- Specified by:
isModifiedin interfaceModelConverter- Parameters:
model- the modelattribute- the attribute qualifierloc- the Locale. Can benull.- Returns:
falseotherwise.
-
exists
Description copied from interface:ModelConverterReturnstrueif for the given model a source Item exists and if this item Item#isAlive()- Specified by:
existsin interfaceModelConverter- Parameters:
model- the model- Returns:
falseif the model was not persisted yet (no underlying item) or the item was removed.
-
isRemoved
Description copied from interface:ModelConverterReturnstrueif for the given model no source Item exists or this item is not Item#isAlive()- Specified by:
isRemovedin interfaceModelConverter- Parameters:
model- the model- Returns:
falseif the modelModelConverter.isNew(Object)or the item is alive.
-
isNew
Description copied from interface:ModelConverterReturnstrueif the given model was not persisted yet.- Specified by:
isNewin interfaceModelConverter- Parameters:
model- the model- Returns:
falseif an AttributeProvider for the given model exists.
-
isUpToDate
Description copied from interface:ModelConverterThe given model is not up-to-date (returnsfalse) when:- the model is new (see
ModelConverter.isNew(Object)) or - the model was removed (see
ModelConverter.isRemoved(Object)) or - the model was locally modified or
- the Item in the database is newer as the source item of the model
- Specified by:
isUpToDatein interfaceModelConverter- Parameters:
model- the model- Returns:
trueif the model is up-to-date
- the model is new (see
-
getAttributeValue
Description copied from interface:ModelConverterGeneric attribute value getter to read attribute data from arbitrary model instances.- Specified by:
getAttributeValuein interfaceModelConverter- Parameters:
model- the model instanceattributeQualifier- the attribute qualifier- Returns:
- the attribute value
-
getLocalizedAttributeValue
Description copied from interface:ModelConverterGeneric attribute value getter to read attribute data from arbitrary model instances.- Specified by:
getLocalizedAttributeValuein interfaceModelConverter- Parameters:
model- the model instanceattributeQualifier- the attribute qualifierlocale- Locale for which value will be returned- Returns:
- the attribute value
-
setAttributeValue
Description copied from interface:ModelConverterGeneric attribute value setter to modify attribute data on arbitrary model instances.- Specified by:
setAttributeValuein interfaceModelConverter- Parameters:
model- the modelattributeQualifier- the attribute qualifiervalue- the attribute value
-
beforeAttach
Description copied from interface:ModelConverterThis method is executed before the givenmodelis attached to the givenModelContext- Specified by:
beforeAttachin interfaceModelConverter
-
afterDetach
Description copied from interface:ModelConverterThis method is executed after the givenmodelis attached from the givenModelContext- Specified by:
afterDetachin interfaceModelConverter
-
getWritablePartOfAttributes
Description copied from interface:ModelConverterReturns a collection of writable partof atrributes- Specified by:
getWritablePartOfAttributesin interfaceModelConverter
-
getPartOfAttributes
Description copied from interface:ModelConverterReturns a collection of all partof atrributes- Specified by:
getPartOfAttributesin interfaceModelConverter
-
getDirtyAttributes
Description copied from interface:ModelConverterReturns a map with all modified attribute qualifiers for the given model. The keys are all localized and non-localized attribute qualifier which were modified. If the map value isnullthe key is a non-localized attribute qualifier else the map value contains the locale in which language the localized attribute was modified.- Specified by:
getDirtyAttributesin interfaceModelConverter- Parameters:
model- the new (not saved) model- Returns:
- a map with all modified attribute qualifier.
-
equals
-
hashCode
public int hashCode()
-