Package org.apache.spark.sql.types

Enum Class FileTypeMode

Object

Enum<FileTypeMode>

org.apache.spark.sql.types.FileTypeMode

All Implemented Interfaces:

Serializable, Comparable<FileTypeMode>, Constable

@Unstable
public enum FileTypeMode
extends Enum<FileTypeMode>

The mode for a FileType column.

• EXTERNAL - simple references, lifecycle independent of the table
• UNKNOWN - mode not yet determined (e.g., the result of a cast or of a UDF)

This enum is carried on FileType as part of the type's identity: FileType equality distinguishes modes (a FILE EXTERNAL column is not equal to a bare FILE under equals); see FileType.acceptsType for how expressions treat them.

Since:

4.4.0

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EXTERNAL
UNKNOWN

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

EXTERNAL

public static final FileTypeMode EXTERNAL

UNKNOWN

public static final FileTypeMode UNKNOWN

Method Details

values

public static FileTypeMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static FileTypeMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null