Package io.substrait.relation.files

Class ImmutableFileFormat.DelimiterSeparatedTextReadOptions.Builder

java.lang.Object

io.substrait.relation.files.ImmutableFileFormat.DelimiterSeparatedTextReadOptions.Builder

Enclosing class:

ImmutableFileFormat.DelimiterSeparatedTextReadOptions

public static final class ImmutableFileFormat.DelimiterSeparatedTextReadOptions.Builder
extends Object

Builds instances of type DelimiterSeparatedTextReadOptions. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method	Description
ImmutableFileFormat.DelimiterSeparatedTextReadOptions	build()	Builds a new DelimiterSeparatedTextReadOptions.
final ImmutableFileFormat.DelimiterSeparatedTextReadOptions.Builder	escape(String escape)	Initializes the value for the escape attribute.
final ImmutableFileFormat.DelimiterSeparatedTextReadOptions.Builder	fieldDelimiter(String fieldDelimiter)	Initializes the value for the fieldDelimiter attribute.
final ImmutableFileFormat.DelimiterSeparatedTextReadOptions.Builder	from(FileFormat.DelimiterSeparatedTextReadOptions instance)	Fill a builder with attribute values from the provided DelimiterSeparatedTextReadOptions instance.
final ImmutableFileFormat.DelimiterSeparatedTextReadOptions.Builder	headerLinesToSkip(long headerLinesToSkip)	Initializes the value for the headerLinesToSkip attribute.
final ImmutableFileFormat.DelimiterSeparatedTextReadOptions.Builder	maxLineSize(long maxLineSize)	Initializes the value for the maxLineSize attribute.
final ImmutableFileFormat.DelimiterSeparatedTextReadOptions.Builder	quote(String quote)	Initializes the value for the quote attribute.
final ImmutableFileFormat.DelimiterSeparatedTextReadOptions.Builder	valueTreatedAsNull(String valueTreatedAsNull)	Initializes the optional value valueTreatedAsNull to valueTreatedAsNull.
final ImmutableFileFormat.DelimiterSeparatedTextReadOptions.Builder	valueTreatedAsNull(Optional<String> valueTreatedAsNull)	Initializes the optional value valueTreatedAsNull to valueTreatedAsNull.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

from

public final ImmutableFileFormat.DelimiterSeparatedTextReadOptions.Builder from(FileFormat.DelimiterSeparatedTextReadOptions instance)

Fill a builder with attribute values from the provided DelimiterSeparatedTextReadOptions instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

fieldDelimiter

public final ImmutableFileFormat.DelimiterSeparatedTextReadOptions.Builder fieldDelimiter(String fieldDelimiter)

Initializes the value for the fieldDelimiter attribute.

Parameters:

fieldDelimiter - The value for fieldDelimiter

Returns:

this builder for use in a chained invocation

maxLineSize

public final ImmutableFileFormat.DelimiterSeparatedTextReadOptions.Builder maxLineSize(long maxLineSize)

Initializes the value for the maxLineSize attribute.

Parameters:

maxLineSize - The value for maxLineSize

Returns:

this builder for use in a chained invocation

quote

public final ImmutableFileFormat.DelimiterSeparatedTextReadOptions.Builder quote(String quote)

Initializes the value for the quote attribute.

Parameters:

quote - The value for quote

Returns:

this builder for use in a chained invocation

headerLinesToSkip

public final ImmutableFileFormat.DelimiterSeparatedTextReadOptions.Builder headerLinesToSkip(long headerLinesToSkip)

Initializes the value for the headerLinesToSkip attribute.

Parameters:

headerLinesToSkip - The value for headerLinesToSkip

Returns:

this builder for use in a chained invocation

escape

public final ImmutableFileFormat.DelimiterSeparatedTextReadOptions.Builder escape(String escape)

Initializes the value for the escape attribute.

Parameters:

escape - The value for escape

Returns:

this builder for use in a chained invocation

valueTreatedAsNull

public final ImmutableFileFormat.DelimiterSeparatedTextReadOptions.Builder valueTreatedAsNull(String valueTreatedAsNull)

Initializes the optional value valueTreatedAsNull to valueTreatedAsNull.

Parameters:

valueTreatedAsNull - The value for valueTreatedAsNull

Returns:

this builder for chained invocation

valueTreatedAsNull

public final ImmutableFileFormat.DelimiterSeparatedTextReadOptions.Builder valueTreatedAsNull(Optional<String> valueTreatedAsNull)

Initializes the optional value valueTreatedAsNull to valueTreatedAsNull.

Parameters:

valueTreatedAsNull - The value for valueTreatedAsNull

Returns:

this builder for use in a chained invocation

build

public ImmutableFileFormat.DelimiterSeparatedTextReadOptions build()

Builds a new DelimiterSeparatedTextReadOptions.

Returns:

An immutable instance of DelimiterSeparatedTextReadOptions

Throws:

IllegalStateException - if any required attributes are missing