Package org.docx4j.org.apache.poi.poifs.crypt

Enum EncryptionMode

java.lang.Object
java.lang.Enum<EncryptionMode>
org.docx4j.org.apache.poi.poifs.crypt.EncryptionMode
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<EncryptionMode>, java.lang.constant.Constable
public enum EncryptionMode
extends java.lang.Enum<EncryptionMode>
Office supports various encryption modes. The encryption is either based on the whole container (agile, standard or binaryRC4) or record based (cryptoAPI). The record based encryption can't be accessed directly, but will be invoked by using the Biff8EncryptionKey#setCurrentUserPassword(String) before saving the document.

  • 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
    agile  
    binaryRC4  
    cryptoAPI  
    standard  

  • Field Summary

    Fields 
    Modifier and Type Field Description
    java.lang.String builder  
    int encryptionFlags  
    int versionMajor  
    int versionMinor  

  • Method Summary

    Modifier and Type Method Description
    static EncryptionMode valueOf​(java.lang.String name)
    Returns the enum constant of this type with the specified name.
    static EncryptionMode[] 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

  • Field Details

  • Method Details

    • values

      public static EncryptionMode[] 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 EncryptionMode 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