Package io.delta.kernel.types

Class FieldMetadata

Object

io.delta.kernel.types.FieldMetadata

public final class FieldMetadata
extends Object

The metadata for a given StructField. The contents are immutable.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FieldMetadata.Builder	Builder class for FieldMetadata.

Method Summary

Modifier and Type	Method	Description
static FieldMetadata.Builder	builder()
boolean	contains(String key)
static FieldMetadata	empty()
boolean	equals(Object o)
boolean	equalsIgnoreKeys(FieldMetadata other, Set<String> keys)	Are the metadata same, ignoring the specified keys?
Object	get(String key)
Boolean	getBoolean(String key)
Boolean[]	getBooleanArray(String key)
Double	getDouble(String key)
Double[]	getDoubleArray(String key)
Map<String,Object>	getEntries()
Long	getLong(String key)
Long[]	getLongArray(String key)
FieldMetadata	getMetadata(String key)
FieldMetadata[]	getMetadataArray(String key)
MetadataColumnSpec	getMetadataColumnSpec(String key)
String	getString(String key)
String[]	getStringArray(String key)
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

getEntries

public Map<String,Object> getEntries()

Returns:

list of the key-value pairs in this FieldMetadata

contains

public boolean contains(String key)

Parameters:

key - the key to check for

Returns:

True if this contains a mapping for the given key, False otherwise

get

public Object get(String key)

Parameters:

key - the key to check for

Returns:

the value to which the specified key is mapped, or null if there is no mapping for the given key

getLong

public Long getLong(String key)

getDouble

public Double getDouble(String key)

getBoolean

public Boolean getBoolean(String key)

getString

public String getString(String key)

getMetadataColumnSpec

public MetadataColumnSpec getMetadataColumnSpec(String key)

getMetadata

public FieldMetadata getMetadata(String key)

getLongArray

public Long[] getLongArray(String key)

getDoubleArray

public Double[] getDoubleArray(String key)

getBooleanArray

public Boolean[] getBooleanArray(String key)

getStringArray

public String[] getStringArray(String key)

getMetadataArray

public FieldMetadata[] getMetadataArray(String key)

toString

public String toString()

Overrides:

toString in class Object

equalsIgnoreKeys

public boolean equalsIgnoreKeys(FieldMetadata other,
 Set<String> keys)

Are the metadata same, ignoring the specified keys?

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

builder

public static FieldMetadata.Builder builder()

Returns:

a new FieldMetadata.Builder

empty

public static FieldMetadata empty()

Returns:

an empty FieldMetadata instance