org.apache.poi.poifs.crypt

Enum EncryptionMode

java.lang.Object

java.lang.Enum<EncryptionMode>

org.apache.poi.poifs.crypt.EncryptionMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable< EncryptionMode>

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. (Office 支持多种加密模式。加密要么基于整个容器（敏捷、标准或二进制RC4），要么基于记录（cryptoAPI）。基于记录的加密不能直接访问，但会在保存文档之前使用 Biff8EncryptionKey.setCurrentUserPassword(String) 调用。)

Enum Constant Summary

Enum Constants

Enum Constant and Description
agile
binaryRC4
cryptoAPI
standard
xor

Field Summary

Fields

Modifier and Type	Field and Description
java.util.function.Supplier<EncryptionInfoBuilder>	builder
int	encryptionFlags
int	versionMajor
int	versionMinor

Method Summary

Modifier and Type	Method and 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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

binaryRC4

public static final EncryptionMode binaryRC4

cryptoAPI

public static final EncryptionMode cryptoAPI

standard

public static final EncryptionMode standard

agile

public static final EncryptionMode agile

xor

public static final EncryptionMode xor

Field Detail

builder

public final java.util.function.Supplier<EncryptionInfoBuilder> builder

versionMajor

public final int versionMajor

versionMinor

public final int versionMinor

encryptionFlags

public final int encryptionFlags

Method Detail

values

public static EncryptionMode[] 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 (EncryptionMode c : EncryptionMode.values())
    System.out.println(c);

(按照声明的顺序返回包含此枚举类型常量的数组。此方法可用于迭代常量，如下所示： for (EncryptionMode c : EncryptionMode.values()) System.out.println(c);)

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. (name - 要返回的枚举常量的名称。)

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.IllegalArgumentException - 如果此枚举类型没有具有指定名称的常量)

java.lang.NullPointerException - if the argument is null (java.lang.NullPointerException - 如果参数为空)