Package org.docx4j.model.datastorage

Enum RemovalHandler.Quantifier

java.lang.Object
java.lang.Enum<RemovalHandler.Quantifier>
org.docx4j.model.datastorage.RemovalHandler.Quantifier
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<RemovalHandler.Quantifier>, java.lang.constant.Constable
Enclosing class:
RemovalHandler
public static enum RemovalHandler.Quantifier
extends java.lang.Enum<RemovalHandler.Quantifier>
A quantifier specifying kinds of SDTs.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

  • Enum Constant Summary

    Enum Constants 
    Enum Constant Description
    ALL
    Every SDT shall be removed.
    ALL_BUT_PLACEHOLDERS
    Ordinarily, if an SDT contains XML but no real content, that XML is also removed.
    ALL_BUT_PLACEHOLDERS_CONTENT
    Ordinarily, if an SDT contains XML but no real content, that XML is also removed.
    DEFAULT
    The default SDTs shall be removed, that is, condition and repeat.
    NAMED
    Named SDTs shall be removed, the names given separately.

  • Method Summary

    Modifier and Type Method Description
    static RemovalHandler.Quantifier valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static RemovalHandler.Quantifier[] values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • ALL

      public static final RemovalHandler.Quantifier ALL
      Every SDT shall be removed. From 3.3.0, this really means all SDTs in the main document part. If an SDT does not contain any 'real' content, then remove that XML as well.

    • ALL_BUT_PLACEHOLDERS_CONTENT

      public static final RemovalHandler.Quantifier ALL_BUT_PLACEHOLDERS_CONTENT
      Ordinarily, if an SDT contains XML but no real content, that XML is also removed. Choose this option if you want to keep placeholder XML (but remove the SDT). Currently, to be identified as a placeholder, it must use rStyle 'PlaceholderText'.
      Since:
      6.1.1

    • ALL_BUT_PLACEHOLDERS

      public static final RemovalHandler.Quantifier ALL_BUT_PLACEHOLDERS
      Ordinarily, if an SDT contains XML but no real content, that XML is also removed. Choose this option if you want to keep placeholder XML (keeping the SDT as well). Currently, to be identified as a placeholder, it must use rStyle 'PlaceholderText'.
      Since:
      6.1.0

    • DEFAULT

      public static final RemovalHandler.Quantifier DEFAULT
      The default SDTs shall be removed, that is, condition and repeat. (If you want to remove xpaths, either use Quantifier.ALL, or pass key "xpath")

    • NAMED

      public static final RemovalHandler.Quantifier NAMED
      Named SDTs shall be removed, the names given separately.

  • Method Details

    • values

      public static RemovalHandler.Quantifier[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static RemovalHandler.Quantifier valueOf​(java.lang.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:
      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null