Interface Property

  • All Superinterfaces:
    org.eclipse.emf.cdo.CDOObject, org.eclipse.emf.cdo.common.id.CDOWithID, org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier, Serializable
    All Known Implementing Classes:
    PropertyImpl

    public interface Property
    extends org.eclipse.emf.cdo.CDOObject, Serializable
    A representation of the model object 'Property'.

    The following features are supported:

    See Also:
    PropertiesPackage.getProperty()
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      PropertyAnnotation findAnnotation​(String name)
      Tries to find an annotation of the given name and returns it.
      org.eclipse.emf.common.util.EList<PropertyAnnotation> getAnnotations()
      Returns the value of the 'Annotations' reference list.
      String getComment()
      Returns the value of the 'Comment' attribute.
      String getCommentWithoutAnnotations()
      Returns the value of the 'Comment Without Annotations' attribute.
      String getKey()
      Returns the value of the 'Key' attribute.
      String getValue()
      Returns the value of the 'Value' attribute.
      void setComment​(String value)
      Sets the value of the 'Comment' attribute.
      void setKey​(String value)
      Sets the value of the 'Key' attribute.
      void setValue​(String value)
      Sets the value of the 'Value' attribute.
      • Methods inherited from interface org.eclipse.emf.cdo.CDOObject

        cdoConflict, cdoDirectResource, cdoHistory, cdoID, cdoInvalid, cdoLockState, cdoPrefetch, cdoReadLock, cdoReload, cdoResource, cdoRevision, cdoState, cdoView, cdoWriteLock, cdoWriteOption
      • Methods inherited from interface org.eclipse.emf.ecore.EObject

        eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset
      • Methods inherited from interface org.eclipse.emf.common.notify.Notifier

        eAdapters, eDeliver, eNotify, eSetDeliver
    • Method Detail

      • getKey

        String getKey()
        Returns the value of the 'Key' attribute.

        If the meaning of the 'Key' attribute isn't clear, there really should be more of a description here...

        Returns:
        the value of the 'Key' attribute.
        See Also:
        setKey(String), PropertiesPackage.getProperty_Key()
      • setKey

        void setKey​(String value)
        Sets the value of the 'Key' attribute.
        Parameters:
        value - the new value of the 'Key' attribute.
        See Also:
        getKey()
      • setValue

        void setValue​(String value)
        Sets the value of the 'Value' attribute.
        Parameters:
        value - the new value of the 'Value' attribute.
        See Also:
        getValue()
      • getComment

        String getComment()
        Returns the value of the 'Comment' attribute.

        The translation comment associated with the comment. If the comment contains any annotations, they are extracted automatically

        Returns:
        the value of the 'Comment' attribute.
        See Also:
        setComment(String), PropertiesPackage.getProperty_Comment()
      • setComment

        void setComment​(String value)
        Sets the value of the 'Comment' attribute.
        Parameters:
        value - the new value of the 'Comment' attribute.
        See Also:
        getComment()
      • getAnnotations

        org.eclipse.emf.common.util.EList<PropertyAnnotation> getAnnotations()
        Returns the value of the 'Annotations' reference list. The list contents are of type PropertyAnnotation.

        If the meaning of the 'Annotations' reference list isn't clear, there really should be more of a description here...

        Returns:
        the value of the 'Annotations' reference list.
        See Also:
        PropertiesPackage.getProperty_Annotations()
      • getCommentWithoutAnnotations

        String getCommentWithoutAnnotations()
        Returns the value of the 'Comment Without Annotations' attribute.

        This is the comment of the property minus any annotations found

        Returns:
        the value of the 'Comment Without Annotations' attribute.
        See Also:
        PropertiesPackage.getProperty_CommentWithoutAnnotations()
      • findAnnotation

        PropertyAnnotation findAnnotation​(String name)
        Tries to find an annotation of the given name and returns it. If none is found, null is returned