Class TemplatePersistenceData
java.lang.Object
org.eclipse.text.templates.TemplatePersistenceData
org.eclipse.jface.text.templates.persistence.TemplatePersistenceData
Deprecated.
TemplatePersistenceData stores information about a template. It uniquely
references contributed templates via their id. Contributed templates may be
deleted or modified. All template may be enabled or not.
Clients may use this class, although this is not usually needed except when implementing a custom template preference page or template store. This class is not intended to be subclassed.
- Since:
- 3.0
- Restriction:
- This class is not intended to be subclassed by clients.
-
Constructor Summary
ConstructorsConstructorDescriptionTemplatePersistenceData(Template template, boolean enabled) Deprecated.TemplatePersistenceData(Template template, boolean enabled, String id) Deprecated.Deprecated.In some cases, we must continue to respect the deprecated TemplatePresistenceData even though we are givenTemplatePersistenceData. -
Method Summary
Modifier and TypeMethodDescriptionbooleanDeprecated.getId()Deprecated.Returns the id of this template store, ornullif there is none.Deprecated.Returns the template encapsulated by the receiver.protected UUIDDeprecated.Required to support equals() with deprecated type org.eclipse.jface.text.templates.persistence.TemplatePersistenceData.inthashCode()Deprecated.booleanisCustom()Deprecated.Returns whether the receiver represents a custom template, i.e. is either a user-added template or a contributed template that has been modified.booleanDeprecated.Returns the deletion state of the stored template.booleanDeprecated.Returns the enablement state of the contained template.booleanDeprecated.Returns whether the receiver represents a modified template, i.e. a contributed template that has been changed.booleanDeprecated.Returnstrueif the contained template was added by a user, i.e. does not reference a contributed template.voidrevert()Deprecated.Reverts the template to its original setting.voidsetDeleted(boolean isDeleted) Deprecated.Sets the deletion state of the stored template.voidsetEnabled(boolean isEnabled) Deprecated.Sets the enablement state of the contained template.voidsetTemplate(Template template) Deprecated.Sets the template encapsulated by the receiver.Methods inherited from class org.eclipse.text.templates.TemplatePersistenceData
getUniqueIdForEquals
-
Constructor Details
-
TemplatePersistenceData
Deprecated.In some cases, we must continue to respect the deprecated TemplatePresistenceData even though we are givenTemplatePersistenceData.- Parameters:
data- TheTemplatePersistenceDatathat will underlie this object.- Since:
- 3.14
-
TemplatePersistenceData
Deprecated. -
TemplatePersistenceData
Deprecated.
-
-
Method Details
-
getId
Deprecated.Description copied from class:TemplatePersistenceDataReturns the id of this template store, ornullif there is none.- Overrides:
getIdin classTemplatePersistenceData- Returns:
- the id of this template store
-
isDeleted
public boolean isDeleted()Deprecated.Description copied from class:TemplatePersistenceDataReturns the deletion state of the stored template. This is only relevant of contributed templates.- Overrides:
isDeletedin classTemplatePersistenceData- Returns:
- the deletion state of the stored template
-
setDeleted
public void setDeleted(boolean isDeleted) Deprecated.Description copied from class:TemplatePersistenceDataSets the deletion state of the stored template.- Overrides:
setDeletedin classTemplatePersistenceData- Parameters:
isDeleted- the deletion state of the stored template
-
getTemplate
Deprecated.Description copied from class:TemplatePersistenceDataReturns the template encapsulated by the receiver.- Overrides:
getTemplatein classTemplatePersistenceData- Returns:
- the template encapsulated by the receiver
-
setTemplate
Deprecated.Description copied from class:TemplatePersistenceDataSets the template encapsulated by the receiver.- Overrides:
setTemplatein classTemplatePersistenceData- Parameters:
template- the new template
-
isCustom
public boolean isCustom()Deprecated.Description copied from class:TemplatePersistenceDataReturns whether the receiver represents a custom template, i.e. is either a user-added template or a contributed template that has been modified.- Overrides:
isCustomin classTemplatePersistenceData- Returns:
trueif the contained template is a custom template and cannot be reconstructed from the contributed templates
-
isModified
public boolean isModified()Deprecated.Description copied from class:TemplatePersistenceDataReturns whether the receiver represents a modified template, i.e. a contributed template that has been changed.- Overrides:
isModifiedin classTemplatePersistenceData- Returns:
trueif the contained template is contributed but has been modified,falseotherwise
-
isUserAdded
public boolean isUserAdded()Deprecated.Description copied from class:TemplatePersistenceDataReturnstrueif the contained template was added by a user, i.e. does not reference a contributed template.- Overrides:
isUserAddedin classTemplatePersistenceData- Returns:
trueif the contained template was added by a user,falseotherwise
-
revert
public void revert()Deprecated.Description copied from class:TemplatePersistenceDataReverts the template to its original setting.- Overrides:
revertin classTemplatePersistenceData
-
isEnabled
public boolean isEnabled()Deprecated.Description copied from class:TemplatePersistenceDataReturns the enablement state of the contained template.- Overrides:
isEnabledin classTemplatePersistenceData- Returns:
- the enablement state of the contained template
-
setEnabled
public void setEnabled(boolean isEnabled) Deprecated.Description copied from class:TemplatePersistenceDataSets the enablement state of the contained template.- Overrides:
setEnabledin classTemplatePersistenceData- Parameters:
isEnabled- the new enablement state of the contained template
-
equals
Deprecated.- Overrides:
equalsin classTemplatePersistenceData
-
hashCode
public int hashCode()Deprecated.- Overrides:
hashCodein classTemplatePersistenceData
-
getUniqueIdForEquals
Deprecated.Description copied from class:TemplatePersistenceDataRequired to support equals() with deprecated type org.eclipse.jface.text.templates.persistence.TemplatePersistenceData.- Overrides:
getUniqueIdForEqualsin classTemplatePersistenceData- Returns:
- unique id to support
TemplatePersistenceData.equals(Object)
-
TemplatePersistenceData