Package org.xwiki.annotation.maintainer

Enum AnnotationState

  • All Implemented Interfaces:
    Serializable, Comparable<AnnotationState>
    public enum AnnotationState
extends Enum<AnnotationState>
    Used to specify if an annotation target has been altered by a document modification.
    Since:
    2.3M1
    Version:
    $Id: 7977e84dbfd72846f21ed79a1b79defab9a4041a $

    • Enum Constant Detail

      • SAFE

        public static final AnnotationState SAFE
        An annotation is safe when it is valid and can be rendered on the document it has been added.

      • ALTERED

        public static final AnnotationState ALTERED
        An annotation is altered when the document on which it has been added changed and the annotation position could not be correctly found on the updated document.

      • UPDATED

        public static final AnnotationState UPDATED
        An annotation is updated if its selected text has suffered a modification and it could be detected and recovered during the maintaining process.

    • Method Detail

      • values

        public static AnnotationState[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (AnnotationState c : AnnotationState.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static AnnotationState valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null