net.devh.boot.grpc.common.codec

Enum CodecType

java.lang.Object

java.lang.Enum<CodecType>

net.devh.boot.grpc.common.codec.CodecType

All Implemented Interfaces:

Serializable, Comparable<CodecType>

public enum CodecType
extends Enum<CodecType>

The type of the codec.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL The codec should be used for both compression and decompression.
COMPRESS The codec should be used for compression only.
DECOMPRESS The codec should be used for decompression only.

Method Summary

Modifier and Type	Method and Description
boolean	isForCompression() Whether the associated codec should be used for compression.
boolean	isForDecompression() Whether the associated codec should be used for decompression.
static CodecType	valueOf(String name) Returns the enum constant of this type with the specified name.
static CodecType[]	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

COMPRESS

public static final CodecType COMPRESS

The codec should be used for compression only.

DECOMPRESS

public static final CodecType DECOMPRESS

The codec should be used for decompression only.

ALL

public static final CodecType ALL

The codec should be used for both compression and decompression.

Method Detail

values

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

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CodecType 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

isForCompression

public boolean isForCompression()

Whether the associated codec should be used for compression.

Returns:

True, if the codec can be used for compression. False otherwise.

isForDecompression

public boolean isForDecompression()

Whether the associated codec should be used for decompression.

Returns:

True, if the codec can be used for decompression. False otherwise.