Package com.e1c.langtool.collector

Interface FeatureValue

All Superinterfaces:
ContextTranslationKey, Serializable, TranslationKey
All Known Subinterfaces:
EFeatureValue, FileFeatureValue
All Known Implementing Classes:
EmfFeatureValue, PersistableFeatureValue, V8FeatureValue
public interface FeatureValue extends Serializable, ContextTranslationKey
The Interface is common for object contains feature string value, feature FQN key, object's resource ID, feature settings and value is computed. Implementers must care themselves to their concurrency usage or be a thread-safe. Implementers are advisable to be immutable.
See Also:

  • Method Details

    • getContextKey

      ContextTranslationKey getContextKey()
      Gets the context translation key.
      Returns:
      the context key, cannot return null.

    • isComputedValue

      boolean isComputedValue()
      Checks if the value is computed from base objects.
      Returns:
      the computedValue, cannot be null.

    • isUnknown

      boolean isUnknown()
      Checks if the value is unknown.
      Returns:
      true if unknown value.

    • isTag

      boolean isTag()
      Checks if is tag or tag parameter.
      Returns:
      true, if is tag or tag parameter.

    • getLocalStrings

      Map<String,String> getLocalStrings()
      Gets the local strings of object feature.
      Returns:
      the Map of local strings. The key of entry is "Language code" and the value of entry is the "local string" in this language. Cannot be null.

    • getComment

      default String getComment()
      Gets the comment for the collected value.
      Returns:
      the comment

    • getFullPath

      @Deprecated default String getFullPath()
      Deprecated.
      Description copied from interface: ContextTranslationKey
      Gets the full path of the resource including project name.
      Specified by:
      getFullPath in interface ContextTranslationKey
      Returns:
      the full path of resource, cannot return null.

    • getFeatureSettings

      @Deprecated default FeatureSettings getFeatureSettings()
      Deprecated.
      Description copied from interface: TranslationKey
      Gets the feature settings.
      Specified by:
      getFeatureSettings in interface TranslationKey
      Returns:
      the feature settings, cannot be null.

    • getValue

      @Deprecated default String getValue()
      Deprecated.
      Description copied from interface: TranslationKey
      Gets the value of object feature.
      Specified by:
      getValue in interface TranslationKey
      Returns:
      the value, cannot be null.

    • getSourceProject

      @Deprecated default org.eclipse.core.resources.IProject getSourceProject()
      Deprecated.
      Description copied from interface: ContextTranslationKey
      Gets the project of the source object.
      Specified by:
      getSourceProject in interface ContextTranslationKey
      Returns:
      the source project, cannot return null.

    • getResourceId

      @Deprecated default org.eclipse.core.runtime.IPath getResourceId()
      Deprecated.
      Description copied from interface: ContextTranslationKey
      Gets the id of resource of translatable feature. It must be unique in project scope and free of project name in prefix that is mean id is project related.
      Specified by:
      getResourceId in interface ContextTranslationKey
      Returns:
      the resource id, cannot return null.

    • getFeatureKey

      @Deprecated default FeatureKey getFeatureKey()
      Deprecated.
      Description copied from interface: ContextTranslationKey
      Gets the feature key in resource.
      Specified by:
      getFeatureKey in interface ContextTranslationKey
      Returns:
      the featureKey, cannot return null.